CL_AcceleratorKey Class Reference
[clanGUI System]

GUI Accelerator Table Entry. More...

#include <accelerator_key.h>

List of all members.

Public Member Functions

Construction

 CL_AcceleratorKey ()
 Constructs a null instance.
 CL_AcceleratorKey (int id, int mod1=-1, int mod2=-1, int mod3=-1)
 Constructs a AcceleratorKey.
 ~CL_AcceleratorKey ()
Attributes

CL_Callback_v2< CL_GUIMessage,
CL_AcceleratorKey > & 
func_pressed ()
bool get_shift () const
 Get Shift.
bool get_alt () const
 Get Alt.
bool get_ctrl () const
 Get Ctrl.
int get_id () const
 Get Id.
bool is_null () const
 Returns true if this object is invalid.
void throw_if_null () const
 Throw an exception if this object is invalid.
Operations

void set_shift (bool)
 Set Shift.
void set_alt (bool)
 Set Alt.
void set_ctrl (bool)
 Set Ctrl.
void set_id (int)
 Set Id.

Detailed Description

GUI Accelerator Table Entry.


Constructor & Destructor Documentation

CL_AcceleratorKey::CL_AcceleratorKey (  ) 

Constructs a null instance.

CL_AcceleratorKey::CL_AcceleratorKey ( int  id,
int  mod1 = -1,
int  mod2 = -1,
int  mod3 = -1 
)

Constructs a AcceleratorKey.

Parameters:
id = value
mod1 = value
mod2 = value
mod3 = value
CL_AcceleratorKey::~CL_AcceleratorKey (  ) 

Member Function Documentation

CL_Callback_v2<CL_GUIMessage, CL_AcceleratorKey>& CL_AcceleratorKey::func_pressed (  ) 
bool CL_AcceleratorKey::get_alt (  )  const

Get Alt.

Returns:
alt
bool CL_AcceleratorKey::get_ctrl (  )  const

Get Ctrl.

Returns:
ctrl
int CL_AcceleratorKey::get_id (  )  const

Get Id.

Returns:
id
bool CL_AcceleratorKey::get_shift (  )  const

Get Shift.

Returns:
shift
bool CL_AcceleratorKey::is_null (  )  const [inline]

Returns true if this object is invalid.

void CL_AcceleratorKey::set_alt ( bool   ) 

Set Alt.

void CL_AcceleratorKey::set_ctrl ( bool   ) 

Set Ctrl.

void CL_AcceleratorKey::set_id ( int   ) 

Set Id.

void CL_AcceleratorKey::set_shift ( bool   ) 

Set Shift.

void CL_AcceleratorKey::throw_if_null (  )  const

Throw an exception if this object is invalid.


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