gtksource.completion

Module for [Completion] class

class Completion CompletionGidBuilder CompletionGidBuilderImpl

Types 3

classCompletion : gobject.object.ObjectWrap, gtk.buildable.Buildable

Methods

GType _getGType()

GType _gType() @property

Completion self()Returns `this`, for use in `with` statements.

CompletionGidBuilder builder()Get builder for [gtksource.completion.Completion] Returns: New builder object

uint accelerators() @propertyGet `accelerators` property. Returns: Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press <keycombo><keycap>Alt</keycap>...

void accelerators(uint propval) @propertySet `accelerators` property. Params: propval = Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press <keycombo><keycap>Alt...

uint autoCompleteDelay() @propertyGet `autoCompleteDelay` property. Returns: Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion.

void autoCompleteDelay(uint propval) @propertySet `autoCompleteDelay` property. Params: propval = Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion.

uint proposalPageSize() @propertyGet `proposalPageSize` property. Returns: The scroll page size of the proposals in the completion window. In other words, when <keycap>PageDown</keycap> or <keycap>PageUp</keycap> is pressed, the s...

void proposalPageSize(uint propval) @propertySet `proposalPageSize` property. Params: propval = The scroll page size of the proposals in the completion window. In other words, when <keycap>PageDown</keycap> or <keycap>PageUp</keycap> is press...

uint providerPageSize() @propertyGet `providerPageSize` property. Returns: The scroll page size of the provider pages in the completion window.

void providerPageSize(uint propval) @propertySet `providerPageSize` property. Params: propval = The scroll page size of the provider pages in the completion window.

bool rememberInfoVisibility() @propertyGet `rememberInfoVisibility` property. Returns: Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.

void rememberInfoVisibility(bool propval) @propertySet `rememberInfoVisibility` property. Params: propval = Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is show...

bool selectOnShow() @propertyGet `selectOnShow` property. Returns: Determines whether the first proposal should be selected when the completion is first shown.

void selectOnShow(bool propval) @propertySet `selectOnShow` property. Params: propval = Determines whether the first proposal should be selected when the completion is first shown.

bool showHeaders() @propertyGet `showHeaders` property. Returns: Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider.

void showHeaders(bool propval) @propertySet `showHeaders` property. Params: propval = Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider.

bool showIcons() @propertyGet `showIcons` property. Returns: Determines whether provider and proposal icons should be shown in the completion popup.

void showIcons(bool propval) @propertySet `showIcons` property. Params: propval = Determines whether provider and proposal icons should be shown in the completion popup.

gtksource.view.View view() @propertyGet `view` property. Returns: The #GtkSourceView bound to the completion object.

bool addProvider(gtksource.completion_provider.CompletionProvider provider)Add a new #GtkSourceCompletionProvider to the completion object. This will add a reference provider, so make sure to unref your own copy when you no longer need it.

void blockInteractive()Block interactive completion. This can be used to disable interactive completion when inserting or deleting text from the buffer associated with the completion. Use [gtksource.completion.Completion...

gtksource.completion_context.CompletionContext createContext(gtk.text_iter.TextIter position = null)Create a new #GtkSourceCompletionContext for completion. The position where the completion occurs can be specified by position. If position is null, the current cursor position will be used.

gtksource.completion_info.CompletionInfo getInfoWindow()The info widget is the window where the completion displays optional extra information of the proposal. Returns: The #GtkSourceCompletionInfo window associated with completion.

gtksource.completion_provider.CompletionProvider[] getProviders()Get list of providers registered on completion. The returned list is owned by the completion and should not be freed. Returns: list of #GtkSourceCompletionProvider.

gtksource.view.View getView()The #GtkSourceView associated with completion, or null if the view has been destroyed. Returns: The #GtkSourceView associated with completion, or null.

void hide()Hides the completion if it is active (visible).

bool removeProvider(gtksource.completion_provider.CompletionProvider provider)Remove provider from the completion.

bool start(gtksource.completion_provider.CompletionProvider[]  providers,  gtksource.completion_context.CompletionContext context)

Starts a new completion with the specified #GtkSourceCompletionContext and a list of potential candidate providers for completion.

void unblockInteractive()Unblock interactive completion. This can be used after using [gtksource.completion.Completion.blockInteractive] to enable interactive completion again.

gulong connectActivateProposal(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtksource.completion.Completion)))
   &&  Parameters!T.length <  2)

Connect to `ActivateProposal` signal.

gulong connectHide(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtksource.completion.Completion)))
   &&  Parameters!T.length <  2)

Connect to `Hide` signal.

gulong connectMoveCursor(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.types.ScrollStep)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  int)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtksource.completion.Completion)))
   &&  Parameters!T.length <  4)

Connect to `MoveCursor` signal.

gulong connectMovePage(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.types.ScrollStep)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  int)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtksource.completion.Completion)))
   &&  Parameters!T.length <  4)

Connect to `MovePage` signal.

gulong connectPopulateContext(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtksource.completion_context.CompletionContext)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtksource.completion.Completion)))
   &&  Parameters!T.length <  3)

Connect to `PopulateContext` signal.

gulong connectShow(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtksource.completion.Completion)))
   &&  Parameters!T.length <  2)

Connect to `Show` signal.

Constructors

this(void * ptr, Flag!"Take" take)

classCompletionGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T, gtk.buildable.BuildableGidBuilderImpl!T

Methods

T accelerators(uint propval)Set `accelerators` property. Params: propval = Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press <keycombo><keycap>Alt...

T autoCompleteDelay(uint propval)Set `autoCompleteDelay` property. Params: propval = Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion. Returns: Builder instance for flue...

T proposalPageSize(uint propval)Set `proposalPageSize` property. Params: propval = The scroll page size of the proposals in the completion window. In other words, when <keycap>PageDown</keycap> or <keycap>PageUp</keycap> is press...

T providerPageSize(uint propval)Set `providerPageSize` property. Params: propval = The scroll page size of the provider pages in the completion window.

T rememberInfoVisibility(bool propval)Set `rememberInfoVisibility` property. Params: propval = Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is show...

T selectOnShow(bool propval)Set `selectOnShow` property. Params: propval = Determines whether the first proposal should be selected when the completion is first shown. Returns: Builder instance for fluent chaining

T showHeaders(bool propval)Set `showHeaders` property. Params: propval = Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider. Returns: Builder...

T showIcons(bool propval)Set `showIcons` property. Params: propval = Determines whether provider and proposal icons should be shown in the completion popup. Returns: Builder instance for fluent chaining

T view(gtksource.view.View propval)Set `view` property. Params: propval = The #GtkSourceView bound to the completion object. Returns: Builder instance for fluent chaining

classCompletionGidBuilder : CompletionGidBuilderImpl!CompletionGidBuilder

Fluent builder for [gtksource.completion.Completion]

Methods

Completion build()