wmKeyMapItem Struct Reference

#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
short	val
short	shift
short	ctrl
short	alt
short	oskey
short	keymodifier
short	flag
short	maptype
short	id
char	_pad [2]
struct PointerRNA *	ptr

Detailed Description

Definition at line 349 of file DNA_windowmanager_types.h.

Member Data Documentation

_pad

char wmKeyMapItem::_pad[2]

Definition at line 382 of file DNA_windowmanager_types.h.

alt

short wmKeyMapItem::alt

Definition at line 370 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), UI_icon_from_keymap_item(), 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

short wmKeyMapItem::ctrl

Definition at line 370 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), UI_icon_from_keymap_item(), 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().

flag

short wmKeyMapItem::flag

Definition at line 375 of file DNA_windowmanager_types.h.

Referenced by direct_link_keymapitem(), initTransform(), 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(), wm_keymap_patch(), and wm_keymap_test_and_clear_update().

id

short wmKeyMapItem::id

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

Definition at line 381 of file DNA_windowmanager_types.h.

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

Referenced by keymap_item_has_invalid_wm_context_data_path(), 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 372 of file DNA_windowmanager_types.h.

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

maptype

short wmKeyMapItem::maptype

Keymap editor.

Definition at line 379 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 350 of file DNA_windowmanager_types.h.

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

oskey

short wmKeyMapItem::oskey

Definition at line 370 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), UI_icon_from_keymap_item(), 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 350 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 356 of file DNA_windowmanager_types.h.

Referenced by direct_link_keymapitem(), keymap_item_free(), keymap_item_has_invalid_wm_context_data_path(), wm_keymap_item_copy(), wm_keymap_item_free(), WM_keymap_item_properties_reset(), wm_keymap_item_properties_set(), wm_keymap_item_properties_update_ot(), WM_keymap_item_restore_to_default(), and write_keymapitem().

propvalue

short wmKeyMapItem::propvalue

If used, the item is from modal map.

Definition at line 362 of file DNA_windowmanager_types.h.

Referenced by initTransform(), wm_event_modalkeymap_begin(), wm_keymap_item_equals_result(), WM_keymap_item_restore_to_default(), WM_modalkeymap_add_item(), wm_modalkeymap_find_propvalue_iter(), and WM_window_modal_keymap_status_draw().

propvalue_str

char wmKeyMapItem::propvalue_str[64]

Runtime temporary storage for loading.

Definition at line 360 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 389 of file DNA_windowmanager_types.h.

Referenced by direct_link_keymapitem(), keymap_item_free(), WM_gizmogroup_keymap_template_select_ex(), WM_keymap_add_context_enum_set_items(), WM_keymap_add_menu(), WM_keymap_add_menu_pie(), WM_keymap_add_panel(), WM_keymap_add_tool(), wm_keymap_item_copy(), wm_keymap_item_equals_result(), wm_keymap_item_find(), wm_keymap_item_free(), 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 is apple or windowskey, value denotes order of pressed.

Definition at line 370 of file DNA_windowmanager_types.h.

Referenced by keymap_event_set(), UI_icon_from_keymap_item(), 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

short wmKeyMapItem::type

Event code itself.

Definition at line 366 of file DNA_windowmanager_types.h.

Referenced by do_version_select_mouse(), initTransform(), keymap_event_set(), kmi_filter_is_visible(), kmi_filter_is_visible_type_mask(), seq_slide_handleEvent(), shrinkfatten_handleEvent(), UI_icon_from_keymap_item(), ui_popup_context_menu_for_button(), uiTemplateEventFromKeymapItem(), wm_eventmatch(), WM_keymap_item_compare(), wm_keymap_item_equals(), WM_keymap_item_map_type_get(), WM_keymap_item_restore_to_default(), and WM_keymap_item_to_string().

val

short wmKeyMapItem::val

KM_ANY, KM_PRESS, KM_NOTHING etc.

Definition at line 368 of file DNA_windowmanager_types.h.

Referenced by initTransform(), keymap_event_set(), seq_slide_handleEvent(), shrinkfatten_handleEvent(), UI_icon_from_keymap_item(), wm_eventmatch(), WM_keymap_item_compare(), wm_keymap_item_equals(), WM_keymap_item_restore_to_default(), WM_keymap_item_to_string(), and WM_window_modal_keymap_status_draw().

---

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

• DNA_windowmanager_types.h