wm_event_types.hh File Reference

#include <cstdint>

Go to the source code of this file.

Macros
#define	_EVT_MOUSE_MIN   0x0001
#define	_EVT_MOUSE_MAX   0x0015 /* 21 */
#define	_EVT_KEYBOARD_MIN   0x0020
#define	_EVT_KEYBOARD_MAX   0x00ff /* 255 */
#define	_NDOF_MIN   NDOF_MOTION
#define	_NDOF_BUTTON_MIN   NDOF_BUTTON_MENU
#define	_NDOF_MAX   NDOF_BUTTON_SAVE_V3
#define	_NDOF_BUTTON_MAX   NDOF_BUTTON_SAVE_V3
#define	_TIMER_MAX   0x011F

Enumerations
enum	{ EVT_DATA_TIMER = 2 , EVT_DATA_DRAGDROP = 3 , EVT_DATA_NDOF_MOTION = 4 , EVT_DATA_XR = 5 }
enum	{ EVT_TABLET_NONE = 0 , EVT_TABLET_STYLUS = 1 , EVT_TABLET_ERASER = 2 }
enum	wmEventType : int16_t {   EVENT_NONE = 0x0000 , LEFTMOUSE = 0x0001 , MIDDLEMOUSE = 0x0002 , RIGHTMOUSE = 0x0003 ,   MOUSEMOVE = 0x0004 , BUTTON4MOUSE = 0x0007 , BUTTON5MOUSE = 0x0008 , BUTTON6MOUSE = 0x0012 ,   BUTTON7MOUSE = 0x0013 , MOUSEPAN = 0x000e , MOUSEZOOM = 0x000f , MOUSEROTATE = 0x0010 ,   MOUSESMARTZOOM = 0x0017 , WHEELUPMOUSE = 0x000a , WHEELDOWNMOUSE = 0x000b , WHEELINMOUSE = 0x000c ,   WHEELOUTMOUSE = 0x000d , INBETWEEN_MOUSEMOVE = 0x0011 , WHEELLEFTMOUSE = 0x0014 , WHEELRIGHTMOUSE = 0x0015 ,   WM_IME_COMPOSITE_START = 0x0016 , WM_IME_COMPOSITE_EVENT = 0x0018 , WM_IME_COMPOSITE_END = 0x0019 , TABLET_STYLUS = 0x001a ,   TABLET_ERASER = 0x001b , EVT_ZEROKEY = 0x0030 , EVT_ONEKEY = 0x0031 , EVT_TWOKEY = 0x0032 ,   EVT_THREEKEY = 0x0033 , EVT_FOURKEY = 0x0034 , EVT_FIVEKEY = 0x0035 , EVT_SIXKEY = 0x0036 ,   EVT_SEVENKEY = 0x0037 , EVT_EIGHTKEY = 0x0038 , EVT_NINEKEY = 0x0039 , EVT_AKEY = 0x0061 ,   EVT_BKEY = 0x0062 , EVT_CKEY = 0x0063 , EVT_DKEY = 0x0064 , EVT_EKEY = 0x0065 ,   EVT_FKEY = 0x0066 , EVT_GKEY = 0x0067 , EVT_HKEY = 0x0068 , EVT_IKEY = 0x0069 ,   EVT_JKEY = 0x006a , EVT_KKEY = 0x006b , EVT_LKEY = 0x006c , EVT_MKEY = 0x006d ,   EVT_NKEY = 0x006e , EVT_OKEY = 0x006f , EVT_PKEY = 0x0070 , EVT_QKEY = 0x0071 ,   EVT_RKEY = 0x0072 , EVT_SKEY = 0x0073 , EVT_TKEY = 0x0074 , EVT_UKEY = 0x0075 ,   EVT_VKEY = 0x0076 , EVT_WKEY = 0x0077 , EVT_XKEY = 0x0078 , EVT_YKEY = 0x0079 ,   EVT_ZKEY = 0x007a , EVT_LEFTARROWKEY = 0x0089 , EVT_DOWNARROWKEY = 0x008a , EVT_RIGHTARROWKEY = 0x008b ,   EVT_UPARROWKEY = 0x008c , EVT_PAD0 = 0x0096 , EVT_PAD1 = 0x0097 , EVT_PAD2 = 0x0098 ,   EVT_PAD3 = 0x0099 , EVT_PAD4 = 0x009a , EVT_PAD5 = 0x009b , EVT_PAD6 = 0x009c ,   EVT_PAD7 = 0x009d , EVT_PAD8 = 0x009e , EVT_PAD9 = 0x009f , EVT_PADASTERKEY = 0x00a0 ,   EVT_PADSLASHKEY = 0x00a1 , EVT_PADMINUS = 0x00a2 , EVT_PADENTER = 0x00a3 , EVT_PADPLUSKEY = 0x00a4 ,   EVT_PAUSEKEY = 0x00a5 , EVT_INSERTKEY = 0x00a6 , EVT_HOMEKEY = 0x00a7 , EVT_PAGEUPKEY = 0x00a8 ,   EVT_PAGEDOWNKEY = 0x00a9 , EVT_ENDKEY = 0x00aa , EVT_UNKNOWNKEY = 0x00ab , EVT_OSKEY = 0x00ac ,   EVT_GRLESSKEY = 0x00ad , EVT_MEDIAPLAY = 0x00ae , EVT_MEDIASTOP = 0x00af , EVT_MEDIAFIRST = 0x00b0 ,   EVT_MEDIALAST = 0x00b1 , EVT_APPKEY = 0x00b2 , EVT_HYPER = 0x00b3 , EVT_PADPERIOD = 0x00c7 ,   EVT_CAPSLOCKKEY = 0x00d3 , EVT_LEFTCTRLKEY = 0x00d4 , EVT_LEFTALTKEY = 0x00d5 , EVT_RIGHTALTKEY = 0x00d6 ,   EVT_RIGHTCTRLKEY = 0x00d7 , EVT_RIGHTSHIFTKEY = 0x00d8 , EVT_LEFTSHIFTKEY = 0x00d9 , EVT_ESCKEY = 0x00da ,   EVT_TABKEY = 0x00db , EVT_RETKEY = 0x00dc , EVT_SPACEKEY = 0x00dd , EVT_LINEFEEDKEY = 0x00de ,   EVT_BACKSPACEKEY = 0x00df , EVT_DELKEY = 0x00e0 , EVT_SEMICOLONKEY = 0x00e1 , EVT_PERIODKEY = 0x00e2 ,   EVT_COMMAKEY = 0x00e3 , EVT_QUOTEKEY = 0x00e4 , EVT_ACCENTGRAVEKEY = 0x00e5 , EVT_MINUSKEY = 0x00e6 ,   EVT_PLUSKEY = 0x00e7 , EVT_SLASHKEY = 0x00e8 , EVT_BACKSLASHKEY = 0x00e9 , EVT_EQUALKEY = 0x00ea ,   EVT_LEFTBRACKETKEY = 0x00eb , EVT_RIGHTBRACKETKEY = 0x00ec , EVT_F1KEY = 0x012c , EVT_F2KEY = 0x012d ,   EVT_F3KEY = 0x012e , EVT_F4KEY = 0x012f , EVT_F5KEY = 0x0130 , EVT_F6KEY = 0x0131 ,   EVT_F7KEY = 0x0132 , EVT_F8KEY = 0x0133 , EVT_F9KEY = 0x0134 , EVT_F10KEY = 0x0135 ,   EVT_F11KEY = 0x0136 , EVT_F12KEY = 0x0137 , EVT_F13KEY = 0x0138 , EVT_F14KEY = 0x0139 ,   EVT_F15KEY = 0x013a , EVT_F16KEY = 0x013b , EVT_F17KEY = 0x013c , EVT_F18KEY = 0x013d ,   EVT_F19KEY = 0x013e , EVT_F20KEY = 0x013f , EVT_F21KEY = 0x0140 , EVT_F22KEY = 0x0141 ,   EVT_F23KEY = 0x0142 , EVT_F24KEY = 0x0143 , NDOF_MOTION = 0x0190 , NDOF_BUTTON_MENU = 0x0191 ,   NDOF_BUTTON_FIT = 0x0192 , NDOF_BUTTON_TOP = 0x0193 , NDOF_BUTTON_BOTTOM = 0x0194 , NDOF_BUTTON_LEFT = 0x0195 ,   NDOF_BUTTON_RIGHT = 0x0196 , NDOF_BUTTON_FRONT = 0x0197 , NDOF_BUTTON_BACK = 0x0198 , NDOF_BUTTON_ISO1 = 0x0199 ,   NDOF_BUTTON_ISO2 = 0x019a , NDOF_BUTTON_ROLL_CW = 0x019b , NDOF_BUTTON_ROLL_CCW = 0x019c , NDOF_BUTTON_SPIN_CW = 0x019d ,   NDOF_BUTTON_SPIN_CCW = 0x019e , NDOF_BUTTON_TILT_CW = 0x019f , NDOF_BUTTON_TILT_CCW = 0x01a0 , NDOF_BUTTON_ROTATE = 0x01a1 ,   NDOF_BUTTON_PANZOOM = 0x01a2 , NDOF_BUTTON_DOMINANT = 0x01a3 , NDOF_BUTTON_PLUS = 0x01a4 , NDOF_BUTTON_MINUS = 0x01a5 ,   NDOF_BUTTON_V1 = 0x01a6 , NDOF_BUTTON_V2 = 0x01a7 , NDOF_BUTTON_V3 = 0x01a8 , NDOF_BUTTON_1 = 0x01aa ,   NDOF_BUTTON_2 = 0x01ab , NDOF_BUTTON_3 = 0x01ac , NDOF_BUTTON_4 = 0x01ad , NDOF_BUTTON_5 = 0x01ae ,   NDOF_BUTTON_6 = 0x01af , NDOF_BUTTON_7 = 0x01b0 , NDOF_BUTTON_8 = 0x01b1 , NDOF_BUTTON_9 = 0x01b2 ,   NDOF_BUTTON_10 = 0x01b3 , NDOF_BUTTON_11 = 0x01b4 , NDOF_BUTTON_12 = 0x01b5 , NDOF_BUTTON_SAVE_V1 = 0x01be ,   NDOF_BUTTON_SAVE_V2 = 0x01bf , NDOF_BUTTON_SAVE_V3 = 0x01c0 , WINDEACTIVATE = 0x0104 , TIMER = 0x0110 ,   TIMER0 = 0x0111 , TIMER1 = 0x0112 , TIMER2 = 0x0113 , TIMERJOBS = 0x0114 ,   TIMERAUTOSAVE = 0x0115 , TIMERREPORT = 0x0116 , TIMERREGION = 0x0117 , TIMERNOTIFIER = 0x0118 ,   EVT_ACTIONZONE_AREA = 0x5000 , EVT_ACTIONZONE_REGION = 0x5001 , EVT_ACTIONZONE_FULLSCREEN = 0x5011 , EVT_FILESELECT = 0x5020 ,   EVT_BUT_OPEN = 0x5021 , EVT_MODAL_MAP = 0x5022 , EVT_DROP = 0x5023 , EVT_BUT_CANCEL = 0x5024 ,   EVT_GIZMO_UPDATE = 0x5025 , EVT_XR_ACTION = 0x5030 }
#wmEvent.val Values
enum	{ EVT_FILESELECT_FULL_OPEN = 1 , EVT_FILESELECT_EXEC = 2 , EVT_FILESELECT_CANCEL = 3 , EVT_FILESELECT_EXTERNAL_CANCEL = 4 }
enum	{   GESTURE_MODAL_CANCEL = 1 , GESTURE_MODAL_CONFIRM = 2 , GESTURE_MODAL_SELECT = 3 , GESTURE_MODAL_DESELECT = 4 ,   GESTURE_MODAL_NOP = 5 , GESTURE_MODAL_CIRCLE_ADD = 6 , GESTURE_MODAL_CIRCLE_SUB = 7 , GESTURE_MODAL_BEGIN = 8 ,   GESTURE_MODAL_IN = 9 , GESTURE_MODAL_OUT = 10 , GESTURE_MODAL_CIRCLE_SIZE = 11 , GESTURE_MODAL_MOVE = 12 ,   GESTURE_MODAL_SNAP = 13 , GESTURE_MODAL_FLIP = 14 }

