GUI input message. More...
#include <gui_message_input.h>
Public Member Functions | |
Construction | |
CL_GUIMessage_Input () | |
Constructs an input GUI message. | |
CL_GUIMessage_Input (const CL_GUIMessage &message) | |
Constructs a GUIMessage Input. | |
~CL_GUIMessage_Input () | |
Operations | |
void | set_event (const CL_InputEvent &event) |
Sets the input event. | |
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_GUIMessageData > | get_data (const CL_StringRef &data_name) const |
Returns the stored data object for a given data name. | |
CL_GUIComponent * | get_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. | |
Attributes | |
| |
CL_InputEvent | get_event () const |
Retrieves the input event for this message. | |
static CL_StringRef | get_type_name () |
Get Type name. |
GUI input message.
CL_GUIMessage_Input::CL_GUIMessage_Input | ( | ) |
Constructs an input GUI message.
CL_GUIMessage_Input::CL_GUIMessage_Input | ( | const CL_GUIMessage & | message | ) |
Constructs a GUIMessage Input.
message | = GUIMessage |
CL_GUIMessage_Input::~CL_GUIMessage_Input | ( | ) |
CL_SharedPtr<CL_GUIMessageData> CL_GUIMessage::get_data | ( | const CL_StringRef & | data_name | ) | const [inherited] |
Returns the stored data object for a given data name.
CL_InputEvent CL_GUIMessage_Input::get_event | ( | ) | const |
Retrieves the input event for this message.
CL_GUIComponent* CL_GUIMessage::get_target | ( | ) | const [inherited] |
Returns the target destination of the message.
CL_StringRef CL_GUIMessage::get_type | ( | ) | const [inherited] |
Returns the message type name.
static CL_StringRef CL_GUIMessage_Input::get_type_name | ( | ) | [static] |
Get Type name.
bool CL_GUIMessage::is_consumed | ( | ) | const [inherited] |
Returns true if the message has been consumed by a component.
bool CL_GUIMessage::is_type | ( | const CL_StringRef & | type | ) | const [inherited] |
Returns true if the message matches the type.
void CL_GUIMessage::set_consumed | ( | ) | [inherited] |
Sets this message as consumed.
void CL_GUIMessage::set_data | ( | const CL_StringRef & | data_name, | |
const CL_SharedPtr< CL_GUIMessageData > & | ptr | |||
) | [inherited] |
Stores an object in the given data name slot.
void CL_GUIMessage_Input::set_event | ( | const CL_InputEvent & | event | ) |
Sets the input event.
void CL_GUIMessage::set_null | ( | ) | [inherited] |
Sets this message to be a null message.
void CL_GUIMessage::set_target | ( | CL_GUIComponent * | target | ) | [inherited] |
Sets the target destination.
void CL_GUIMessage::set_type | ( | const CL_StringRef & | type | ) | [inherited] |
Sets the message type name.