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)

new

Parameters:
  • name (string, (never None)) – Name
  • space_type (enum in [‘EMPTY’, ‘VIEW_3D’, ‘TIMELINE’, ‘GRAPH_EDITOR’, ‘DOPESHEET_EDITOR’, ‘NLA_EDITOR’, ‘IMAGE_EDITOR’, ‘SEQUENCE_EDITOR’, ‘CLIP_EDITOR’, ‘TEXT_EDITOR’, ‘NODE_EDITOR’, ‘LOGIC_EDITOR’, ‘PROPERTIES’, ‘OUTLINER’, ‘USER_PREFERENCES’, ‘INFO’, ‘FILE_BROWSER’, ‘CONSOLE’], (optional)) –

    Space Type

    • EMPTY Empty.
    • VIEW_3D 3D View, 3D viewport.
    • TIMELINE Timeline, Timeline and playback controls.
    • GRAPH_EDITOR Graph Editor, Edit drivers and keyframe interpolation.
    • DOPESHEET_EDITOR Dope Sheet, Adjust timing of keyframes.
    • NLA_EDITOR NLA Editor, Combine and layer Actions.
    • IMAGE_EDITOR UV/Image Editor, View and edit images and UV Maps.
    • SEQUENCE_EDITOR Video Sequence Editor, Video editing tools.
    • CLIP_EDITOR Movie Clip Editor, Motion tracking tools.
    • TEXT_EDITOR Text Editor, Edit scripts and in-file documentation.
    • NODE_EDITOR Node Editor, Editor for node-based shading and compositing tools.
    • LOGIC_EDITOR Logic Editor, Game logic editing.
    • PROPERTIES Properties, Edit properties of active object and related datablocks.
    • OUTLINER Outliner, Overview of scene graph and all available datablocks.
    • USER_PREFERENCES User Preferences, Edit persistent configuration settings.
    • INFO Info, Main menu bar and list of error messages (drag down to expand and display).
    • FILE_BROWSER File Browser, Browse for files and assets.
    • CONSOLE Python Console, Interactive programmatic console for advanced editing and script development.
  • region_type (enum in [‘WINDOW’, ‘HEADER’, ‘CHANNELS’, ‘TEMPORARY’, ‘UI’, ‘TOOLS’, ‘TOOL_PROPS’, ‘PREVIEW’], (optional)) – Region Type
  • modal (boolean, (optional)) – Modal
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’, ‘TIMELINE’, ‘GRAPH_EDITOR’, ‘DOPESHEET_EDITOR’, ‘NLA_EDITOR’, ‘IMAGE_EDITOR’, ‘SEQUENCE_EDITOR’, ‘CLIP_EDITOR’, ‘TEXT_EDITOR’, ‘NODE_EDITOR’, ‘LOGIC_EDITOR’, ‘PROPERTIES’, ‘OUTLINER’, ‘USER_PREFERENCES’, ‘INFO’, ‘FILE_BROWSER’, ‘CONSOLE’], (optional)) –

    Space Type

    • EMPTY Empty.
    • VIEW_3D 3D View, 3D viewport.
    • TIMELINE Timeline, Timeline and playback controls.
    • GRAPH_EDITOR Graph Editor, Edit drivers and keyframe interpolation.
    • DOPESHEET_EDITOR Dope Sheet, Adjust timing of keyframes.
    • NLA_EDITOR NLA Editor, Combine and layer Actions.
    • IMAGE_EDITOR UV/Image Editor, View and edit images and UV Maps.
    • SEQUENCE_EDITOR Video Sequence Editor, Video editing tools.
    • CLIP_EDITOR Movie Clip Editor, Motion tracking tools.
    • TEXT_EDITOR Text Editor, Edit scripts and in-file documentation.
    • NODE_EDITOR Node Editor, Editor for node-based shading and compositing tools.
    • LOGIC_EDITOR Logic Editor, Game logic editing.
    • PROPERTIES Properties, Edit properties of active object and related datablocks.
    • OUTLINER Outliner, Overview of scene graph and all available datablocks.
    • USER_PREFERENCES User Preferences, Edit persistent configuration settings.
    • INFO Info, Main menu bar and list of error messages (drag down to expand and display).
    • FILE_BROWSER File Browser, Browse for files and assets.
    • CONSOLE Python Console, Interactive programmatic console for advanced editing and script development.
  • region_type (enum in [‘WINDOW’, ‘HEADER’, ‘CHANNELS’, ‘TEMPORARY’, ‘UI’, ‘TOOLS’, ‘TOOL_PROPS’, ‘PREVIEW’], (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

Inherited Properties

Inherited Functions

References