#wmEvent.type Helpers
#define	ISTIMER(event_type)
#define	ISKEYBOARD(event_type)
#define	ISKEYBOARD_OR_BUTTON(event_type)
#define	ISKEYMODIFIER(event_type)
#define	ISMOUSE(event_type)
#define	ISMOUSE_MOTION(event_type)
#define	ISMOUSE_BUTTON(event_type)
#define	ISMOUSE_WHEEL(event_type)
#define	ISMOUSE_GESTURE(event_type)
#define	ISNDOF(event_type)
#define	ISNDOF_BUTTON(event_type)
#define	IS_EVENT_ACTIONZONE(event_type)
#define	ISHOTKEY(event_type)
#define	EVT_TYPE_MASK_ALL   (EVT_TYPE_MASK_KEYBOARD | EVT_TYPE_MASK_MOUSE | EVT_TYPE_MASK_NDOF | 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
enum	eEventType_Mask {   EVT_TYPE_MASK_KEYBOARD_MODIFIER = (1 << 0) , EVT_TYPE_MASK_KEYBOARD = (1 << 1) , EVT_TYPE_MASK_MOUSE_WHEEL = (1 << 2) , EVT_TYPE_MASK_MOUSE_GESTURE = (1 << 3) ,   EVT_TYPE_MASK_MOUSE_BUTTON = (1 << 4) , EVT_TYPE_MASK_MOUSE = (1 << 5) , EVT_TYPE_MASK_NDOF = (1 << 6) , EVT_TYPE_MASK_ACTIONZONE = (1 << 7) }
bool	WM_event_type_mask_test (int event_type, enum eEventType_Mask mask)

