API Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
KeyEvent Class Reference

A class which describes a user key press. More...

#include <Event.h>

Inheritance diagram for KeyEvent:
[legend]
Collaboration diagram for KeyEvent:
[legend]

Public Types

enum  KEY {
  VK_UNSPECIFIED = 0x00 , VK_ABNT_C1 = 0xC1 , VK_ABNT_C2 = 0xC2 , LIB_VK_ADD = 0x6B ,
  LIB_VK_ATTN = 0xF6 , LIB_VK_BACK = 0x08 , LIB_VK_CANCEL = 0x03 , LIB_VK_CLEAR = 0x0C ,
  LIB_VK_CRSEL = 0xF7 , LIB_VK_DECIMAL = 0x6E , LIB_VK_DIVIDE = 0x6F , LIB_VK_EREOF = 0xF9 ,
  LIB_VK_EQUAL = 61 , LIB_VK_SHIFT = 0x10 , LIB_VK_LEFT = 0x25 , LIB_VK_UP = 0x26 ,
  LIB_VK_RIGHT = 0x27 , LIB_VK_DOWN = 0x28 , LIB_VK_DELETE = 0x2E , LIB_VK_LCONTROL = 0xA2 ,
  LIB_VK_RCONTROL = 0xA3 , LIB_VK_META = 0xA4 , LIB_VK_MENU = 0x12 , LIB_VK_ESCAPE = 256 ,
  LIB_VK_EXECUTE = 0x2B , LIB_VK_EXSEL = 0xF8 , LIB_VK_ICO_CLEAR = 0xE6 , LIB_VK_ICO_HELP = 0xE3 ,
  VK_KEY_0 = 0x30 , VK_KEY_1 = 0x31 , VK_KEY_2 = 0x32 , VK_KEY_3 = 0x33 ,
  VK_KEY_4 = 0x34 , VK_KEY_5 = 0x35 , VK_KEY_6 = 0x36 , VK_KEY_7 = 0x37 ,
  VK_KEY_8 = 0x38 , VK_KEY_9 = 0x39 , VK_KEY_A = 0x41 , VK_KEY_B = 0x42 ,
  VK_KEY_C = 0x43 , VK_KEY_D = 0x44 , VK_KEY_E = 0x45 , VK_KEY_F = 0x46 ,
  VK_KEY_G = 0x47 , VK_KEY_H = 0x48 , VK_KEY_I = 0x49 , VK_KEY_J = 0x4A ,
  VK_KEY_K = 0x4B , VK_KEY_L = 0x4C , VK_KEY_M = 0x4D , VK_KEY_N = 0x4E ,
  VK_KEY_O = 0x4F , VK_KEY_P = 0x50 , VK_KEY_Q = 0x51 , VK_KEY_R = 0x52 ,
  VK_KEY_S = 0x53 , VK_KEY_T = 0x54 , VK_KEY_U = 0x55 , VK_KEY_V = 0x56 ,
  VK_KEY_W = 0x57 , VK_KEY_X = 0x58 , VK_KEY_Y = 0x59 , VK_KEY_Z = 0x5A ,
  LIB_VK_MULTIPLY = 0x6A , LIB_VK_NONAME = 0xFC , LIB_VK_NUMPAD0 = 0x60 , LIB_VK_NUMPAD1 = 0x61 ,
  LIB_VK_NUMPAD2 = 0x62 , LIB_VK_NUMPAD3 = 0x63 , LIB_VK_NUMPAD4 = 0x64 , LIB_VK_NUMPAD5 = 0x65 ,
  LIB_VK_NUMPAD6 = 0x66 , LIB_VK_NUMPAD7 = 0x67 , LIB_VK_NUMPAD8 = 0x68 , LIB_VK_NUMPAD9 = 0x69 ,
  VK_KEY_F1 = 0x70 , VK_KEY_F2 = 0x71 , VK_KEY_F3 = 0x72 , VK_KEY_F4 = 0x73 ,
  VK_KEY_F5 = 0x74 , VK_KEY_F6 = 0x75 , VK_KEY_F7 = 0x76 , VK_KEY_F8 = 0x77 ,
  VK_KEY_F9 = 0x78 , VK_KEY_F10 = 0x79 , VK_KEY_F11 = 0x7A , VK_KEY_F12 = 0x7B ,
  VK_KEY_F13 = 0x7C , VK_KEY_F14 = 0x7D , VK_KEY_F15 = 0x7E , VK_KEY_F16 = 0x7F ,
  VK_KEY_F17 = 0x80 , VK_KEY_F18 = 0x81 , VK_KEY_F19 = 0x82 , VK_KEY_F20 = 0x83 ,
  VK_KEY_F21 = 0x84 , VK_KEY_F22 = 0x85 , VK_KEY_F23 = 0x86 , VK_KEY_F24 = 0x87 ,
  LIB_VK_OEM_1 = 0xBA , LIB_VK_OEM_102 = 0xE2 , LIB_VK_OEM_2 = 0xBF , LIB_VK_OEM_3 = 0xC0 ,
  LIB_VK_OEM_4 = 0xDB , LIB_VK_OEM_5 = 0xDC , LIB_VK_OEM_6 = 0xDD , LIB_VK_OEM_7 = 0xDE ,
  LIB_VK_OEM_8 = 0xDF , LIB_VK_OEM_ATTN = 0xF0 , LIB_VK_OEM_AUTO = 0xF3 , LIB_VK_OEM_AX = 0xE1 ,
  LIB_VK_OEM_BACKTAB = 0xF5 , LIB_LIB_VK_OEM_CLEAR = 0xFE , LIB_VK_OEM_COMMA = 44 , LIB_VK_OEM_COPY = 0xF2 ,
  LIB_VK_OEM_CUSEL = 0xEF , LIB_VK_OEM_ENLW = 0xF4 , LIB_VK_OEM_FINISH = 0xF1 , LIB_VK_OEM_FJ_LOYA = 0x95 ,
  LIB_VK_OEM_FJ_MASSHOU = 0x93 , LIB_VK_OEM_FJ_ROYA = 0x96 , LIB_VK_OEM_FJ_TOUROKU = 0x94 , LIB_VK_OEM_JUMP = 0xEA ,
  LIB_VK_OEM_MINUS = 0xBD , LIB_VK_OEM_PA1 = 0xEB , LIB_VK_OEM_PA2 = 0xEC , LIB_VK_OEM_PA3 = 0xED ,
  LIB_VK_OEM_PERIOD = 0xBE , LIB_VK_OEM_PLUS = 0xBB , LIB_VK_OEM_RESET = 0xE9 , LIB_VK_OEM_WSCTRL = 0xEE ,
  LIB_VK_PA1 = 0xFD , LIB_VK_PACKET = 0xE7 , LIB_VK_PLAY = 0xFA , LIB_VK_PROCESSKEY = 0xE5 ,
  LIB_VK_RETURN = 257 , LIB_VK_SELECT = 0x29 , LIB_VK_SEPARATOR = 0x6C , LIB_VK_SPACE = 0x20 ,
  LIB_VK_SUBTRACT = 0x6D , LIB_VK_TAB = 258 , LIB_VK_ZOOM = 0xFB , LIB_VK_NONE = 0xFF ,
  LIB_VK_BACKSLASH = 0x5C , LIB_VK_BUTTON_A = 0x0130 , LIB_VK_BUTTON_B = 0x0131 , LIB_VK_BUTTON_X = 0x0133 ,
  LIB_VK_BUTTON_Y = 0x0134 , LIB_VK_BUTTON_L1 = 0x0136 , LIB_VK_BUTTON_R1 = 0x0137 , LIB_VK_BUTTON_SELECT = 0x013A ,
  LIB_VK_BUTTON_START = 0x013B , LIB_VK_BUTTON_MODE = 0x013C , LIB_VK_BUTTON_THUMBL = 0x013D , LIB_VK_BUTTON_THUMBR = 0x013E ,
  LIB_VK_VOLUME_UP = 0x0200 , LIB_VK_VOLUME_DOWN = 0x0201 , LIB_VK_VOLUME_MUTE = 0x0202 , LIB_VK_BASS_BOOST = 0x0203 ,
  LIB_VK_BASS_UP = 0x0204 , LIB_VK_BASS_DOWN = 0x0205 , LIB_VK_TREBLE_UP = 0x0206 , LIB_VK_TREBLE_DOWN = 0x0207 ,
  LIB_VK_FORWARD = 0x0301 , LIB_VK_STOP = 0x0302 , LIB_VK_REFRESH = 0x0303 , LIB_VK_MEDIA_PLAY = 0x0200 ,
  LIB_VK_MEDIA_STOP = 0x0201 , LIB_VK_MEDIA_PREVIOUS = 0x0202 , LIB_VK_MEDIA_NEXT = 0x0203 , LIB_VK_MEDIA_RECORD = 0x0204 ,
  LIB_VK_MEDIA_PAUSE = 0x0205
}
 
