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 &) |
EventSet & | operator= (EventSet &) |
Protected Attributes |
EventMap | d_events |
bool | d_muted |
| true if events for this EventSet have been muted.
|
Class that collects together a set of Event objects.
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.
- As of 0.5, the EventSet no longer needs to be filled with available events. Events are now added to the set as they are first used; that is, the first time a handler is subscribed to an event for a given EventSet, an Event object is created and added to the EventSet.
- Instead of throwing an exception when firing an event that does not actually exist in the set, we now do nothing (if the Event does not exist, then it has no handlers subscribed, and therefore doing nothing is the correct course action).