GscTrigger

GscTrigger — Completion trigger interface

Synopsis

                    GscTrigger;
                    GscTriggerIface;
const gchar *       gsc_trigger_get_name                (GscTrigger *self);
gboolean            gsc_trigger_activate                (GscTrigger *self);
gboolean            gsc_trigger_deactivate              (GscTrigger *self);

Object Hierarchy

  GInterface
   +----GscTrigger

Known Implementations

GscTrigger is implemented by GscTriggerAutowords, GscTriggerCustomkey and GscTriggerUserRequest.

Description

You must implement this interface to trigger completion events with GscCompletion

Details

GscTrigger

typedef struct _GscTrigger GscTrigger;


GscTriggerIface

typedef struct {
	GTypeInterface parent;
	
	const gchar* (*get_name)   (GscTrigger *self);
	gboolean     (*activate)   (GscTrigger* self);
	gboolean     (*deactivate) (GscTrigger* self);
} GscTriggerIface;


gsc_trigger_get_name ()

const gchar *       gsc_trigger_get_name                (GscTrigger *self);

The trigger name. By example: "C autocompletion trigger".

self :

The GscTrigger

Returns :

The trigger's name

gsc_trigger_activate ()

gboolean            gsc_trigger_activate                (GscTrigger *self);

Activate the completion trigger.

self :

The GscTrigger

Returns :

TRUE if the activation was OK, FALSE if not.

gsc_trigger_deactivate ()

gboolean            gsc_trigger_deactivate              (GscTrigger *self);

Deactive the completion trigger

self :

The GscTrigger

Returns :

TRUE if the deactivation was OK, FALSE if not.