CL_GUIMessage Class Reference
[clanGUI System]

GUI message. More...

#include <gui_message.h>

Inheritance diagram for CL_GUIMessage:

List of all members.

Public Member Functions
Construction
	CL_GUIMessage ()
	Constructs a GUI message.
virtual	~CL_GUIMessage ()

---

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_UnknownSharedPtr 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_null (   )  const

Returns true if this is a null message.

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_UnknownSharedPtr &  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:

• gui_message.h

---