version 3.3

VRS::KeyEvent Class Reference

Keyboard Event. More...

#include <vrs/sg/keyevent.h>

Inheritance diagram for VRS::KeyEvent:

VRS::InputEvent VRS::CanvasEvent VRS::Event VRS::SharedObj VRS::Visitable

List of all members.

Public Member Functions

 KeyEvent (Canvas *canvas, InputEvent::Modifier modifiers=InputEvent::NoModifier, VRSTime time=0, unsigned int keyCode=0, InputEvent::Change pressed=InputEvent::Pressed, bool isAutoRepeat=false)
unsigned int keyCode () const
bool pressed () const
bool released () const
bool isAutoRepeat () const
 Returns true if the event has been caused by auto-repeat.
 VRS_TYPEINFO (KeyEvent, InputEvent)

Friends

class Canvas


Detailed Description

Keyboard Event.

Constructor & Destructor Documentation

VRS::KeyEvent::KeyEvent ( Canvas canvas,
InputEvent::Modifier  modifiers = InputEvent::NoModifier,
VRSTime  time = 0,
unsigned int  keyCode = 0,
InputEvent::Change  pressed = InputEvent::Pressed,
bool  isAutoRepeat = false 
)


Member Function Documentation

unsigned int VRS::KeyEvent::keyCode (  )  const [inline]

The key code specific to the operating system. ASCII keys are given by their ASCII key code. Special keys are encoded by the constants defined in the 'Key' class.

bool VRS::KeyEvent::pressed (  )  const [inline]

bool VRS::KeyEvent::released (  )  const [inline]

In general, a key event is produced if a key is pressed and when it is released. Some user interface systems do not provide release events.

bool VRS::KeyEvent::isAutoRepeat (  )  const [inline]

Returns true if the event has been caused by auto-repeat.

If this information is not available for the used GUI lib, the result is always 'false'.

VRS::KeyEvent::VRS_TYPEINFO ( KeyEvent  ,
InputEvent   
)


Friends And Related Function Documentation

friend class Canvas [friend]

Reimplemented from VRS::InputEvent.


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

Generated on Tue May 21 06:00:31 2013 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact