Trait sourceview5::prelude::CompletionProviderExt

source · 
pub trait CompletionProviderExt: IsA<CompletionProvider> + Sealed + 'static {
    // Provided methods
    fn activate(
        &self,
        context: &CompletionContext,
        proposal: &impl IsA<CompletionProposal>,
    ) { ... }
    fn display(
        &self,
        context: &CompletionContext,
        proposal: &impl IsA<CompletionProposal>,
        cell: &CompletionCell,
    ) { ... }
    fn priority(&self, context: &CompletionContext) -> i32 { ... }
    fn title(&self) -> Option<GString> { ... }
    fn is_trigger(&self, iter: &TextIter, ch: char) -> bool { ... }
    fn key_activates(
        &self,
        context: &CompletionContext,
        proposal: &impl IsA<CompletionProposal>,
        keyval: u32,
        state: ModifierType,
    ) -> bool { ... }
    fn list_alternates(
        &self,
        context: &CompletionContext,
        proposal: &impl IsA<CompletionProposal>,
    ) -> Vec<CompletionProposal> { ... }
    fn populate_async<P: FnOnce(Result<ListModel, Error>) + 'static>(
        &self,
        context: &CompletionContext,
        cancellable: Option<&impl IsA<Cancellable>>,
        callback: P,
    ) { ... }
    fn populate_future(
        &self,
        context: &CompletionContext,
    ) -> Pin<Box_<dyn Future<Output = Result<ListModel, Error>> + 'static>> { ... }
    fn refilter(&self, context: &CompletionContext, model: &impl IsA<ListModel>) { ... }
}
Expand description

Trait containing all CompletionProvider methods.

§Implementors

CompletionProvider, CompletionSnippets, CompletionWords

Provided Methods§

source

fn activate( &self, context: &CompletionContext, proposal: &impl IsA<CompletionProposal>, )

This function requests @proposal to be activated by the #GtkSourceCompletionProvider.

What the provider does to activate the proposal is specific to that provider. Many providers may choose to insert a #GtkSourceSnippet with edit points the user may cycle through.

See also: Snippet, SnippetChunk, View::push_snippet()

§context

a #GtkSourceCompletionContext

§proposal

a #GtkSourceCompletionProposal

source

fn display( &self, context: &CompletionContext, proposal: &impl IsA<CompletionProposal>, cell: &CompletionCell, )

This function requests that the #GtkSourceCompletionProvider prepares @cell to display the contents of @proposal.

Based on @cells column type, you may want to display different information.

This allows for columns of information among completion proposals resulting in better alignment of similar content (icons, return types, method names, and parameter lists).

§context

a #GtkSourceCompletionContext

§proposal

a #GtkSourceCompletionProposal

§cell

a #GtkSourceCompletionCell

source

fn priority(&self, context: &CompletionContext) -> i32

This function should return the priority of @self in @context.

The priority is used to sort groups of completion proposals by provider so that higher priority providers results are shown above lower priority providers.

Higher value indicates higher priority.

§context

a #GtkSourceCompletionContext

source

fn title(&self) -> Option<GString>

Gets the title of the completion provider, if any.

Currently, titles are not displayed in the completion results, but may be at some point in the future when non-None.

§Returns

a title for the provider or None

source

fn is_trigger(&self, iter: &TextIter, ch: char) -> bool

This function is used to determine if a character inserted into the text editor should cause a new completion request to be triggered.

An example would be period ‘.’ which might indicate that the user wants to complete method or field names of an object.

This method will only trigger when text is inserted into the #GtkTextBuffer while the completion list is visible and a proposal is selected. Incremental key-presses (like shift, control, or alt) are not triggerable.

§iter

a #GtkTextIter

§ch

a #gunichar of the character inserted

source

fn key_activates( &self, context: &CompletionContext, proposal: &impl IsA<CompletionProposal>, keyval: u32, state: ModifierType, ) -> bool

This function is used to determine if a key typed by the user should activate @proposal (resulting in committing the text to the editor).

This is useful when using languages where convention may lead to less typing by the user. One example may be the use of “.” or “-” to expand a field access in the C programming language.

§context

a #GtkSourceCompletionContext

§proposal

a #GtkSourceCompletionProposal

§keyval

a keyval such as Gdk::KEY_period

§state

a #GdkModifierType or 0

source

fn list_alternates( &self, context: &CompletionContext, proposal: &impl IsA<CompletionProposal>, ) -> Vec<CompletionProposal>

Providers should return a list of alternates to @proposal or None if there are no alternates available.

This can be used by the completion view to allow the user to move laterally through similar proposals, such as overrides of methods by the same name.

§context

a #GtkSourceCompletionContext

§proposal

a #GtkSourceCompletionProposal

§Returns

a #GPtrArray of #GtkSourceCompletionProposal or None.

source

fn populate_async<P: FnOnce(Result<ListModel, Error>) + 'static>( &self, context: &CompletionContext, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Asynchronously requests that the provider populates the completion results for @context.

For providers that would like to populate a gio::ListModel while those results are displayed to the user, CompletionContext::set_proposals_for_provider() may be used to reduce latency until the user sees results.

§context

a #GtkSourceCompletionContext

§cancellable

a #GCancellable or None

§callback

a callback to execute upon completion

source

fn populate_future( &self, context: &CompletionContext, ) -> Pin<Box_<dyn Future<Output = Result<ListModel, Error>> + 'static>>

source

fn refilter(&self, context: &CompletionContext, model: &impl IsA<ListModel>)

This function can be used to filter results previously provided to the CompletionContext by the #GtkSourceCompletionProvider.

This can happen as the user types additional text onto the word so that previously matched items may be removed from the list instead of generating new gio::ListModel of results.

§context

a #GtkSourceCompletionContext

§model

a #GListModel

Object Safety§

This trait is not object safe.

Implementors§