Macro Definition Documentation

_EVT_KEYBOARD_MAX

#define _EVT_KEYBOARD_MAX   0x00ff /* 255 */

Definition at line 222 of file wm_event_types.hh.

_EVT_KEYBOARD_MIN

#define _EVT_KEYBOARD_MIN   0x0020

Definition at line 101 of file wm_event_types.hh.

_EVT_MOUSE_MAX

#define _EVT_MOUSE_MAX   0x0015 /* 21 */

Definition at line 84 of file wm_event_types.hh.

_EVT_MOUSE_MIN

#define _EVT_MOUSE_MIN   0x0001

Definition at line 50 of file wm_event_types.hh.

_NDOF_BUTTON_MAX

#define _NDOF_BUTTON_MAX   NDOF_BUTTON_SAVE_V3

Definition at line 333 of file wm_event_types.hh.

_NDOF_BUTTON_MIN

#define _NDOF_BUTTON_MIN   NDOF_BUTTON_MENU

Definition at line 265 of file wm_event_types.hh.

_NDOF_MAX

#define _NDOF_MAX   NDOF_BUTTON_SAVE_V3

Definition at line 332 of file wm_event_types.hh.

_NDOF_MIN

#define _NDOF_MIN   NDOF_MOTION

Definition at line 264 of file wm_event_types.hh.

