ScummVM API documentation
Ultima::Shared::CMessage Class Reference

#include <messages.h>

Inheritance diagram for Ultima::Shared::CMessage:
Ultima::Shared::BaseObject Ultima::Shared::CAttackMsg Ultima::Shared::CBoardMsg Ultima::Shared::CCastMsg Ultima::Shared::CCharacterInputMsg Ultima::Shared::CClimbMsg Ultima::Shared::CDropMsg Ultima::Shared::CEndOfTurnMsg Ultima::Shared::CEnterMsg Ultima::Shared::CExitTransportMsg Ultima::Shared::CFireMsg Ultima::Shared::CFrameMsg Ultima::Shared::CGetMsg Ultima::Shared::CHideMsg Ultima::Shared::CHuhMsg Ultima::Shared::CHyperJumpMsg Ultima::Shared::CInfoGetCommandKeypress Ultima::Shared::CInfoGetInput Ultima::Shared::CInfoGetKeypress Ultima::Shared::CInfoMsg Ultima::Shared::CInformMsg Ultima::Shared::CKeyCharMsg Ultima::Shared::CKeypressMsg Ultima::Shared::CMouseMsg Ultima::Shared::CMoveMsg Ultima::Shared::COpenMsg Ultima::Shared::CPassMsg Ultima::Shared::CPopupHiddenMsg Ultima::Shared::CPopupShownMsg Ultima::Shared::CQuitMsg Ultima::Shared::CReadyMsg Ultima::Shared::CShowMsg Ultima::Shared::CStatsMsg Ultima::Shared::CStealMsg Ultima::Shared::CTextInputMsg Ultima::Shared::CTransactMsg Ultima::Shared::CUnlockMsg Ultima::Shared::CViewChangeMsg

Public Member Functions

virtual ClassDef getType () const
 
bool execute (TreeItem *target, const ClassDef *classDef=nullptr, int flags=MSGFLAG_SCAN|MSGFLAG_BREAK_IF_HANDLED)
 
bool execute (const Common::String &target, const ClassDef *classDef=nullptr, int flags=MSGFLAG_SCAN|MSGFLAG_BREAK_IF_HANDLED)
 
virtual bool perform (TreeItem *treeItem)
 
virtual bool isMouseMsg () const
 
virtual bool isButtonDownMsg () const
 
virtual bool isButtonUpMsg () const
 
virtual bool isMouseMoveMsg () const
 
virtual bool isDoubleClickMsg () const
 
- Public Member Functions inherited from Ultima::Shared::BaseObject
virtual ::Ultima::Shared::ClassDef getType () const
 
bool isInstanceOf (const ClassDef &classDef) const
 

Static Public Member Functions

static ClassDef type ()
 
static bool supports (const TreeItem *treeItem, const ClassDef &classDef)
 
- Static Public Member Functions inherited from Ultima::Shared::BaseObject
::Ultima::Shared::ClassDef type ()
 

Detailed Description

Base class for all messages

Member Function Documentation

◆ execute() [1/2]

bool Ultima::Shared::CMessage::execute ( TreeItem target,
const ClassDef classDef = nullptr,
int  flags = MSGFLAG_SCAN|MSGFLAG_BREAK_IF_HANDLED 
)

Executes the message, passing it on to the designated target, and optionally it's children

◆ execute() [2/2]

bool Ultima::Shared::CMessage::execute ( const Common::String target,
const ClassDef classDef = nullptr,
int  flags = MSGFLAG_SCAN|MSGFLAG_BREAK_IF_HANDLED 
)

Executes the message, passing it on to the designated target, and optionally it's children

◆ perform()

virtual bool Ultima::Shared::CMessage::perform ( TreeItem treeItem)
virtual

Makes the passed item execute the message

◆ supports()

static bool Ultima::Shared::CMessage::supports ( const TreeItem treeItem,
const ClassDef classDef 
)
static

Returns true if the passed item supports the specified message class


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