Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

MsgHook Class Reference

#include <msghook.h>

Collaboration diagram for MsgHook:

Collaboration graph
[legend]
List of all members.

Detailed Description

Object used to hook into a wtk object message processing pipeline.

Author:
Mattias Jansson (mattias@realityrift.com)


Public Member Functions

 MsgHook ()
 MsgHook (Msg::MSGID eID, Object *pkSender, Object *pkReceiver, MsgHookMethod *pkProcessor, bool bDeleteProcessor=false)
virtual ~MsgHook ()
virtual bool IsHook (Msg *pkMsg)

Public Attributes

Msg::MSGID m_eID
Objectm_pkSender
Objectm_pkReceiver
MsgHookMethodm_pkProcessor
bool m_bDeleteProcessor


Constructor & Destructor Documentation

MsgHook  ) 
 

MsgHook Msg::MSGID  eID,
Object pkSender,
Object pkReceiver,
MsgHookMethod pkProcessor,
bool  bDeleteProcessor = false
 

Parameters:
eID Message ID to listen to, Msg::INVALID if any
pkSender Required sender object, null if any
pkReceiver Required receiver object, null if any
pkProcessor Hook method object
bDeleteProcessor Flag indicating if processor method object in dtor, default false

virtual ~MsgHook  )  [virtual]
 


Member Function Documentation

virtual bool IsHook Msg pkMsg  )  [virtual]
 

Parameters:
pkMsg Message object
Returns:
true if message match hook parameters, false if not


Member Data Documentation

Msg::MSGID m_eID
 

Message ID or MSGID_INVALID if any

Object* m_pkSender
 

Required sender object or null if any

Object* m_pkReceiver
 

Required receiver object or null if any

MsgHookMethod* m_pkProcessor
 

Method

bool m_bDeleteProcessor
 

Flag indicating if we should delete processor object in dtor (default false)


The documentation for this class was generated from the following file:
Generated on Wed Jan 21 14:21:20 2004 for NeoWTK by doxygen 1.3.5