![]() |
![]() |
![]() |
GtkSourceView 3 Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
#include <gtksourceview/gtksourcecompletioncontext.h> enum GtkSourceCompletionActivation; GtkSourceCompletionContext; void gtk_source_completion_context_add_proposals (GtkSourceCompletionContext *context
,GtkSourceCompletionProvider *provider
,GList *proposals
,gboolean finished
); void gtk_source_completion_context_get_iter (GtkSourceCompletionContext *context
,GtkTextIter *iter
); GtkSourceCompletionActivation gtk_source_completion_context_get_activation (GtkSourceCompletionContext *context
);
"activation" GtkSourceCompletionActivation : Read / Write "completion" GtkSourceCompletion* : Read / Write / Construct Only "iter" GtkTextIter* : Read / Write
A completion context is created when a completion occurs. The completion can be activated by several means, listed in GtkSourceCompletionActivation.
The completion can be activated by user request, i.e. when the user presses Control+space, by default.
The completion can also be activated interactively, on each insertion or deletion in the GtkTextBuffer.
A GtkTextIter is associated with the context, this is where the completion
takes place. With this GtkTextIter, you can get the associated
GtkTextBuffer with gtk_text_iter_get_buffer()
.
Once the context is created, the eligible providers are asked to add
proposals with gtk_source_completion_context_add_proposals()
.
typedef enum { GTK_SOURCE_COMPLETION_ACTIVATION_NONE = 0, GTK_SOURCE_COMPLETION_ACTIVATION_INTERACTIVE = 1 << 0, GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED = 1 << 1 } GtkSourceCompletionActivation;
void gtk_source_completion_context_add_proposals (GtkSourceCompletionContext *context
,GtkSourceCompletionProvider *provider
,GList *proposals
,gboolean finished
);
Providers can use this function to add proposals to the completion. They
can do so asynchronously by means of the finished
argument. Providers must
ensure that they always call this function with finished
set to TRUE
once each population (even if no proposals need to be added).
Population occurs when the gtk_source_completion_provider_populate()
function is called.
|
a GtkSourceCompletionContext. |
|
a GtkSourceCompletionProvider. [type GtkSource.CompletionProvider] |
|
The list of proposals to add. [element-type GtkSource.CompletionProposal] |
|
Whether the provider is finished adding proposals. |
void gtk_source_completion_context_get_iter (GtkSourceCompletionContext *context
,GtkTextIter *iter
);
Get the iter at which the completion was invoked. Providers can use this to determine how and if to match proposals.
|
a GtkSourceCompletionContext. |
|
a GtkTextIter. [out] |
GtkSourceCompletionActivation gtk_source_completion_context_get_activation
(GtkSourceCompletionContext *context
);
Get the context activation.
|
a GtkSourceCompletionContext. |
Returns : |
The context activation. |
"activation"
property"activation" GtkSourceCompletionActivation : Read / Write
The completion activation
"completion"
property"completion" GtkSourceCompletion* : Read / Write / Construct Only
The GtkSourceCompletion associated with the context.
"cancelled"
signalvoid user_function (GtkSourceCompletionContext *arg0,
gpointer user_data) : Action
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.
|
user data set when the signal handler was connected. |