ClanLib  2.3.7
List of all members
CL_AcceleratorKey Class Reference

GUI Accelerator Table Entry. More...

#include <accelerator_key.h>

Public Member Functions

Construction
 CL_AcceleratorKey ()
 Constructs a null instance. More...
 
 CL_AcceleratorKey (int id, int mod1=-1, int mod2=-1, int mod3=-1)
 Constructs a AcceleratorKey. More...
 
 ~CL_AcceleratorKey ()
 
Attributes
CL_Callback_v2< CL_GUIMessage,
CL_AcceleratorKey > & 
func_pressed ()
 
bool get_shift () const
 Get Shift. More...
 
bool get_alt () const
 Get Alt. More...
 
bool get_ctrl () const
 Get Ctrl. More...
 
int get_id () const
 Get Id. More...
 
bool is_null () const
 Returns true if this object is invalid. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
Operations
void set_shift (bool)
 Set Shift. More...
 
void set_alt (bool)
 Set Alt. More...
 
void set_ctrl (bool)
 Set Ctrl. More...
 
void set_id (int)
 Set Id. More...
 

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: