gtksource/org.gtkkn.bindings.gtksource/CompletionProvider

CompletionProvider

Completion provider interface.

You must implement this interface to provide proposals to class@Completion.

In most cases, implementations of this interface will want to use vfunc@CompletionProvider.populate_async to asynchronously populate the results to avoid blocking the main loop.

Skipped during bindings generation

method list_alternates: Array parameter of type CompletionProposal is not supported

Inheritors

CompletionSnippets

CompletionWords

Types

Companion

object Companion

Properties

gtksourceCompletionProviderPointer

abstract val gtksourceCompletionProviderPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

activate

open fun activate(context: CompletionContext, proposal: CompletionProposal)

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

display

open fun display(context: CompletionContext, proposal: CompletionProposal, cell: CompletionCell)

This function requests that the #GtkSourceCompletionProvider prepares

getPriority

open fun getPriority(context: CompletionContext): Int

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

getTitle

open fun getTitle(): String?

Gets the title of the completion provider, if any.

isTrigger

open fun isTrigger(iter: <Error class: unknown class>, ch: <Error class: unknown class>): Boolean

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

keyActivates

open fun keyActivates(context: CompletionContext, proposal: CompletionProposal, keyval: <Error class: unknown class>, state: <Error class: unknown class>): Boolean

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

populateAsync

open fun populateAsync(context: CompletionContext, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>)

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

populateFinish

open fun populateFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

Completes an asynchronous operation to populate a completion provider.

refilter

open fun refilter(context: CompletionContext, model: <Error class: unknown class>)

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