GscProvider

GscProvider — Completion provider interface

Synopsis

                    GscProvider;
                    GscProviderIface;
const gchar *       gsc_provider_get_name               (GscProvider *self);
GList *             gsc_provider_get_proposals          (GscProvider *self,
                                                         GscTrigger *trigger);
void                gsc_provider_finish                 (GscProvider *self);

Object Hierarchy

  GInterface
   +----GscProvider

Description

You must implement this interface to provide proposals to GscCompletion

Details

GscProvider

typedef struct _GscProvider GscProvider;


GscProviderIface

typedef struct {
	GTypeInterface g_iface;
	
	const gchar* (*get_name)       (GscProvider *self);
	GList*       (*get_proposals)  (GscProvider* self,
				        GscTrigger *trigger);
	void         (*finish)         (GscProvider* self);
} GscProviderIface;


gsc_provider_get_name ()

const gchar *       gsc_provider_get_name               (GscProvider *self);

The provider name. By example: "Document word completion provider"

self :

The GscProvider

Returns :

The provider's name

gsc_provider_get_proposals ()

GList *             gsc_provider_get_proposals          (GscProvider *self,
                                                         GscTrigger *trigger);

The completion call this function when an event is raised. This function may return a list of GscProposal to be shown in the popup to the user.

self :

The GscProvider

trigger :

The GscTrigger that raise the event

Returns :

a list of GscProposal or NULL if there are no proposals

gsc_provider_finish ()

void                gsc_provider_finish                 (GscProvider *self);

The completion call this function when it is goint to hide the popup (The user selects a proposal or hide the completion popup)

self :

The GscProvider