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  * Contributor(s): Blender Foundation
  19  *
  20  * ***** END GPL LICENSE BLOCK *****
  21  */
  22
  23 /** \file blender/windowmanager/wm_event_types.h
  24  *  \ingroup wm
  25  */
  26
  27
  28 /*
  29  *  These define have its origin at sgi, where all device defines were written down in device.h.
  30  *  Blender copied the conventions quite some, and expanded it with internal new defines (ton)
  31  *
  32  */
  33
  34
  35 #ifndef __WM_EVENT_TYPES_H__
  36 #define __WM_EVENT_TYPES_H__
  37
  38 /* customdata type */
  39 enum {
  40         EVT_DATA_GESTURE     = 1,
  41         EVT_DATA_TIMER       = 2,
  42         EVT_DATA_DRAGDROP    = 3,
  43         EVT_DATA_NDOF_MOTION = 4,
  44 };
  45
  46 /* tablet active, matches GHOST_TTabletMode */
  47 enum {
  48         EVT_TABLET_NONE   = 0,
  49         EVT_TABLET_STYLUS = 1,
  50         EVT_TABLET_ERASER = 2,
  51 };
  52
  53 /* ********** wmEvent.type ********** */
  54 enum {
  55         /* non-event, for example disabled timer */
  56         EVENT_NONE = 0x0000,
  57
  58         /* ********** Start of Input devices. ********** */
  59
  60         /* MOUSE : 0x000x, 0x001x */
  61         LEFTMOUSE           = 0x0001,
  62         MIDDLEMOUSE         = 0x0002,
  63         RIGHTMOUSE          = 0x0003,
  64         MOUSEMOVE           = 0x0004,
  65         /* only use if you want user option switch possible */
  66         ACTIONMOUSE         = 0x0005,
  67         SELECTMOUSE         = 0x0006,
  68         /* Extra mouse buttons */
  69         BUTTON4MOUSE        = 0x0007,
  70         BUTTON5MOUSE        = 0x0008,
  71         /* More mouse buttons - can't use 9 and 10 here (wheel) */
  72         BUTTON6MOUSE        = 0x0012,
  73         BUTTON7MOUSE        = 0x0013,
  74         /* Extra trackpad gestures */
  75         MOUSEPAN            = 0x000e,
  76         MOUSEZOOM           = 0x000f,
  77         MOUSEROTATE         = 0x0010,
  78         /* defaults from ghost */
  79         WHEELUPMOUSE        = 0x000a,
  80         WHEELDOWNMOUSE      = 0x000b,
  81         /* mapped with userdef */
  82         WHEELINMOUSE        = 0x000c,
  83         WHEELOUTMOUSE       = 0x000d,
  84         /* Successive MOUSEMOVE's are converted to this, so we can easily
  85          * ignore all but the most recent MOUSEMOVE (for better performance),
  86          * paint and drawing tools however will want to handle these. */
  87         INBETWEEN_MOUSEMOVE = 0x0011,
  88
  89 /* IME event, GHOST_kEventImeCompositionStart in ghost */
  90         WM_IME_COMPOSITE_START = 0x0014,
  91 /* IME event, GHOST_kEventImeComposition in ghost */
  92         WM_IME_COMPOSITE_EVENT      = 0x0015,
  93 /* IME event, GHOST_kEventImeCompositionEnd in ghost */
  94         WM_IME_COMPOSITE_END   = 0x0016,
  95
  96         /* Tablet/Pen Specific Events */
  97         TABLET_STYLUS       = 0x001a,
  98         TABLET_ERASER       = 0x001b,
  99
 100         /* *** Start of keyboard codes. *** */
 101
 102         /* standard keyboard.
 103          * XXX from 0x0020 to 0x00ff, and 0x012c to 0x013f for function keys! */
 104
 105         /* NOTE: these values are saved in keymap files, do not change them but just add new ones */
 106         AKEY            = 0x0061,  /* 'a' */
 107         BKEY            = 0x0062,  /* 'b' */
 108         CKEY            = 0x0063,  /* 'c' */
 109         DKEY            = 0x0064,  /* 'd' */
 110         EKEY            = 0x0065,  /* 'e' */
 111         FKEY            = 0x0066,  /* 'f' */
 112         GKEY            = 0x0067,  /* 'g' */
 113 #ifndef WIN32
 114         HKEY            = 0x0068,  /* 'h' */
 115 #else
 116 #define HKEY 0x0068
 117 #endif
 118         IKEY            = 0x0069,  /* 'i' */
 119         JKEY            = 0x006a,  /* 'j' */
 120         KKEY            = 0x006b,  /* 'k' */
 121         LKEY            = 0x006c,  /* 'l' */
 122         MKEY            = 0x006d,  /* 'm' */
 123         NKEY            = 0x006e,  /* 'n' */
 124         OKEY            = 0x006f,  /* 'o' */
 125         PKEY            = 0x0070,  /* 'p' */
 126         QKEY            = 0x0071,  /* 'q' */
 127         RKEY            = 0x0072,  /* 'r' */
 128         SKEY            = 0x0073,  /* 's' */
 129         TKEY            = 0x0074,  /* 't' */
 130         UKEY            = 0x0075,  /* 'u' */
 131         VKEY            = 0x0076,  /* 'v' */
 132         WKEY            = 0x0077,  /* 'w' */
 133         XKEY            = 0x0078,  /* 'x' */
 134         YKEY            = 0x0079,  /* 'y' */
 135         ZKEY            = 0x007a,  /* 'z' */
 136
 137         ZEROKEY         = 0x0030,  /* '0' */
 138         ONEKEY          = 0x0031,  /* '1' */
 139         TWOKEY          = 0x0032,  /* '2' */
 140         THREEKEY        = 0x0033,  /* '3' */
 141         FOURKEY         = 0x0034,  /* '4' */
 142         FIVEKEY         = 0x0035,  /* '5' */
 143         SIXKEY          = 0x0036,  /* '6' */
 144         SEVENKEY        = 0x0037,  /* '7' */
 145         EIGHTKEY        = 0x0038,  /* '8' */
 146         NINEKEY         = 0x0039,  /* '9' */
 147
 148         CAPSLOCKKEY     = 0x00d3,  /* 211 */
 149
 150         LEFTCTRLKEY     = 0x00d4,  /* 212 */
 151         LEFTALTKEY      = 0x00d5,  /* 213 */
 152         RIGHTALTKEY     = 0x00d6,  /* 214 */
 153         RIGHTCTRLKEY    = 0x00d7,  /* 215 */
 154         RIGHTSHIFTKEY   = 0x00d8,  /* 216 */
 155         LEFTSHIFTKEY    = 0x00d9,  /* 217 */
 156
 157         ESCKEY          = 0x00da,  /* 218 */
 158         TABKEY          = 0x00db,  /* 219 */
 159         RETKEY          = 0x00dc,  /* 220 */
 160         SPACEKEY        = 0x00dd,  /* 221 */
 161         LINEFEEDKEY     = 0x00de,  /* 222 */
 162         BACKSPACEKEY    = 0x00df,  /* 223 */
 163         DELKEY          = 0x00e0,  /* 224 */
 164         SEMICOLONKEY    = 0x00e1,  /* 225 */
 165         PERIODKEY       = 0x00e2,  /* 226 */
 166         COMMAKEY        = 0x00e3,  /* 227 */
 167         QUOTEKEY        = 0x00e4,  /* 228 */
 168         ACCENTGRAVEKEY  = 0x00e5,  /* 229 */
 169         MINUSKEY        = 0x00e6,  /* 230 */
 170         PLUSKEY         = 0x00e7,  /* 231 */
 171         SLASHKEY        = 0x00e8,  /* 232 */
 172         BACKSLASHKEY    = 0x00e9,  /* 233 */
 173         EQUALKEY        = 0x00ea,  /* 234 */
 174         LEFTBRACKETKEY  = 0x00eb,  /* 235 */
 175         RIGHTBRACKETKEY = 0x00ec,  /* 236 */
 176
 177         LEFTARROWKEY    = 0x0089,  /* 137 */
 178         DOWNARROWKEY    = 0x008a,  /* 138 */
 179         RIGHTARROWKEY   = 0x008b,  /* 139 */
 180         UPARROWKEY      = 0x008c,  /* 140 */
 181
 182         PAD0            = 0x0096,  /* 150 */
 183         PAD1            = 0x0097,  /* 151 */
 184         PAD2            = 0x0098,  /* 152 */
 185         PAD3            = 0x0099,  /* 153 */
 186         PAD4            = 0x009a,  /* 154 */
 187         PAD5            = 0x009b,  /* 155 */
 188         PAD6            = 0x009c,  /* 156 */
 189         PAD7            = 0x009d,  /* 157 */
 190         PAD8            = 0x009e,  /* 158 */
 191         PAD9            = 0x009f,  /* 159 */
 192
 193         PADPERIOD       = 0x00c7,  /* 199 */
 194         PADASTERKEY     = 0x00a0,  /* 160 */
 195         PADSLASHKEY     = 0x00a1,  /* 161 */
 196         PADMINUS        = 0x00a2,  /* 162 */
 197         PADENTER        = 0x00a3,  /* 163 */
 198         PADPLUSKEY      = 0x00a4,  /* 164 */
 199
 200         PAUSEKEY        = 0x00a5,  /* 165 */
 201         INSERTKEY       = 0x00a6,  /* 166 */
 202         HOMEKEY         = 0x00a7,  /* 167 */
 203         PAGEUPKEY       = 0x00a8,  /* 168 */
 204         PAGEDOWNKEY     = 0x00a9,  /* 169 */
 205         ENDKEY          = 0x00aa,  /* 170 */
 206
 207         UNKNOWNKEY      = 0x00ab,  /* 171 */
 208         OSKEY           = 0x00ac,  /* 172 */
 209         GRLESSKEY       = 0x00ad,  /* 173 */
 210
 211         /* XXX: are these codes ok? */
 212         MEDIAPLAY       = 0x00ae,  /* 174 */
 213         MEDIASTOP       = 0x00af,  /* 175 */
 214         MEDIAFIRST      = 0x00b0,  /* 176 */
 215         MEDIALAST       = 0x00b1,  /* 177 */
 216
 217         F1KEY           = 0x012c,  /* 300 */
 218         F2KEY           = 0x012d,  /* 301 */
 219         F3KEY           = 0x012e,  /* 302 */
 220         F4KEY           = 0x012f,  /* 303 */
 221         F5KEY           = 0x0130,  /* 304 */
 222         F6KEY           = 0x0131,  /* 305 */
 223         F7KEY           = 0x0132,  /* 306 */
 224         F8KEY           = 0x0133,  /* 307 */
 225         F9KEY           = 0x0134,  /* 308 */
 226         F10KEY          = 0x0135,  /* 309 */
 227         F11KEY          = 0x0136,  /* 310 */
 228         F12KEY          = 0x0137,  /* 311 */
 229         F13KEY          = 0x0138,  /* 312 */
 230         F14KEY          = 0x0139,  /* 313 */
 231         F15KEY          = 0x013a,  /* 314 */
 232         F16KEY          = 0x013b,  /* 315 */
 233         F17KEY          = 0x013c,  /* 316 */
 234         F18KEY          = 0x013d,  /* 317 */
 235         F19KEY          = 0x013e,  /* 318 */
 236
 237         /* *** End of keyboard codes. *** */
 238
 239         /* NDOF (from SpaceNavigator & friends)
 240          * These should be kept in sync with GHOST_NDOFManager.h
 241          * Ordering matters, exact values do not. */
 242         NDOF_MOTION = 0x0190,
 243         /* used internally, never sent */
 244         NDOF_BUTTON_NONE = NDOF_MOTION,
 245         /* these two are available from any 3Dconnexion device */
 246         NDOF_BUTTON_MENU,
 247         NDOF_BUTTON_FIT,
 248         /* standard views */
 249         NDOF_BUTTON_TOP,
 250         NDOF_BUTTON_BOTTOM,
 251         NDOF_BUTTON_LEFT,
 252         NDOF_BUTTON_RIGHT,
 253         NDOF_BUTTON_FRONT,
 254         NDOF_BUTTON_BACK,
 255         /* more views */
 256         NDOF_BUTTON_ISO1,
 257         NDOF_BUTTON_ISO2,
 258         /* 90 degree rotations */
 259         NDOF_BUTTON_ROLL_CW,
 260         NDOF_BUTTON_ROLL_CCW,
 261         NDOF_BUTTON_SPIN_CW,
 262         NDOF_BUTTON_SPIN_CCW,
 263         NDOF_BUTTON_TILT_CW,
 264         NDOF_BUTTON_TILT_CCW,
 265         /* device control */
 266         NDOF_BUTTON_ROTATE,
 267         NDOF_BUTTON_PANZOOM,
 268         NDOF_BUTTON_DOMINANT,
 269         NDOF_BUTTON_PLUS,
 270         NDOF_BUTTON_MINUS,
 271         /* keyboard emulation */
 272         NDOF_BUTTON_ESC,
 273         NDOF_BUTTON_ALT,
 274         NDOF_BUTTON_SHIFT,
 275         NDOF_BUTTON_CTRL,
 276         /* general-purpose buttons */
 277         NDOF_BUTTON_1,
 278         NDOF_BUTTON_2,
 279         NDOF_BUTTON_3,
 280         NDOF_BUTTON_4,
 281         NDOF_BUTTON_5,
 282         NDOF_BUTTON_6,
 283         NDOF_BUTTON_7,
 284         NDOF_BUTTON_8,
 285         NDOF_BUTTON_9,
 286         NDOF_BUTTON_10,
 287         /* more general-purpose buttons */
 288         NDOF_BUTTON_A,
 289         NDOF_BUTTON_B,
 290         NDOF_BUTTON_C,
 291         /* the end */
 292         NDOF_LAST,
 293
 294         /* ********** End of Input devices. ********** */
 295
 296         /* ********** Start of Blender internal events. ********** */
 297
 298         /* XXX Those are mixed inside keyboard 'area'! */
 299         /* System: 0x010x */
 300         INPUTCHANGE           = 0x0103,  /* input connected or disconnected */
 301         WINDEACTIVATE         = 0x0104,  /* window is deactivated, focus lost */
 302         /* Timer: 0x011x */
 303         TIMER                 = 0x0110,  /* timer event, passed on to all queues */
 304         TIMER0                = 0x0111,  /* timer event, slot for internal use */
 305         TIMER1                = 0x0112,  /* timer event, slot for internal use */
 306         TIMER2                = 0x0113,  /* timer event, slot for internal use */
 307         TIMERJOBS             = 0x0114,  /* timer event, jobs system */
 308         TIMERAUTOSAVE         = 0x0115,  /* timer event, autosave */
 309         TIMERREPORT           = 0x0116,  /* timer event, reports */
 310         TIMERREGION           = 0x0117,  /* timer event, region slide in/out */
 311         TIMERNOTIFIER         = 0x0118,  /* timer event, notifier sender */
 312         TIMERF                = 0x011F,  /* last timer */
 313
 314         /* Actionzones, tweak, gestures: 0x500x, 0x501x */
 315         EVT_ACTIONZONE_AREA   = 0x5000,
 316         EVT_ACTIONZONE_REGION = 0x5001,
 317         EVT_ACTIONZONE_FULLSCREEN = 0x5011,
 318
 319         /* NOTE: these values are saved in keymap files, do not change them but just add new ones */
 320
 321         /* Tweak events:
 322          * Sent as additional event with the mouse coordinates from where the initial click was placed. */
 323
 324         /* tweak events for L M R mousebuttons */
 325         EVT_TWEAK_L           = 0x5002,
 326         EVT_TWEAK_M           = 0x5003,
 327         EVT_TWEAK_R           = 0x5004,
 328         /* tweak events for action or select mousebutton */
 329         EVT_TWEAK_A           = 0x5005,
 330         EVT_TWEAK_S           = 0x5006,
 331         EVT_GESTURE           = 0x5010,
 332
 333         /* 0x5011 is taken, see EVT_ACTIONZONE_FULLSCREEN */
 334
 335         /* Misc Blender internals: 0x502x */
 336         EVT_FILESELECT        = 0x5020,
 337         EVT_BUT_OPEN          = 0x5021,
 338         EVT_MODAL_MAP         = 0x5022,
 339         EVT_DROP              = 0x5023,
 340         EVT_BUT_CANCEL        = 0x5024,
 341
 342         /* ********** End of Blender internal events. ********** */
 343 };
 344
 345
 346 /* *********** wmEvent.type helpers. ********** */
 347
 348 /* test whether the event is timer event */
 349 #define ISTIMER(event_type)     ((event_type) >= TIMER && (event_type) <= TIMERF)
 350
 351 /* for event checks */
 352 /* only used for KM_TEXTINPUT, so assume that we want all user-inputtable ascii codes included */
 353 /* UNUSED - see wm_eventmatch - BUG [#30479] */
 354 /* #define ISTEXTINPUT(event_type)  ((event_type) >= ' ' && (event_type) <= 255) */
 355 /* note, an alternative could be to check 'event->utf8_buf' */
 356
 357 /* test whether the event is a key on the keyboard */
 358 #define ISKEYBOARD(event_type)                          \
 359         (((event_type) >= 0x0020 && (event_type) <= 0x00ff) ||  \
 360          ((event_type) >= 0x012c && (event_type) <= 0x013f))
 361
 362 /* test whether the event is a modifier key */
 363 #define ISKEYMODIFIER(event_type) \
 364         (((event_type) >= LEFTCTRLKEY && (event_type) <= LEFTSHIFTKEY) || (event_type) == OSKEY)
 365
 366 /* test whether the event is a mouse button */
 367 #define ISMOUSE(event_type)  ((event_type) >= LEFTMOUSE && (event_type) <= BUTTON7MOUSE)
 368
 369 /* test whether the event is tweak event */
 370 #define ISTWEAK(event_type)  ((event_type) >= EVT_TWEAK_L && (event_type) <= EVT_GESTURE)
 371
 372 /* test whether the event is a NDOF event */
 373 #define ISNDOF(event_type)  ((event_type) >= NDOF_MOTION && (event_type) < NDOF_LAST)
 374
 375 /* test whether event type is acceptable as hotkey, excluding modifiers */
 376 #define ISHOTKEY(event_type)                                                  \
 377         ((ISKEYBOARD(event_type) || ISMOUSE(event_type) || ISNDOF(event_type)) && \
 378          ((event_type) != ESCKEY) &&                                                \
 379          ((event_type) >= LEFTCTRLKEY && (event_type) <= LEFTSHIFTKEY) == false &&    \
 380          ((event_type) >= UNKNOWNKEY  && (event_type) <= GRLESSKEY) == false)
 381
 382 /* internal helpers*/
 383 #define _VA_IS_EVENT_MOD2(v, a) (CHECK_TYPE_INLINE(v, wmEvent *), \
 384        ((v)->a))
 385 #define _VA_IS_EVENT_MOD3(v, a, b) \
 386        (_VA_IS_EVENT_MOD2(v, a) || ((v)->b))
 387 #define _VA_IS_EVENT_MOD4(v, a, b, c) \
 388        (_VA_IS_EVENT_MOD3(v, a, b) || ((v)->c))
 389 #define _VA_IS_EVENT_MOD5(v, a, b, c, d) \
 390        (_VA_IS_EVENT_MOD4(v, a, b, c) || ((v)->d))
 391
 392 /* reusable IS_EVENT_MOD(event, shift, ctrl, alt, oskey), macro */
 393 #define IS_EVENT_MOD(...) VA_NARGS_CALL_OVERLOAD(_VA_IS_EVENT_MOD, __VA_ARGS__)
 394
 395 /* ********** wmEvent.val ********** */
 396
 397 /* Gestures */
 398 /* NOTE: these values are saved in keymap files, do not change them but just add new ones */
 399 enum {
 400         /* value of tweaks and line gestures, note, KM_ANY (-1) works for this case too */
 401         EVT_GESTURE_N   = 1,
 402         EVT_GESTURE_NE  = 2,
 403         EVT_GESTURE_E   = 3,
 404         EVT_GESTURE_SE  = 4,
 405         EVT_GESTURE_S   = 5,
 406         EVT_GESTURE_SW  = 6,
 407         EVT_GESTURE_W   = 7,
 408         EVT_GESTURE_NW  = 8,
 409         /* value of corner gestures */
 410         EVT_GESTURE_N_E = 9,
 411         EVT_GESTURE_N_W = 10,
 412         EVT_GESTURE_E_N = 11,
 413         EVT_GESTURE_E_S = 12,
 414         EVT_GESTURE_S_E = 13,
 415         EVT_GESTURE_S_W = 14,
 416         EVT_GESTURE_W_S = 15,
 417         EVT_GESTURE_W_N = 16,
 418 };
 419
 420 /* File select */
 421 enum {
 422         EVT_FILESELECT_FULL_OPEN        = 1,
 423         EVT_FILESELECT_EXEC             = 2,
 424         EVT_FILESELECT_CANCEL           = 3,
 425         EVT_FILESELECT_EXTERNAL_CANCEL  = 4,
 426 };
 427
 428 /* Gesture */
 429 /* NOTE: these values are saved in keymap files, do not change them but just add new ones */
 430 enum {
 431         GESTURE_MODAL_CANCEL      = 1,
 432         GESTURE_MODAL_CONFIRM     = 2,
 433
 434         /* Uses 'deselect' operator property. */
 435         GESTURE_MODAL_SELECT      = 3,
 436         GESTURE_MODAL_DESELECT    = 4,
 437
 438         GESTURE_MODAL_NOP         = 5, /* circle select when no mouse button is pressed */
 439
 440         GESTURE_MODAL_CIRCLE_ADD  = 6, /* circle sel: larger brush */
 441         GESTURE_MODAL_CIRCLE_SUB  = 7, /* circle sel: smaller brush */
 442
 443         GESTURE_MODAL_BEGIN       = 8, /* border select/straight line, activate, use release to detect which button */
 444
 445         /* Uses 'zoom_out' operator property. */
 446         GESTURE_MODAL_IN          = 9,
 447         GESTURE_MODAL_OUT         = 10,
 448
 449         GESTURE_MODAL_CIRCLE_SIZE = 11, /* circle sel: size brush (for trackpad event) */
 450 };
 451
 452
 453 #endif  /* __WM_EVENT_TYPES_H__ */
 454