Initially, the completion window is hidden. For a completion to occur, it has
to be activated. The different possible activations are listed in
GtkSourceCompletionActivation. When an activation occurs, a
GtkSourceCompletionContext object is created, and the eligible providers are
asked to add proposals with
If no proposals are added, the completion window remains hidden, and the context is destroyed.
On the other hand, if proposals are added, the completion window becomes visible, and the user can choose a proposal. If the user is not happy with the shown proposals, he or she can insert or delete characters, to modify the completion context and therefore hoping to see the proposal he or she wants. This means that when an insertion or deletion occurs in the GtkTextBuffer when the completion window is visible, the eligible providers are again asked to add proposals. The “activation” remains the same in this case.
When the completion window is hidden, the interactive completion is triggered only on insertion in the buffer, not on deletion. Once the completion window is visible, then on each insertion or deletion, there is a new population and the providers are asked to add proposals. If there are no more proposals, the completion window disappears. So if you want to keep the completion window visible, but there are no proposals, you can insert a dummy proposal named "No proposals". For example, the user types progressively the name of a function, and some proposals appear. The user types a bad character and there are no proposals anymore. What the user wants is to delete the last character, and see the previous proposals. If the completion window disappears, the previous proposals will not reappear on the character deletion.
void gtk_source_completion_context_add_proposals (
Providers can use this function to add proposals to the completion. They
can do so asynchronously by means of the
argument. Providers must
ensure that they always call this function with
once each population (even if no proposals need to be added).
Population occurs when the
function is called.
void gtk_source_completion_context_get_iter (
Get the iter at which the completion was invoked. Providers can use this to determine how and if to match proposals.
Types and Values
User requested activation. By default, it occurs when the user pressesControl+space.
The completion activation
Flags: Read / Write / Construct
Default value: GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED
“completion” GtkSourceCompletion *
The GtkSourceCompletion associated with the context.
Flags: Read / Write / Construct Only
void user_function (GtkSourceCompletionContext *arg0, gpointer user_data)
Emitted when the current population of proposals has been cancelled. Providers adding proposals asynchronously should connect to this signal to know when to cancel running proposal queries.