ClanLib
2.3.7
|
GUI message. More...
#include <gui_message.h>
Public Member Functions | |
Construction | |
CL_GUIMessage () | |
Constructs a GUI message. More... | |
virtual | ~CL_GUIMessage () |
Attributes | |
CL_StringRef | get_type () const |
Returns the message type name. More... | |
bool | is_type (const CL_StringRef &type) const |
Returns true if the message matches the type. More... | |
CL_SharedPtr< CL_GUIMessageData > | get_data (const CL_StringRef &data_name) const |
Returns the stored data object for a given data name. More... | |
CL_GUIComponent * | get_target () const |
Returns the target destination of the message. More... | |
bool | is_consumed () const |
Returns true if the message has been consumed by a component. More... | |
Operations | |
void | set_type (const CL_StringRef &type) |
Sets the message type name. More... | |
void | set_data (const CL_StringRef &data_name, const CL_SharedPtr< CL_GUIMessageData > &ptr) |
Stores an object in the given data name slot. More... | |
void | set_target (CL_GUIComponent *target) |
Sets the target destination. More... | |
void | set_null () |
Sets this message to be a null message. More... | |
void | set_consumed () |
Sets this message as consumed. More... | |
GUI message.
CL_GUIMessage::CL_GUIMessage | ( | ) |
Constructs a GUI message.
|
virtual |
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.