EEventHook

EEventHook

Functions

void (*EEventItemsFunc) ()
void (*EEventFunc) ()
void (*EEventFactoryFunc) ()
EEvent * e_event_construct ()
gpointer e_event_add_items ()
void e_event_remove_items ()
void e_event_emit ()
gpointer e_event_target_new ()
void e_event_target_free ()
void (*EEventHookFunc) ()
void e_event_hook_class_add_target_map ()

Types and Values

Description

Functions

EEventItemsFunc ()

void
(*EEventItemsFunc) (EEvent *ee,
                    GSList *items,
                    gpointer data);

EEventItemsFunc is deprecated and should not be used in newly-written code.


EEventFunc ()

void
(*EEventFunc) (EEvent *ee,
               EEventItem *item,
               gpointer data);

EEventFunc is deprecated and should not be used in newly-written code.


EEventFactoryFunc ()

void
(*EEventFactoryFunc) (EEvent *ee,
                      gpointer Param2);

EEventFactoryFunc is deprecated and should not be used in newly-written code.


e_event_construct ()

EEvent *
e_event_construct (EEvent *event,
                   const gchar *id);

e_event_construct is deprecated and should not be used in newly-written code.

Construct the base event instance with standard parameters.

Parameters

event

An instantiated but uninitialised EEvent.

 

id

Event manager id.

 

Returns

the event


e_event_add_items ()

gpointer
e_event_add_items (EEvent *event,
                   GSList *items,
                   EEventItemsFunc freefunc,
                   gpointer data);

e_event_add_items is deprecated and should not be used in newly-written code.

Adds items to the list of events listened to on the event manager event .

Parameters

event

An initialised EEvent structure.

 

items

A list of EEventItems event listeners to register on this event manager.

 

freefunc

A function called when the items list is no longer needed.

 

data

callback data for freefunc and for item event handlers.

 

Returns

An opaque key which can later be passed to remove_items.


e_event_remove_items ()

void
e_event_remove_items (EEvent *event,
                      gpointer handle);

e_event_remove_items is deprecated and should not be used in newly-written code.

Remove items previously added. They MUST have been previously added, and may only be removed once.

Parameters

event

an EEvent

 

handle

an opaque key returned by e_event_add_items()

 

e_event_emit ()

void
e_event_emit (EEvent *event,
              const gchar *id,
              EEventTarget *target);

e_event_emit is deprecated and should not be used in newly-written code.

Emit an event. target will automatically be freed once its emission is complete.

Parameters

id

Event name. This will be compared against EEventItem.id.

 

target

The target describing the event context. This will be implementation defined.

 

e_event_target_new ()

gpointer
e_event_target_new (EEvent *event,
                    gint type,
                    gsize size);

e_event_target_new is deprecated and should not be used in newly-written code.

Allocate a new event target suitable for this class. It is up to the implementation to define the available target types and their structure.

Parameters

event

An initialised EEvent instance.

 

type

type, up to implementor

 

size

The size of memory to allocate. This must be >= sizeof(EEventTarget).

 

e_event_target_free ()

void
e_event_target_free (EEvent *event,
                     gpointer target);

e_event_target_free is deprecated and should not be used in newly-written code.

Free a target. This invokes the virtual free method on the EEventClass.

Parameters

event

An initialised EEvent instance on which this target was allocated.

 

target

The target to free.

 

EEventHookFunc ()

void
(*EEventHookFunc) (EPlugin *plugin,
                   EEventTarget *target);

EEventHookFunc is deprecated and should not be used in newly-written code.


e_event_hook_class_add_target_map ()

void
e_event_hook_class_add_target_map (EEventHookClass *hook_class,
                                   const EEventHookTargetMap *map);

e_event_hook_class_add_target_map is deprecated and should not be used in newly-written code.

Add a target map to a concrete derived class of EEvent. The target map enumerates a single target type and th eenable mask bit names, so that the type can be loaded automatically by the base EEvent class.

Parameters

hook_class

The derived EEventHook class.

 

map

A map used to describe a single EEventTarget type for this class.

 

Types and Values

enum e_event_t

e_event_t is deprecated and should not be used in newly-written code.

Members

E_EVENT_INVALID

   

E_EVENT_PASS

   

E_EVENT_SINK

   

struct EEventItem

struct EEventItem {
	enum _e_event_t type;
	gint priority;		/* priority of event */
	const gchar *id;		/* event id */
	gint target_type;
	EEventFunc handle;
	gpointer user_data;
	guint32 enable;		/* enable mask */
};

EEventItem is deprecated and should not be used in newly-written code.


struct EEventTarget

struct EEventTarget {
	EEvent *event; /* used for virtual methods */

	guint32 type;		/* targe type, for implementors */
	guint32 mask;		/* depends on type, enable mask */

	/* implementation fields follow */
};

EEventTarget is deprecated and should not be used in newly-written code.


EEventHookTargetMap

typedef struct _EPluginHookTargetMap EEventHookTargetMap;

EEventHookTargetMap is deprecated and should not be used in newly-written code.


EEventHookTargetMask

typedef struct _EPluginHookTargetKey EEventHookTargetMask;

EEventHookTargetMask is deprecated and should not be used in newly-written code.


EEventFactory

typedef struct _EEventFactory EEventFactory;

EEventFactory is deprecated and should not be used in newly-written code.