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