Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

EventTrapper Class Reference

An interface to allow a standard method of trapping events. More...

#include <EventTrapper.h>

Inheritance diagram for EventTrapper:

Detailed Description

An interface to allow a standard method of trapping events.

Trappers get first dibs on events and can prevent the event from being sent any further
This is handy in situations where an event is more than a notification, and must be "handled" - the trapper which handles it returns true, otherwise it is passed to the next one
A trapper can filter any and all events, EXCEPT timers. This *could* be changed, if a good reason is presented.

Definition at line 12 of file EventTrapper.h.

List of all members.

Public Member Functions

virtual ~EventTrapper ()
 destructor
virtual bool trapEvent (const EventBase &event)=0
 for receiving events - you must override this to inherit

Constructor & Destructor Documentation

virtual EventTrapper::~EventTrapper (  )  [virtual]

destructor

Definition at line 15 of file EventTrapper.h.


Member Function Documentation

virtual bool EventTrapper::trapEvent ( const EventBase event  )  [pure virtual]

for receiving events - you must override this to inherit

See also:
EventRouter
Parameters:
event the event being received
Returns:
true if the event was trapped (shouldn't be sent to listeners), false otherwise

Implemented in Controller, and EventTranslator.

Referenced by EventRouter::PostingStatus::process().


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

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:07 2016 by Doxygen 1.6.3