KeyMap(bpy_struct)

base class — bpy_struct

class bpy.types.KeyMap(bpy_struct)

Input configuration, including keymaps

is_modal

Indicates that a keymap is used for translate modal events for an operator

Type :boolean, default False, (readonly)

is_user_defined

Keymap is defined by the user

Type :boolean, default False

keymap_items

Items in the keymap, linking an operator to an input event

Type :KeyMapItems bpy_prop_collection of KeyMapItem, (readonly)

name

Name of the key map

Type :string, default “”, (readonly)

region_type

Optional region type keymap is associated with

Type :enum in [‘WINDOW’, ‘HEADER’, ‘CHANNELS’, ‘TEMPORARY’, ‘UI’, ‘TOOLS’, ‘TOOL_PROPS’, ‘PREVIEW’], default ‘WINDOW’, (readonly)

show_expanded_children

Children expanded in the user interface

Type :boolean, default False

show_expanded_items

Expanded in the user interface

Type :boolean, default False

space_type

Optional space type keymap is associated with

Type :enum in [‘EMPTY’, ‘VIEW_3D’, ‘GRAPH_EDITOR’, ‘OUTLINER’, ‘PROPERTIES’, ‘FILE_BROWSER’, ‘IMAGE_EDITOR’, ‘INFO’, ‘SEQUENCE_EDITOR’, ‘TEXT_EDITOR’, ‘AUDIO_WINDOW’, ‘DOPESHEET_EDITOR’, ‘NLA_EDITOR’, ‘SCRIPTS_WINDOW’, ‘TIMELINE’, ‘NODE_EDITOR’, ‘LOGIC_EDITOR’, ‘CONSOLE’, ‘USER_PREFERENCES’], default ‘EMPTY’, (readonly)

active()

active

Returns:Key Map, Active key map. Return type:KeyMap

copy_to_user()

copy_to_user

Returns:Key Map, User editable key map. Return type:KeyMap

restore_to_default()

restore_to_default

restore_item_to_default(item)

restore_item_to_default

Parameters:item (KeyMapItem, (never None)) – Item

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

KeyConfig.keymaps KeyMap.active KeyMap.copy_to_user KeyMaps.find

KeyMaps.find_modal KeyMaps.new UserPreferencesInput.edited_keymaps