Blender: wmKeyMapItem Struct Reference

Blender V5.0

#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
int8_t	shift
int8_t	ctrl
int8_t	alt
int8_t	oskey
int8_t	hyper
char	_pad0 [7]
short	keymodifier
uint8_t	flag
uint8_t	maptype
short	id
struct PointerRNA *	ptr

Detailed Description

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

Definition at line 341 of file DNA_windowmanager_types.h.

Member Data Documentation

◆ _pad0

char wmKeyMapItem::_pad0[7]

Definition at line 382 of file DNA_windowmanager_types.h.

◆ alt

int8_t wmKeyMapItem::alt

Definition at line 376 of file DNA_windowmanager_types.h.

Referenced by blo_do_versions_userdef(), 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_equals(), WM_keymap_item_restore_to_default(), WM_keymap_item_to_string(), and wm_keymap_item_uses_modifier().

◆ ctrl

int8_t wmKeyMapItem::ctrl

Definition at line 375 of file DNA_windowmanager_types.h.

Referenced by blo_do_versions_userdef(), 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_equals(), 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_PRESS_DRAG. Set to KM_DIRECTION_N, KM_DIRECTION_S & related values, KM_NOTHING for any direction.

Definition at line 365 of file DNA_windowmanager_types.h.

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

◆ flag

uint8_t wmKeyMapItem::flag

Definition at line 388 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_equals(), wm_keymap_item_equals_result(), WM_keymap_item_restore_to_default(), and wm_keymap_patch().

◆ hyper

int8_t wmKeyMapItem::hyper

See KM_HYPER for details.

Definition at line 380 of file DNA_windowmanager_types.h.

Referenced by blo_do_versions_userdef(), 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_equals(), WM_keymap_item_restore_to_default(), WM_keymap_item_to_string(), and wm_keymap_item_uses_modifier().

◆ id

short wmKeyMapItem::id

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

Definition at line 394 of file DNA_windowmanager_types.h.

Referenced by keymap_item_set_id(), menu_add_shortcut(), WM_keymap_item_find_match(), 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 346 of file DNA_windowmanager_types.h.

Referenced by do_version_keyframe_jump(), keymap_handler_log_kmi_op_str(), keymap_item_has_invalid_wm_context_data_path(), keymap_update_brushes_handle_add_item(), keymap_update_brushes_handle_remove_item(), WM_keymap_add_item(), wm_keymap_item_copy(), wm_keymap_item_equals_result(), 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 385 of file DNA_windowmanager_types.h.

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

◆ maptype

uint8_t wmKeyMapItem::maptype

Keymap editor.

Definition at line 392 of file DNA_windowmanager_types.h.

Referenced by wm_keymap_item_equals(), and WM_keymap_item_restore_to_default().

◆ next

struct wmKeyMapItem* wmKeyMapItem::next

Definition at line 342 of file DNA_windowmanager_types.h.

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

◆ oskey

int8_t wmKeyMapItem::oskey

Also known as "Apple", "Windows-Key" or "Super.

Definition at line 378 of file DNA_windowmanager_types.h.

Referenced by blo_do_versions_userdef(), 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_equals(), 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 342 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 348 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(), keymap_update_brushes_handle_add_item(), keymap_update_brushes_handle_remove_item(), 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 354 of file DNA_windowmanager_types.h.

Referenced by wm_event_modalkeymap_begin(), wm_keymap_item_equals_result(), 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 352 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 401 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_equals_result(), 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

int8_t wmKeyMapItem::shift

Definition at line 374 of file DNA_windowmanager_types.h.

Referenced by blo_do_versions_userdef(), 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_equals(), WM_keymap_item_restore_to_default(), WM_keymap_item_to_string(), and wm_keymap_item_uses_modifier().

◆ type

◆ val

int8_t wmKeyMapItem::val

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

DNA_windowmanager_types.h