GSC_PROVIDER_GET_INTERFACE()

#define GSC_PROVIDER_GET_INTERFACE(obj) 	(G_TYPE_INSTANCE_GET_INTERFACE ((obj), GSC_TYPE_PROVIDER, GscProviderIface))

GSC_COMPLETION_CAPABILITY_INTERACTIVE

#define GSC_COMPLETION_CAPABILITY_INTERACTIVE "standard::interactive"

GSC_COMPLETION_CAPABILITY_AUTOMATIC

#define GSC_COMPLETION_CAPABILITY_AUTOMATIC "standard::automatic"

GscProvider

typedef struct _GscProvider GscProvider;

GscProviderIface

typedef struct {
	GTypeInterface g_iface;
	
	const gchar	*(*get_name)       	(GscProvider *provider);
	GdkPixbuf	*(*get_icon)       	(GscProvider *provider);
	void		 (*populate_completion)	(GscProvider *provider,
						 GscContext  *context);

	const gchar     *(*get_capabilities)	(GscProvider *provider);

	GtkWidget 	*(*get_info_widget)	(GscProvider *provider,
						 GscProposal *proposal);
	void		 (*update_info)		(GscProvider *provider,
						 GscProposal *proposal,
						 GscInfo     *info);

	gboolean	 (*activate_proposal)	(GscProvider *provider,
						 GscProposal *proposal,
						 GtkTextIter                 *iter);
} GscProviderIface;

gsc_provider_get_name ()

const gchar *       gsc_provider_get_name               (GscProvider *provider);

Get the name of the provider. This should be a translatable name for display to the user. For example: _("Document word completion provider").

gsc_provider_get_icon ()

GdkPixbuf *         gsc_provider_get_icon               (GscProvider *provider);

Get the icon of the provider.

gsc_provider_populate_completion ()

void                gsc_provider_populate_completion    (GscProvider *provider,
                                                         GscContext *context);

TODO Document this function

gsc_provider_get_capabilities ()

const gchar *       gsc_provider_get_capabilities       (GscProvider *provider);

A list of capabilities this provider supports

gsc_provider_get_info_widget ()

GtkWidget *         gsc_provider_get_info_widget        (GscProvider *provider,
                                                         GscProposal *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, gsc_provider_update_info MUST also be implemented. If not implemented, the default gsc_proposal_get_info will be used to display extra information about a GscProposal.

gsc_provider_update_info ()

void                gsc_provider_update_info            (GscProvider *provider,
                                                         GscProposal *proposal,
                                                         GscInfo *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 gsc_provider_get_info_widget is implemented.

gsc_provider_activate_proposal ()

gboolean            gsc_provider_activate_proposal      (GscProvider *provider,
                                                         GscProposal *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.