Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

CSMessage Class Reference

#include <CSMessage.h>

Inheritance diagram for CSMessage:

ActionMessage GameMessage GuiMessage InputMessage SDLMessage SpriteMessage

Detailed Description

The CSMessage class is the base class for messages. It might have been possible to use this class as an overall massage system. but due to non inheritable friend relations and data consistency (most set methods should only be accessable from the message initiator) the actual use of the class is like:

(Example from CSSprite)

class CSSprite : ... { ... public: class SpriteMessage: public CSMessage { friend CSSprite; }; SpriteMessage MESSAGE_SPRITE_NEXT_DEFAULT; ... };
In the constructor of the message using class fixed messages might be pre-defined. That also meens, that messages are owned by the message - Source. And should never be freed from any place else!

######################

Also message types are defined here! (for now)

Definition at line 133 of file CSMessage.h.

Public Member Functions

 CSMessage ()
virtual ~CSMessage ()
virtual void setSuccess (bool b)
virtual void setOrigin (CSMessageDispatchable *origin)
virtual void setSubtype (int subtype)
virtual void setSubsubtype (int type)
virtual void setPriority (int priority)
virtual void setDispatchAtOnce (bool dispatchAtOnce)
virtual bool isSuccess ()
virtual CSMessageDispatchablegetOrigin ()
virtual int getSubtype ()
virtual int getSubsubtype ()
virtual int getType ()
virtual int getPriority ()
virtual bool isDispatchAtOnce ()
virtual void setHandled (bool isHandled)
bool isHandled ()

Data Fields

bool mIsHandled

Protected Member Functions

virtual void setType (int type)

Protected Attributes

CSMessageDispatchablemOrigin
int mType
int mSubtype
int mSubsubtype
int mPriority
bool mIsDispatchAtOnce
bool mSuccess


Constructor & Destructor Documentation

CSMessage::CSMessage  )  [inline]
 

Definition at line 150 of file CSMessage.h.

References mIsDispatchAtOnce, mIsHandled, mOrigin, mPriority, mSubsubtype, mSubtype, and mSuccess.

00151         {
00152             mIsHandled = false;
00153             mSuccess = false;
00154             mOrigin = 0;
00155             mSubtype = 0;
00156             mSubsubtype = 0;
00157             mType = 0;
00158             mPriority = 0;
00159             mIsDispatchAtOnce = true;
00160         }

virtual CSMessage::~CSMessage  )  [inline, virtual]
 

Definition at line 162 of file CSMessage.h.

00162 {}


Member Function Documentation

virtual void CSMessage::setType int  type  )  [inline, protected, virtual]
 

Definition at line 146 of file CSMessage.h.

00146 {mType = type;}

virtual void CSMessage::setSuccess bool  b  )  [inline, virtual]
 

Definition at line 164 of file CSMessage.h.

References mSuccess.

Referenced by CSSprite::reactOnMessage().

00164 {mSuccess = b;}

virtual void CSMessage::setOrigin CSMessageDispatchable origin  )  [inline, virtual]
 

Definition at line 165 of file CSMessage.h.

References mOrigin.

00165 {mOrigin = origin;}

virtual void CSMessage::setSubtype int  subtype  )  [inline, virtual]
 

Definition at line 166 of file CSMessage.h.

References mSubtype.

Referenced by CSCheckBox::CSCheckBox(), CSDragButton::CSDragButton(), CSMenuItem::CSMenuItem(), CSScrollbar::CSScrollbar(), CSGrafikElement::init(), CSListbox::initListbox(), and CSWindow::initWindow().

00166 {mSubtype = subtype;}

virtual void CSMessage::setSubsubtype int  type  )  [inline, virtual]
 

Definition at line 167 of file CSMessage.h.

References mSubsubtype.

Referenced by CSGame::checkOutOfBounds().

00167 {mSubsubtype = type;}

virtual void CSMessage::setPriority int  priority  )  [inline, virtual]
 

Definition at line 168 of file CSMessage.h.

References mPriority.

00168 {mPriority = priority;}

virtual void CSMessage::setDispatchAtOnce bool  dispatchAtOnce  )  [inline, virtual]
 

Definition at line 169 of file CSMessage.h.

References mIsDispatchAtOnce.

00169 {mIsDispatchAtOnce = dispatchAtOnce;}

virtual bool CSMessage::isSuccess  )  [inline, virtual]
 

Definition at line 171 of file CSMessage.h.

References mSuccess.

00171 {return mSuccess;}

virtual CSMessageDispatchable* CSMessage::getOrigin  )  [inline, virtual]
 

Definition at line 172 of file CSMessage.h.

References mOrigin.

00172 {return mOrigin;}

virtual int CSMessage::getSubtype  )  [inline, virtual]
 

