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_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’], 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 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.

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’], default ‘EMPTY’, (readonly)

active()¶

active

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

restore_item_to_default(item)¶

restore_item_to_default

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

Inherited Properties

Inherited Functions

References