csBaseEventHandler Class Reference
[Event handling]
Base implementation of a generic event handler.
More...
#include <csutil/csbaseeventh.h>
Public Member Functions | |
void | Initialize (iObjectRegistry *registry) |
Perform basic initialization. | |
bool | RegisterQueue (iEventQueue *queue, csEventID names[]) |
Register the event handler with an event queue. | |
bool | RegisterQueue (iEventQueue *queue, csEventID name) |
Register the event handler with an event queue. | |
bool | RegisterQueue (iObjectRegistry *registry, csEventID names[]) |
Register the event handler with the event queue registered with the object registry. | |
bool | RegisterQueue (iObjectRegistry *registry, csEventID name) |
Register the event handler with the event queue registered with the object registry. | |
virtual | ~csBaseEventHandler () |
Destructor. | |
Protected Member Functions | |
csBaseEventHandler () | |
Constructor. | |
virtual void | FinishFrame () |
Invoked by the handler during a finish frame broadcast event. | |
virtual void | Frame () |
Invoked by the handler for the crystalspace.frame event. | |
virtual csHandlerID | GenericID (csRef< iEventHandlerRegistry > ®) const |
virtual const char * | GenericName () const |
Override this if you want to refer to your csBaseEventHandler derived event handler as anything besides "application" for purposes of event subscription scheduling. | |
virtual const csHandlerID * | GenericPrec (csRef< iEventHandlerRegistry > &, csRef< iEventNameRegistry > &, csEventID) const |
Override this if you want to force some modules to always handle some events before csBaseEventHandler. | |
virtual const csHandlerID * | GenericSucc (csRef< iEventHandlerRegistry > &, csRef< iEventNameRegistry > &, csEventID) const |
Override this if you want to force some modules to always handle some events after csBaseEventHandler. | |
virtual bool | HandleEvent (iEvent &event) |
Implementation of the event handling mechanism. | |
virtual const csHandlerID * | InstancePrec (csRef< iEventHandlerRegistry > &, csRef< iEventNameRegistry > &, csEventID) const |
Override this if you want to force some modules to always handle some events before this instance of csBaseEventHandler. | |
virtual const csHandlerID * | InstanceSucc (csRef< iEventHandlerRegistry > &, csRef< iEventNameRegistry > &, csEventID) const |
Override this if you want to force some modules to always handle some events before this instance of csBaseEventHandler. | |
virtual bool | OnJoystickDown (iEvent &event) |
Invoked by the event handler when a joystick button down event is received. | |
virtual bool | OnJoystickMove (iEvent &event) |
Invoked by the event handler when a joystick movement event is received. | |
virtual bool | OnJoystickUp (iEvent &event) |
Invoked by the event handler when a joystick button up event is received. | |
virtual bool | OnKeyboard (iEvent &event) |
Invoked by the event handler when a keyboard event is received. | |
virtual bool | OnMouseClick (iEvent &event) |
Invoked by the event handler when a mouse button click event is received. | |
virtual bool | OnMouseDoubleClick (iEvent &event) |
Invoked by the event handler when a mouse button double-click event is received. | |
virtual bool | OnMouseDown (iEvent &event) |
Invoked by the event handler when a mouse down event is received. | |
virtual bool | OnMouseMove (iEvent &event) |
Invoked by the event handler when a mouse move event is received. | |
virtual bool | OnMouseUp (iEvent &event) |
Invoked by the event handler when a mouse up event is received. | |
virtual bool | OnUnhandledEvent (iEvent &event) |
Invoked by the event handler when an unknown event is received. | |
virtual void | PostProcessFrame () |
Invoked by the handler during a post-process frame broadcast event. | |
virtual void | PreProcessFrame () |
Invoked by the handler during a pre-process frame broadcast event. | |
virtual void | ProcessFrame () |
Invoked by the handler during a process frame broadcast event. | |
Protected Attributes | |
csRef< EventHandlerImpl > | eventh |
csEventID | FinalProcess |
csEventID | FrameEvent |
iObjectRegistry * | object_registry |
csEventID | PostProcess |
csEventID | PreProcess |
csEventID | Process |
csHandlerID | self |
Classes | |
class | EventHandlerImpl |
Actual iEventHandler implementation. More... |
Detailed Description
Base implementation of a generic event handler.
- This class provides a base object which does absolutely nothing with the events that are sent to it. In order to properly use, you must derive a class from this one and override the specific
OnFoo()
trigger methods you are interested in processing.
- Remarks:
- Although this class is derived from iEventHandler, you should not attempt to overload the HandleEvent() method. Always override the specific
On
... trigger function.
Definition at line 57 of file csbaseeventh.h.
Constructor & Destructor Documentation
|
Constructor.
|
|
Destructor.
|
Member Function Documentation
|
Invoked by the handler during a finish frame broadcast event.
|
|
Invoked by the handler for the crystalspace.frame event.
|
|
Override this if you want to refer to your csBaseEventHandler derived event handler as anything besides "application" for purposes of event subscription scheduling.
Definition at line 219 of file csbaseeventh.h. Referenced by GenericID(). |
|
Override this if you want to force some modules to always handle some events before csBaseEventHandler.
Definition at line 232 of file csbaseeventh.h. |
|
Override this if you want to force some modules to always handle some events after csBaseEventHandler.
Definition at line 241 of file csbaseeventh.h. |
|
Implementation of the event handling mechanism. This low-level method examines the event dispatches it to the appropriate OnFoo() or FooFrame() method.
|
|
Perform basic initialization. This function MUST be called before invoking any of the RegisterQueue() methods. |
|
Override this if you want to force some modules to always handle some events before this instance of csBaseEventHandler.
Definition at line 250 of file csbaseeventh.h. |
|
Override this if you want to force some modules to always handle some events before this instance of csBaseEventHandler.
Definition at line 259 of file csbaseeventh.h. |
|
Invoked by the event handler when a joystick button down event is received.
|
|
Invoked by the event handler when a joystick movement event is received.
|
|
Invoked by the event handler when a joystick button up event is received.
|
|
Invoked by the event handler when a keyboard event is received.
|
|
Invoked by the event handler when a mouse button click event is received.
|
|
Invoked by the event handler when a mouse button double-click event is received.
|
|
Invoked by the event handler when a mouse down event is received.
|
|
Invoked by the event handler when a mouse move event is received.
|
|
Invoked by the event handler when a mouse up event is received.
|
|
Invoked by the event handler when an unknown event is received.
|
|
Invoked by the handler during a post-process frame broadcast event.
|
|
Invoked by the handler during a pre-process frame broadcast event.
|
|
Invoked by the handler during a process frame broadcast event.
|
|
Register the event handler with an event queue.
|
|
Register the event handler with an event queue.
|
|
Register the event handler with the event queue registered with the object registry.
|
|
Register the event handler with the event queue registered with the object registry.
|
The documentation for this class was generated from the following file:
- csutil/csbaseeventh.h
Generated for Crystal Space by doxygen 1.4.6