CL_GUIMessage Class Reference
[clanGUI System]

GUI message. More...

#include <gui_message.h>

Inheritance diagram for CL_GUIMessage:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_GUIMessage ()
 Constructs a GUI message.
virtual ~CL_GUIMessage ()
Attributes

CL_StringRef get_type () const
 Returns the message type name.
bool is_type (const CL_StringRef &type) const
 Returns true if the message matches the type.
CL_SharedPtr< CL_GUIMessageDataget_data (const CL_StringRef &data_name) const
 Returns the stored data object for a given data name.
CL_GUIComponentget_target () const
 Returns the target destination of the message.
bool is_consumed () const
 Returns true if the message has been consumed by a component.
Operations

void set_type (const CL_StringRef &type)
 Sets the message type name.
void set_data (const CL_StringRef &data_name, const CL_SharedPtr< CL_GUIMessageData > &ptr)
 Stores an object in the given data name slot.
void set_target (CL_GUIComponent *target)
 Sets the target destination.
void set_null ()
 Sets this message to be a null message.
void set_consumed ()
 Sets this message as consumed.

Detailed Description

GUI message.


Constructor & Destructor Documentation

CL_GUIMessage::CL_GUIMessage (  ) 

Constructs a GUI message.

virtual CL_GUIMessage::~CL_GUIMessage (  )  [virtual]

Member Function Documentation

CL_SharedPtr<CL_GUIMessageData> CL_GUIMessage::get_data ( const CL_StringRef data_name  )  const

Returns the stored data object for a given data name.

CL_GUIComponent* CL_GUIMessage::get_target (  )  const

Returns the target destination of the message.

CL_StringRef CL_GUIMessage::get_type (  )  const

Returns the message type name.

bool CL_GUIMessage::is_consumed (  )  const

Returns true if the message has been consumed by a component.

bool CL_GUIMessage::is_type ( const CL_StringRef type  )  const

Returns true if the message matches the type.

void CL_GUIMessage::set_consumed (  ) 

Sets this message as consumed.

void CL_GUIMessage::set_data ( const CL_StringRef data_name,
const CL_SharedPtr< CL_GUIMessageData > &  ptr 
)

Stores an object in the given data name slot.

void CL_GUIMessage::set_null (  ) 

Sets this message to be a null message.

void CL_GUIMessage::set_target ( CL_GUIComponent target  ) 

Sets the target destination.

void CL_GUIMessage::set_type ( const CL_StringRef type  ) 

Sets the message type name.


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