gtksource.completion_proposal_mixin

Module for [CompletionProposal] interface mixin

tmpl CompletionProposalGidBuilderT CompletionProposalT

Templates 2

tmplCompletionProposalT()

Functions

void changed()

Emits the "changed" signal on proposal. This should be called by implementations whenever the name, icon or info of the proposal has changed.

bool equal(gtksource.completion_proposal.CompletionProposal other)

Get whether two proposal objects are the same. This is used to (together with [gtksource.completion_proposal.CompletionProposal.hash]) to match proposals in the completion model. By default, it uses direct equality ([glib.global.directEqual]).

Parameters

other a #GtkSourceCompletionProposal.

Returns

true if proposal and object are the same proposal

gio.icon.Icon getGicon()

Gets the #GIcon for the icon of proposal.

Returns

A #GIcon with the icon of proposal.

gdkpixbuf.pixbuf.Pixbuf getIcon()

Gets the #GdkPixbuf for the icon of proposal.

Returns

A #GdkPixbuf with the icon of proposal.

string getIconName()

Gets the icon name of proposal.

Returns

The icon name of proposal.

string getInfo()

Gets extra information associated to the proposal. This information will be used to present the user with extra, detailed information about the selected proposal. The returned string must be freed with [glib.global.gfree].

Returns

a newly-allocated string containing

extra information of proposal or null if no extra information is associated to proposal.

string getLabel()

Gets the label of proposal. The label is shown in the list of proposals as plain text. If you need any markup (such as bold or italic text), you have to implement [gtksource.completion_proposal.CompletionProposal.getMarkup]. The returned string must be freed with [glib.global.gfree].

Returns

a new string containing the label of proposal.

string getMarkup()

Gets the label of proposal with markup. The label is shown in the list of proposals and may contain markup. This will be used instead of [gtksource.completion_proposal.CompletionProposal.getLabel] if implemented. The returned string must be freed with [glib.global.gfree].

Returns

a new string containing the label of proposal with markup.

string getText()

Gets the text of proposal. The text that is inserted into the text buffer when the proposal is activated by the default activation. You are free to implement a custom activation handler in the provider and not implement this function. For more information, see [gtksource.completion_provider.CompletionProvider.activateProposal]. The returned string must be freed with [glib.global.gfree].

Returns

a new string containing the text of proposal.

uint hash()

Get the hash value of proposal. This is used to (together with [gtksource.completion_proposal.CompletionProposal.equal]) to match proposals in the completion model. By default, it uses a direct hash ([glib.global.directHash]).

Returns

The hash value of proposal.

gulong connectChanged(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_proposal.CompletionProposal))) && Parameters!T.length < 2)

Connect to Changed signal.

Emitted when the proposal has changed. The completion popup will react to this by updating the shown information.

Parameters

`callback`	signal callback delegate or function to connect `void callback(gtksource.completion_proposal.CompletionProposal completionProposal)` `completionProposal` the instance the signal is connected to (optional)
`after`	Yes.After to execute callback after default handler, No.After to execute before (default)

Returns

Signal ID

tmplCompletionProposalGidBuilderT()