CompletionContext

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_source_completion_context_get_type ()" ) ]
public sealed class CompletionContext : Object, ListModel

The context of a completion.

`GtkSourceCompletionContext` contains information about an attept to display completion proposals to the user based on typed text in the [ class@View].

When typing, [class@Completion] may use registered [iface@CompletionProvider] to determine if there may be results which could be displayed. If so, a `GtkSourceCompletionContext` is created with information that is provided to the [iface@CompletionProvider] to populate results which might be useful to the user.

[iface@CompletionProvider] are expected to provide [iface@Gio.ListModel] with [iface@CompletionProposal] which may be joined together in a list of results for the user. They are also responsible for how the contents are displayed using [class@CompletionCell] which allows for some level of customization.

Namespace: GtkSource

Package: gtksourceview-5

Content:

Properties:

public bool busy { get; }
The "busy" property is true while the completion context is populating completion proposals.
public Completion completion { get; construct; }
The "completion" is the Completion that was used to create the context.
public bool empty { get; }
The "empty" property is true when there are no results.

Creation methods:

protected CompletionContext ()

Methods:

public CompletionActivation get_activation ()
Gets the mode for which the context was activated.
public bool get_bounds (out TextIter begin, out TextIter end)
Gets the bounds for the completion, which is the beginning of the current word (taking break characters into account) to the current insertion cursor.
public unowned Buffer? get_buffer ()
Gets the underlying buffer used by the context.
public bool get_busy ()
Gets the "busy" property.
public unowned Completion? get_completion ()
Gets the Completion that created the context.
public bool get_empty ()
Checks if any proposals have been provided to the context.
public unowned Language? get_language ()
Gets the language of the underlying buffer, if any.
public unowned ListModel? get_proposals_for_provider (CompletionProvider provider)
Gets the ListModel associated with the provider.
public unowned View? get_view ()
Gets the text view for the context.
public string get_word ()
Gets the word that is being completed up to the position of the insert mark.
public ListModel list_providers ()
Gets the providers that are associated with the context.
public void set_proposals_for_provider (CompletionProvider provider, ListModel? results)
This function allows providers to update their results for a context outside of a call to [method@CompletionProvider.

Signals:

public signal void provider_model_changed (CompletionProvider provider, ListModel? model)
Emitted when a provider changes a model.

Inherited Members:

All known members inherited from class GLib.Object

All known members inherited from interface GLib.ListModel

items_changed