KeyConfigurations(bpy_struct)

base class — bpy_struct

class bpy.types.KeyConfigurations(bpy_struct)

Collection of KeyConfigs

active

Active key configuration (preset)

Type:KeyConfig
addon

Key configuration that can be extended by add-ons, and is added to the active configuration when handling events

Type:KeyConfig, (readonly)
default

Default builtin key configuration

Type:KeyConfig, (readonly)
user

Final key configuration that combines keymaps from the active and add-on configurations, and can be edited by the user

Type:KeyConfig, (readonly)
new(name)

new

Parameters:name (string, (never None)) – Name
Returns:Key Configuration, Added key configuration
Return type:KeyConfig
remove(keyconfig)

remove

Parameters:keyconfig (KeyConfig, (never None)) – Key Configuration, Removed key configuration
find_item_from_operator(idname, context='INVOKE_DEFAULT', properties=None, include={'ACTIONZONE', 'KEYBOARD', 'MOUSE', 'NDOF', 'TWEAK'}, exclude={})

find_item_from_operator

Parameters:
  • idname (string, (never None)) – Operator Identifier
  • context (enum in ['INVOKE_DEFAULT', 'INVOKE_REGION_WIN', 'INVOKE_REGION_CHANNELS', 'INVOKE_REGION_PREVIEW', 'INVOKE_AREA', 'INVOKE_SCREEN', 'EXEC_DEFAULT', 'EXEC_REGION_WIN', 'EXEC_REGION_CHANNELS', 'EXEC_REGION_PREVIEW', 'EXEC_AREA', 'EXEC_SCREEN'], (optional)) – context
  • include (enum set in {'KEYBOARD_MODIFIER', 'KEYBOARD', 'MOUSE_WHEEL', 'MOUSE_GESTURE', 'MOUSE_BUTTON', 'MOUSE', 'NDOF', 'TWEAK', 'ACTIONZONE'}, (optional)) – Include
  • exclude (enum set in {'KEYBOARD_MODIFIER', 'KEYBOARD', 'MOUSE_WHEEL', 'MOUSE_GESTURE', 'MOUSE_BUTTON', 'MOUSE', 'NDOF', 'TWEAK', 'ACTIONZONE'}, (optional)) – Exclude
Return (keymap, item):
 

keymap, KeyMap

item, KeyMapItem
update()

update

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