ADTF  v2.14.3
IKeyEventHandler Class Referenceabstract

Interface of global key event handler. More...

Public Types

enum  tKeyEventCode { EC_KeyDown = 12, EC_KeyUp = 13, EC_KeyInput = 14 }
 The Key Event Code Enumeration for the IKeyEventHandler::OnKeyEvent method. More...
 
enum  tKeyState { KS_CtrlKeyDown = 0x1, KS_AltKeyDown = 0x2, KS_ShiftKeyDown = 0x4 }
 The KeyStates for the tKeyEventCode with Key.
 
enum  tKey {
  KEY_ESCAPE = 0x01000000, KEY_TAB = 0x01000001, KEY_BACKSPACE = 0x01000003, KEY_RETURN = 0x01000004,
  KEY_INSERT = 0x01000006, KEY_DELETE = 0x01000007, KEY_PRINT = 0x01000009, KEY_HOME = 0x01000010,
  KEY_END = 0x01000011, KEY_LEFT = 0x01000012, KEY_UP = 0x01000013, KEY_RIGHT = 0x01000014,
  KEY_DOWN = 0x01000015, KEY_PAGEUP = 0x01000016, KEY_PAGEDOWN = 0x01000017, KEY_SPACE = 0x20,
  KEY_NUMLOCK = 0x01000025, KEY_F1 = 0x01000030, KEY_F2 = 0x01000031, KEY_F3 = 0x01000032,
  KEY_F4 = 0x01000033, KEY_F5 = 0x01000034, KEY_F6 = 0x01000035, KEY_F7 = 0x01000036,
  KEY_F8 = 0x01000037, KEY_F9 = 0x01000038, KEY_F10 = 0x01000039, KEY_F11 = 0x0100003a,
  KEY_F12 = 0x0100003b, KEY_PLUS = 0x2b, KEY_COMMA = 0x2c, KEY_MINUS = 0x2d,
  KEY_PERIOD = 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_SHIFT = 0x01000020, KEY_CTRL = 0x01000021, KEY_ALT = 0x01000023
}
 These are the standard adtf key codes. More...
 

Public Member Functions

virtual tResult OnKeyEvent (tKeyEventCode eCode, tInt nParam1=0, tInt nParam2=0, tInt nFlags=0, tVoid *pEventData=NULL)=0
 Callback function to retrieve the Key Events. More...
 

Detailed Description

Interface of global key event handler.

Definition at line 27 of file globalkeyeventmanager_intf.h.

Member Enumeration Documentation

enum tKey

These are the standard adtf key codes.

always use this definition to provide the key code within your application.

Enumerator
KEY_ESCAPE 

the escape key.

KEY_TAB 

the tab key.

KEY_BACKSPACE 

the backspace key.

KEY_RETURN 

the return key.

KEY_INSERT 

the insert key.

KEY_DELETE 

the delete key.

KEY_PRINT 

the print key.

KEY_HOME 

the home key.

KEY_END 

the end key.

KEY_LEFT 

the left key.

KEY_UP 

the up key.

KEY_RIGHT 

the right key.

KEY_DOWN 

the down key.

KEY_PAGEUP 

the page-up key.

KEY_PAGEDOWN 

the page-down key.

KEY_SPACE 

the space key.

KEY_NUMLOCK 

the numlock key.

KEY_F1 

the f1 key.

KEY_F2 

the f2 key.

KEY_F3 

the f3 key.

KEY_F4 

the f4 key.

KEY_F5 

the f5 key.

KEY_F6 

the f6 key.

KEY_F7 

the f7 key.

KEY_F8 

the f8 key.

KEY_F9 

the f9 key.

KEY_F10 

the f10 key.

KEY_F11 

the f11 key.

KEY_F12 

the f12 key.

KEY_PLUS 

the + key.

KEY_COMMA 

the , key.

KEY_MINUS 

the - key.

Definition at line 69 of file globalkeyeventmanager_intf.h.

The Key Event Code Enumeration for the IKeyEventHandler::OnKeyEvent method.

Enumerator
EC_KeyDown 

key down event
nParam1 = see tKey
nParam2 = see tKeyState

EC_KeyUp 

key up event
nParam1 = see tKey
nParam2 = see tKeyState

EC_KeyInput 

key input event
nParam1 = see tKey
nParam2 = see tKeyState

Definition at line 33 of file globalkeyeventmanager_intf.h.

Member Function Documentation

virtual tResult OnKeyEvent ( tKeyEventCode  eCode,
tInt  nParam1 = 0,
tInt  nParam2 = 0,
tInt  nFlags = 0,
tVoid pEventData = NULL 
)
pure virtual

Callback function to retrieve the Key Events.

Parameters
eCode[in] See the tKeyEventCode for the possible Key Codes.
nParam1[in] Depends on the KeyCode sent. See the tKeyEventCode.
nParam2[in] Depends on the KeyCode sent. See the tKeyEventCode.
nFlags[in] Depends on the KeyCode sent. See the tKeyEventCode.
pEventData[in] Depends on the KeyCode sent. See the tKeyEventCode.
Returns
The Standard tResult.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Fri Mar 22 2019 by doxygen 1.8.10)