iEventHandlerRegistry Struct Reference
[Event handling]
This interface represents a general event handler registry/resolver.
More...
#include <iutil/eventhandlers.h>
Inheritance diagram for iEventHandlerRegistry:

Public Member Functions | |
virtual csHandlerID const | GetGeneric (csHandlerID id)=0 |
Returns the csHandleID for the generic name for instance name id. | |
virtual csHandlerID | GetGenericID (const csString &)=0 |
Get a csHandlerID based upon some string. | |
virtual iEventHandler * | GetHandler (csHandlerID id)=0 |
Returns the handler registered for a csHandlerID (will be NULL if csHandlerID is a generic name, i.e., if (!csEventHandlerRegistry->IsInstance(id)). | |
virtual csHandlerID | GetID (iEventHandler *)=0 |
Get the csHandlerID for a specified event handler, which provides its own name via the iEventHandler::GetInstanceName() method. | |
virtual const char * | GetString (csHandlerID id)=0 |
Returns the string name for a csHandlerID. | |
virtual bool const | IsInstance (csHandlerID id)=0 |
returns true if id is a handler instance (i.e., not a generic name). | |
virtual bool const | IsInstanceOf (csHandlerID instanceid, csHandlerID genericid)=0 |
returns true if instanceid is a handler instance, genericid is a generic instance, and instanceid is an instance of genericid in particular. | |
virtual void | ReleaseID (iEventHandler *)=0 |
Used when an iEventHandler is destroyed to remove our reference. | |
virtual void | ReleaseID (csHandlerID id)=0 |
Used when an iEventHandler is desroyed to remove our reference. |
Detailed Description
This interface represents a general event handler registry/resolver.An iHandlerRegistry maintains a one-to-one mapping from strings to csHandlerIDs, and a one-to-(zero or one) mapping from csHandlerIDs to iEventHandler pointers.
Definition at line 58 of file eventhandlers.h.
Member Function Documentation
|
Returns the csHandleID for the generic name for instance name id.
Implemented in csEventHandlerRegistry. |
|
Get a csHandlerID based upon some string. This should only ever be done to reference generic (non-instantiated) handler names or single-instance handlers. Implemented in csEventHandlerRegistry. |
|
Returns the handler registered for a csHandlerID (will be NULL if csHandlerID is a generic name, i.e., if (!csEventHandlerRegistry->IsInstance(id)).
Implemented in csEventHandlerRegistry. |
|
Get the csHandlerID for a specified event handler, which provides its own name via the iEventHandler::GetInstanceName() method.
Implemented in csEventHandlerRegistry. |
|
Returns the string name for a csHandlerID.
Implemented in csEventHandlerRegistry. |
|
returns true if id is a handler instance (i.e., not a generic name).
Implemented in csEventHandlerRegistry. |
|
returns true if instanceid is a handler instance, genericid is a generic instance, and instanceid is an instance of genericid in particular.
Implemented in csEventHandlerRegistry. |
|
Used when an iEventHandler is destroyed to remove our reference.
Implemented in csEventHandlerRegistry. |
|
Used when an iEventHandler is desroyed to remove our reference.
Implemented in csEventHandlerRegistry. |
The documentation for this struct was generated from the following file:
- iutil/eventhandlers.h
Generated for Crystal Space by doxygen 1.4.6