Definition at line 173 of file CSMessage.h.

References mSubtype.

Referenced by CSSprite::reactOnMessage(), CSButton::reactOnMessageButton(), CSCheckBox::reactOnMessageCheckBox(), CSCombobox::reactOnMessageCombobox(), CSDragButton::reactOnMessageDragButton(), CSGame::reactOnMessageGame(), CSHTMLPanel::reactOnMessageHTMLPanel(), CSListbox::reactOnMessageListbox(), CSMenu::reactOnMessageMenu(), CSMenuItem::reactOnMessageMenuItem(), CSScrollbar::reactOnMessageScrollbar(), CSTextarea::reactOnMessageTextarea(), CSTextfield::reactOnMessageTextField(), and CSWindow::reactOnMessageWindow().

00173 {return mSubtype;}

virtual int CSMessage::getSubsubtype  )  [inline, virtual]
 

Definition at line 174 of file CSMessage.h.

References mSubsubtype.

00174 {return mSubsubtype;}

virtual int CSMessage::getType  )  [inline, virtual]
 

Definition at line 175 of file CSMessage.h.

Referenced by CSSprite::reactOnMessage(), CSButton::reactOnMessageButton(), CSCheckBox::reactOnMessageCheckBox(), CSCombobox::reactOnMessageCombobox(), CSDragButton::reactOnMessageDragButton(), CSGame::reactOnMessageGame(), CSHTMLPanel::reactOnMessageHTMLPanel(), CSListbox::reactOnMessageListbox(), CSMenu::reactOnMessageMenu(), CSMenuItem::reactOnMessageMenuItem(), CSScrollbar::reactOnMessageScrollbar(), CSTextarea::reactOnMessageTextarea(), CSTextfield::reactOnMessageTextField(), CSWindow::reactOnMessageWindow(), and CSMessageDispatchable::sendMessage().

00175 {return mType;}

virtual int CSMessage::getPriority  )  [inline, virtual]
 

Definition at line 176 of file CSMessage.h.

References mPriority.

00176 {return mPriority;}

virtual bool CSMessage::isDispatchAtOnce  )  [inline, virtual]
 

Definition at line 177 of file CSMessage.h.

References mIsDispatchAtOnce.

Referenced by CSMessageListener::dispatchMessage().

00177 {return mIsDispatchAtOnce;}

virtual void CSMessage::setHandled bool  isHandled  )  [inline, virtual]
 

Definition at line 178 of file CSMessage.h.

References mIsHandled.

00178 {mIsHandled = isHandled;}

bool CSMessage::isHandled  )  [inline]
 

Definition at line 179 of file CSMessage.h.

References mIsHandled.

00179 {return mIsHandled;}


Field Documentation

CSMessageDispatchable* CSMessage::mOrigin [protected]
 

Definition at line 138 of file CSMessage.h.

Referenced by CSMessage(), getOrigin(), and setOrigin().

int CSMessage::mType [protected]
 

Definition at line 139 of file CSMessage.h.

int CSMessage::mSubtype [protected]
 

Definition at line 140 of file CSMessage.h.

Referenced by CSMessage(), getSubtype(), and setSubtype().

int CSMessage::mSubsubtype [protected]
 

Definition at line 141 of file CSMessage.h.

Referenced by CSMessage(), getSubsubtype(), and setSubsubtype().

int CSMessage::mPriority [protected]
 

Definition at line 142 of file CSMessage.h.

Referenced by CSMessage(), getPriority(), and setPriority().

bool CSMessage::mIsDispatchAtOnce [protected]
 

Definition at line 143 of file CSMessage.h.

Referenced by CSMessage(), isDispatchAtOnce(), and setDispatchAtOnce().

bool CSMessage::mSuccess [protected]
 

Definition at line 144 of file CSMessage.h.

Referenced by CSMessage(), isSuccess(), and setSuccess().

bool CSMessage::mIsHandled
 

Definition at line 149 of file CSMessage.h.

Referenced by CSMessage(), isHandled(), CSButton::reactOnMessageButton(), CSCheckBox::reactOnMessageCheckBox(), CSCombobox::reactOnMessageCombobox(), CSDragButton::reactOnMessageDragButton(), CSHTMLPanel::reactOnMessageHTMLPanel(), CSListbox::reactOnMessageListbox(), CSMenu::reactOnMessageMenu(), CSMenuItem::reactOnMessageMenuItem(), CSScrollbar::reactOnMessageScrollbar(), CSTextarea::reactOnMessageTextarea(), CSTextfield::reactOnMessageTextField(), CSWindow::reactOnMessageWindow(), CSDesktop::setFocusedComponent(), CSListbox::setGrafikCursor(), and setHandled().


Generated on Wed Jul 14 00:44:53 2004 for CSLib by doxygen 1.3.6