Inheritance diagram for CEGUI::EventSet:
Public Types | |
typedef ConstBaseIterator< EventMap > | Iterator |
Public Member Functions | |
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. | |
void | removeEvent (const String &name) |
Removes the Event with the given name. All connections to the event are disconnected. | |
void | removeAllEvents (void) |
Remove all Event objects from the EventSet. | |
bool | isEventPresent (const String &name) |
Checks to see if an Event with the given name is present in the EventSet. | |
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. | |
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. | |
virtual Event::Connection | subscribeScriptedEvent (const String &name, const String &subscriber_name) |
Subscribes the named Event to a scripted funtion. | |
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. | |
virtual void | fireEvent (const String &name, EventArgs &args, const String &eventNamespace="") |
Fires the named event passing the given EventArgs object. | |
bool | isMuted (void) const |
Return whether the EventSet is muted or not. | |
void | setMutedState (bool setting) |
Set the mute state for this EventSet. | |
Iterator | getIterator (void) const |
Return a EventSet::Iterator object to iterate over the events currently added to the EventSet. | |
Protected Types | |
typedef std::map< String, Event *, String::FastLessCompare > | EventMap |
Protected Member Functions | |
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. | |
void | fireEvent_impl (const String &name, EventArgs &args) |
Implementation event firing member. | |
EventSet (EventSet &e) | |
EventSet & | operator= (EventSet &e) |
Protected Attributes | |
EventMap | d_events |
bool | d_muted |
true if events for this EventSet have been muted. |
The EventSet is a means for code to attach a handler function to some named event, and later, for that event to be fired and the subscribed handler(s) called.
void CEGUI::EventSet::addEvent | ( | const String & | name | ) |
void CEGUI::EventSet::fireEvent | ( | const String & | name, | |
EventArgs & | args, | |||
const String & | eventNamespace = "" | |||
) | [virtual] |
Fires the named event passing the given EventArgs object.
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 global event namespace prefix for this event. |
Reimplemented in CEGUI::GlobalEventSet.
bool CEGUI::EventSet::isEventPresent | ( | const String & | name | ) |
bool CEGUI::EventSet::isMuted | ( | void | ) | const |
void CEGUI::EventSet::removeAllEvents | ( | void | ) |
void CEGUI::EventSet::removeEvent | ( | const String & | name | ) |
void CEGUI::EventSet::setMutedState | ( | bool | setting | ) |
Event::Connection CEGUI::EventSet::subscribeEvent | ( | const String & | name, | |
Event::Group | group, | |||
Event::Subscriber | subscriber | |||
) | [virtual] |
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.
Event::Connection CEGUI::EventSet::subscribeEvent | ( | const String & | name, | |
Event::Subscriber | subscriber | |||
) | [virtual] |
Event::Connection CEGUI::EventSet::subscribeScriptedEvent | ( | const String & | name, | |
Event::Group | group, | |||
const String & | subscriber_name | |||
) | [virtual] |
Subscribes the specified group of the named Event to a scripted funtion.
Event::Connection CEGUI::EventSet::subscribeScriptedEvent | ( | const String & | name, | |
const String & | subscriber_name | |||
) | [virtual] |