gtk_source_completion_add_provider ()

gboolean
gtk_source_completion_add_provider (GtkSourceCompletion *completion,
                                    GtkSourceCompletionProvider *provider,
                                    GError **error);

Add a new GtkSourceCompletionProvider to the completion object. This will add a reference provider , so make sure to unref your own copy when you no longer need it.

gtk_source_completion_remove_provider ()

gboolean
gtk_source_completion_remove_provider (GtkSourceCompletion *completion,
                                       GtkSourceCompletionProvider *provider,
                                       GError **error);

Remove provider from the completion.

gtk_source_completion_get_providers ()

GList *
gtk_source_completion_get_providers (GtkSourceCompletion *completion);

Get list of providers registered on completion . The returned list is owned by the completion and should not be freed.

gtk_source_completion_show ()

gboolean
gtk_source_completion_show (GtkSourceCompletion *completion,
                            GList *providers,
                            GtkSourceCompletionContext *context);

Starts a new completion with the specified GtkSourceCompletionContext and a list of potential candidate providers for completion.

It can be convenient for showing a completion on-the-fly, without the need to add or remove providers to the GtkSourceCompletion.

Another solution is to add providers with gtk_source_completion_add_provider(), and implement gtk_source_completion_provider_match() for each provider.

gtk_source_completion_hide ()

void
gtk_source_completion_hide (GtkSourceCompletion *completion);

Hides the completion if it is active (visible).

gtk_source_completion_get_info_window ()

GtkSourceCompletionInfo *
gtk_source_completion_get_info_window (GtkSourceCompletion *completion);

The info widget is the window where the completion displays optional extra information of the proposal.

gtk_source_completion_get_view ()

GtkSourceView *
gtk_source_completion_get_view (GtkSourceCompletion *completion);

The GtkSourceView associated with completion .

gtk_source_completion_create_context ()

GtkSourceCompletionContext *
gtk_source_completion_create_context (GtkSourceCompletion *completion,
                                      GtkTextIter *position);

Create a new GtkSourceCompletionContext for completion . The position where the completion occurs can be specified by position . If position is NULL, the current cursor position will be used.

gtk_source_completion_move_window ()

void
gtk_source_completion_move_window (GtkSourceCompletion *completion,
                                   GtkTextIter *iter);

Move the completion window to a specific iter.

gtk_source_completion_block_interactive ()

void
gtk_source_completion_block_interactive
                               (GtkSourceCompletion *completion);

Block interactive completion. This can be used to disable interactive completion when inserting or deleting text from the buffer associated with the completion. Use gtk_source_completion_unblock_interactive() to enable interactive completion again.

This function may be called multiple times. It will continue to block interactive completion until gtk_source_completion_unblock_interactive() has been called the same number of times.

gtk_source_completion_unblock_interactive ()

void
gtk_source_completion_unblock_interactive
                               (GtkSourceCompletion *completion);

Unblock interactive completion. This can be used after using gtk_source_completion_block_interactive() to enable interactive completion again.

GtkSourceCompletion

typedef struct _GtkSourceCompletion GtkSourceCompletion;

GTK_SOURCE_COMPLETION_ERROR

#define GTK_SOURCE_COMPLETION_ERROR		(gtk_source_completion_error_quark ())

Error domain for the completion. Errors in this domain will be from the GtkSourceCompletionError enumeration. See GError for more information on error domains.

enum GtkSourceCompletionError

An error code used with GTK_SOURCE_COMPLETION_ERROR in a GError returned from a completion-related function.

The “accelerators” property

  “accelerators”             guint

Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press

Alt+1.

Flags: Read / Write / Construct

Allowed values: <= 10

Default value: 5

The “auto-complete-delay” property

  “auto-complete-delay”      guint

Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion.

Flags: Read / Write / Construct

Default value: 250

The “proposal-page-size” property

  “proposal-page-size”       guint

The scroll page size of the proposals in the completion window. In other words, when PageDown or

PageUp is pressed, the selected

proposal becomes the one which is located one page size backward or forward.

See also the “move-cursor” signal.

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 5

The “provider-page-size” property

  “provider-page-size”       guint

The scroll page size of the provider pages in the completion window.

See the “move-page” signal.

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 5

The “remember-info-visibility” property

  “remember-info-visibility” gboolean

Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.

Flags: Read / Write / Construct

Default value: FALSE

The “select-on-show” property

  “select-on-show”           gboolean

Determines whether the first proposal should be selected when the completion is first shown.

Flags: Read / Write / Construct

Default value: TRUE

The “show-headers” property

  “show-headers”             gboolean

Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider.

Flags: Read / Write / Construct

Default value: TRUE

The “show-icons” property

  “show-icons”               gboolean

Determines whether provider and proposal icons should be shown in the completion popup.

Flags: Read / Write / Construct

Default value: TRUE

The “view” property

  “view”                     GtkSourceView *

The GtkSourceView bound to the completion object.

Flags: Read / Write / Construct Only

The “activate-proposal” signal

void
user_function (GtkSourceCompletion *completion,
               gpointer             user_data)

The “activate-proposal” signal is a keybinding signal which gets emitted when the user initiates a proposal activation.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the proposal activation programmatically.

Flags: Action

The “hide” signal

void
user_function (GtkSourceCompletion *completion,
               gpointer             user_data)

Emitted when the completion window is hidden. The default handler will actually hide the window.

Flags: Action

The “move-cursor” signal

void
user_function (GtkSourceCompletion *completion,
               GtkScrollStep        step,
               gint                 num,
               gpointer             user_data)

The “move-cursor” signal is a keybinding signal which gets emitted when the user initiates a cursor movement.

The Up, Down,

PageUp, PageDown, Home and End keys are bound to the

normal behavior expected by those keys.

When step is equal to GTK_SCROLL_PAGES, the page size is defined by the “proposal-page-size” property. It is used for the PageDown and PageUp keys.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

Flags: Action

The “move-page” signal

void
user_function (GtkSourceCompletion *completion,
               GtkScrollStep        step,
               gint                 num,
               gpointer             user_data)

The “move-page” signal is a keybinding signal which gets emitted when the user initiates a page movement (i.e. switches between provider pages).

Control+Left

is for going to the previous provider.

Control+Right

is for going to the next provider.

Control+Home

is for displaying all the providers.

Control+End

is for going to the last provider.

When step is equal to GTK_SCROLL_PAGES, the page size is defined by the “provider-page-size” property.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the page selection programmatically.

Flags: Action

The “populate-context” signal

void
user_function (GtkSourceCompletion        *completion,
               GtkSourceCompletionContext *context,
               gpointer                    user_data)

Emitted just before starting to populate the completion with providers. You can use this signal to add additional attributes in the context.

Flags: Action

The “show” signal

void
user_function (GtkSourceCompletion *completion,
               gpointer             user_data)

Emitted when the completion window is shown. The default handler will actually show the window.

Flags: Action