CrystalSpace

Public API Reference

csEventNameRegistry Class Reference
[Event handling]

The csEventNameRegistry transforms textual event names (e.g., "crystalspace.input.joystick.3.button") into easier-to-manage csEventIDs (which, in non-debug builds, are really just csStringIDs). More...

#include <csutil/eventnames.h>

Inherits scfImplementation1< csEventNameRegistry, iEventNameRegistry >.

List of all members.

Static Public Member Functions

static csRef< iEventNameRegistryGetRegistry (iObjectRegistry *object_reg)
 Return the singleton iEventNameRegistry object registered in the iObjectRegistry (or create one if none yet exists).

iEventNameRegistry implementation



csEventID GetID (const char *name)
const char * GetString (const csEventID id)
csEventID GetParentID (const csEventID id)
bool IsImmediateChildOf (const csEventID child, const csEventID parent)
bool IsKindOf (const csEventID child, const csEventID parent)
static const char * GetString (iObjectRegistry *object_reg, csEventID id)

Detailed Description

The csEventNameRegistry transforms textual event names (e.g., "crystalspace.input.joystick.3.button") into easier-to-manage csEventIDs (which, in non-debug builds, are really just csStringIDs).

Also offers easy methods for querying parentage relationships between two event names.

Note that any modules across which event names will be shared need to call csEventNameRegistry::Register() on the same iObjectRegistry.

Definition at line 63 of file eventnames.h.


Member Function Documentation

static csRef<iEventNameRegistry> csEventNameRegistry::GetRegistry ( iObjectRegistry object_reg  )  [static]

Return the singleton iEventNameRegistry object registered in the iObjectRegistry (or create one if none yet exists).


The documentation for this class was generated from the following file:

Generated for Crystal Space 1.4.1 by doxygen 1.7.1