KeyMaps(bpy_struct)

base class — bpy_struct

class bpy.types.KeyMaps(bpy_struct)

Collection of keymaps

new(name, space_type='EMPTY', region_type='WINDOW', modal=False, tool=False)

Ensure the keymap exists. This will return the one with the given name/space type/region type, or create a new one if it does not exist yet.

Parameters

  • name (string, (never None)) – Name

  • space_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', 'SPREADSHEET', 'PREFERENCES'], (optional)) –

    Space Type

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

    • SPREADSHEET Spreadsheet – Explore geometry data in a table.

    • PREFERENCES Preferences – Edit persistent configuration settings.

  • region_type (enum in ['WINDOW', 'HEADER', 'CHANNELS', 'TEMPORARY', 'UI', 'TOOLS', 'TOOL_PROPS', 'PREVIEW', 'HUD', 'NAVIGATION_BAR', 'EXECUTE', 'FOOTER', 'TOOL_HEADER', 'XR'], (optional)) – Region Type

  • modal (boolean, (optional)) – Modal, Keymap for modal operators

  • tool (boolean, (optional)) – Tool, Keymap for active tools

Returns

Key Map, Added key map

Return type

KeyMap

remove(keymap)

remove

Parameters

keymap (KeyMap, (never None)) – Key Map, Removed key map

find(name, space_type='EMPTY', region_type='WINDOW')

find

Parameters

  • name (string, (never None)) – Name

  • space_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', 'SPREADSHEET', 'PREFERENCES'], (optional)) –

    Space Type

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

    • SPREADSHEET Spreadsheet – Explore geometry data in a table.

    • PREFERENCES Preferences – Edit persistent configuration settings.

  • region_type (enum in ['WINDOW', 'HEADER', 'CHANNELS', 'TEMPORARY', 'UI', 'TOOLS', 'TOOL_PROPS', 'PREVIEW', 'HUD', 'NAVIGATION_BAR', 'EXECUTE', 'FOOTER', 'TOOL_HEADER', 'XR'], (optional)) – Region Type

Returns

Key Map, Corresponding key map

Return type

KeyMap

find_modal(name)

find_modal

Parameters

name (string, (never None)) – Operator Name

Returns

Key Map, Corresponding key map

Return type

KeyMap

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

Inherited Functions

References