cKeyEvent

OpenGLPrakt --> events --> cEvent --> cKeyEvent

class cKeyEvent
extends cEvent as public

a cEvent with a payload (a key stroke)

Source:: ../src/cKeyEvent.hh:19

cKeyEvent: [public] constructor w/ initialization
cKeyEvent: [public] constructor w/ initialization
cKeyEvent: [public] copy constructor
~cKeyEvent: [public] destructor

mKey: [protected] the key to transport
mModifiers: [protected] modifiers to transport
mSpecial: [protected] special key to transport

Clone: [public] clone function
GetKey: [public] allow accessing the stored key
GetKeyModifiers: [public] allow accessing the stored key modifiers
GetSpecialKey: [public] allow accessing the stored special key

cKeyEvent

public cKeyEvent ( const string & name = "cKeyEvent" ,
                   unsigned char key = 0 ,
                   int special = 0 ,
                   int modifiers = 0 ) ;

constructor w/ initialization

Parameters:

name	string which contains the event's name
key	ASCII key (0 if special)
special	special key if key==0
modifiers	active modifiers (CTRL etc.)

cKeyEvent

public cKeyEvent ( unsigned char key = 0 ,
                   int special = 0 ,
                   int modifiers = 0 ,
                   const string & name = "cKeyEvent" ) ;

constructor w/ initialization

Parameters:

name	string which contains the event's name
key	ASCII key (0 if special)
special	special key if key==0
modifiers	active modifiers (CTRL etc.)

cKeyEvent

public cKeyEvent ( const cKeyEvent & e ) ;

copy constructor

cKeyEvent

public virtual ~ cKeyEvent ( ) ;

destructor

mKey

protected unsigned char mKey

the key to transport

mSpecial

protected int mSpecial

special key to transport

mModifiers

protected int mModifiers

modifiers to transport

Clone

public virtual cKeyEvent * Clone ( ) const ;

clone function

Return:: pointer to new allocated cKeyEvent

GetKey

public virtual unsigned char GetKey ( ) const ;

allow accessing the stored key

Return:: ASCII key value (zero for special key)

GetSpecialKey

public virtual int GetSpecialKey ( ) const ;

allow accessing the stored special key

Return:: special key value (zero for ASCII key)

GetKeyModifiers

public virtual int GetKeyModifiers ( ) const ;

allow accessing the stored key modifiers

Return:: modifiers in action when key was pressed

This documentation was generated automatically by the ccdoc tool (version 0.7a).
Click here to submit a bug report or feature request.

Click here to return to the top of the page.