wmKeyMap Struct Reference

#include <DNA_windowmanager_types.h>

Public Attributes
struct wmKeyMap *	next
struct wmKeyMap *	prev
ListBase	items
ListBase	diff_items
char	idname [64]
short	spaceid
short	regionid
char	owner_id [128]
short	flag
short	kmi_id
bool(*	poll )(struct bContext *)
bool(*	poll_modal_item )(const struct wmOperator *op, int value)
const void *	modal_items

Detailed Description

Stored in WM, the actively used key-maps.

Definition at line 539 of file DNA_windowmanager_types.h.

Member Data Documentation

diff_items

ListBase wmKeyMap::diff_items

Definition at line 543 of file DNA_windowmanager_types.h.

Referenced by BKE_keyconfig_keymap_filter_item(), WM_keymap_clear(), wm_keymap_copy(), wm_keymap_diff(), wm_keymap_diff_update(), and wm_keymap_patch().

flag

short wmKeyMap::flag

General flags.

Definition at line 555 of file DNA_windowmanager_types.h.

Referenced by keymap_item_set_id(), topbar_main_region_init(), WM_keyconfig_update_ex(), WM_keyconfig_update_tag(), wm_keymap_copy(), wm_keymap_diff_update(), wm_keymap_patch_update(), wm_keymap_test_and_clear_update(), WM_modalkeymap_ensure(), wm_modalkeymap_find_propvalue_iter(), and wm_user_modal_keymap_set_items().

idname

char wmKeyMap::idname[64]

Global editor keymaps, or for more per space/region.

Definition at line 546 of file DNA_windowmanager_types.h.

Referenced by wm_handlers_do_keymap_with_gizmo_handler(), wm_handlers_do_keymap_with_keymap_handler(), WM_keymap_active(), wm_keymap_diff_update(), wm_keymap_item_find(), wm_keymap_item_find_in_keymap(), WM_keymap_item_restore_to_default(), wm_keymap_new(), wm_keymap_patch_update(), WM_keymap_poll(), wm_keymap_preset(), WM_keymap_restore_to_default(), WM_modalkeymap_ensure(), and wm_user_modal_keymap_set_items().

items

ListBase wmKeyMap::items

Definition at line 542 of file DNA_windowmanager_types.h.

Referenced by BKE_keyconfig_keymap_filter_item(), initTransform(), initTransInfo(), keymap_item_from_enum_item(), menu_types_add_from_keymap_items(), ui_tooltip_data_from_tool(), v3d_cursor_is_snap_invert(), ViewOpsData_Utility::ViewOpsData_Utility(), WM_event_match_keymap_item(), wm_eventmatch_modal_keymap_items(), WM_gizmogroup_keymap_template_select_ex(), wm_handlers_do_gizmo_handler(), wm_handlers_do_keymap_with_gizmo_handler(), wm_handlers_do_keymap_with_keymap_handler(), WM_keymap_add_item(), WM_keymap_add_item_copy(), wm_keymap_addon_add(), WM_keymap_clear(), wm_keymap_copy(), wm_keymap_diff(), wm_keymap_find_item_equals(), wm_keymap_find_item_equals_result(), WM_keymap_item_find_id(), wm_keymap_item_find_in_keymap(), wm_keymap_patch(), wm_keymap_patch_update(), WM_keymap_poll(), WM_keymap_remove_item(), wm_keymap_test_and_clear_update(), WM_keymap_uses_event_modifier(), WM_modalkeymap_add_item(), WM_modalkeymap_add_item_str(), wm_modalkeymap_find_propvalue_iter(), wm_user_modal_keymap_set_items(), and ViewOpsData_Utility::~ViewOpsData_Utility().

kmi_id

short wmKeyMap::kmi_id

Last kmi id.

Definition at line 557 of file DNA_windowmanager_types.h.

Referenced by keymap_item_set_id(), and wm_keymap_patch_update().

modal_items

const void* wmKeyMap::modal_items

For modal, EnumPropertyItem for now.

Definition at line 565 of file DNA_windowmanager_types.h.

