CL_GUIMessage_ActivationChange Class Reference
[clanGUI System]

GUI activation change notification message. More...

#include <gui_message_activation_change.h>

Inheritance diagram for CL_GUIMessage_ActivationChange:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_GUIMessage_ActivationChange ()
 Constructs an input GUI message.
 CL_GUIMessage_ActivationChange (const CL_GUIMessage &message)
 Constructs a GUIMessage ActivationChange.
 ~CL_GUIMessage_ActivationChange ()
Operations

void set_activation_type (ActivationType activation_type)
 Sets the activation 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_SharedPtr< CL_GUIMessageDataget_data (const CL_StringRef &data_name) const
 Returns the stored data object for a given data name.
CL_GUIComponentget_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



enum  ActivationType { activation_lost, activation_gained }
ActivationType get_activation_type () const
 Retrieves the focus type of this message.
static CL_StringRef get_type_name ()
 Get Type name.

Detailed Description

GUI activation change notification message.


Member Enumeration Documentation

Enumerator:
activation_lost 
activation_gained 

Constructor & Destructor Documentation

CL_GUIMessage_ActivationChange::CL_GUIMessage_ActivationChange (  ) 

Constructs an input GUI message.

CL_GUIMessage_ActivationChange::CL_GUIMessage_ActivationChange ( const CL_GUIMessage message  ) 

Constructs a GUIMessage ActivationChange.

Parameters:
message = GUIMessage
CL_GUIMessage_ActivationChange::~CL_GUIMessage_ActivationChange (  ) 

Member Function Documentation

ActivationType CL_GUIMessage_ActivationChange::get_activation_type (  )  const

Retrieves the focus type of this message.

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_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_ActivationChange::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_type ( const CL_StringRef type  )  const [inherited]

Returns true if the message matches the type.

void CL_GUIMessage_ActivationChange::set_activation_type ( ActivationType  activation_type  ) 

Sets the activation type for this Message.

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