_TIMER_MAX

#define _TIMER_MAX   0x011F

Definition at line 354 of file wm_event_types.hh.

EVT_TYPE_MASK_ALL

#define EVT_TYPE_MASK_ALL   (EVT_TYPE_MASK_KEYBOARD | EVT_TYPE_MASK_MOUSE | EVT_TYPE_MASK_NDOF | EVT_TYPE_MASK_ACTIONZONE)

Definition at line 469 of file wm_event_types.hh.

Referenced by RNA_api_keyconfigs(), RNA_api_keymapitems(), ui_popup_context_menu_for_button(), WM_key_event_operator(), and WM_key_event_operator_from_keymap().

EVT_TYPE_MASK_HOTKEY_EXCLUDE

#define EVT_TYPE_MASK_HOTKEY_EXCLUDE   EVT_TYPE_MASK_KEYBOARD_MODIFIER

Definition at line 474 of file wm_event_types.hh.

Referenced by menu_change_shortcut(), and remove_shortcut_func().

EVT_TYPE_MASK_HOTKEY_INCLUDE

#define EVT_TYPE_MASK_HOTKEY_INCLUDE   (EVT_TYPE_MASK_KEYBOARD | EVT_TYPE_MASK_MOUSE | EVT_TYPE_MASK_NDOF)

Definition at line 472 of file wm_event_types.hh.

Referenced by menu_change_shortcut(), and remove_shortcut_func().

IS_EVENT_ACTIONZONE

#define IS_EVENT_ACTIONZONE

(

event_type

)

Value:

ELEM(event_type, EVT_ACTIONZONE_AREA, EVT_ACTIONZONE_REGION, EVT_ACTIONZONE_FULLSCREEN)

Definition at line 442 of file wm_event_types.hh.

Referenced by kmi_filter_is_visible(), and WM_event_type_mask_test().

ISHOTKEY

#define ISHOTKEY

(

event_type

)

Value:

