KeyMapItem_Params Struct Reference

#include <WM_keymap.hh>

Public Attributes
int16_t	type
int8_t	value
int16_t	modifier
int16_t	keymodifier
int8_t	direction

Detailed Description

Keymap. Parameters for matching events, passed into functions that create key-map items.

Definition at line 56 of file WM_keymap.hh.

Member Data Documentation

direction

int8_t KeyMapItem_Params::direction

wmKeyMapItem.direction.

Definition at line 77 of file WM_keymap.hh.

Referenced by keymap_event_set(), menu_add_shortcut(), WM_gizmogroup_keymap_template_select_ex(), and wm_gizmogroup_tweak_modal_keymap().

keymodifier

int16_t KeyMapItem_Params::keymodifier

wmKeyMapItem.keymodifier.

Definition at line 75 of file WM_keymap.hh.

Referenced by keymap_event_set().

modifier

int16_t KeyMapItem_Params::modifier

This value is used to initialize wmKeyMapItem ctrl, shift, alt, oskey, hyper.

Valid values:

• Combinations of: KM_SHIFT, KM_CTRL, KM_ALT, KM_OSKEY, KM_HYPER. Are mapped to KM_MOD_HELD.
• Combinations of the modifier flags bit-shifted using KMI_PARAMS_MOD_TO_ANY. Are mapped to KM_ANY.
• The value KM_ANY is represents all modifiers being set to KM_ANY.

Definition at line 72 of file WM_keymap.hh.

Referenced by keymap_event_set(), menu_add_shortcut(), WM_gizmogroup_keymap_template_select_ex(), and wm_gizmogroup_tweak_modal_keymap().

type

int16_t KeyMapItem_Params::type

wmKeyMapItem.type.

Definition at line 58 of file WM_keymap.hh.

Referenced by keymap_event_set(), menu_add_shortcut(), WM_gizmogroup_keymap_template_select_ex(), and wm_gizmogroup_tweak_modal_keymap().

value

int8_t KeyMapItem_Params::value

wmKeyMapItem.val.

Definition at line 60 of file WM_keymap.hh.

Referenced by keymap_event_set(), menu_add_shortcut(), WM_gizmogroup_keymap_template_select_ex(), and wm_gizmogroup_tweak_modal_keymap().

---

The documentation for this struct was generated from the following file:

• WM_keymap.hh