wm_keymap_utils.cc File Reference

#include <cstring>
#include "DNA_object_types.h"
#include "DNA_space_types.h"
#include "DNA_userdef_types.h"
#include "DNA_windowmanager_types.h"
#include "BLI_listbase.h"
#include "BLI_utildefines.h"
#include "BKE_context.hh"
#include "RNA_access.hh"
#include "WM_api.hh"
#include "WM_types.hh"

Go to the source code of this file.

Functions
Wrappers for #WM_keymap_add_item
wmKeyMapItem *	WM_keymap_add_menu (wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
wmKeyMapItem *	WM_keymap_add_menu_pie (wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
wmKeyMapItem *	WM_keymap_add_panel (wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
wmKeyMapItem *	WM_keymap_add_tool (wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
Introspection
wmKeyMap *	WM_keymap_guess_from_context (const bContext *C)
wmKeyMap *	WM_keymap_guess_opname (const bContext *C, const char *opname)
static bool	wm_keymap_item_uses_modifier (const wmKeyMapItem *kmi, const int event_modifier)
bool	WM_keymap_uses_event_modifier (const wmKeyMap *keymap, const int event_modifier)
void	WM_keymap_fix_linking ()

Detailed Description

Utilities to help define keymaps.

Definition in file wm_keymap_utils.cc.

Function Documentation

WM_keymap_add_menu()

wmKeyMapItem * WM_keymap_add_menu	(	wmKeyMap *	keymap,
		const char *	idname,
		const KeyMapItem_Params *	params )

Menu wrapper for WM_keymap_add_item.

Definition at line 34 of file wm_keymap_utils.cc.

References params, wmKeyMapItem::ptr, RNA_string_set(), and WM_keymap_add_item().

WM_keymap_add_menu_pie()

wmKeyMapItem * WM_keymap_add_menu_pie	(	wmKeyMap *	keymap,
		const char *	idname,
		const KeyMapItem_Params *	params )

Pie-menu wrapper for WM_keymap_add_item.

Definition at line 43 of file wm_keymap_utils.cc.

References params, wmKeyMapItem::ptr, RNA_string_set(), and WM_keymap_add_item().

WM_keymap_add_panel()

wmKeyMapItem * WM_keymap_add_panel	(	wmKeyMap *	keymap,
		const char *	idname,
		const KeyMapItem_Params *	params )

Panel (popover) wrapper for WM_keymap_add_item.

Definition at line 52 of file wm_keymap_utils.cc.

References params, wmKeyMapItem::ptr, RNA_boolean_set(), RNA_string_set(), and WM_keymap_add_item().

WM_keymap_add_tool()

wmKeyMapItem * WM_keymap_add_tool	(	wmKeyMap *	keymap,
		const char *	idname,
		const KeyMapItem_Params *	params )

Tool wrapper for WM_keymap_add_item.

Definition at line 63 of file wm_keymap_utils.cc.

References params, wmKeyMapItem::ptr, RNA_string_set(), and WM_keymap_add_item().

WM_keymap_fix_linking()

void WM_keymap_fix_linking

(

)

Definition at line 549 of file wm_keymap_utils.cc.

Referenced by wm_window_keymap().

WM_keymap_guess_from_context()

wmKeyMap * WM_keymap_guess_from_context

(

const bContext *

C

)

Definition at line 78 of file wm_keymap_utils.cc.

References BLI_assert, CTX_data_mode_enum(), CTX_MODE_EDIT_ARMATURE, CTX_MODE_EDIT_CURVE, CTX_MODE_EDIT_CURVES, CTX_MODE_EDIT_GPENCIL_LEGACY, CTX_MODE_EDIT_GREASE_PENCIL, CTX_MODE_EDIT_LATTICE, CTX_MODE_EDIT_MESH, CTX_MODE_EDIT_METABALL, CTX_MODE_EDIT_POINT_CLOUD, CTX_MODE_EDIT_SURFACE, CTX_MODE_EDIT_TEXT, CTX_MODE_OBJECT, CTX_MODE_PAINT_GPENCIL_LEGACY, CTX_MODE_PAINT_GREASE_PENCIL, CTX_MODE_PAINT_TEXTURE, CTX_MODE_PAINT_VERTEX, CTX_MODE_PAINT_WEIGHT, CTX_MODE_PARTICLE, CTX_MODE_POSE, CTX_MODE_SCULPT, CTX_MODE_SCULPT_CURVES, CTX_MODE_SCULPT_GPENCIL_LEGACY, CTX_MODE_SCULPT_GREASE_PENCIL, CTX_MODE_VERTEX_GPENCIL_LEGACY, CTX_MODE_VERTEX_GREASE_PENCIL, CTX_MODE_WEIGHT_GPENCIL_LEGACY, CTX_MODE_WEIGHT_GREASE_PENCIL, CTX_wm_manager(), CTX_wm_space_data(), SpaceImage::mode, RGN_TYPE_WINDOW, SEQ_VIEW_PREVIEW, SEQ_VIEW_SEQUENCE, SEQ_VIEW_SEQUENCE_PREVIEW, SI_MODE_MASK, SI_MODE_PAINT, SI_MODE_UV, SI_MODE_VIEW, SPACE_EMPTY, SPACE_IMAGE, SPACE_SEQ, SPACE_VIEW3D, SpaceLink::spacetype, SpaceSeq::view, and WM_keymap_find_all().

Referenced by WM_keymap_guess_opname().

WM_keymap_guess_opname()

wmKeyMap * WM_keymap_guess_opname	(	const bContext *	C,
		const char *	opname )

Guess an appropriate key-map from the operator name.

Note

Needs to be kept up to date with Key-map and Operator naming.

Definition at line 213 of file wm_keymap_utils.cc.

References CTX_data_mode_enum(), CTX_MODE_EDIT_CURVES, CTX_MODE_EDIT_MESH, CTX_MODE_EDIT_POINT_CLOUD, CTX_MODE_OBJECT, CTX_MODE_POSE, CTX_MODE_SCULPT, CTX_MODE_SCULPT_CURVES, CTX_wm_manager(), CTX_wm_space_data(), RGN_TYPE_WINDOW, SPACE_ACTION, SPACE_EMPTY, SPACE_GRAPH, SPACE_IMAGE, SPACE_NLA, SPACE_NODE, SPACE_SEQ, SPACE_VIEW3D, SpaceLink::spacetype, STREQ, STRPREFIX, WM_keymap_find_all(), WM_keymap_guess_from_context(), and WM_keymap_poll().

Referenced by menu_add_shortcut(), menu_add_shortcut_cancel(), and ui_popup_context_menu_for_button().

wm_keymap_item_uses_modifier()

static bool wm_keymap_item_uses_modifier ( const wmKeyMapItem * kmi, const int event_modifier )

static

Definition at line 509 of file wm_keymap_utils.cc.

References wmKeyMapItem::alt, wmKeyMapItem::ctrl, KM_ALT, KM_ANY, KM_CTRL, KM_NOTHING, KM_OSKEY, KM_SHIFT, wmKeyMapItem::oskey, and wmKeyMapItem::shift.

Referenced by WM_keymap_uses_event_modifier().

WM_keymap_uses_event_modifier()

bool WM_keymap_uses_event_modifier	(	const wmKeyMap *	keymap,
		const int	event_modifier )

Definition at line 537 of file wm_keymap_utils.cc.

References wmKeyMap::items, KMI_INACTIVE, LISTBASE_FOREACH, and wm_keymap_item_uses_modifier().

Referenced by wm_gizmo_keymap_uses_event_modifier().