((ISKEYBOARD(event_type) || ISMOUSE_BUTTON(event_type) || ISMOUSE_WHEEL(event_type) || \
  ISNDOF_BUTTON(event_type)) && \
 (ISKEYMODIFIER(event_type) == false))

Test whether event type is acceptable as hotkey (excluding modifiers).

Definition at line 446 of file wm_event_types.hh.

Referenced by ui_do_but_HOTKEYEVT().

ISKEYBOARD

#define ISKEYBOARD

(

event_type

)

Value:

(((event_type) >= _EVT_KEYBOARD_MIN && (event_type) <= _EVT_KEYBOARD_MAX) || \
 ((event_type) >= EVT_F1KEY && (event_type) <= EVT_F24KEY))

Test whether the event is a key on the keyboard (including modifier keys).

Definition at line 390 of file wm_event_types.hh.

Referenced by annotation_draw_modal(), ui_handle_button_return_submenu(), ui_popup_context_menu_for_button(), uiTemplateStatusBarModalItem(), WM_event_add_simulate(), wm_event_free(), WM_event_type_mask_test(), wm_eventmatch(), wm_keymap_item_equals(), and WM_keymap_item_map_type_get().

ISKEYBOARD_OR_BUTTON

#define ISKEYBOARD_OR_BUTTON

(

event_type

)

Value:

(ISMOUSE_BUTTON(event_type) || ISKEYBOARD(event_type) || ISNDOF_BUTTON(event_type))

Test whether the event is a key on the keyboard or any other kind of button that supports press & release (use for click & click-drag detection).

Note

Mouse wheel events are excluded from this macro, while they do generate press events it doesn't make sense to have click & click-drag events for a mouse-wheel as it can't be held down.

Definition at line 402 of file wm_event_types.hh.

Referenced by wm_event_add_ghostevent(), WM_event_add_simulate(), WM_event_consecutive_gesture_test_break(), wm_event_do_handlers(), wm_event_state_update_and_click_set_ex(), and wm_handlers_do().

ISKEYMODIFIER

#define ISKEYMODIFIER

(

event_type

)

Value:

(((event_type) >= EVT_LEFTCTRLKEY && (event_type) <= EVT_LEFTSHIFTKEY) || \
 ELEM((event_type), EVT_OSKEY, EVT_HYPER))

Test whether the event is a modifier key.

Definition at line 406 of file wm_event_types.hh.

Referenced by graph_slider_modal(), ViewOpsData_Utility::ViewOpsData_Utility(), WM_event_consecutive_gesture_test_break(), wm_event_do_region_handlers(), wm_event_drag_and_drop_test(), WM_event_type_mask_test(), wm_handlers_do(), and wm_handlers_do_gizmo_handler().

ISMOUSE

#define ISMOUSE

(

event_type

)

Value:

((event_type) >= _EVT_MOUSE_MIN && (event_type) <= _EVT_MOUSE_MAX)

Test whether the event is any kind: ISMOUSE_MOTION, ISMOUSE_BUTTON, ISMOUSE_WHEEL & ISMOUSE_GESTURE.

Note

It's best to use more specific check if possible as mixing motion/buttons/gestures is very broad and not necessarily obvious which kinds of events are important.

Definition at line 417 of file wm_event_types.hh.

Referenced by WM_event_type_mask_test(), wm_handlers_do_gizmo_handler(), and WM_keymap_item_map_type_get().

ISMOUSE_BUTTON

#define ISMOUSE_BUTTON

(

event_type

)

Value:

(ELEM(event_type, \
      LEFTMOUSE, \
      MIDDLEMOUSE, \
      RIGHTMOUSE, \
      BUTTON4MOUSE, \
      BUTTON5MOUSE, \
      BUTTON6MOUSE, \
      BUTTON7MOUSE))

Test whether the event is a mouse button (excluding mouse-wheel).

Definition at line 421 of file wm_event_types.hh.

Referenced by annotation_draw_modal(), blender::ed::transform::initTransInfo(), blender::ed::space_node::node_group_enter_exit_invoke(), blender::ed::object::object_transform_axis_target_modal(), ui_handle_menu_button(), wm_event_do_handlers(), WM_event_drag_threshold(), wm_event_is_double_click(), WM_event_is_mouse_drag(), WM_event_is_mouse_drag_or_press(), and wm_handler_ui_call().

ISMOUSE_GESTURE

#define ISMOUSE_GESTURE

