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:

Public Member Functions
virtual void	fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
	Fires the named event passing the given EventArgs object. More...
Public Member Functions inherited from CEGUI::EventSet
	EventSet ()
	Constructor for EventSet objects.
virtual	~EventSet (void)
	Destructor for EventSet objects.
void	addEvent (const String &name)
	Add a new Event to the EventSet with the given name. More...
void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected. More...
void	removeAllEvents (void)
	Remove all Event objects from the EventSet. More...
bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in the EventSet. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Subscriber subscriber)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
	Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, const String &subscriber_name)
	Subscribes the named Event to a scripted funtion. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
	Subscribes the specified group of the named Event to a scripted funtion. More...
bool	isMuted (void) const
	Return whether the EventSet is muted or not. More...
void	setMutedState (bool setting)
	Set the mute state for this EventSet. More...
Iterator	getIterator (void) const
	Return a EventSet::Iterator object to iterate over the events currently added to the EventSet.

Static Public Member Functions
static GlobalEventSet &	getSingleton (void)
	Return singleton System object. More...
static GlobalEventSet *	getSingletonPtr (void)
	Return pointer to singleton System object. More...
Static Public Member Functions inherited from CEGUI::Singleton< GlobalEventSet >
static GlobalEventSet &	getSingleton (void)
static GlobalEventSet *	getSingletonPtr (void)

Additional Inherited Members
Public Types inherited from CEGUI::EventSet
typedef ConstBaseIterator < EventMap >	Iterator
Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, String::FastLessCompare >	EventMap
Protected Member Functions inherited from CEGUI::EventSet
Event *	getEventObject (const String &name, bool autoAdd=false)
	Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.
	EventSet (EventSet &)
EventSet &	operator= (EventSet &)
Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events
bool	d_muted
	true if events for this EventSet have been muted.
Static Protected Attributes inherited from CEGUI::Singleton< GlobalEventSet >
static GlobalEventSet *	ms_Singleton

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

name	String object holding the name of the Event that is to be fired (triggered)
args	The 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.
eventNamespace	String object describing the namespace prefix to use when firing the global event.

Returns

Nothing.

Reimplemented from CEGUI::EventSet.

static GlobalEventSet& CEGUI::GlobalEventSet::getSingleton ( void  )

static

Return singleton System object.

Returns

Singleton System object

static GlobalEventSet* CEGUI::GlobalEventSet::getSingletonPtr ( void  )

static

Return pointer to singleton System object.

Returns

Pointer to singleton System object