|  |  |  | GtkSourceView 2 Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Prerequisites | ||||
#include <gtksourceview/gtksourcecompletionprovider.h>
                    GtkSourceCompletionProvider;
const 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);
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);
typedef struct _GtkSourceCompletionProvider GtkSourceCompletionProvider;
const 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 GtkSourceCompletionProvider | 
| Returns : | 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 NULLif 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 | 
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 : | TRUEifprovidermatches the completion context,FALSEotherwise | 
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 GtkSourceCompletionContext | 
| 
 | A GtkSourceCompletionProposal | 
| 
 | A GtkTextIter | 
| Returns : | TRUEifiterwas set forproposal,FALSEotherwise | 
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 : | TRUEto indicate that the proposal activation has been handled,FALSEotherwise. |