Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

iEventCord Struct Reference

The iEventCord is an interface provided by an event queue to any event handlers wanting to receive some subclasses of events ASAP in a specified priority, bypassing the queue itself. More...

#include <event.h>

Inheritance diagram for iEventCord:

List of all members.

Public Methods

virtual int Insert (iEventHandler *, int priority)=0
 Insert an event handler into the cord. More...

virtual void Remove (iEventHandler *)=0
 Remove an event handler from the cord.

virtual bool GetPass () const=0
 Returns true if events are passed on to the owning event queue if all plugins in the cord return false from HandleEvent().

virtual void SetPass (bool)=0
 Sets whether events are passed along to the owning event queue if all plugins in the cord return false from HandleEvent().

virtual int GetCategory () const=0
 Get the category of this cord.

virtual int GetSubcategory () const=0

Detailed Description

The iEventCord is an interface provided by an event queue to any event handlers wanting to receive some subclasses of events ASAP in a specified priority, bypassing the queue itself.

Events may also optionally be sent to the normal event queue itself if none of the event handlers in the cord handle the event.


Member Function Documentation

int iEventCord::Insert ( iEventHandler *,
int priority ) [pure virtual]
 

Insert an event handler into the cord.

The priority defines when it will receive the event with respect to other registered event handlers. Event handlers with the same priority are handled in a first-come first-served fashion. This is significant since returning true from HandleEvent() will stop further event processing.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000