Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HEventManager Class Reference

The HEventManager class dispatches arbitrary events. More...

#include <HEventManager.h>

List of all members.

Public Member Functions

HEventListenerGetEventListenerManager (HEventListenerType eventtype)
HEventListenerGetEventListenerManager (const char *eventtype)
 HEventManager ()
void RegisterHandler (HEventListener *listener, HEventListenerType eventtype, int priority)
void RegisterHandler (HEventListener *listener, const char *eventtype, int priority)
void UnRegisterHandler (HEventListener *listener)
bool UnRegisterHandler (HEventListener *listener, HEventListenerType eventtype)
bool UnRegisterHandler (HEventListener *listener, const char *eventtype)

Protected Attributes

struct vhash_s * m_pEventListenerListHash
struct vhash_s * m_pEventListenerListHashString


Detailed Description

The HEventManager class dispatches arbitrary events.

By registering with the HEventManager, any class that subclasses from HEventListener can receive events from arbitrary sender. Each event type can have any number of recipients


Constructor & Destructor Documentation

HEventManager::HEventManager (  ) 

Constructs an HEventManager object.


Member Function Documentation

HEventListener* HEventManager::GetEventListenerManager ( HEventListenerType  eventtype  ) 

Get event listener manager for specified event type.

Parameters:
eventtype One of the enumerations from HEventListenerType.
Returns:
A pointer to the associatend event listener manager.

HEventListener* HEventManager::GetEventListenerManager ( const char *  eventtype  ) 

Get event listener manager for specified user-defined event type.

Parameters:
eventtype A user-defined event type.
Returns:
Event Listener Manager

void HEventManager::RegisterHandler ( HEventListener listener,
HEventListenerType  eventtype,
int  priority 
)

Register handler for an event type.

Parameters:
listener Event listener to receive event
eventtype One of the enumerations from HEventListenerType.
priority Event Priority

void HEventManager::RegisterHandler ( HEventListener listener,
const char *  eventtype,
int  priority 
)

Register handler for a user-defined event type.

Parameters:
listener Event listener to receive event
eventtype A user-defined event type.
priority Event Priority

void HEventManager::UnRegisterHandler ( HEventListener listener  ) 

Unregister specified event listener from Event Manager for all event types.

Parameters:
listener Event Listener

bool HEventManager::UnRegisterHandler ( HEventListener listener,
HEventListenerType  eventtype 
)

Unregister specified event listener from Event Manager.

Parameters:
listener Event Listener
eventtype One of the enumerations from HEventListenerType.

bool HEventManager::UnRegisterHandler ( HEventListener listener,
const char *  eventtype 
)

Unregister specified event listener from the event manager for the specified user-defined event type.

Parameters:
listener Event Listener
eventtype A user-defined event type.


Member Data Documentation

struct vhash_s* HEventManager::m_pEventListenerListHash [read, protected]

Event Listener Hash for event types defined in HEventListenerType.

struct vhash_s* HEventManager::m_pEventListenerListHashString [read, protected]

Event Listener Hash for user-defined event types.


The documentation for this class was generated from the following file: