Blender: wmKeyMapItem Struct Reference

Blender V4.3

#include <DNA_windowmanager_types.h>

Public Attributes
struct wmKeyMapItem *	next

struct wmKeyMapItem *	prev

char	idname [64]

IDProperty *	properties

char	propvalue_str [64]

short	propvalue

short	type

int8_t	val

int8_t	direction

short	shift

short	ctrl

short	alt

short	oskey

short	keymodifier

short	flag

short	maptype

short	id

char	_pad [2]

struct PointerRNA *	ptr

Detailed Description

Partial copy of the event, for matching by event handler.

Definition at line 448 of file DNA_windowmanager_types.h.

Member Data Documentation

◆ _pad

char wmKeyMapItem::_pad[2]

Definition at line 486 of file DNA_windowmanager_types.h.

◆ alt

short wmKeyMapItem::alt

Definition at line 474 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), keymap_item_can_collapse(), WorkspaceStatus::opmodal(), ui_but_update_ex(), UI_icon_from_keymap_item(), ViewOpsData_Utility::ViewOpsData_Utility(), wm_eventmatch(), WM_keymap_item_compare(), WM_keymap_item_restore_to_default(), WM_keymap_item_to_string(), and wm_keymap_item_uses_modifier().

◆ ctrl

short wmKeyMapItem::ctrl

Definition at line 474 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), keymap_item_can_collapse(), WorkspaceStatus::opmodal(), ui_but_update_ex(), UI_icon_from_keymap_item(), ViewOpsData_Utility::ViewOpsData_Utility(), wm_eventmatch(), WM_keymap_item_compare(), WM_keymap_item_restore_to_default(), WM_keymap_item_to_string(), and wm_keymap_item_uses_modifier().

◆ direction

int8_t wmKeyMapItem::direction

The 2D direction of the event to use when val == KM_CLICK_DRAG. Set to KM_DIRECTION_N, KM_DIRECTION_S & related values, KM_NOTHING for any direction.

Definition at line 472 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), keymap_item_update_tweak_event(), wm_eventmatch(), and WM_keymap_item_compare().

◆ flag

short wmKeyMapItem::flag

Definition at line 479 of file DNA_windowmanager_types.h.

Referenced by direct_link_keymapitem(), wm_eventmatch(), WM_keyconfig_update_tag(), wm_keymap_diff(), WM_keymap_item_compare(), wm_keymap_item_copy(), WM_keymap_item_restore_to_default(), and wm_keymap_patch().

◆ id

short wmKeyMapItem::id

Unique identifier. Positive for kmi that override builtins, negative otherwise.

Definition at line 485 of file DNA_windowmanager_types.h.

Referenced by keymap_item_set_id(), menu_add_shortcut(), WM_keymap_item_restore_to_default(), wm_keymap_patch(), and wm_keymap_patch_update().

◆ idname

char wmKeyMapItem::idname[64]

Used to retrieve operator type pointer.

Definition at line 453 of file DNA_windowmanager_types.h.

Referenced by keymap_handler_log_kmi_op_str(), keymap_item_has_invalid_wm_context_data_path(), WM_keymap_add_item(), wm_keymap_item_copy(), wm_keymap_item_properties_set(), wm_keymap_item_properties_update_ot(), WM_keymap_item_restore_to_default(), and WM_window_cursor_keymap_status_refresh().

◆ keymodifier

short wmKeyMapItem::keymodifier

Raw-key modifier.

Definition at line 476 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), ViewOpsData_Utility::ViewOpsData_Utility(), wm_eventmatch(), WM_keymap_item_compare(), WM_keymap_item_restore_to_default(), and WM_keymap_item_to_string().

◆ maptype

short wmKeyMapItem::maptype

Keymap editor.

Definition at line 483 of file DNA_windowmanager_types.h.

Referenced by WM_keymap_item_restore_to_default().

◆ next

struct wmKeyMapItem* wmKeyMapItem::next

Definition at line 449 of file DNA_windowmanager_types.h.

Referenced by BKE_keyconfig_keymap_filter_item(), wm_keymap_item_copy(), and wm_modalkeymap_find_propvalue_iter().

◆ oskey

short wmKeyMapItem::oskey

Definition at line 474 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), keymap_item_can_collapse(), WorkspaceStatus::opmodal(), ui_but_update_ex(), UI_icon_from_keymap_item(), ViewOpsData_Utility::ViewOpsData_Utility(), wm_eventmatch(), WM_keymap_item_compare(), WM_keymap_item_restore_to_default(), WM_keymap_item_to_string(), and wm_keymap_item_uses_modifier().

