pymel.core.windows.toolButton¶

toolButton(*args, **kwargs)¶

This command creates a toolButton that is added to the most recently created tool button collection unless the cl/collectionflag is used. It also attaches the named tool, activating it when this control is selected. By default, this control only handles one tool at a time. Using the t/toolflag to associate a new tool will simply override the previous attached tool. If you use the amt/allowMultipleToolsflag then you will be able to attach more than one tool with this control. Only one tool will be current within the control. To access the other tools press the right mouse button to display a popup menu containing all the tools associated with this control. If you set the piv/popupIndicatorVisibleflag then a small arrow will be drawn on the control to indicate that additional tools are attached to this control.

Flags:

Long Name / Short Name		Argument Types	Properties
allowMultipleTools / amt		bool
	Indicates whether this control will allow you to attach more than one tool. By default, this control accepts only one tool. You can add multiple tools by setting this flag to true. Only one tool will be current and displayed at any one time. Use the pop up menu attached to the right mouse button to view all the tools.
annotation / ann		unicode
	Annotate the control with an extra string value.
backgroundColor / bgc		float, float, float
	The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
changeCommand / cc		script
	Command executed when the control’s state is changed. Note that this flag should not be used in conjunction with onCommand and offCommand. That is, one should either use changeCommand and test the state of the control from inside the callback, or use onCommand and offCommand as separate callbacks.
collection / cl		unicode
	To explicitly add a tool button to a tool collection.
defineTemplate / dt		unicode
	Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
docTag / dtg		unicode
	Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
doubleClickCommand / dcc		script
	Command executed when the control is double clicked.
dragCallback / dgc		script
	Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form: global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y, modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’
dropCallback / dpc		script
	Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages, x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print ‘%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d’
enable / en		bool
	The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
enableBackground / ebg		bool
	Enables the background color of the control.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
fullPathName / fpn		bool
	Return the full path name of the widget, which includes all the parents
height / h		int
	The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
highlightColor / hlc		float, float, float
	The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
image1 / i1		unicode
image2 / i2		unicode
image3 / i3		unicode
	This control supports three images. The image that best fits the current size of the control will be displayed. This flag applies the image to the current tool.
imageOverlayLabel / iol		unicode
	A short string (5 characters) label that will be displayed on top of the icon.
isObscured / io		bool
	Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control’s window is invisible or iconified.
ltVersion / lt		unicode
	This flag is used to specify the Maya LT version that this control feature was introduced, if the version flag is not specified, or if the version flag is specified but its argument is different. This value is only used by Maya LT, and otherwise ignored. The argument should be given as a string of the version number (e.g. 2013, 2014). Currently only accepts major version numbers (e.g. 2013 Ext 1, or 2013.5 should be given as 2014).
manage / m		bool
	Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
noBackground / nbg		bool
	Clear/reset the control’s background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
numberOfPopupMenus / npm		bool
	Return the number of popup menus attached to this control.
offCommand / ofc		script
	Command executed when the control is turned off.
onCommand / onc		script
	Command executed when the control is turned on.
parent / p		unicode
	The parent layout for this control.
popupIndicatorVisible / piv		bool
	Edit this flag to set the visibility of the popup tool indicator. The indicator is a simple image that appears in the top right corner of the button when more that one tool is associated with this control. This flag is queryable and true by default.
popupMenuArray / pma		bool
	Return the names of all the popup menus attached to this control.
preventOverride / po		bool
	If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
select / sl		bool
	Will set this button as the selected one. This flag also queries the select state of the control.
style / st		unicode
	The draw style of the control. Valid styles are iconOnly, textOnly, iconAndTextHorizontaland iconAndTextVertical.
tool / t		unicode
	The name of the tool to be attached to the button. If the tool specified is already attached to this button then it will be selected. Query this flag to return the current tool. This flag may be specified more than once to attach more than one tool.
toolArray / ta		bool
	This query only flag returns the names of all the tools attached to the toolButton control.
toolCount / tc		bool
	This query only flag return the number of tools attached to the toolButton control.
toolImage1 / ti1		unicode, unicode
toolImage2 / ti2		unicode, unicode
toolImage3 / ti3		unicode, unicode
	This control supports three images. The image that best fits the current size of the control will be displayed. This flag applies the image to the specified tool. The first argument is the name of the tool and the second is the name of the image. When queried an array of tool icon pairs is returned.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one.
version / ver		unicode
	Specify the version that this tool button feature was introduced. The argument should be given as a string of the version number (e.g. 2013, 2014). Currently only accepts major version numbers (e.g. 2013 Ext 1, or 2013.5 should be given as 2014).
visible / vis		bool
	The visible state of the control. A control is created visible by default. Note that a control’s actual appearance is also dependent on the visible state of its parent layout(s).
visibleChangeCommand / vcc		script
	Command that gets executed when visible state of the control changes.
width / w		int
	The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.toolButton

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout92') #
pm.toolCollection()
# Result: ui.ToolCollection('window1|columnLayout92|toolCollection1') #
pm.toolButton( tool='selectSuperContext', toolImage1=('selectSuperContext', 'aselect.xpm') )
# Result: ui.ToolButton('window1|columnLayout92|toolButton1') #
pm.toolButton( tool='moveSuperContext', toolImage1=('moveSuperContext', 'move_M.xpm') )
# Result: ui.ToolButton('window1|columnLayout92|toolButton2') #
pm.toolButton( tool='scaleSuperContext', toolImage1=('scaleSuperContext', 'scale_M.png') )
# Result: ui.ToolButton('window1|columnLayout92|toolButton3') #
pm.showWindow()

# example showing how to create tool buttons for artisan tools
#
# create the contexts
selectCtx = pm.artSelectCtx()
puttyCtx = pm.artPuttyCtx()
setPaintCtx = pm.artSetPaintCtx()

pm.window()
# Result: ui.Window('window2') #
pm.gridLayout()
# Result: ui.GridLayout('window2|gridLayout3') #
pm.toolCollection()
# Result: ui.ToolCollection('window2|gridLayout3|toolCollection2') #
# create the tool buttons using the contexts returned
pm.toolButton(
                amt=True, piv=True,
                doubleClickCommand='pm.toolPropertyWindow()',
                tool=(selectCtx, puttyCtx, setPaintCtx),
                toolImage1=(selectCtx, 'artSelect.xpm'),
                toolImage2=(puttyCtx, 'putty.png'),
                toolImage3=(setPaintCtx, 'paintSetMembership.png') )
pm.showWindow()