KeyMap(bpy_struct)

base class — bpy_struct

class bpy.types.KeyMap.KeyMap(bpy_struct)

Input configuration, including keymaps

bl_owner_id

Internal owner

Type

string, default “”, (never None)

is_modal

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

Type

boolean, default False, (readonly)

is_user_modified

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, never None)

region_type

Optional region type keymap is associated with

Type

enum in [‘WINDOW’, ‘HEADER’, ‘CHANNELS’, ‘TEMPORARY’, ‘UI’, ‘TOOLS’, ‘TOOL_PROPS’, ‘PREVIEW’, ‘HUD’, ‘NAVIGATION_BAR’, ‘EXECUTE’, ‘FOOTER’, ‘TOOL_HEADER’], 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

  • EMPTY Empty.

  • VIEW_3D 3D Viewport, Manipulate objects in a 3D environment.

  • IMAGE_EDITOR UV/Image Editor, View and edit images and UV Maps.

  • NODE_EDITOR Node Editor, Editor for node-based shading and compositing tools.

  • SEQUENCE_EDITOR Video Sequencer, Video editing tools.

  • CLIP_EDITOR Movie Clip Editor, Motion tracking tools.

  • DOPESHEET_EDITOR Dope Sheet, Adjust timing of keyframes.

  • GRAPH_EDITOR Graph Editor, Edit drivers and keyframe interpolation.

  • NLA_EDITOR Nonlinear Animation, Combine and layer Actions.

  • TEXT_EDITOR Text Editor, Edit scripts and in-file documentation.

  • CONSOLE Python Console, Interactive programmatic console for advanced editing and script development.

  • INFO Info, Log of operations, warnings and error messages.

  • TOPBAR Top Bar, Global bar at the top of the screen for global per-window settings.

  • STATUSBAR Status Bar, Global bar at the bottom of the screen for general status information.

  • OUTLINER Outliner, Overview of scene graph and all available data-blocks.

  • PROPERTIES Properties, Edit properties of active object and related data-blocks.

  • FILE_BROWSER File Browser, Browse for files and assets.

  • PREFERENCES Preferences, Edit persistent configuration settings.

Type

enum in [‘EMPTY’, ‘VIEW_3D’, ‘IMAGE_EDITOR’, ‘NODE_EDITOR’, ‘SEQUENCE_EDITOR’, ‘CLIP_EDITOR’, ‘DOPESHEET_EDITOR’, ‘GRAPH_EDITOR’, ‘NLA_EDITOR’, ‘TEXT_EDITOR’, ‘CONSOLE’, ‘INFO’, ‘TOPBAR’, ‘STATUSBAR’, ‘OUTLINER’, ‘PROPERTIES’, ‘FILE_BROWSER’, ‘PREFERENCES’], default ‘EMPTY’, (readonly)

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, (never None)) – Item

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

  • bpy_struct.id_data

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • 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.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

References

  • GizmoGroup.setup_keymap

  • KeyConfig.keymaps

  • KeyConfigurations.find_item_from_operator

  • KeyMap.active

  • KeyMaps.find

  • KeyMaps.find_modal

  • KeyMaps.new

  • KeyMaps.remove

  • WindowManager.popover_end__internal