CL_GUIMessage_Pointer Class Reference
[clanGUI System]

GUI mouse pointer change notification message. More...

#include <gui_message_pointer.h>

Inheritance diagram for CL_GUIMessage_Pointer:

List of all members.

Attributes
enum	PointerType { pointer_enter, pointer_leave }
PointerType	get_pointer_type () const
	Retrieves the pointer type of this message.
static CL_StringRef	get_type_name ()
	Get Type name.
Public Member Functions
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_UnknownSharedPtr	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_null () const
	Returns true if this is a null 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_UnknownSharedPtr &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_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_UnknownSharedPtr	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_null () const
	Returns true if this is a null 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_UnknownSharedPtr &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_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_UnknownSharedPtr	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_null () const
	Returns true if this is a null 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_UnknownSharedPtr &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.
Construction
	CL_GUIMessage_Pointer ()
	Constructs an input GUI message.
	CL_GUIMessage_Pointer (const CL_GUIMessage &message)
	Constructs a GUIMessage Pointer.
	~CL_GUIMessage_Pointer ()
Operations
void	set_pointer_type (PointerType pointer_type)
	Sets the pointer type for this message.
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_UnknownSharedPtr	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_null () const
	Returns true if this is a null 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_UnknownSharedPtr &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 mouse pointer change notification message.

---

Member Enumeration Documentation

enum CL_GUIMessage_Pointer::PointerType

Enumerator: pointer_enter  pointer_leave

---

Constructor & Destructor Documentation

CL_GUIMessage_Pointer::CL_GUIMessage_Pointer (   )

Constructs an input GUI message.

CL_GUIMessage_Pointer::CL_GUIMessage_Pointer (  const CL_GUIMessage &  message  )

Constructs a GUIMessage Pointer. Parameters: message  = GUIMessage

CL_GUIMessage_Pointer::~CL_GUIMessage_Pointer (   )

---

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.

PointerType CL_GUIMessage_Pointer::get_pointer_type (   )  const

Retrieves the pointer 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_Pointer::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::set_null (   )  [inherited]

Sets this message to be a null message.

void CL_GUIMessage_Pointer::set_pointer_type (  PointerType  pointer_type  )

Sets the pointer type for this 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_pointer.h

---