Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members | Related Pages | Search

EventTrapper Class Reference

#include <EventTrapper.h>

Inheritance diagram for EventTrapper:

Inheritance graph
[legend]
List of all members.

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.

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 (   )  [inline, 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.

The documentation for this class was generated from the following file:
Tekkotsu v1.4
 		Generated Sat Jul 19 00:08:56 2003 by Doxygen 1.3.2