docs/doxygen/mainpages/const_keycode.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        platdetails.h
   3 // Purpose:     wxKeyCode values enumerated
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11
  12 @page page_keycodes Keycodes
  13
  14 @header{wx/defs.h}
  15
  16 Keypresses are represented by an enumerated type, wxKeyCode. The possible
  17 values are the ASCII character codes, plus the following:
  18
  19 @verbatim
  20     WXK_BACK    = 8
  21     WXK_TAB     = 9
  22     WXK_RETURN  = 13
  23     WXK_ESCAPE  = 27
  24     WXK_SPACE   = 32
  25     WXK_DELETE  = 127
  26
  27     // These are by design not compatible with unicode characters.
  28     // If you want to get a unicode character from a key event use
  29     // wxKeyEvent::GetUnicodeKey instead.
  30     WXK_START   = 300
  31     WXK_LBUTTON
  32     WXK_RBUTTON
  33     WXK_CANCEL
  34     WXK_MBUTTON
  35     WXK_CLEAR
  36     WXK_SHIFT
  37     WXK_ALT
  38     WXK_CONTROL
  39     WXK_MENU
  40     WXK_PAUSE
  41     WXK_CAPITAL
  42     WXK_END
  43     WXK_HOME
  44     WXK_LEFT
  45     WXK_UP
  46     WXK_RIGHT
  47     WXK_DOWN
  48     WXK_SELECT
  49     WXK_PRINT
  50     WXK_EXECUTE
  51     WXK_SNAPSHOT
  52     WXK_INSERT
  53     WXK_HELP
  54     WXK_NUMPAD0
  55     WXK_NUMPAD1
  56     WXK_NUMPAD2
  57     WXK_NUMPAD3
  58     WXK_NUMPAD4
  59     WXK_NUMPAD5
  60     WXK_NUMPAD6
  61     WXK_NUMPAD7
  62     WXK_NUMPAD8
  63     WXK_NUMPAD9
  64     WXK_MULTIPLY
  65     WXK_ADD
  66     WXK_SEPARATOR
  67     WXK_SUBTRACT
  68     WXK_DECIMAL
  69     WXK_DIVIDE
  70     WXK_F1
  71     WXK_F2
  72     WXK_F3
  73     WXK_F4
  74     WXK_F5
  75     WXK_F6
  76     WXK_F7
  77     WXK_F8
  78     WXK_F9
  79     WXK_F10
  80     WXK_F11
  81     WXK_F12
  82     WXK_F13
  83     WXK_F14
  84     WXK_F15
  85     WXK_F16
  86     WXK_F17
  87     WXK_F18
  88     WXK_F19
  89     WXK_F20
  90     WXK_F21
  91     WXK_F22
  92     WXK_F23
  93     WXK_F24
  94     WXK_NUMLOCK
  95     WXK_SCROLL
  96     WXK_PAGEUP,
  97     WXK_PAGEDOWN,
  98
  99     WXK_NUMPAD_SPACE,
 100     WXK_NUMPAD_TAB,
 101     WXK_NUMPAD_ENTER,
 102     WXK_NUMPAD_F1,
 103     WXK_NUMPAD_F2,
 104     WXK_NUMPAD_F3,
 105     WXK_NUMPAD_F4,
 106     WXK_NUMPAD_HOME,
 107     WXK_NUMPAD_LEFT,
 108     WXK_NUMPAD_UP,
 109     WXK_NUMPAD_RIGHT,
 110     WXK_NUMPAD_DOWN,
 111     WXK_NUMPAD_PAGEUP,
 112     WXK_NUMPAD_PAGEDOWN,
 113     WXK_NUMPAD_END,
 114     WXK_NUMPAD_BEGIN,
 115     WXK_NUMPAD_INSERT,
 116     WXK_NUMPAD_DELETE,
 117     WXK_NUMPAD_EQUAL,
 118     WXK_NUMPAD_MULTIPLY,
 119     WXK_NUMPAD_ADD,
 120     WXK_NUMPAD_SEPARATOR,
 121     WXK_NUMPAD_SUBTRACT,
 122     WXK_NUMPAD_DECIMAL,
 123     WXK_NUMPAD_DIVIDE,
 124
 125     // the following key codes are only generated under Windows currently
 126     WXK_WINDOWS_LEFT,
 127     WXK_WINDOWS_RIGHT,
 128     WXK_WINDOWS_MENU,
 129     WXK_COMMAND,
 130
 131     // Hardware-specific buttons
 132     WXK_SPECIAL1 = 193,
 133     WXK_SPECIAL2,
 134     WXK_SPECIAL3,
 135     WXK_SPECIAL4,
 136     WXK_SPECIAL5,
 137     WXK_SPECIAL6,
 138     WXK_SPECIAL7,
 139     WXK_SPECIAL8,
 140     WXK_SPECIAL9,
 141     WXK_SPECIAL10,
 142     WXK_SPECIAL11,
 143     WXK_SPECIAL12,
 144     WXK_SPECIAL13,
 145     WXK_SPECIAL14,
 146     WXK_SPECIAL15,
 147     WXK_SPECIAL16,
 148     WXK_SPECIAL17,
 149     WXK_SPECIAL18,
 150     WXK_SPECIAL19,
 151     WXK_SPECIAL20
 152 @endverbatim
 153
 154 */