GtkSource.CompletionContext – gtksourceview-5

Description:

[ CCode ( type_id = "gtk_source_completion_context_get_type ()" ) ]
public 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 [[email protected]] 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

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:

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 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 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.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface GLib.ListModel

get_item
get_item_type

get_n_items
get_object

items_changed