CL_GUIMessage_FocusChange Class Reference
[clanGUI System]

GUI focus change notification message. More...

#include <gui_message_focus_change.h>

Inheritance diagram for CL_GUIMessage_FocusChange:

List of all members.

Attributes
enum	FocusType { losing_focus, gained_focus }
FocusType	get_focus_type () const
	Retrieves the focus type of this message.
static CL_StringRef	get_type_name ()
	Get Type name.
Public Member Functions
Construction
	CL_GUIMessage_FocusChange ()
	Constructs an input GUI message.
	CL_GUIMessage_FocusChange (const CL_GUIMessage &message)
	Constructs a GUIMessage FocusChange.
	~CL_GUIMessage_FocusChange ()
Operations
void	set_focus_type (FocusType focus_type)
	Sets the focus type for this Message.

---

Detailed Description

GUI focus change notification message.

---

Member Enumeration Documentation

enum CL_GUIMessage_FocusChange::FocusType

Enumerator: losing_focus  gained_focus

---

Constructor & Destructor Documentation

CL_GUIMessage_FocusChange::CL_GUIMessage_FocusChange (   )

Constructs an input GUI message.

CL_GUIMessage_FocusChange::CL_GUIMessage_FocusChange (  const CL_GUIMessage &  message  )

Constructs a GUIMessage FocusChange. Parameters: message  = GUIMessage

CL_GUIMessage_FocusChange::~CL_GUIMessage_FocusChange (   )

---

Member Function Documentation

CL_UnknownSharedPtr CL_GUIMessage::get_data (  const CL_StringRef &  data_name  )  const [inherited]

Returns the stored data object for a given data name.

FocusType CL_GUIMessage_FocusChange::get_focus_type (   )  const

Retrieves the focus type of 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_FocusChange::get_type_name (   )  [static]

Get Type name. Returns: type_name

bool CL_GUIMessage::is_consumed (   )  const [inherited]

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

bool CL_GUIMessage::is_null (   )  const [inherited]

Returns true if this is a null message.

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_UnknownSharedPtr &  ptr )  [inherited]

Stores an object in the given data name slot.

void CL_GUIMessage_FocusChange::set_focus_type (  FocusType  focus_type  )

Sets the focus type for this Message.

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.

---

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

• gui_message_focus_change.h

---