pymel.core.windows.hotkey¶

hotkey(*args, **kwargs)¶

This command sets the single-key hotkeys for the entire application. In query mode, return type is based on queried flag.

Flags:

Long Name / Short Name		Argument Types	Properties
altModifier / alt		bool
autoSave / autoSave		bool
	If set to true then the hotkeys will always be saved when you quit. If false then the hotkeys are not saved unless savePrefs -hotkeysis used.
commandModifier / cmd		bool
	The Command key must be pressed to get the hotkey. This is only available on systems which have a separate command key. Note that if menu item accelerator keys are being used (menuItem -ke/keyEquivalent), then the accelerator key settings override the hotkey settings.
ctrlModifier / ctl		bool
	The Ctrl key must be pressed to get the hotkey. Note that if menu item accelerator keys are being used (menuItem -ke/keyEquivalent), then the accelerator key settings override the hotkey settings.
ctxClient / cc		unicode
	Specifies the hotkey context. It is used together with the other flags to modify or query the hotkey for a certain hotkey context. If it is not specified, the global hotkey context will be taken into account. Check hotkeyCtx command to see how the hotkeys work with the hotkey contexts.
dragPress / dp		bool
	Specify true and the command may be executed during manipulator dragging, if the tool context also allows this. This flag is false by default.
factorySettings / fs		bool
	Resets the hotkeys back to the initial defaults.
isModifier / mod		bool
	This flag is obsolete and should no longer be used.
keyShortcut / k		unicode
	Specify what key is being set. The key must be either a single ascii character (capital and lowercase can be set independently) or one of the keyword strings for the specialkeyboard characters. The valid keywords are:Up, Down, Right, Left,Home, End, Page_Up, Page_Down, InsertReturn, SpaceF1 to F12Tab (Will only work when modifiers are specified)Delete, Backspace (Will only work when modifiers are specified)
name / n		unicode
	The name of the namedCommand object that will be executed when the key is pressed.
pressCommandRepeat / pcr		bool
	Specify true and the command may be repeated by executing the command repeatLast. This flag is false by default.
releaseCommandRepeat / rcr		bool
	Specify true and the command may be repeated by executing the command repeatLast. This flag is false by default.
releaseName / rn		unicode
	The name of the namedCommand object that will be executed when the key is released.
shiftModifier / sht		bool
	The Shift key must be pressed to get the hotkey.
sourceUserHotkeys / suh		bool
	This flag is obsolete. Please use import flag from hotkeySet command to import the user hotkeys.Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.hotkey

Example:

import pymel.core as pm

# Here's an example of how to create a namedCommand
# object and then map it to a key.
#
pm.nameCommand( 'circleToolNamedCommand', annotation='Select Circle Tool', command='setToolTo circleContext')
# Result: u'circleToolNamedCommand' #
pm.hotkey( k='F5', alt=True, name='circleToolNamedCommand' )


# Here are more examples of how to use the hotkey command.
#
pm.hotkey( k='d', name='Delete_Command' )
pm.hotkey( k='d', name='' ) # unsets the above command

pm.hotkey( k='d', name='Delete_Command' )
pm.hotkey( k='d', releaseName='After_Delete_Command' )
pm.hotkey( k='d', name='' ) #only unsets the key press name
pm.hotkey( k='d', releaseName='' ) #only unsets the key release name
pm.hotkey( k='d', n='', rn='' ) #unsets both the key press and release name

#    Determine if a command is attached to either the press or release
#    of the "z" hotkey.
#
pm.hotkey( 'z', query=True )
# Result: True #

#    Likewise, for the modified variations of the "z" key.
#
pm.hotkey( 'z', query=True, alt=True )
# Result: True #
pm.hotkey( 'z', query=True, ctl=True )
# Result: True #
pm.hotkey( 'z', query=True, alt=True, ctl=True )
# Result: False #

#    Determine the press command attached to the "z" key.
#
pm.hotkey( 'z', query=True, name=True )
# Result: u'NameComUndo' #

#    To query the "-" hotkey use the string "Dash" instead.
#
pm.hotkey( 'Dash', query=True )
# Result: True #