◆ prev

struct wmKeyMapItem * wmKeyMapItem::prev

Definition at line 449 of file DNA_windowmanager_types.h.

Referenced by wm_keymap_item_copy().

◆ properties

IDProperty* wmKeyMapItem::properties

Operator properties, assigned to ptr->data and can be written to a file.

Definition at line 455 of file DNA_windowmanager_types.h.

Referenced by direct_link_keymapitem(), keymap_handler_log_kmi_op_str(), keymap_item_free(), keymap_item_free(), keymap_item_has_invalid_wm_context_data_path(), wm_keymap_item_clear_runtime(), wm_keymap_item_copy(), wm_keymap_item_free_data(), WM_keymap_item_properties_reset(), wm_keymap_item_properties_set(), wm_keymap_item_properties_update_ot(), WM_keymap_item_restore_to_default(), WM_keymap_remove_item(), and write_keymapitem().

◆ propvalue

short wmKeyMapItem::propvalue

If used, the item is from modal map.

Definition at line 461 of file DNA_windowmanager_types.h.

Referenced by wm_event_modalkeymap_begin(), WM_keymap_item_restore_to_default(), WM_modalkeymap_add_item(), and wm_modalkeymap_find_propvalue_iter().

◆ propvalue_str

char wmKeyMapItem::propvalue_str[64]

Runtime temporary storage for loading.

Definition at line 459 of file DNA_windowmanager_types.h.

Referenced by WM_modalkeymap_add_item_str().

◆ ptr

struct PointerRNA* wmKeyMapItem::ptr

RNA pointer to access properties.

Note: The ptr.owner_id value must be NULL, as a signal not to use the context when running property callbacks such as ENUM item functions.

Definition at line 493 of file DNA_windowmanager_types.h.

Referenced by direct_link_keymapitem(), keymap_handler_log_kmi_op_str(), keymap_item_free(), keymap_item_free(), WM_gizmogroup_keymap_template_select_ex(), WM_keymap_add_menu(), WM_keymap_add_menu_pie(), WM_keymap_add_panel(), WM_keymap_add_tool(), wm_keymap_item_clear_runtime(), wm_keymap_item_copy(), wm_keymap_item_find(), wm_keymap_item_free_data(), WM_keymap_item_properties_reset(), wm_keymap_item_properties_set(), wm_keymap_item_properties_update_ot(), WM_keymap_item_restore_to_default(), WM_keymap_remove_item(), and WM_window_cursor_keymap_status_refresh().

◆ shift

short wmKeyMapItem::shift

oskey also known as apple, windows-key or super.

Definition at line 474 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), keymap_item_can_collapse(), WorkspaceStatus::opmodal(), ui_but_update_ex(), UI_icon_from_keymap_item(), ViewOpsData_Utility::ViewOpsData_Utility(), wm_eventmatch(), WM_keymap_item_compare(), WM_keymap_item_restore_to_default(), WM_keymap_item_to_string(), and wm_keymap_item_uses_modifier().

◆ type

short wmKeyMapItem::type

Event code itself (EVT_LEFTCTRLKEY, LEFTMOUSE etc).

Definition at line 465 of file DNA_windowmanager_types.h.

Referenced by do_version_select_mouse(), keymap_event_set(), keymap_item_update_tweak_event(), kmi_filter_is_visible(), kmi_filter_is_visible_type_mask(), WorkspaceStatus::opmodal(), shrinkfatten_handleEvent(), UI_icon_from_keymap_item(), ui_popup_context_menu_for_button(), uiTemplateEventFromKeymapItem(), wm_eventmatch(), WM_keymap_item_compare(), WM_keymap_item_map_type_get(), WM_keymap_item_restore_to_default(), and WM_keymap_item_to_string().

◆ val

int8_t wmKeyMapItem::val

Button state (KM_ANY, KM_PRESS, KM_DBL_CLICK, KM_CLICK_DRAG, KM_NOTHING etc).

Definition at line 467 of file DNA_windowmanager_types.h.

Referenced by do_version_select_mouse(), keymap_event_set(), keymap_item_update_tweak_event(), WorkspaceStatus::opmodal(), shrinkfatten_handleEvent(), UI_icon_from_keymap_item(), uiTemplateStatusBarModalItem(), wm_eventmatch(), WM_keymap_item_compare(), WM_keymap_item_restore_to_default(), and WM_keymap_item_to_string().

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

DNA_windowmanager_types.h