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