gsc-provider

gsc-provider

Synopsis

#define             GSC_PROVIDER_GET_INTERFACE          (obj)
                    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

Known Implementations

GscProvider is implemented by GscDocumentwordsProvider and GscProviderFile.

Description

Details

GSC_PROVIDER_GET_INTERFACE()

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

obj :


GscProvider

typedef struct _GscProvider GscProvider;


GscProviderIface

typedef struct {
	GTypeInterface parent;
	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

self :

the GscProvider