enum  KeyEentType { KEY_UNSPECIFIED , KEY_CLICKED , KEY_PRESSED , KEY_RELEASED }
 The action taken with the key. More...
 
enum  KeyModifier {
  SHIFT = 0x01 , CTRL = 0x02 , FUNCTION = 0x04 , ALT = 0x08 ,
  META = 0x10
}
 Modifiers describe a second key which affects the behavior of the key. More...
 

Public Member Functions

 KeyEvent ()
 
 KeyEvent (KEY key_type, uint01 key_modifier=0, KeyEentType event_type=KeyEentType::KEY_UNSPECIFIED)
 
bool operator== (const KeyEvent &other) const
 
NDEVR_BASE_API char toChar () const
 

Public Attributes

KeyEentType event_type
 
uint01 key_modifier
 
KEY key_type
 

Detailed Description

A class which describes a user key press.

The KeyEvent can be used to trigger various behavior in the NDEVR API

Member Enumeration Documentation

◆ KEY

enum KEY

The pressed key

Enumerator
VK_UNSPECIFIED 
VK_ABNT_C1 
VK_ABNT_C2 
LIB_VK_ADD 
LIB_VK_ATTN 
LIB_VK_BACK 
LIB_VK_CANCEL 
LIB_VK_CLEAR 
LIB_VK_CRSEL 
LIB_VK_DECIMAL 
LIB_VK_DIVIDE 
LIB_VK_EREOF 
LIB_VK_EQUAL 
LIB_VK_SHIFT 
LIB_VK_LEFT 
LIB_VK_UP 
LIB_VK_RIGHT 
LIB_VK_DOWN 
LIB_VK_DELETE 
LIB_VK_LCONTROL 
LIB_VK_RCONTROL 
LIB_VK_META 
LIB_VK_MENU 
LIB_VK_ESCAPE 
LIB_VK_EXECUTE 
LIB_VK_EXSEL 
LIB_VK_ICO_CLEAR 
LIB_VK_ICO_HELP 
VK_KEY_0 
VK_KEY_1 
VK_KEY_2 
VK_KEY_3 
VK_KEY_4 
VK_KEY_5 
VK_KEY_6 
VK_KEY_7 
VK_KEY_8 
VK_KEY_9 
VK_KEY_A 
VK_KEY_B 
VK_KEY_C 
VK_KEY_D 
VK_KEY_E 
VK_KEY_F 
VK_KEY_G 
VK_KEY_H 
VK_KEY_I 
VK_KEY_J 
VK_KEY_K 
VK_KEY_L 
VK_KEY_M 
VK_KEY_N 
VK_KEY_O 
VK_KEY_P 
VK_KEY_Q 
VK_KEY_R 
VK_KEY_S 
VK_KEY_T 
VK_KEY_U 
VK_KEY_V 
VK_KEY_W 
VK_KEY_X 
VK_KEY_Y 
VK_KEY_Z 
LIB_VK_MULTIPLY 
LIB_VK_NONAME 
LIB_VK_NUMPAD0 
LIB_VK_NUMPAD1 
LIB_VK_NUMPAD2 
LIB_VK_NUMPAD3 
LIB_VK_NUMPAD4 
LIB_VK_NUMPAD5 
LIB_VK_NUMPAD6 
LIB_VK_NUMPAD7 
LIB_VK_NUMPAD8 
LIB_VK_NUMPAD9 
VK_KEY_F1 
VK_KEY_F2 
VK_KEY_F3 
VK_KEY_F4 
VK_KEY_F5 
VK_KEY_F6 
VK_KEY_F7 
VK_KEY_F8 
VK_KEY_F9 
VK_KEY_F10 
VK_KEY_F11 
VK_KEY_F12 
VK_KEY_F13 
VK_KEY_F14 
VK_KEY_F15 
VK_KEY_F16 
VK_KEY_F17 
VK_KEY_F18 
VK_KEY_F19 
VK_KEY_F20 
VK_KEY_F21 
VK_KEY_F22 
VK_KEY_F23 
VK_KEY_F24 
LIB_VK_OEM_1 
LIB_VK_OEM_102 
LIB_VK_OEM_2 
LIB_VK_OEM_3 
LIB_VK_OEM_4 
LIB_VK_OEM_5 
LIB_VK_OEM_6 
LIB_VK_OEM_7 
LIB_VK_OEM_8 
LIB_VK_OEM_ATTN 
LIB_VK_OEM_AUTO 
LIB_VK_OEM_AX 
LIB_VK_OEM_BACKTAB 
LIB_LIB_VK_OEM_CLEAR 
LIB_VK_OEM_COMMA 
LIB_VK_OEM_COPY 
LIB_VK_OEM_CUSEL 
LIB_VK_OEM_ENLW 
LIB_VK_OEM_FINISH 
LIB_VK_OEM_FJ_LOYA 
LIB_VK_OEM_FJ_MASSHOU 
LIB_VK_OEM_FJ_ROYA 
LIB_VK_OEM_FJ_TOUROKU 
LIB_VK_OEM_JUMP 
LIB_VK_OEM_MINUS 
LIB_VK_OEM_PA1 
LIB_VK_OEM_PA2 
LIB_VK_OEM_PA3 
LIB_VK_OEM_PERIOD 
LIB_VK_OEM_PLUS 
LIB_VK_OEM_RESET 
LIB_VK_OEM_WSCTRL 
LIB_VK_PA1 
LIB_VK_PACKET 
LIB_VK_PLAY 
LIB_VK_PROCESSKEY 
LIB_VK_RETURN 
LIB_VK_SELECT 
LIB_VK_SEPARATOR 
LIB_VK_SPACE 
LIB_VK_SUBTRACT 
LIB_VK_TAB 
LIB_VK_ZOOM 
LIB_VK_NONE 
LIB_VK_BACKSLASH 
LIB_VK_BUTTON_A 
LIB_VK_BUTTON_B 
LIB_VK_BUTTON_X 
LIB_VK_BUTTON_Y 
LIB_VK_BUTTON_L1 
LIB_VK_BUTTON_R1 
LIB_VK_BUTTON_SELECT 
LIB_VK_BUTTON_START 
LIB_VK_BUTTON_MODE 
LIB_VK_BUTTON_THUMBL 
LIB_VK_BUTTON_THUMBR 
LIB_VK_VOLUME_UP 
LIB_VK_VOLUME_DOWN 
LIB_VK_VOLUME_MUTE 
LIB_VK_BASS_BOOST 
LIB_VK_BASS_UP 
LIB_VK_BASS_DOWN 
LIB_VK_TREBLE_UP 
LIB_VK_TREBLE_DOWN 
LIB_VK_FORWARD 
LIB_VK_STOP 
LIB_VK_REFRESH 
LIB_VK_MEDIA_PLAY 
LIB_VK_MEDIA_STOP 
LIB_VK_MEDIA_PREVIOUS 
LIB_VK_MEDIA_NEXT 
LIB_VK_MEDIA_RECORD 
LIB_VK_MEDIA_PAUSE 

◆ KeyEentType

enum KeyEentType

The action taken with the key.

The type of the KeyEvent determines how the program will react.

Enumerator
KEY_UNSPECIFIED 
KEY_CLICKED 
KEY_PRESSED 
KEY_RELEASED 

◆ KeyModifier

enum KeyModifier

Modifiers describe a second key which affects the behavior of the key.

being pressed

Enumerator
SHIFT 
CTRL 
FUNCTION 
ALT 
META 

Constructor & Destructor Documentation

◆ KeyEvent() [1/2]

KeyEvent ( )
inline

◆ KeyEvent() [2/2]

KeyEvent ( KEY key_type,
uint01 key_modifier = 0,
KeyEentType event_type = KeyEentType::KEY_UNSPECIFIED )
inline

Member Function Documentation

◆ operator==()

bool operator== ( const KeyEvent & other) const
inline

◆ toChar()

NDEVR_BASE_API char toChar ( ) const

Member Data Documentation

◆ event_type

KeyEentType event_type

◆ key_modifier

uint01 key_modifier

◆ key_type

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