(

event_type

)

Value:

((event_type) >= MOUSEPAN && (event_type) <= MOUSESMARTZOOM)

Test whether the event is a mouse (trackpad) gesture.

Definition at line 435 of file wm_event_types.hh.

Referenced by WM_event_consecutive_gesture_test(), WM_event_type_mask_test(), and wm_handlers_do().

ISMOUSE_MOTION

#define ISMOUSE_MOTION

(

event_type

)

Value:

ELEM(event_type, MOUSEMOVE, INBETWEEN_MOUSEMOVE)

Test whether the event is a mouse button (excluding mouse-wheel).

Definition at line 419 of file wm_event_types.hh.

Referenced by annotation_draw_modal(), curve_draw_modal(), curve_pen_modal(), blender::ed::curves::curves_draw_modal(), edbm_point_normals_modal(), eyedropper_modal(), blender::ed::sculpt_paint::paint_stroke_modal(), blender::ed::transform::transformEvent(), ui_do_but_HOTKEYEVT(), ui_do_but_KEYEVT(), ui_do_button(), ui_handler_panel_region(), walkEvent(), WM_event_consecutive_gesture_test_break(), wm_event_do_handlers(), wm_event_free(), WM_generic_select_modal(), wm_handlers_do(), and wm_handlers_do_intern().

ISMOUSE_WHEEL

#define ISMOUSE_WHEEL

(

event_type

)

Value:

(((event_type) >= WHEELUPMOUSE && (event_type) <= WHEELOUTMOUSE) || \
 ELEM((event_type), WHEELLEFTMOUSE, WHEELRIGHTMOUSE))

Test whether the event is a mouse wheel.

Definition at line 431 of file wm_event_types.hh.

Referenced by ui_colorpicker_wheel_cb(), WM_event_type_mask_test(), and wm_handlers_do().

ISNDOF

#define ISNDOF

(

event_type

)

Value:

((event_type) >= _NDOF_MIN && (event_type) <= _NDOF_MAX)

Test whether the event is a NDOF event.

Definition at line 438 of file wm_event_types.hh.

Referenced by WM_event_print(), WM_event_type_mask_test(), and WM_keymap_item_map_type_get().

ISNDOF_BUTTON

#define ISNDOF_BUTTON

(

event_type

)

Value:

((event_type) >= _NDOF_BUTTON_MIN && (event_type) <= _NDOF_BUTTON_MAX)

Definition at line 439 of file wm_event_types.hh.

Referenced by ui_popup_context_menu_for_button().

ISTIMER

#define ISTIMER

(

event_type

)

Value:

((event_type) >= TIMER && (event_type) <= _TIMER_MAX)

Test whether the event is timer event.

Definition at line 387 of file wm_event_types.hh.

Referenced by wm_event_always_pass(), WM_event_timer_add(), wm_handlers_do_intern(), and WM_keymap_item_map_type_get().

Enumeration Type Documentation

anonymous enum

anonymous enum

wmEvent.customdata type.

Enumerator
EVT_DATA_TIMER
EVT_DATA_DRAGDROP
EVT_DATA_NDOF_MOTION
EVT_DATA_XR

Definition at line 19 of file wm_event_types.hh.

anonymous enum

anonymous enum

Gesture Used in wmEvent.val

Note

These values are saved in keymap files, do not change them but just add new ones.

Enumerator
GESTURE_MODAL_CANCEL
GESTURE_MODAL_CONFIRM
GESTURE_MODAL_SELECT	Uses 'deselect' operator property.
GESTURE_MODAL_DESELECT
GESTURE_MODAL_NOP	Circle select: when no mouse button is pressed.
GESTURE_MODAL_CIRCLE_ADD	Circle select: larger brush.
GESTURE_MODAL_CIRCLE_SUB	Circle select: smaller brush.
GESTURE_MODAL_BEGIN	Box select/straight line, activate, use release to detect which button.
GESTURE_MODAL_IN	Uses 'zoom_out' operator property.
GESTURE_MODAL_OUT
GESTURE_MODAL_CIRCLE_SIZE	Circle select: size brush (for trackpad event).
GESTURE_MODAL_MOVE	Move selection area.
GESTURE_MODAL_SNAP	Toggle to activate snapping (angle snapping for straight line).
GESTURE_MODAL_FLIP	Toggle to activate flip (flip the active side of a straight line).

