makVrv::DtKeyState Class Reference

This class encapsulates the state associated with a key event. More...

Public Types
enum	KeyType {   KEY_BACKSPACE = 0x08, KEY_TAB = 0x09, KEY_CLEAR = 0x0C, KEY_ENTER = 0x0D,   KEY_PAUSE = 0x13, KEY_ESCAPE = 0x1B, KEY_SPACE = 0x20, KEY_PAGE_UP = 0x21,   KEY_PAGE_DOWN = 0x22, KEY_END = 0x23, KEY_HOME = 0x24, KEY_LEFT = 0x25,   KEY_UP = 0x26, KEY_RIGHT = 0x27, KEY_DOWN = 0x28, KEY_PRINT_SCREEN = 0x2C,   KEY_INSERT = 0x2D, KEY_DELETE = 0x2E, KEY_0 = 0x30, KEY_1 = 0x31,   KEY_2 = 0x32, KEY_3 = 0x33, KEY_4 = 0x34, KEY_5 = 0x35,   KEY_6 = 0x36, KEY_7 = 0x37, KEY_8 = 0x38, KEY_9 = 0x39,   KEY_A = 0x41, KEY_B = 0x42, KEY_C = 0x43, KEY_D = 0x44,   KEY_E = 0x45, KEY_F = 0x46, KEY_G = 0x47, KEY_H = 0x48,   KEY_I = 0x49, KEY_J = 0x4A, KEY_K = 0x4B, KEY_L = 0x4C,   KEY_M = 0x4D, KEY_N = 0x4E, KEY_O = 0x4F, KEY_P = 0x50,   KEY_Q = 0x51, KEY_R = 0x52, KEY_S = 0x53, KEY_T = 0x54,   KEY_U = 0x55, KEY_V = 0x56, KEY_W = 0x57, KEY_X = 0x58,   KEY_Y = 0x59, KEY_Z = 0x5A, KEY_PAD_0 = 0x60, KEY_PAD_1 = 0x61,   KEY_PAD_2 = 0x62, KEY_PAD_3 = 0x63, KEY_PAD_4 = 0x64, KEY_PAD_5 = 0x65,   KEY_PAD_6 = 0x66, KEY_PAD_7 = 0x67, KEY_PAD_8 = 0x68, KEY_PAD_9 = 0x69,   KEY_PAD_ADD = 0x6B, KEY_PAD_SUBTRACT = 0x6D, KEY_PAD_MULTIPLY = 0x6A, KEY_PAD_DIVIDE = 0x6F,   KEY_PAD_DECIMAL = 0x6E, KEY_F1 = 0x70, KEY_F2 = 0x71, KEY_F3 = 0x72,   KEY_F4 = 0x73, KEY_F5 = 0x74, KEY_F6 = 0x75, KEY_F7 = 0x76,   KEY_F8 = 0x77, KEY_F9 = 0x78, KEY_F10 = 0x79, KEY_F11 = 0x7A,   KEY_F12 = 0x7B, KEY_LEFT_SHIFT = 0xA0, KEY_RIGHT_SHIFT = 0xA1, KEY_LEFT_CTRL = 0xA2,   KEY_RIGHT_CTRL = 0xA3, KEY_LEFT_ALT = 0xA4, KEY_RIGHT_ALT = 0xA5, KEY_SEMICOLON = 0xBA,   KEY_EQUAL_SIGN = 0xBB, KEY_COMMA = 0xBC, KEY_MINUS_SIGN = 0xBD, KEY_PERIOD = 0xBE,   KEY_SLASH = 0xBF, KEY_GRAVE = 0xC0, KEY_LEFT_BRACKET = 0xDB, KEY_BACKSLASH = 0xDC,   KEY_RIGHT_BRACKET = 0xDD, KEY_APOSTROPHE = 0xDE, KEY_NO_KEY = 0xFF }
	Enumerate the key types. These are based on Virtual Key Codes. More...
enum	KeyModifier { NO_MODIFIER = 0x0, ALT_MODIFIER = 0x1, CTRL_MODIFIER = 0x2, SHIFT_MODIFIER = 0x4 }
	Describe which modifier(s) are pressed. More...

Public Member Functions
	DtKeyState ()
	Default constructor.
	DtKeyState (KeyType key, KeyModifier modifiers)
	Construct a key event.
virtual	~DtKeyState ()
	Destructor.
	DtKeyState (const DtKeyState &)
	Copy constructor.
DtKeyState &	operator= (const DtKeyState &)
	Assignment operator.
virtual KeyType	keyType () const
	Get the type of key.
virtual void	setKeyType (KeyType keyType)
	Set the type of key.
virtual bool	altDown () const
	Return if the alt modifier key was pressed during the event.
virtual void	setAltDown (bool altDown)
	Set the alt (modifier) variable.
virtual bool	ctrlDown () const
	Return if the ctrl modifier key was pressed during the event.
virtual void	setCtrlDown (bool ctrlDown)
	Set the ctrl (modifier) variable.
virtual bool	shiftDown () const
	Return if the shift modifier key was pressed during the event.
virtual void	setShiftDown (bool shiftDown)
	Set the shift (modifier) variable.
