GtkSourceView 2 Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites |
#include <gtksourceview/gtksourcecompletionprovider.h> GtkSourceCompletionProvider; gchar * gtk_source_completion_provider_get_name (GtkSourceCompletionProvider *provider
); GdkPixbuf * gtk_source_completion_provider_get_icon (GtkSourceCompletionProvider *provider
); void gtk_source_completion_provider_populate (GtkSourceCompletionProvider *provider
,GtkSourceCompletionContext *context
); GtkSourceCompletionActivation gtk_source_completion_provider_get_activation (GtkSourceCompletionProvider *provider
); gboolean gtk_source_completion_provider_match (GtkSourceCompletionProvider *provider
,GtkSourceCompletionContext *context
); GtkWidget * gtk_source_completion_provider_get_info_widget (GtkSourceCompletionProvider *provider
,GtkSourceCompletionProposal *proposal
); void gtk_source_completion_provider_update_info (GtkSourceCompletionProvider *provider
,GtkSourceCompletionProposal *proposal
,GtkSourceCompletionInfo *info
); gboolean gtk_source_completion_provider_get_start_iter (GtkSourceCompletionProvider *provider
,GtkSourceCompletionContext *context
,GtkSourceCompletionProposal *proposal
,GtkTextIter *iter
); gboolean gtk_source_completion_provider_activate_proposal (GtkSourceCompletionProvider *provider
,GtkSourceCompletionProposal *proposal
,GtkTextIter *iter
); gint gtk_source_completion_provider_get_interactive_delay (GtkSourceCompletionProvider *provider
); gint gtk_source_completion_provider_get_priority (GtkSourceCompletionProvider *provider
);
typedef struct _GtkSourceCompletionProvider GtkSourceCompletionProvider;
gchar * gtk_source_completion_provider_get_name
(GtkSourceCompletionProvider *provider
);
Get the name of the provider. This should be a translatable name for
display to the user. For example: _("Document word completion provider"). The
returned string must be freed with g_free()
.
|
The GtkSourceCompletionProvider |
Returns : |
A new string containing the name of the provider. |
GdkPixbuf * gtk_source_completion_provider_get_icon
(GtkSourceCompletionProvider *provider
);
Get the icon of the provider.
|
The GtkSourceCompletionProvider |
Returns : |
The icon to be used for the provider, or NULL if the provider does
not have a special icon.
|
void gtk_source_completion_provider_populate (GtkSourceCompletionProvider *provider
,GtkSourceCompletionContext *context
);
Populate context
with proposals from provider
|
The GtkSourceCompletionProvider |
|
The GtkSourceCompletionContext |
GtkSourceCompletionActivation gtk_source_completion_provider_get_activation
(GtkSourceCompletionProvider *provider
);
Get with what kind of activation the provider should be activated.
|
A GtkSourceCompletionProvider |
Returns : |
a combination of GtkSourceCompletionActivation. |
gboolean gtk_source_completion_provider_match (GtkSourceCompletionProvider *provider
,GtkSourceCompletionContext *context
);
Get whether the provider match the context of completion detailed in
context
.
|
The GtkSourceCompletionProvider |
|
The GtkSourceCompletionContext |
Returns : |
TRUE if provider matches the completion context, FALSE otherwise
|
GtkWidget * gtk_source_completion_provider_get_info_widget (GtkSourceCompletionProvider *provider
,GtkSourceCompletionProposal *proposal
);
Get a customized info widget to show extra information of a proposal.
This allows for customized widgets on a proposal basis, although in general
providers will have the same custom widget for all their proposals and
proposal
can be ignored. The implementation of this function is optional.
If implemented, gtk_source_completion_provider_update_info MUST also be
implemented. If not implemented, the default
gtk_source_completion_proposal_get_info will be used to display extra
information about a GtkSourceCompletionProposal.
|
The GtkSourceCompletionProvider |
|
The currently selected GtkSourceCompletionProposal |
Returns : |
a custom GtkWidget to show extra information about proposal .
|
void gtk_source_completion_provider_update_info (GtkSourceCompletionProvider *provider
,GtkSourceCompletionProposal *proposal
,GtkSourceCompletionInfo *info
);
Update extra information shown in info
for proposal
. This should be
implemented if your provider sets a custom info widget for proposal
.
This function MUST be implemented when
gtk_source_completion_provider_get_info_widget is implemented.
|
A GtkSourceCompletionProvider |
|
A GtkSourceCompletionProposal |
|
A GtkSourceCompletionInfo |
gboolean gtk_source_completion_provider_get_start_iter (GtkSourceCompletionProvider *provider
,GtkSourceCompletionContext *context
,GtkSourceCompletionProposal *proposal
,GtkTextIter *iter
);
Get the GtkTextIter at which the completion for proposal
starts. When
implemented, the completion can use this information to position the
completion window accordingly when a proposal is selected in the completion
window.
|
A GtkSourceCompletionProvider |
|
A GtkSourceCompletionProposal |
|
A GtkSourceCompletionContext |
|
A GtkTextIter |
Returns : |
TRUE if iter was set for proposal , FALSE otherwise
|
gboolean gtk_source_completion_provider_activate_proposal (GtkSourceCompletionProvider *provider
,GtkSourceCompletionProposal *proposal
,GtkTextIter *iter
);
Activate proposal
at iter
. When this functions returns FALSE
, the default
activation of proposal
will take place which replaces the word at iter
with the label of proposal
.
|
A GtkSourceCompletionProvider |
|
A GtkSourceCompletionProposal |
|
A GtkTextIter |
Returns : |
TRUE to indicate that the proposal activation has been handled,
FALSE otherwise.
|
gint gtk_source_completion_provider_get_interactive_delay
(GtkSourceCompletionProvider *provider
);
Get the delay in milliseconds before starting interactive completion for this provider. A value of -1 indicates to use the default value as set by "auto-complete-delay".
|
A # GtkSourceCompletionProvider |
Returns : |
the interactive delay in milliseconds. |
gint gtk_source_completion_provider_get_priority
(GtkSourceCompletionProvider *provider
);
Get the provider priority. The priority determines the order in which proposals appear in the completion popup. Higher priorities are sorted before lower priorities. The default priority is 0.
|
A # GtkSourceCompletionProvider |
Returns : |
the provider priority. |