Definition at line 501 of file wm_event_types.hh.

anonymous enum

anonymous enum

Enumerator
EVT_FILESELECT_FULL_OPEN
EVT_FILESELECT_EXEC
EVT_FILESELECT_CANCEL
EVT_FILESELECT_EXTERNAL_CANCEL

Definition at line 487 of file wm_event_types.hh.

anonymous enum

anonymous enum

wmTabletData.active tablet active, matches GHOST_TTabletMode.

Typically access via event->tablet.active.

Enumerator
EVT_TABLET_NONE
EVT_TABLET_STYLUS
EVT_TABLET_ERASER

Definition at line 31 of file wm_event_types.hh.

eEventType_Mask

enum eEventType_Mask

Enumerator
EVT_TYPE_MASK_KEYBOARD_MODIFIER	ISKEYMODIFIER.
EVT_TYPE_MASK_KEYBOARD	ISKEYBOARD.
EVT_TYPE_MASK_MOUSE_WHEEL	ISMOUSE_WHEEL.
EVT_TYPE_MASK_MOUSE_GESTURE	ISMOUSE_BUTTON.
EVT_TYPE_MASK_MOUSE_BUTTON	ISMOUSE_GESTURE.
EVT_TYPE_MASK_MOUSE	ISMOUSE.
EVT_TYPE_MASK_NDOF	ISNDOF.
EVT_TYPE_MASK_ACTIONZONE	IS_EVENT_ACTIONZONE.

Definition at line 451 of file wm_event_types.hh.

wmEventType

enum wmEventType : int16_t

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.

