CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iEventHandler Struct Reference
[Event handling]

This interface describes an entity that can receive events. More...

#include <eventh.h>

Inheritance diagram for iEventHandler:

iBase csApp::csAppPlugin::eiEventHandler csBaseEventHandler csEngine::EventHandler csJoystickDriver::eiEventHandler csKeyboardDriver::eiEventHandler csMouseDriver::eiEventHandler List of all members.

Public Methods

virtual bool HandleEvent (iEvent &)=0
 This is the basic event handling function. More...


Detailed Description

This interface describes an entity that can receive events.

Definition at line 36 of file eventh.h.


Member Function Documentation

virtual bool iEventHandler::HandleEvent iEvent   [pure virtual]
 

This is the basic event handling function.

To receive events, a component must implement iEventHandler and register with an event queue using iEventQueue::RegisterListener(). The event handler should return true if the event was handled. Returning true prevents the event from being passed along to other event handlers. If the event was not handled, then false should be returned, in which case other event handlers are given a shot at the event. Note that broadcast events are sent to all handlers which are interested in them regardless of the return value of this method. NOTE: Do _not_ return true unless you really handled the event and want event dispatch to stop at your handler.

Implemented in csEngine::EventHandler.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14