tornavis/source/blender/windowmanager/wm_event_types.h

495 lines
15 KiB
C

/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file
* \ingroup wm
*/
/*
* These define have its origin at sgi, where all device defines were written down in device.h.
* Blender copied the conventions quite some, and expanded it with internal new defines (ton)
*/
#ifndef __WM_EVENT_TYPES_H__
#define __WM_EVENT_TYPES_H__
/* customdata type */
enum {
EVT_DATA_TIMER = 2,
EVT_DATA_DRAGDROP = 3,
EVT_DATA_NDOF_MOTION = 4,
};
/* tablet active, matches GHOST_TTabletMode */
enum {
EVT_TABLET_NONE = 0,
EVT_TABLET_STYLUS = 1,
EVT_TABLET_ERASER = 2,
};
/**
* #wmEvent.type
*
* \note Also used for #wmKeyMapItem.type which is saved in key-map files,
* do not change the values of existing values which can be used in key-maps.
*/
enum {
/* non-event, for example disabled timer */
EVENT_NONE = 0x0000,
/* ********** Start of Input devices. ********** */
/* MOUSE : 0x000x, 0x001x */
LEFTMOUSE = 0x0001,
MIDDLEMOUSE = 0x0002,
RIGHTMOUSE = 0x0003,
MOUSEMOVE = 0x0004,
/* Extra mouse buttons */
BUTTON4MOUSE = 0x0007,
BUTTON5MOUSE = 0x0008,
/* More mouse buttons - can't use 9 and 10 here (wheel) */
BUTTON6MOUSE = 0x0012,
BUTTON7MOUSE = 0x0013,
/* Extra trackpad gestures */
MOUSEPAN = 0x000e,
MOUSEZOOM = 0x000f,
MOUSEROTATE = 0x0010,
MOUSESMARTZOOM = 0x0017,
/* defaults from ghost */
WHEELUPMOUSE = 0x000a,
WHEELDOWNMOUSE = 0x000b,
/* mapped with userdef */
WHEELINMOUSE = 0x000c,
WHEELOUTMOUSE = 0x000d,
/* Successive MOUSEMOVE's are converted to this, so we can easily
* ignore all but the most recent MOUSEMOVE (for better performance),
* paint and drawing tools however will want to handle these. */
INBETWEEN_MOUSEMOVE = 0x0011,
/* IME event, GHOST_kEventImeCompositionStart in ghost */
WM_IME_COMPOSITE_START = 0x0014,
/* IME event, GHOST_kEventImeComposition in ghost */
WM_IME_COMPOSITE_EVENT = 0x0015,
/* IME event, GHOST_kEventImeCompositionEnd in ghost */
WM_IME_COMPOSITE_END = 0x0016,
/* Tablet/Pen Specific Events */
TABLET_STYLUS = 0x001a,
TABLET_ERASER = 0x001b,
/* *** Start of keyboard codes. *** */
/* Standard keyboard.
* From 0x0020 to 0x00ff, and 0x012c to 0x0143 for function keys! */
ZEROKEY = 0x0030, /* '0' (48). */
ONEKEY = 0x0031, /* '1' (49). */
TWOKEY = 0x0032, /* '2' (50). */
THREEKEY = 0x0033, /* '3' (51). */
FOURKEY = 0x0034, /* '4' (52). */
FIVEKEY = 0x0035, /* '5' (53). */
SIXKEY = 0x0036, /* '6' (54). */
SEVENKEY = 0x0037, /* '7' (55). */
EIGHTKEY = 0x0038, /* '8' (56). */
NINEKEY = 0x0039, /* '9' (57). */
AKEY = 0x0061, /* 'a' (97). */
BKEY = 0x0062, /* 'b' (98). */
CKEY = 0x0063, /* 'c' (99). */
DKEY = 0x0064, /* 'd' (100). */
EKEY = 0x0065, /* 'e' (101). */
FKEY = 0x0066, /* 'f' (102). */
GKEY = 0x0067, /* 'g' (103). */
#ifndef WIN32
HKEY = 0x0068, /* 'h' (104). */
#else
# define HKEY 0x0068
#endif
IKEY = 0x0069, /* 'i' (105). */
JKEY = 0x006a, /* 'j' (106). */
KKEY = 0x006b, /* 'k' (107). */
LKEY = 0x006c, /* 'l' (108). */
MKEY = 0x006d, /* 'm' (109). */
NKEY = 0x006e, /* 'n' (110). */
OKEY = 0x006f, /* 'o' (111). */
PKEY = 0x0070, /* 'p' (112). */
QKEY = 0x0071, /* 'q' (113). */
RKEY = 0x0072, /* 'r' (114). */
SKEY = 0x0073, /* 's' (115). */
TKEY = 0x0074, /* 't' (116). */
UKEY = 0x0075, /* 'u' (117). */
VKEY = 0x0076, /* 'v' (118). */
WKEY = 0x0077, /* 'w' (119). */
XKEY = 0x0078, /* 'x' (120). */
YKEY = 0x0079, /* 'y' (121). */
ZKEY = 0x007a, /* 'z' (122). */
LEFTARROWKEY = 0x0089, /* 137 */
DOWNARROWKEY = 0x008a, /* 138 */
RIGHTARROWKEY = 0x008b, /* 139 */
UPARROWKEY = 0x008c, /* 140 */
PAD0 = 0x0096, /* 150 */
PAD1 = 0x0097, /* 151 */
PAD2 = 0x0098, /* 152 */
PAD3 = 0x0099, /* 153 */
PAD4 = 0x009a, /* 154 */
PAD5 = 0x009b, /* 155 */
PAD6 = 0x009c, /* 156 */
PAD7 = 0x009d, /* 157 */
PAD8 = 0x009e, /* 158 */
PAD9 = 0x009f, /* 159 */
/* Key-pad keys. */
PADASTERKEY = 0x00a0, /* 160 */
PADSLASHKEY = 0x00a1, /* 161 */
PADMINUS = 0x00a2, /* 162 */
PADENTER = 0x00a3, /* 163 */
PADPLUSKEY = 0x00a4, /* 164 */
PAUSEKEY = 0x00a5, /* 165 */
INSERTKEY = 0x00a6, /* 166 */
HOMEKEY = 0x00a7, /* 167 */
PAGEUPKEY = 0x00a8, /* 168 */
PAGEDOWNKEY = 0x00a9, /* 169 */
ENDKEY = 0x00aa, /* 170 */
/* Note that 'PADPERIOD' is defined out-of-order. */
UNKNOWNKEY = 0x00ab, /* 171 */
OSKEY = 0x00ac, /* 172 */
GRLESSKEY = 0x00ad, /* 173 */
/* Media keys. */
MEDIAPLAY = 0x00ae, /* 174 */
MEDIASTOP = 0x00af, /* 175 */
MEDIAFIRST = 0x00b0, /* 176 */
MEDIALAST = 0x00b1, /* 177 */
/* Menu/App key. */
APPKEY = 0x00b2, /* 178 */
PADPERIOD = 0x00c7, /* 199 */
CAPSLOCKKEY = 0x00d3, /* 211 */
/* Modifier keys. */
LEFTCTRLKEY = 0x00d4, /* 212 */
LEFTALTKEY = 0x00d5, /* 213 */
RIGHTALTKEY = 0x00d6, /* 214 */
RIGHTCTRLKEY = 0x00d7, /* 215 */
RIGHTSHIFTKEY = 0x00d8, /* 216 */
LEFTSHIFTKEY = 0x00d9, /* 217 */
/* Special characters. */
ESCKEY = 0x00da, /* 218 */
TABKEY = 0x00db, /* 219 */
RETKEY = 0x00dc, /* 220 */
SPACEKEY = 0x00dd, /* 221 */
LINEFEEDKEY = 0x00de, /* 222 */
BACKSPACEKEY = 0x00df, /* 223 */
DELKEY = 0x00e0, /* 224 */
SEMICOLONKEY = 0x00e1, /* 225 */
PERIODKEY = 0x00e2, /* 226 */
COMMAKEY = 0x00e3, /* 227 */
QUOTEKEY = 0x00e4, /* 228 */
ACCENTGRAVEKEY = 0x00e5, /* 229 */
MINUSKEY = 0x00e6, /* 230 */
PLUSKEY = 0x00e7, /* 231 */
SLASHKEY = 0x00e8, /* 232 */
BACKSLASHKEY = 0x00e9, /* 233 */
EQUALKEY = 0x00ea, /* 234 */
LEFTBRACKETKEY = 0x00eb, /* 235 */
RIGHTBRACKETKEY = 0x00ec, /* 236 */
F1KEY = 0x012c, /* 300 */
F2KEY = 0x012d, /* 301 */
F3KEY = 0x012e, /* 302 */
F4KEY = 0x012f, /* 303 */
F5KEY = 0x0130, /* 304 */
F6KEY = 0x0131, /* 305 */
F7KEY = 0x0132, /* 306 */
F8KEY = 0x0133, /* 307 */
F9KEY = 0x0134, /* 308 */
F10KEY = 0x0135, /* 309 */
F11KEY = 0x0136, /* 310 */
F12KEY = 0x0137, /* 311 */
F13KEY = 0x0138, /* 312 */
F14KEY = 0x0139, /* 313 */
F15KEY = 0x013a, /* 314 */
F16KEY = 0x013b, /* 315 */
F17KEY = 0x013c, /* 316 */
F18KEY = 0x013d, /* 317 */
F19KEY = 0x013e, /* 318 */
F20KEY = 0x013f, /* 319 */
F21KEY = 0x0140, /* 320 */
F22KEY = 0x0141, /* 321 */
F23KEY = 0x0142, /* 322 */
F24KEY = 0x0143, /* 323 */
/* *** End of keyboard codes. *** */
/* NDOF (from SpaceNavigator & friends)
* These should be kept in sync with GHOST_NDOFManager.h
* Ordering matters, exact values do not. */
NDOF_MOTION = 0x0190, /* 400 */
/* used internally, never sent */
NDOF_BUTTON_NONE = NDOF_MOTION,
/* these two are available from any 3Dconnexion device */
NDOF_BUTTON_MENU,
NDOF_BUTTON_FIT,
/* standard views */
NDOF_BUTTON_TOP,
NDOF_BUTTON_BOTTOM,
NDOF_BUTTON_LEFT,
NDOF_BUTTON_RIGHT,
NDOF_BUTTON_FRONT,
NDOF_BUTTON_BACK,
/* more views */
NDOF_BUTTON_ISO1,
NDOF_BUTTON_ISO2,
/* 90 degree rotations */
NDOF_BUTTON_ROLL_CW,
NDOF_BUTTON_ROLL_CCW,
NDOF_BUTTON_SPIN_CW,
NDOF_BUTTON_SPIN_CCW,
NDOF_BUTTON_TILT_CW,
NDOF_BUTTON_TILT_CCW,
/* device control */
NDOF_BUTTON_ROTATE,
NDOF_BUTTON_PANZOOM,
NDOF_BUTTON_DOMINANT,
NDOF_BUTTON_PLUS,
NDOF_BUTTON_MINUS,
/* keyboard emulation */
NDOF_BUTTON_ESC,
NDOF_BUTTON_ALT,
NDOF_BUTTON_SHIFT,
NDOF_BUTTON_CTRL,
/* general-purpose buttons */
NDOF_BUTTON_1,
NDOF_BUTTON_2,
NDOF_BUTTON_3,
NDOF_BUTTON_4,
NDOF_BUTTON_5,
NDOF_BUTTON_6,
NDOF_BUTTON_7,
NDOF_BUTTON_8,
NDOF_BUTTON_9,
NDOF_BUTTON_10,
/* more general-purpose buttons */
NDOF_BUTTON_A,
NDOF_BUTTON_B,
NDOF_BUTTON_C,
/* the end */
NDOF_LAST,
/* ********** End of Input devices. ********** */
/* ********** Start of Blender internal events. ********** */
/* XXX Those are mixed inside keyboard 'area'! */
/* System: 0x010x */
INPUTCHANGE = 0x0103, /* Input connected or disconnected, (259). */
WINDEACTIVATE = 0x0104, /* Window is deactivated, focus lost, (260). */
/* Timer: 0x011x */
TIMER = 0x0110, /* Timer event, passed on to all queues (272). */
TIMER0 = 0x0111, /* Timer event, slot for internal use (273). */
TIMER1 = 0x0112, /* Timer event, slot for internal use (274). */
TIMER2 = 0x0113, /* Timer event, slot for internal use (275). */
TIMERJOBS = 0x0114, /* Timer event, jobs system (276). */
TIMERAUTOSAVE = 0x0115, /* Timer event, autosave (277). */
TIMERREPORT = 0x0116, /* Timer event, reports (278). */
TIMERREGION = 0x0117, /* Timer event, region slide in/out (279). */
TIMERNOTIFIER = 0x0118, /* Timer event, notifier sender (280). */
TIMERF = 0x011F, /* Last timer (287). */
/* Actionzones, tweak, gestures: 0x500x, 0x501x */
/* Keep in sync with IS_EVENT_ACTIONZONE(...). */
EVT_ACTIONZONE_AREA = 0x5000, /* 20480 */
EVT_ACTIONZONE_REGION = 0x5001, /* 20481 */
EVT_ACTIONZONE_FULLSCREEN = 0x5011, /* 20497 */
/* NOTE: these values are saved in keymap files, do not change them but just add new ones */
/* Tweak events:
* Sent as additional event with the mouse coordinates
* from where the initial click was placed. */
/* tweak events for L M R mousebuttons */
EVT_TWEAK_L = 0x5002, /* 20482 */
EVT_TWEAK_M = 0x5003, /* 20483 */
EVT_TWEAK_R = 0x5004, /* 20484 */
/* 0x5010 (and lower) should be left to add other tweak types in the future. */
/* 0x5011 is taken, see EVT_ACTIONZONE_FULLSCREEN */
/* Misc Blender internals: 0x502x */
EVT_FILESELECT = 0x5020, /* 20512 */
EVT_BUT_OPEN = 0x5021, /* 20513 */
EVT_MODAL_MAP = 0x5022, /* 20514 */
EVT_DROP = 0x5023, /* 20515 */
EVT_BUT_CANCEL = 0x5024, /* 20516 */
/* could become gizmo callback */
EVT_GIZMO_UPDATE = 0x5025, /* 20517 */
/* ********** End of Blender internal events. ********** */
};
/* *********** wmEvent.type helpers. ********** */
/* test whether the event is timer event */
#define ISTIMER(event_type) ((event_type) >= TIMER && (event_type) <= TIMERF)
/* for event checks */
/* only used for KM_TEXTINPUT, so assume that we want all user-inputtable ascii codes included */
/* UNUSED - see wm_eventmatch - BUG [#30479] */
/* #define ISTEXTINPUT(event_type) ((event_type) >= ' ' && (event_type) <= 255) */
/* note, an alternative could be to check 'event->utf8_buf' */
/* test whether the event is a key on the keyboard */
#define ISKEYBOARD(event_type) \
(((event_type) >= 0x0020 && (event_type) <= 0x00ff) || \
((event_type) >= 0x012c && (event_type) <= 0x0143))
/* test whether the event is a modifier key */
#define ISKEYMODIFIER(event_type) \
(((event_type) >= LEFTCTRLKEY && (event_type) <= LEFTSHIFTKEY) || (event_type) == OSKEY)
/* test whether the event is a mouse button */
#define ISMOUSE(event_type) \
(((event_type) >= LEFTMOUSE && (event_type) <= BUTTON7MOUSE) || (event_type) == MOUSESMARTZOOM)
#define ISMOUSE_WHEEL(event_type) ((event_type) >= WHEELUPMOUSE && (event_type) <= WHEELOUTMOUSE)
#define ISMOUSE_GESTURE(event_type) ((event_type) >= MOUSEPAN && (event_type) <= MOUSEROTATE)
#define ISMOUSE_BUTTON(event_type) \
(ELEM(event_type, \
LEFTMOUSE, \
MIDDLEMOUSE, \
RIGHTMOUSE, \
BUTTON4MOUSE, \
BUTTON5MOUSE, \
BUTTON6MOUSE, \
BUTTON7MOUSE))
/* test whether the event is tweak event */
#define ISTWEAK(event_type) ((event_type) >= EVT_TWEAK_L && (event_type) <= EVT_TWEAK_R)
/* test whether the event is a NDOF event */
#define ISNDOF(event_type) ((event_type) >= NDOF_MOTION && (event_type) < NDOF_LAST)
#define IS_EVENT_ACTIONZONE(event_type) \
ELEM(event_type, EVT_ACTIONZONE_AREA, EVT_ACTIONZONE_REGION, EVT_ACTIONZONE_FULLSCREEN)
/* test whether event type is acceptable as hotkey, excluding modifiers */
#define ISHOTKEY(event_type) \
((ISKEYBOARD(event_type) || ISMOUSE(event_type) || ISNDOF(event_type)) && \
(ISKEYMODIFIER(event_type) == false))
/* internal helpers*/
#define _VA_IS_EVENT_MOD2(v, a) (CHECK_TYPE_INLINE(v, wmEvent *), ((v)->a))
#define _VA_IS_EVENT_MOD3(v, a, b) (_VA_IS_EVENT_MOD2(v, a) || ((v)->b))
#define _VA_IS_EVENT_MOD4(v, a, b, c) (_VA_IS_EVENT_MOD3(v, a, b) || ((v)->c))
#define _VA_IS_EVENT_MOD5(v, a, b, c, d) (_VA_IS_EVENT_MOD4(v, a, b, c) || ((v)->d))
/* reusable IS_EVENT_MOD(event, shift, ctrl, alt, oskey), macro */
#define IS_EVENT_MOD(...) VA_NARGS_CALL_OVERLOAD(_VA_IS_EVENT_MOD, __VA_ARGS__)
enum eEventType_Mask {
/* ISKEYMODIFIER */
EVT_TYPE_MASK_KEYBOARD_MODIFIER = (1 << 0),
/* ISKEYBOARD */
EVT_TYPE_MASK_KEYBOARD = (1 << 1),
/* ISMOUSE_WHEEL */
EVT_TYPE_MASK_MOUSE_WHEEL = (1 << 2),
/* ISMOUSE_BUTTON */
EVT_TYPE_MASK_MOUSE_GESTURE = (1 << 3),
/* ISMOUSE_GESTURE */
EVT_TYPE_MASK_MOUSE_BUTTON = (1 << 4),
/* ISMOUSE */
EVT_TYPE_MASK_MOUSE = (1 << 5),
/* ISNDOF */
EVT_TYPE_MASK_NDOF = (1 << 6),
/* ISTWEAK */
EVT_TYPE_MASK_TWEAK = (1 << 7),
/* IS_EVENT_ACTIONZONE */
EVT_TYPE_MASK_ACTIONZONE = (1 << 8),
};
#define EVT_TYPE_MASK_ALL \
(EVT_TYPE_MASK_KEYBOARD | EVT_TYPE_MASK_MOUSE | EVT_TYPE_MASK_NDOF | EVT_TYPE_MASK_TWEAK | \
EVT_TYPE_MASK_ACTIONZONE)
#define EVT_TYPE_MASK_HOTKEY_INCLUDE \
(EVT_TYPE_MASK_KEYBOARD | EVT_TYPE_MASK_MOUSE | EVT_TYPE_MASK_NDOF)
#define EVT_TYPE_MASK_HOTKEY_EXCLUDE EVT_TYPE_MASK_KEYBOARD_MODIFIER
bool WM_event_type_mask_test(const int event_type, const enum eEventType_Mask mask);
/* ********** wmEvent.val ********** */
/* Gestures */
/* NOTE: these values are saved in keymap files, do not change them but just add new ones */
enum {
/* value of tweaks and line gestures, note, KM_ANY (-1) works for this case too */
EVT_GESTURE_N = 1,
EVT_GESTURE_NE = 2,
EVT_GESTURE_E = 3,
EVT_GESTURE_SE = 4,
EVT_GESTURE_S = 5,
EVT_GESTURE_SW = 6,
EVT_GESTURE_W = 7,
EVT_GESTURE_NW = 8,
};
/* File select */
enum {
EVT_FILESELECT_FULL_OPEN = 1,
EVT_FILESELECT_EXEC = 2,
EVT_FILESELECT_CANCEL = 3,
EVT_FILESELECT_EXTERNAL_CANCEL = 4,
};
/**
* Gesture
* Used in #wmEvent.val
*
* \note These values are saved in keymap files,
* do not change them but just add new ones.
*/
enum {
GESTURE_MODAL_CANCEL = 1,
GESTURE_MODAL_CONFIRM = 2,
/** Uses 'deselect' operator property. */
GESTURE_MODAL_SELECT = 3,
GESTURE_MODAL_DESELECT = 4,
/** Circle select: when no mouse button is pressed */
GESTURE_MODAL_NOP = 5,
/** Circle select: larger brush. */
GESTURE_MODAL_CIRCLE_ADD = 6,
/** Circle select: smaller brush. */
GESTURE_MODAL_CIRCLE_SUB = 7,
/** Box select/straight line, activate, use release to detect which button. */
GESTURE_MODAL_BEGIN = 8,
/** Uses 'zoom_out' operator property. */
GESTURE_MODAL_IN = 9,
GESTURE_MODAL_OUT = 10,
/** circle select: size brush (for trackpad event). */
GESTURE_MODAL_CIRCLE_SIZE = 11,
};
#endif /* __WM_EVENT_TYPES_H__ */