GtkSourceCompletionContext

GtkSourceCompletionContext

Synopsis

#include <gtksourceview/gtksourcecompletioncontext.h>

enum                GtkSourceCompletionActivation;
                    GtkSourceCompletionContext;
void                gtk_source_completion_context_add_proposals
                                                        (GtkSourceCompletionContext *context,
                                                         struct _GtkSourceCompletionProvider *provider,
                                                         GList *proposals,
                                                         gboolean finished);
void                gtk_source_completion_context_get_iter
                                                        (GtkSourceCompletionContext *context,
                                                         GtkTextIter *iter);
GtkSourceCompletionActivation  gtk_source_completion_context_get_activation
                                                        (GtkSourceCompletionContext *context);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkSourceCompletionContext

Properties

  "activation"               GtkSourceCompletionActivation  : Read / Write
  "completion"               GtkSourceCompletion*  : Read / Write / Construct Only
  "iter"                     GtkTextIter*          : Read / Write

Signals

  "cancelled"                                      : Run Last / Action

Description

Details

enum GtkSourceCompletionActivation

typedef enum
{
	GTK_SOURCE_COMPLETION_ACTIVATION_NONE = 0,
	GTK_SOURCE_COMPLETION_ACTIVATION_INTERACTIVE = 1 << 0,
	GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED = 1 << 1
} GtkSourceCompletionActivation;

GTK_SOURCE_COMPLETION_ACTIVATION_NONE

none.

GTK_SOURCE_COMPLETION_ACTIVATION_INTERACTIVE

interactive activation

GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED

user requested activation (e.g. through a keyboard accelerator from the view)

GtkSourceCompletionContext

typedef struct _GtkSourceCompletionContext GtkSourceCompletionContext;

gtk_source_completion_context_add_proposals ()

void                gtk_source_completion_context_add_proposals
                                                        (GtkSourceCompletionContext *context,
                                                         struct _GtkSourceCompletionProvider *provider,
                                                         GList *proposals,
                                                         gboolean finished);

Providers can use this function to add proposals to the completion. They can do so asynchronously by means of the finished argument. Providers must ensure that they always call this function with finished set to TRUE once each population (even if no proposals need to be added).

context :

A GtkSourceCompletionContext

provider :

A GtkSourceCompletionProvider

proposals :

The list of proposals to add

finished :

Whether the provider is finished adding proposals

gtk_source_completion_context_get_iter ()

void                gtk_source_completion_context_get_iter
                                                        (GtkSourceCompletionContext *context,
                                                         GtkTextIter *iter);

Get the iter at which the completion was invoked. Providers can use this to determine how and if to match proposals.

context :

A GtkSourceCompletionContext

iter :

A GtkTextIter

gtk_source_completion_context_get_activation ()

GtkSourceCompletionActivation  gtk_source_completion_context_get_activation
                                                        (GtkSourceCompletionContext *context);

Get the context activation

context :

A GtkSourceCompletionContext

Returns :

The context activation

Property Details

The "activation" property

  "activation"               GtkSourceCompletionActivation  : Read / Write

The completion activation


The "completion" property

  "completion"               GtkSourceCompletion*  : Read / Write / Construct Only

The GtkSourceCompletion associated with the context.


The "iter" property

  "iter"                     GtkTextIter*          : Read / Write

The GtkTextIter at which the completion is invoked.

Signal Details

The "cancelled" signal

void                user_function                      (GtkSourceCompletionContext *arg0,
                                                        gpointer                    user_data)      : Run Last / Action

Emitted when the current population of proposals has been cancelled. Providers adding proposals asynchronously should connect to this signal to know when to cancel running proposal queries.

user_data :

user data set when the signal handler was connected.