Home       Trees       Indices       Help   
Package bpy :: Module types :: Class KeyMap
[hide private]
[frames] | no frames]

Class KeyMap

The Key Map Object

Input configuration, including keymaps.

References

Instance Methods [hide private]
KeyMapItem
add_item(idname, type, value, any, shift, ctrl, alt, oskey, key_modifier)
add_item
KeyMapItem
add_modal_item(propvalue, type, value, any, shift, ctrl, alt, oskey, key_modifier)
add_modal_item
KeyMap
active()
active
 
remove_item(item)
remove_item
KeyMap
copy_to_user()
copy_to_user
 
restore_to_default()
restore_to_default
Instance Variables [hide private]
Collection of KeyMapItem (readonly) items
Items in the keymap, linking an operator to an input event.
boolean modal
Indicates that a keymap is used for translate modal events for an operator.
string name
Name of the key map.
enum region_type
Optional region type keymap is associated with.
enum space_type
Optional space type keymap is associated with.
boolean user_defined
Keymap is defined by the user.
Method Details [hide private]

add_item(idname, type, value, any, shift, ctrl, alt, oskey, key_modifier)

 

add_item

Parameters:
  • ctrl (boolean)
  • shift (boolean)
  • idname (string)
  • value (enum)
  • alt (boolean)
  • type (enum)
  • any (boolean)
  • oskey (boolean)
  • key_modifier (enum)
Returns: KeyMapItem
Added key map item.

add_modal_item(propvalue, type, value, any, shift, ctrl, alt, oskey, key_modifier)

 

add_modal_item

Parameters:
  • ctrl (boolean)
  • shift (boolean)
  • value (enum)
  • propvalue (string)
  • alt (boolean)
  • type (enum)
  • any (boolean)
  • oskey (boolean)
  • key_modifier (enum)
Returns: KeyMapItem
Added key map item.

active()

 

active

Returns: KeyMap
Active key map.

remove_item(item)

 

remove_item

Parameters:

copy_to_user()

 

copy_to_user

Returns: KeyMap
User editable key map.

Instance Variable Details [hide private]

name

Name of the key map. (maximum length of 64)
Type:
string

region_type

Optional region type keymap is associated with. in...
  • WINDOW
  • HEADER
  • CHANNELS
  • TOOLS
  • TEMPORARY
  • UI
Type:
enum

space_type

Optional space type keymap is associated with. in...
  • EMPTY
  • VIEW_3D
  • GRAPH_EDITOR
  • OUTLINER
  • PROPERTIES
  • FILE_BROWSER
  • IMAGE_EDITOR
  • INFO
  • SEQUENCE_EDITOR
  • TEXT_EDITOR
  • AUDIO_WINDOW
  • DOPESHEET_EDITOR
  • NLA_EDITOR
  • SCRIPTS_WINDOW
  • TIMELINE
  • NODE_EDITOR
  • LOGIC_EDITOR
  • CONSOLE
  • USER_PREFERENCES
Type:
enum

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Wed Dec 9 12:15:52 2009 http://epydoc.sourceforge.net