virtual KeyModifier	modifiers () const
	get the entire modifier vector instead of using the boolean accessors
virtual void	setModifiers (KeyModifier modifiers)
	set the entire modifier vector instead of using the boolean mutators

Static Public Member Functions
static std::string	keyTypeToString (KeyType key)

Protected Attributes
KeyType	myKeyType
KeyModifier	myModifiers

Detailed Description

This class encapsulates the state associated with a key event.

Member Enumeration Documentation

enum makVrv::DtKeyState::KeyType

Enumerate the key types. These are based on Virtual Key Codes.

Enumerator:

KEY_BACKSPACE
KEY_TAB
KEY_CLEAR
KEY_ENTER
KEY_PAUSE
KEY_ESCAPE
KEY_SPACE
KEY_PAGE_UP
KEY_PAGE_DOWN	VK_PRIOR.
KEY_END	VK_NEXT.
KEY_HOME
KEY_LEFT
KEY_UP
KEY_RIGHT
KEY_DOWN
KEY_PRINT_SCREEN
KEY_INSERT
KEY_DELETE
KEY_0
KEY_1
KEY_2
KEY_3
KEY_4
KEY_5
KEY_6
KEY_7
KEY_8
KEY_9
KEY_A
KEY_B
KEY_C
KEY_D
KEY_E
KEY_F
KEY_G
KEY_H
KEY_I
KEY_J
KEY_K
KEY_L
KEY_M
KEY_N
KEY_O
KEY_P
KEY_Q
KEY_R
KEY_S
KEY_T
KEY_U
KEY_V
KEY_W
KEY_X
KEY_Y
KEY_Z
KEY_PAD_0
KEY_PAD_1
KEY_PAD_2
KEY_PAD_3
KEY_PAD_4
KEY_PAD_5
KEY_PAD_6
KEY_PAD_7
KEY_PAD_8
KEY_PAD_9
KEY_PAD_ADD
KEY_PAD_SUBTRACT
KEY_PAD_MULTIPLY
KEY_PAD_DIVIDE
KEY_PAD_DECIMAL
KEY_F1
KEY_F2
KEY_F3
KEY_F4
KEY_F5
KEY_F6
KEY_F7
KEY_F8
KEY_F9
KEY_F10
KEY_F11
KEY_F12
KEY_LEFT_SHIFT
KEY_RIGHT_SHIFT
KEY_LEFT_CTRL
KEY_RIGHT_CTRL
KEY_LEFT_ALT
KEY_RIGHT_ALT
KEY_SEMICOLON
KEY_EQUAL_SIGN
KEY_COMMA
KEY_MINUS_SIGN
KEY_PERIOD
KEY_SLASH
KEY_GRAVE
KEY_LEFT_BRACKET
KEY_BACKSLASH
KEY_RIGHT_BRACKET
KEY_APOSTROPHE
KEY_NO_KEY

enum makVrv::DtKeyState::KeyModifier

Describe which modifier(s) are pressed.

Enumerator:

NO_MODIFIER
ALT_MODIFIER
CTRL_MODIFIER
SHIFT_MODIFIER

Constructor & Destructor Documentation

makVrv::DtKeyState::DtKeyState

(

)

Default constructor.

makVrv::DtKeyState::DtKeyState	(	KeyType	key,
		KeyModifier	modifiers
	)

Construct a key event.

virtual makVrv::DtKeyState::~DtKeyState ( )

virtual

Destructor.

makVrv::DtKeyState::DtKeyState

(

const DtKeyState &

)

Copy constructor.

Member Function Documentation

static std::string makVrv::DtKeyState::keyTypeToString ( KeyType  key )

static

DtKeyState& makVrv::DtKeyState::operator=

(

const DtKeyState &

)

Assignment operator.

virtual KeyType makVrv::DtKeyState::keyType ( ) const

virtual

Get the type of key.

virtual void makVrv::DtKeyState::setKeyType ( KeyType  keyType )

virtual

Set the type of key.

virtual bool makVrv::DtKeyState::altDown ( ) const

virtual

Return if the alt modifier key was pressed during the event.

virtual void makVrv::DtKeyState::setAltDown ( bool  altDown )

virtual

Set the alt (modifier) variable.

virtual bool makVrv::DtKeyState::ctrlDown ( ) const

virtual

Return if the ctrl modifier key was pressed during the event.

virtual void makVrv::DtKeyState::setCtrlDown ( bool  ctrlDown )

virtual

Set the ctrl (modifier) variable.

virtual bool makVrv::DtKeyState::shiftDown ( ) const

virtual

Return if the shift modifier key was pressed during the event.

virtual void makVrv::DtKeyState::setShiftDown ( bool  shiftDown )

virtual

Set the shift (modifier) variable.

virtual KeyModifier makVrv::DtKeyState::modifiers ( ) const

virtual

get the entire modifier vector instead of using the boolean accessors

virtual void makVrv::DtKeyState::setModifiers ( KeyModifier  modifiers )

virtual

set the entire modifier vector instead of using the boolean mutators

Member Data Documentation

KeyType makVrv::DtKeyState::myKeyType

protected

KeyModifier makVrv::DtKeyState::myModifiers

protected

---

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

• include/vrvCore/DtKeyState.h