Completion

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_source_completion_get_type ()" ) ]
public sealed class Completion : Object

Main Completion Object.

The completion system helps the user when they writes some text, such as words, command names, functions, and suchlike. Proposals can be shown, to complete the text the user is writing. Each proposal can contain an additional piece of information (for example documentation), that is displayed when the "Details" button is clicked.

Proposals are created via a [iface@CompletionProvider]. There can be for example a provider to complete words (see [class@CompletionWords]), another provider for the completion of function names, etc. To add a provider, call [method@Completion.add_provider].

The [iface@CompletionProposal] interface represents a proposal.

If a proposal contains extra information (see gtk_source_completion_column_details), it will be displayed in a supplemental details window, which appears when the "Details" button is clicked.

Each [class@View] object is associated with a [class@Completion] instance. This instance can be obtained with [method@View.get_completion]. The [class@View] class contains also the [signal@View:GtkSourceCompletion:show-completion] signal.

A same [iface@CompletionProvider] object can be used for several `GtkSourceCompletion`'s.

Namespace: GtkSource

Package: gtksourceview-5

Content:

Properties:

public TextView buffer { get; }
The TextBuffer for the view.
public uint page_size { get; set; }
The number of rows to display to the user before scrolling.
public bool remember_info_visibility { get; set; }
Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.
public bool select_on_show { get; set; }
Determines whether the first proposal should be selected when the completion is first shown.
public bool show_icons { get; set; }
The "show-icons" property denotes if icons should be displayed within the list of completions presented to the user.
public View view { get; construct; }
The "view" property is the TextView for which this Completion is providing completion features.

Static methods:

public static AttrList? fuzzy_highlight (string haystack, string casefold_query)
This will add `<b>` tags around matched characters in haystack based on casefold_query.
public static bool fuzzy_match (string? haystack, string casefold_needle, out uint priority)
This helper function can do a fuzzy match for you giving a haystack and casefolded needle.

Creation methods:

protected Completion ()

Methods:

public void add_provider (CompletionProvider provider)
Adds a [iface@CompletionProvider] to the list of providers to be queried for completion results.
public void block_interactive ()
public unowned Buffer get_buffer ()
Gets the connected [class@View]'s [class@Buffer]
public uint get_page_size ()
public unowned View get_view ()
Gets the [class@View] that owns the [class@Completion].
public void remove_provider (CompletionProvider provider)
Removes a [iface@CompletionProvider] previously added with [ method@Completion.
public void set_page_size (uint page_size)
public void unblock_interactive ()

Signals:

public signal void hide ()
The "hide" signal is emitted when the completion window should be hidden.
public signal void provider_added (CompletionProvider provider)
The "provided-added" signal is emitted when a new provider is added to the completion.
public signal void provider_removed (CompletionProvider provider)
The "provided-removed" signal is emitted when a provider has been removed from the completion.
public signal void show ()
The "show" signal is emitted when the completion window should be shown.

Inherited Members:

All known members inherited from class GLib.Object