wm_keymap_utils.c File Reference

#include <string.h>
#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.h"
#include "RNA_access.h"
#include "WM_api.h"
#include "WM_types.h"

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, int type, int val, int modifier, int keymodifier)
wmKeyMapItem *	WM_keymap_add_menu_pie (wmKeyMap *keymap, const char *idname, int type, int val, int modifier, int keymodifier)
wmKeyMapItem *	WM_keymap_add_panel (wmKeyMap *keymap, const char *idname, int type, int val, int modifier, int keymodifier)
wmKeyMapItem *	WM_keymap_add_tool (wmKeyMap *keymap, const char *idname, int type, int val, int modifier, int keymodifier)
void	WM_keymap_add_context_enum_set_items (wmKeyMap *keymap, const EnumPropertyItem *items, const char *data_path, int type_start, int val, int modifier, int keymodifier)
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 (void)

Detailed Description

Utilities to help define keymaps.

Definition in file wm_keymap_utils.c.

Function Documentation

WM_keymap_add_context_enum_set_items()

void WM_keymap_add_context_enum_set_items	(	wmKeyMap *	keymap,
		const EnumPropertyItem *	items,
		const char *	data_path,
		int	type_start,
		int	val,
		int	modifier,
		int	keymodifier
	)

Useful for mapping numbers to an enum.

Definition at line 87 of file wm_keymap_utils.c.

References EnumPropertyItem::identifier, wmKeyMapItem::ptr, RNA_string_set(), and WM_keymap_add_item().

WM_keymap_add_menu()

wmKeyMapItem* WM_keymap_add_menu	(	struct wmKeyMap *	keymap,
		const char *	idname,
		int	type,
		int	val,
		int	modifier,
		int	keymodifier
	)

Wrappers for WM_keymap_add_item

Definition at line 47 of file wm_keymap_utils.c.

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

WM_keymap_add_menu_pie()

wmKeyMapItem* WM_keymap_add_menu_pie	(	wmKeyMap *	keymap,
		const char *	idname,
		int	type,
		int	val,
		int	modifier,
		int	keymodifier
	)

Definition at line 56 of file wm_keymap_utils.c.

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

WM_keymap_add_panel()

wmKeyMapItem* WM_keymap_add_panel	(	wmKeyMap *	keymap,
		const char *	idname,
		int	type,
		int	val,
		int	modifier,
		int	keymodifier
	)

Definition at line 65 of file wm_keymap_utils.c.

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

WM_keymap_add_tool()

wmKeyMapItem* WM_keymap_add_tool	(	wmKeyMap *	keymap,
		const char *	idname,
		int	type,
		int	val,
		int	modifier,
		int	keymodifier
	)

Definition at line 77 of file wm_keymap_utils.c.

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

WM_keymap_fix_linking()

void WM_keymap_fix_linking

(

void

)

Definition at line 520 of file wm_keymap_utils.c.

Referenced by wm_window_keymap().

WM_keymap_guess_from_context()

wmKeyMap* WM_keymap_guess_from_context

(

const bContext *

C

)

Definition at line 113 of file wm_keymap_utils.c.

References BLI_assert, C, CTX_data_mode_enum(), CTX_MODE_EDIT_ARMATURE, CTX_MODE_EDIT_CURVE, CTX_MODE_EDIT_GPENCIL, CTX_MODE_EDIT_LATTICE, CTX_MODE_EDIT_MESH, CTX_MODE_EDIT_METABALL, CTX_MODE_EDIT_SURFACE, CTX_MODE_EDIT_TEXT, CTX_MODE_OBJECT, CTX_MODE_PAINT_GPENCIL, CTX_MODE_PAINT_TEXTURE, CTX_MODE_PAINT_VERTEX, CTX_MODE_PAINT_WEIGHT, CTX_MODE_PARTICLE, CTX_MODE_POSE, CTX_MODE_SCULPT, CTX_MODE_SCULPT_GPENCIL, CTX_MODE_VERTEX_GPENCIL, CTX_MODE_WEIGHT_GPENCIL, CTX_wm_manager(), CTX_wm_space_data(), SpaceImage::mode, NULL, SI_MODE_MASK, SI_MODE_PAINT, SI_MODE_UV, SI_MODE_VIEW, SPACE_IMAGE, SPACE_VIEW3D, SpaceLink::spacetype, 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
	)

Definition at line 208 of file wm_keymap_utils.c.

References C, CTX_data_mode_enum(), CTX_MODE_OBJECT, CTX_MODE_PAINT_TEXTURE, CTX_MODE_PAINT_VERTEX, CTX_MODE_PAINT_WEIGHT, CTX_MODE_POSE, CTX_MODE_SCULPT, CTX_wm_manager(), CTX_wm_space_data(), NULL, SPACE_ACTION, 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 480 of file wm_keymap_utils.c.

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 508 of file wm_keymap_utils.c.

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

Referenced by wm_gizmo_keymap_uses_event_modifier().