gtksource/org.gtkkn.bindings.gtksource/Completion

Completion

open class Completion(pointer: <Error class: unknown class><<Error class: unknown class>>)

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::show-completion signal.

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

Skipped during bindings generation

method remember-info-visibility: Property has no getter nor setter
method select-on-show: Property has no getter nor setter
method show-icons: Property has no getter nor setter
parameter priority: priority: Out parameter is not supported

Constructors

Completion

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

buffer

open val buffer: Buffer

The #GtkTextBuffer for the #GtkSourceCompletion:view. This is a convenience property for providers.

gtksourceCompletionPointer

val gtksourceCompletionPointer: <Error class: unknown class><<Error class: unknown class>>

pageSize

open var pageSize: <Error class: unknown class>

The number of rows to display to the user before scrolling.

view

open val view: View

The "view" property is the #GtkTextView for which this #GtkSourceCompletion is providing completion features.

Functions

addProvider

open fun addProvider(provider: CompletionProvider)

Adds a iface@CompletionProvider to the list of providers to be queried for completion results.

blockInteractive

open fun blockInteractive()

connectHide

fun connectHide(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

The "hide" signal is emitted when the completion window should be hidden.

connectProviderAdded

fun connectProviderAdded(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (provider: CompletionProvider) -> Unit): <Error class: unknown class>

The "provided-added" signal is emitted when a new provider is added to the completion.

connectProviderRemoved

fun connectProviderRemoved(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (provider: CompletionProvider) -> Unit): <Error class: unknown class>

The "provided-removed" signal is emitted when a provider has been removed from the completion.

connectShow