Enumerator
EVENT_NONE
LEFTMOUSE
MIDDLEMOUSE
RIGHTMOUSE
MOUSEMOVE
BUTTON4MOUSE
BUTTON5MOUSE
BUTTON6MOUSE
BUTTON7MOUSE
MOUSEPAN
MOUSEZOOM
MOUSEROTATE
MOUSESMARTZOOM
WHEELUPMOUSE
WHEELDOWNMOUSE
WHEELINMOUSE
WHEELOUTMOUSE
INBETWEEN_MOUSEMOVE
WHEELLEFTMOUSE
WHEELRIGHTMOUSE
WM_IME_COMPOSITE_START
WM_IME_COMPOSITE_EVENT
WM_IME_COMPOSITE_END
TABLET_STYLUS
TABLET_ERASER
EVT_ZEROKEY
EVT_ONEKEY
EVT_TWOKEY
EVT_THREEKEY
EVT_FOURKEY
EVT_FIVEKEY
EVT_SIXKEY
EVT_SEVENKEY
EVT_EIGHTKEY
EVT_NINEKEY
EVT_AKEY
EVT_BKEY
EVT_CKEY
EVT_DKEY
EVT_EKEY
EVT_FKEY
EVT_GKEY
EVT_HKEY
EVT_IKEY
EVT_JKEY
EVT_KKEY
EVT_LKEY
EVT_MKEY
EVT_NKEY
EVT_OKEY
EVT_PKEY
EVT_QKEY
EVT_RKEY
EVT_SKEY
EVT_TKEY
EVT_UKEY
EVT_VKEY
EVT_WKEY
EVT_XKEY
EVT_YKEY
EVT_ZKEY
EVT_LEFTARROWKEY
EVT_DOWNARROWKEY
EVT_RIGHTARROWKEY
EVT_UPARROWKEY
EVT_PAD0
EVT_PAD1
EVT_PAD2
EVT_PAD3
EVT_PAD4
EVT_PAD5
EVT_PAD6
EVT_PAD7
EVT_PAD8
EVT_PAD9
EVT_PADASTERKEY
EVT_PADSLASHKEY
EVT_PADMINUS
EVT_PADENTER
EVT_PADPLUSKEY
EVT_PAUSEKEY
EVT_INSERTKEY
EVT_HOMEKEY
EVT_PAGEUPKEY
EVT_PAGEDOWNKEY
EVT_ENDKEY
EVT_UNKNOWNKEY
EVT_OSKEY	OS modifier, see: KM_OSKEY for details.
EVT_GRLESSKEY
EVT_MEDIAPLAY
EVT_MEDIASTOP
EVT_MEDIAFIRST
EVT_MEDIALAST
EVT_APPKEY
EVT_HYPER	Additional modifier, see: KM_HYPER for details.
EVT_PADPERIOD
EVT_CAPSLOCKKEY
EVT_LEFTCTRLKEY
EVT_LEFTALTKEY
EVT_RIGHTALTKEY
EVT_RIGHTCTRLKEY
EVT_RIGHTSHIFTKEY
EVT_LEFTSHIFTKEY
EVT_ESCKEY
EVT_TABKEY
EVT_RETKEY
EVT_SPACEKEY
EVT_LINEFEEDKEY
EVT_BACKSPACEKEY
EVT_DELKEY
EVT_SEMICOLONKEY
EVT_PERIODKEY
EVT_COMMAKEY
EVT_QUOTEKEY
EVT_ACCENTGRAVEKEY
EVT_MINUSKEY
EVT_PLUSKEY
EVT_SLASHKEY
EVT_BACKSLASHKEY
EVT_EQUALKEY
EVT_LEFTBRACKETKEY
EVT_RIGHTBRACKETKEY
EVT_F1KEY
EVT_F2KEY
EVT_F3KEY
EVT_F4KEY
EVT_F5KEY
EVT_F6KEY
EVT_F7KEY
EVT_F8KEY
EVT_F9KEY
EVT_F10KEY
EVT_F11KEY
EVT_F12KEY
EVT_F13KEY
EVT_F14KEY
EVT_F15KEY
EVT_F16KEY
EVT_F17KEY
EVT_F18KEY
EVT_F19KEY
EVT_F20KEY
EVT_F21KEY
EVT_F22KEY
EVT_F23KEY
EVT_F24KEY
NDOF_MOTION	Motion from 3D input (translation & rotation). Check WM_EVENT_IS_CONSECUTIVE to detect motion events.
NDOF_BUTTON_MENU
NDOF_BUTTON_FIT
NDOF_BUTTON_TOP
NDOF_BUTTON_BOTTOM
NDOF_BUTTON_LEFT
NDOF_BUTTON_RIGHT
NDOF_BUTTON_FRONT
NDOF_BUTTON_BACK
NDOF_BUTTON_ISO1
NDOF_BUTTON_ISO2
NDOF_BUTTON_ROLL_CW
NDOF_BUTTON_ROLL_CCW
NDOF_BUTTON_SPIN_CW
NDOF_BUTTON_SPIN_CCW
NDOF_BUTTON_TILT_CW
NDOF_BUTTON_TILT_CCW
NDOF_BUTTON_ROTATE
NDOF_BUTTON_PANZOOM
NDOF_BUTTON_DOMINANT
NDOF_BUTTON_PLUS
NDOF_BUTTON_MINUS
NDOF_BUTTON_V1
NDOF_BUTTON_V2
NDOF_BUTTON_V3
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
NDOF_BUTTON_11
NDOF_BUTTON_12
NDOF_BUTTON_SAVE_V1
NDOF_BUTTON_SAVE_V2
NDOF_BUTTON_SAVE_V3
WINDEACTIVATE
TIMER
TIMER0
TIMER1
TIMER2
TIMERJOBS
TIMERAUTOSAVE
TIMERREPORT
TIMERREGION
TIMERNOTIFIER
EVT_ACTIONZONE_AREA
EVT_ACTIONZONE_REGION
EVT_ACTIONZONE_FULLSCREEN
EVT_FILESELECT
EVT_BUT_OPEN
EVT_MODAL_MAP
EVT_DROP
EVT_BUT_CANCEL
EVT_GIZMO_UPDATE
EVT_XR_ACTION

Definition at line 43 of file wm_event_types.hh.

Function Documentation

WM_event_type_mask_test()

bool WM_event_type_mask_test	(	int	event_type,
		enum eEventType_Mask	mask )

Definition at line 192 of file wm_event_query.cc.

References EVT_TYPE_MASK_ACTIONZONE, EVT_TYPE_MASK_KEYBOARD, EVT_TYPE_MASK_KEYBOARD_MODIFIER, EVT_TYPE_MASK_MOUSE, EVT_TYPE_MASK_MOUSE_GESTURE, EVT_TYPE_MASK_MOUSE_WHEEL, EVT_TYPE_MASK_NDOF, IS_EVENT_ACTIONZONE, ISKEYBOARD, ISKEYMODIFIER, ISMOUSE, ISMOUSE_GESTURE, ISMOUSE_WHEEL, ISNDOF, and mask().

Referenced by kmi_filter_is_visible_type_mask().