Crazy Eddie's GUI System  0.8.4
CEGUI::GlobalEventSet Class Reference

The GlobalEventSet singleton allows you to subscribe to an event for all instances of a class. The GlobalEventSet effectively supports "late binding" to events; which means you can subscribe to some event that does not actually exist (yet). More...

+ Inheritance diagram for CEGUI::GlobalEventSet:
+ Collaboration diagram for CEGUI::GlobalEventSet:

List of all members.

Public Member Functions

virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object.

Static Public Member Functions

static GlobalEventSetgetSingleton (void)
 Return singleton System object.
static GlobalEventSetgetSingletonPtr (void)
 Return pointer to singleton System object.

Detailed Description

The GlobalEventSet singleton allows you to subscribe to an event for all instances of a class. The GlobalEventSet effectively supports "late binding" to events; which means you can subscribe to some event that does not actually exist (yet).


Member Function Documentation

virtual void CEGUI::GlobalEventSet::fireEvent ( const String name,
EventArgs args,
const String eventNamespace = "" 
) [virtual]

Fires the named event passing the given EventArgs object.

Parameters:
nameString object holding the name of the Event that is to be fired (triggered)
argsThe EventArgs (or derived) object that is to be bassed to each subscriber of the Event. Once all subscribers have been called the 'handled' field of the event is updated appropriately.
eventNamespaceString object describing the namespace prefix to use when firing the global event.
Returns:
Nothing.

Reimplemented from CEGUI::EventSet.

Return singleton System object.

Returns:
Singleton System object

Reimplemented from CEGUI::Singleton< GlobalEventSet >.

Return pointer to singleton System object.

Returns:
Pointer to singleton System object

Reimplemented from CEGUI::Singleton< GlobalEventSet >.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends