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