KeyMap(bpy_struct)

base class — bpy_struct

class bpy.types.KeyMap(bpy_struct)

Input configuration, including keymaps

bl_owner_id

Internal owner (default “”, never None)

Type:

str

is_modal

Indicates that a keymap is used for translate modal events for an operator (default False, readonly)

Type:

bool

is_user_modified

Keymap is defined by the user (default False)

Type:

bool

keymap_items

Items in the keymap, linking an operator to an input event (default None, readonly)

Type:

KeyMapItems[KeyMapItem]

modal_event_values

Give access to the possible event values of this modal keymap’s items (#KeyMapItem.propvalue), for API introspection (default None, readonly)

Type:

bpy_prop_collection[EnumPropertyItem]

name

Name of the key map (default “”, readonly, never None)

Type:

str

region_type

Optional region type keymap is associated with (default 'WINDOW', readonly)

Type:

Literal[Region Type Items]

show_expanded_children

Children expanded in the user interface (default False)

Type:

bool

show_expanded_items

Expanded in the user interface (default False)

Type:

bool

space_type

Optional space type keymap is associated with (default 'EMPTY', readonly)

Type:

Literal[Space Type Items]

active()

active

Returns:

Key Map, Active key map

Return type:

KeyMap

restore_to_default()

restore_to_default

restore_item_to_default(item)

restore_item_to_default

Parameters:

item (KeyMapItem) – Item, (never None)

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References