210dd902b99ec4fa8873ca09f415c0960dbac13e
[blender.git] / source / blender / windowmanager / wm_event_types.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Blender Foundation
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/windowmanager/wm_event_types.h
29  *  \ingroup wm
30  */
31
32
33 /*
34  *  These define have its origin at sgi, where all device defines were written down in device.h.
35  *  Blender copied the conventions quite some, and expanded it with internal new defines (ton)
36  *
37  */ 
38
39
40 #ifndef WM_EVENT_TYPES_H
41 #define WM_EVENT_TYPES_H
42
43 /* customdata type */
44 #define EVT_DATA_TABLET         1
45 #define EVT_DATA_GESTURE        2
46 #define EVT_DATA_TIMER          3
47 #define EVT_DATA_LISTBASE       4
48 #define EVT_DATA_NDOF_MOTION 5
49
50 /* tablet active, matches GHOST_TTabletMode */
51 #define EVT_TABLET_NONE         0
52 #define EVT_TABLET_STYLUS       1
53 #define EVT_TABLET_ERASER       2
54
55 #define MOUSEX          4
56 #define MOUSEY          5
57
58 /* MOUSE : 0x00x */
59 #define LEFTMOUSE               1
60 #define MIDDLEMOUSE             2
61 #define RIGHTMOUSE              3
62 #define MOUSEMOVE               4
63                 /* only use if you want user option switch possible */
64 #define ACTIONMOUSE             5
65 #define SELECTMOUSE             6
66                 /* Extra mouse buttons */
67 #define BUTTON4MOUSE    7
68 #define BUTTON5MOUSE    8
69                 /* Extra trackpad gestures */
70 #define MOUSEPAN                14
71 #define MOUSEZOOM               15
72 #define MOUSEROTATE             16
73                 /* defaults from ghost */
74 #define WHEELUPMOUSE    10
75 #define WHEELDOWNMOUSE  11
76                 /* mapped with userdef */
77 #define WHEELINMOUSE    12
78 #define WHEELOUTMOUSE   13
79 #define INBETWEEN_MOUSEMOVE     17
80
81
82 /* NDOF (from SpaceNavigator & friends)
83    These should be kept in sync with GHOST_NDOFManager.h
84    Ordering matters, exact values do not. */
85
86 #define NDOF_MOTION 400
87
88 enum {
89         // used internally, never sent
90         NDOF_BUTTON_NONE = NDOF_MOTION,
91         // these two are available from any 3Dconnexion device
92         NDOF_BUTTON_MENU,
93         NDOF_BUTTON_FIT,
94         // standard views
95         NDOF_BUTTON_TOP,
96         NDOF_BUTTON_BOTTOM,
97         NDOF_BUTTON_LEFT,
98         NDOF_BUTTON_RIGHT,
99         NDOF_BUTTON_FRONT,
100         NDOF_BUTTON_BACK,
101         // more views
102         NDOF_BUTTON_ISO1,
103         NDOF_BUTTON_ISO2,
104         // 90 degree rotations
105         NDOF_BUTTON_ROLL_CW,
106         NDOF_BUTTON_ROLL_CCW,
107         NDOF_BUTTON_SPIN_CW,
108         NDOF_BUTTON_SPIN_CCW,
109         NDOF_BUTTON_TILT_CW,
110         NDOF_BUTTON_TILT_CCW,
111         // device control
112         NDOF_BUTTON_ROTATE,
113         NDOF_BUTTON_PANZOOM,
114         NDOF_BUTTON_DOMINANT,
115         NDOF_BUTTON_PLUS,
116         NDOF_BUTTON_MINUS,
117         // general-purpose buttons
118         NDOF_BUTTON_1,
119         NDOF_BUTTON_2,
120         NDOF_BUTTON_3,
121         NDOF_BUTTON_4,
122         NDOF_BUTTON_5,
123         NDOF_BUTTON_6,
124         NDOF_BUTTON_7,
125         NDOF_BUTTON_8,
126         NDOF_BUTTON_9,
127         NDOF_BUTTON_10,
128         };
129
130
131 /* SYSTEM : 0x01xx */
132 #define INPUTCHANGE             0x0103  /* input connected or disconnected */
133 #define WINDEACTIVATE   0x0104  /* window is deactivated, focus lost */
134
135 #define TIMER                   0x0110  /* timer event, passed on to all queues */
136 #define TIMER0                  0x0111  /* timer event, slot for internal use */
137 #define TIMER1                  0x0112  /* timer event, slot for internal use */
138 #define TIMER2                  0x0113  /* timer event, slot for internal use */
139 #define TIMERJOBS               0x0114  /* timer event, jobs system */
140 #define TIMERAUTOSAVE   0x0115  /* timer event, autosave */
141 #define TIMERREPORT             0x0116  /* timer event, reports */
142 #define TIMERF                  0x011F  /* last timer */
143
144 /* test whether the event is timer event */
145 #define ISTIMER(event)  (event >= TIMER && event <= TIMERF)
146
147
148 /* standard keyboard */
149 #define AKEY            'a'
150 #define BKEY            'b'
151 #define CKEY            'c'
152 #define DKEY            'd'
153 #define EKEY            'e'
154 #define FKEY            'f'
155 #define GKEY            'g'
156 #define HKEY            'h'
157 #define IKEY            'i'
158 #define JKEY            'j'
159 #define KKEY            'k'
160 #define LKEY            'l'
161 #define MKEY            'm'
162 #define NKEY            'n'
163 #define OKEY            'o'
164 #define PKEY            'p'
165 #define QKEY            'q'
166 #define RKEY            'r'
167 #define SKEY            's'
168 #define TKEY            't'
169 #define UKEY            'u'
170 #define VKEY            'v'
171 #define WKEY            'w'
172 #define XKEY            'x'
173 #define YKEY            'y'
174 #define ZKEY            'z'
175
176 #define ZEROKEY         '0'
177 #define ONEKEY          '1'
178 #define TWOKEY          '2'
179 #define THREEKEY        '3'
180 #define FOURKEY         '4'
181 #define FIVEKEY         '5'
182 #define SIXKEY          '6'
183 #define SEVENKEY        '7'
184 #define EIGHTKEY        '8'
185 #define NINEKEY         '9'
186
187 #define CAPSLOCKKEY             211
188
189 #define LEFTCTRLKEY             212
190 #define LEFTALTKEY              213
191 #define RIGHTALTKEY     214
192 #define RIGHTCTRLKEY    215
193 #define RIGHTSHIFTKEY   216
194 #define LEFTSHIFTKEY    217
195
196 #define ESCKEY                  218
197 #define TABKEY                  219
198 #define RETKEY                  220
199 #define SPACEKEY                221
200 #define LINEFEEDKEY             222
201 #define BACKSPACEKEY    223
202 #define DELKEY                  224
203 #define SEMICOLONKEY    225
204 #define PERIODKEY               226
205 #define COMMAKEY                227
206 #define QUOTEKEY                228
207 #define ACCENTGRAVEKEY  229
208 #define MINUSKEY                230
209 #define SLASHKEY                232
210 #define BACKSLASHKEY    233
211 #define EQUALKEY                234
212 #define LEFTBRACKETKEY  235
213 #define RIGHTBRACKETKEY 236
214
215 #define LEFTARROWKEY    137
216 #define DOWNARROWKEY    138
217 #define RIGHTARROWKEY   139
218 #define UPARROWKEY              140
219
220 #define PAD0                    150
221 #define PAD1                    151
222 #define PAD2                    152
223 #define PAD3                    153
224 #define PAD4                    154
225 #define PAD5                    155
226 #define PAD6                    156
227 #define PAD7                    157
228 #define PAD8                    158
229 #define PAD9                    159
230
231
232 #define PADPERIOD               199
233 #define PADSLASHKEY     161
234 #define PADASTERKEY     160
235
236 #define PADMINUS                162
237 #define PADENTER                163
238 #define PADPLUSKEY              164
239
240 #define F1KEY           300
241 #define F2KEY           301
242 #define F3KEY           302
243 #define F4KEY           303
244 #define F5KEY           304
245 #define F6KEY           305
246 #define F7KEY           306
247 #define F8KEY           307
248 #define F9KEY           308
249 #define F10KEY          309
250 #define F11KEY          310
251 #define F12KEY          311
252 #define F13KEY          312
253 #define F14KEY          313
254 #define F15KEY          314
255 #define F16KEY          315
256 #define F17KEY          316
257 #define F18KEY          317
258 #define F19KEY          318
259
260 #define PAUSEKEY        165
261 #define INSERTKEY       166
262 #define HOMEKEY         167
263 #define PAGEUPKEY       168
264 #define PAGEDOWNKEY     169
265 #define ENDKEY          170
266
267 #define UNKNOWNKEY      171
268 #define OSKEY           172
269 #define GRLESSKEY       173
270
271 // XXX: are these codes ok?
272 #define MEDIAPLAY       174
273 #define MEDIASTOP       175
274 #define MEDIAFIRST      176
275 #define MEDIALAST       177
276
277 /* for event checks */
278         /* only used for KM_TEXTINPUT, so assume that we want all user-inputtable ascii codes included */
279 #define ISTEXTINPUT(event)      (event >=' ' && event <=255)
280
281         /* test whether the event is a key on the keyboard */
282 #define ISKEYBOARD(event)       (event >=' ' && event <=320)
283
284         /* test whether the event is a modifier key */
285 #define ISKEYMODIFIER(event)    ((event >= LEFTCTRLKEY && event <= LEFTSHIFTKEY) || event == OSKEY)
286
287         /* test whether the event is a mouse button */
288 #define ISMOUSE(event)  (event >= LEFTMOUSE && event <= MOUSEROTATE)
289
290         /* test whether the event is tweak event */
291 #define ISTWEAK(event)  (event >= EVT_TWEAK_L && event <= EVT_GESTURE)
292
293 /* test whether event type is acceptable as hotkey, excluding modifiers */
294 #define ISHOTKEY(event) ((ISKEYBOARD(event) || ISMOUSE(event)) && event!=ESCKEY && !(event>=LEFTCTRLKEY && event<=LEFTSHIFTKEY) && !(event>=UNKNOWNKEY && event<=GRLESSKEY))
295
296 /* **************** BLENDER GESTURE EVENTS (0x5000) **************** */
297
298 #define EVT_ACTIONZONE_AREA             20480
299 #define EVT_ACTIONZONE_REGION   20481
300
301                 /* tweak events, for L M R mousebuttons */
302 #define EVT_TWEAK_L             20482
303 #define EVT_TWEAK_M             20483
304 #define EVT_TWEAK_R             20484
305                 /* tweak events for action or select mousebutton */
306 #define EVT_TWEAK_A             20485
307 #define EVT_TWEAK_S             20486
308
309 #define EVT_GESTURE             20496
310
311 /* value of tweaks and line gestures, note, KM_ANY (-1) works for this case too */
312 #define EVT_GESTURE_N           1
313 #define EVT_GESTURE_NE          2
314 #define EVT_GESTURE_E           3
315 #define EVT_GESTURE_SE          4
316 #define EVT_GESTURE_S           5
317 #define EVT_GESTURE_SW          6
318 #define EVT_GESTURE_W           7
319 #define EVT_GESTURE_NW          8
320 /* value of corner gestures */
321 #define EVT_GESTURE_N_E         9
322 #define EVT_GESTURE_N_W         10
323 #define EVT_GESTURE_E_N         11
324 #define EVT_GESTURE_E_S         12
325 #define EVT_GESTURE_S_E         13
326 #define EVT_GESTURE_S_W         14
327 #define EVT_GESTURE_W_S         15
328 #define EVT_GESTURE_W_N         16
329
330 /* **************** OTHER BLENDER EVENTS ********************* */
331
332 /* event->type */
333 #define EVT_FILESELECT  0x5020
334
335 /* event->val */
336 #define EVT_FILESELECT_OPEN                                     1
337 #define EVT_FILESELECT_FULL_OPEN                        2
338 #define EVT_FILESELECT_EXEC                                     3
339 #define EVT_FILESELECT_CANCEL                           4
340 #define EVT_FILESELECT_EXTERNAL_CANCEL          5
341
342 /* event->type */
343 #define EVT_BUT_OPEN    0x5021
344 #define EVT_MODAL_MAP   0x5022
345 #define EVT_DROP                0x5023
346 #define EVT_BUT_CANCEL  0x5024
347
348 /* NOTE: these defines are saved in keymap files, do not change values but just add new ones */
349 #define GESTURE_MODAL_CANCEL            1
350 #define GESTURE_MODAL_CONFIRM           2
351
352 #define GESTURE_MODAL_SELECT            3
353 #define GESTURE_MODAL_DESELECT          4
354
355 #define GESTURE_MODAL_NOP                       5 /* circle select when no mouse button is pressed */
356
357 #define GESTURE_MODAL_CIRCLE_ADD        6 /* circle sel: larger brush */
358 #define GESTURE_MODAL_CIRCLE_SUB        7 /* circle sel: smaller brush */
359
360 #define GESTURE_MODAL_BEGIN                     8 /* border select/straight line, activate, use release to detect which button */
361
362 #define GESTURE_MODAL_IN                        9
363 #define GESTURE_MODAL_OUT                       10
364
365
366 #endif  /* WM_EVENT_TYPES_H */
367