Referenced by bevel_modal_keymap(), curve_pen_modal_keymap(), ED_filltool_modal_keymap(), ED_interpolatetool_modal_keymap(), ED_primitivetool_modal_keymap(), eyedropper_colorband_modal_keymap(), eyedropper_modal_keymap(), fly_modal_keymap(), gesture_box_modal_keymap(), gesture_circle_modal_keymap(), gesture_lasso_modal_keymap(), gesture_polyline_modal_keymap(), gesture_straightline_modal_keymap(), gesture_zoom_border_modal_keymap(), knifetool_modal_keymap(), blender::ed::sculpt_paint::expand::modal_keymap(), blender::ed::sculpt_paint::filter::modal_keymap(), blender::ed::space_node::node_link_modal_keymap(), point_normals_modal_keymap(), v3d_cursor_snap_activate(), viewdolly_modal_keymap(), viewmove_modal_keymap(), viewplace_modal_keymap(), viewrotate_modal_keymap(), viewzoom_modal_keymap(), walk_modal_keymap(), wm_gizmogroup_tweak_modal_keymap(), WM_keyconfig_update_ex(), wm_keymap_copy(), WM_modalkeymap_ensure(), wm_user_modal_keymap_set_items(), and WM_window_modal_keymap_status_draw().

next

struct wmKeyMap* wmKeyMap::next

Definition at line 540 of file DNA_windowmanager_types.h.

owner_id

char wmKeyMap::owner_id[128]

Optional, see: wmOwnerID.

Definition at line 552 of file DNA_windowmanager_types.h.

Referenced by wm_keymap_new(), and WM_keymap_poll().

poll

bool(* wmKeyMap::poll) (struct bContext *)

Verify if enabled in the current context, use WM_keymap_poll instead of direct calls.

Definition at line 561 of file DNA_windowmanager_types.h.

Referenced by ED_keymap_armature(), ED_keymap_curve(), ED_keymap_lattice(), ED_keymap_mask(), ED_keymap_mesh(), ED_keymap_metaball(), ED_keymap_paint(), ED_keymap_uvedit(), blender::ed::curves::keymap_curves(), blender::ed::greasepencil::keymap_grease_pencil_brush_stroke(), blender::ed::greasepencil::keymap_grease_pencil_edit_mode(), blender::ed::greasepencil::keymap_grease_pencil_fill_tool(), blender::ed::greasepencil::keymap_grease_pencil_paint_mode(), blender::ed::greasepencil::keymap_grease_pencil_sculpt_mode(), blender::ed::greasepencil::keymap_grease_pencil_selection(), blender::ed::greasepencil::keymap_grease_pencil_vertex_paint_mode(), blender::ed::greasepencil::keymap_grease_pencil_weight_paint_mode(), blender::ed::object::keymap_object(), keymap_particle(), WM_keyconfig_update_ex(), wm_keymap_copy(), WM_keymap_poll(), WM_modalkeymap_ensure(), and wm_user_modal_keymap_set_items().

poll_modal_item

bool(* wmKeyMap::poll_modal_item) (const struct wmOperator *op, int value)

Definition at line 562 of file DNA_windowmanager_types.h.

Referenced by transform_modal_keymap(), wm_eventmatch_modal_keymap_items(), WM_keyconfig_update_ex(), wm_keymap_copy(), WM_modalkeymap_ensure(), wm_user_modal_keymap_set_items(), and WM_window_modal_keymap_status_draw().

prev

struct wmKeyMap * wmKeyMap::prev

Definition at line 540 of file DNA_windowmanager_types.h.

regionid

short wmKeyMap::regionid

See above.

Definition at line 550 of file DNA_windowmanager_types.h.

Referenced by WM_keymap_active(), wm_keymap_diff_update(), WM_keymap_item_restore_to_default(), wm_keymap_new(), wm_keymap_patch_update(), wm_keymap_preset(), and WM_keymap_restore_to_default().

spaceid

short wmKeyMap::spaceid

Same IDs as in DNA_space_types.h.

Definition at line 548 of file DNA_windowmanager_types.h.

Referenced by WM_keymap_active(), wm_keymap_diff_update(), WM_keymap_item_restore_to_default(), wm_keymap_new(), wm_keymap_patch_update(), wm_keymap_preset(), and WM_keymap_restore_to_default().

---

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

• DNA_windowmanager_types.h