Prev Up Home Guifications Library Reference Manual Next

GfEvent

GfEvent — GfEvent Object API

Synopsis




            GfEvent;
GfEvent*    gf_event_new                    (const gchar *name,
                                             const gchar *i18n,
                                             const gchar *description);
const gchar* gf_event_get_name              (const GfEvent *event);
const gchar* gf_event_get_i18n              (const GfEvent *event);
const gchar* gf_event_get_description       (const GfEvent *event);
void        gf_event_freev                  (GfEvent **events);

Object Hierarchy


  GObject
   +----GfObject
         +----GfEvent

Properties


  "description"          gchararray            : Read / Write / Construct Only
  "i18n"                 gchararray            : Read / Write / Construct Only
  "name"                 gchararray            : Read / Write / Construct Only

Description

GfEvent is an object that holds metadata about events.

Details

GfEvent

typedef struct _GfEvent GfEvent;

GfEvent is an opaque structure that should not be used directly.

gf_event_new ()

GfEvent*    gf_event_new                    (const gchar *name,
                                             const gchar *i18n,
                                             const gchar *description);

Creates a new GfEvent.

name : The name of the GfEvent.
i18n : The translated version of name.
description : The description of the GfEvent.
Returns : The new GfEvent or NULL.

gf_event_get_name ()

const gchar* gf_event_get_name              (const GfEvent *event);

Gets the name from event.

event : The GfEvent instance.
Returns : The name of event or NULL.

gf_event_get_i18n ()

const gchar* gf_event_get_i18n              (const GfEvent *event);

Gets the translated name from event.

event : The GfEvent instance.
Returns : The translated name of event or NULL.

gf_event_get_description ()

const gchar* gf_event_get_description       (const GfEvent *event);

Gets the description of event.

event : The GfEvent instance.
Returns : The description of event or NULL.

gf_event_freev ()

void        gf_event_freev                  (GfEvent **events);

Frees and array of GfEvent's.

events : The array of GfEvent's to free.

Properties

The "description" property

  "description"          gchararray            : Read / Write / Construct Only

The description for the event.

Default value: NULL

The "i18n" property

  "i18n"                 gchararray            : Read / Write / Construct Only

The translated name of the event.

Default value: NULL

The "name" property

  "name"                 gchararray            : Read / Write / Construct Only

The name of the event.

Default value: NULL

<< Events GfEventInfo >>