pymel.core.uitypes.ToolButton

class ToolButton

class counterpart of mel function toolButton

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.

changeCommand(val=True, **kwargs)

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.

Derived from mel command maya.cmds.toolButton

collection(val=True, **kwargs)

To explicitly add a tool button to a tool collection.

Derived from mel command maya.cmds.toolButton

doubleClickCommand(val=True, **kwargs)

Command executed when the control is double clicked.

Derived from mel command maya.cmds.toolButton

dragCallback(val=True, **kwargs)

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 “dragControl” value is a string and the other values are integers (eg the callback string could be “print ‘%(dragControl)s %(x)d %(y)d %(modifiers)d’”)

Derived from mel command maya.cmds.toolButton

dropCallback(val=True, **kwargs)

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 “dragControl” value 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’”)

Derived from mel command maya.cmds.toolButton

getAllowMultipleTools(**kwargs)

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.

Derived from mel command maya.cmds.toolButton

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.toolButton

getBackgroundColor(**kwargs)

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.

Derived from mel command maya.cmds.toolButton

getDocTag(**kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.toolButton

getEnable(**kwargs)

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.

Derived from mel command maya.cmds.toolButton

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.toolButton

getFullPathName(**kwargs)

Return the full path name of the widget, which includes all the parents

Derived from mel command maya.cmds.toolButton

getHeight(**kwargs)

The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.toolButton

getImage1(**kwargs)

Derived from mel command maya.cmds.toolButton

getImage2(**kwargs)

Derived from mel command maya.cmds.toolButton

getImage3(**kwargs)

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.

Derived from mel command maya.cmds.toolButton

getImageOverlayLabel(**kwargs)

A short string (5 characters) label that will be displayed on top of the icon.

Derived from mel command maya.cmds.toolButton

getIsObscured(**kwargs)

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.

Derived from mel command maya.cmds.toolButton

getManage(**kwargs)

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.

Derived from mel command maya.cmds.toolButton

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.toolButton

getPopupIndicatorVisible(**kwargs)

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.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.toolButton

getPopupMenuArray(**kwargs)

Return the names of all the popup menus attached to this control.

Derived from mel command maya.cmds.toolButton

getPreventOverride(**kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.toolButton

getTool(**kwargs)

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.

Derived from mel command maya.cmds.toolButton

getToolArray(**kwargs)

This query only flag returns the names of all the tools attached to the toolButton control.

Derived from mel command maya.cmds.toolButton

getToolCount(**kwargs)

This query only flag return the number of tools attached to the toolButton control.

Derived from mel command maya.cmds.toolButton

getToolImage1(**kwargs)

Derived from mel command maya.cmds.toolButton

getToolImage2(**kwargs)

Derived from mel command maya.cmds.toolButton

getToolImage3(**kwargs)

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.

Derived from mel command maya.cmds.toolButton

getVisible(**kwargs)

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).

Derived from mel command maya.cmds.toolButton

getVisibleChangeCommand(**kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.toolButton

getWidth(**kwargs)

The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.toolButton

offCommand(val=True, **kwargs)

Command executed when the control is turned off.

Derived from mel command maya.cmds.toolButton

onCommand(val=True, **kwargs)

Command executed when the control is turned on.

Derived from mel command maya.cmds.toolButton

select(val=True, **kwargs)

Will set this button as the selected one. This flag also queries the select state of the control.

Derived from mel command maya.cmds.toolButton

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.toolButton

setBackgroundColor(val=True, **kwargs)

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.

Derived from mel command maya.cmds.toolButton

setDocTag(val=True, **kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.toolButton

setEnable(val=True, **kwargs)

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.

Derived from mel command maya.cmds.toolButton

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.toolButton

setHeight(val=True, **kwargs)

The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.toolButton

setImage1(val=True, **kwargs)

Derived from mel command maya.cmds.toolButton

setImage2(val=True, **kwargs)

Derived from mel command maya.cmds.toolButton

setImage3(val=True, **kwargs)

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.

Derived from mel command maya.cmds.toolButton

setImageOverlayLabel(val=True, **kwargs)

A short string (5 characters) label that will be displayed on top of the icon.

Derived from mel command maya.cmds.toolButton

setManage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.toolButton

setPopupIndicatorVisible(val=True, **kwargs)

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.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.toolButton

setPreventOverride(val=True, **kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.toolButton

setTool(val=True, **kwargs)

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.

Derived from mel command maya.cmds.toolButton

setToolImage1(val=True, **kwargs)

Derived from mel command maya.cmds.toolButton

setToolImage2(val=True, **kwargs)

Derived from mel command maya.cmds.toolButton

setToolImage3(val=True, **kwargs)

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.

Derived from mel command maya.cmds.toolButton

setVisible(val=True, **kwargs)

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).

Derived from mel command maya.cmds.toolButton

setVisibleChangeCommand(val=True, **kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.toolButton

setWidth(val=True, **kwargs)

The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.toolButton

style(val=True, **kwargs)

The draw style of the control. Valid styles are “iconOnly”, “textOnly”, “iconAndTextHorizontal” and “iconAndTextVertical”.

Derived from mel command maya.cmds.toolButton