Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

toolButton [-allowMultipleTools boolean] [-annotation string] [-backgroundColor float float float] [-changeCommand script] [-collection string] [-defineTemplate string] [-docTag string] [-doubleClickCommand script] [-dragCallback script] [-dropCallback script] [-enable boolean] [-enableBackground boolean] [-exists] [-fullPathName string] [-height int] [-image1 string] [-image2 string] [-image3 string] [-imageOverlayLabel string] [-isObscured] [-manage boolean] [-noBackground boolean] [-numberOfPopupMenus] [-offCommand script] [-onCommand script] [-parent string] [-popupIndicatorVisible boolean] [-popupMenuArray] [-preventOverride boolean] [-select] [-style string] [-tool string] [-toolArray] [-toolCount] [-toolImage1 string string] [-toolImage2 string string] [-toolImage3 string string] [-useTemplate string] [-version string] [-visible boolean] [-visibleChangeCommand script] [-width int] [string]

toolButton is undoable, queryable, and editable.

This command creates a toolButton that is added to the most recently created tool button collection unless the cl/collection flag 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/tool flag to associate a new tool will simply override the previous attached tool. If you use the amt/allowMultipleTools flag 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/popupIndicatorVisible flag then a small arrow will be drawn on the control to indicate that additional tools are attached to this control.

Return value

stringThe name of the toolButton created.

In query mode, return type is based on queried flag.

Flags

allowMultipleTools, annotation, backgroundColor, changeCommand, collection, defineTemplate, docTag, doubleClickCommand, dragCallback, dropCallback, enable, enableBackground, exists, fullPathName, height, image1, image2, image3, imageOverlayLabel, isObscured, manage, noBackground, numberOfPopupMenus, offCommand, onCommand, parent, popupIndicatorVisible, popupMenuArray, preventOverride, select, style, tool, toolArray, toolCount, toolImage1, toolImage2, toolImage3, useTemplate, version, visible, visibleChangeCommand, width
Long name (short name) Argument types Properties
-exists(-ex) create
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate(-dt) string create
Puts a 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.
-useTemplate(-ut) string create
Force the command to use a command template other than the current one.
-parent(-p) string createquery
The parent layout for this control.
-enable(-en) boolean createqueryedit
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.
-width(-w) int createqueryedit
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-height(-h) int createqueryedit
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-visible(-vis) boolean createqueryedit
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 createqueryedit
Command that gets executed when visible state of the control changes.
-isObscured(-io) query
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.
-manage(-m) boolean createqueryedit
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.
-numberOfPopupMenus(-npm) query
Return the number of popup menus attached to this control.
-popupMenuArray(-pma) query
Return the names of all the popup menus attached to this control.
-preventOverride(-po) boolean createqueryedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
-annotation(-ann) string createqueryedit
Annotate the control with an extra string value.
-backgroundColor(-bgc) float float float createqueryedit
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.
-noBackground(-nbg) boolean createedit
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.
-enableBackground(-ebg) boolean createqueryedit
Enables the background color of the control.
-docTag(-dtg) string createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
-dragCallback(-dgc) script createedit
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'")

-dropCallback(-dpc) script createedit
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'")

-fullPathName(-fpn) string query
Return the full path name of the widget, which includes all the parents
-image1(-i1) string createqueryedit
-image2(-i2) string createqueryedit
-image3(-i3) string createqueryedit
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) string createqueryedit
A short string (5 characters) label that will be displayed on top of the icon.
-toolImage1(-ti1) string string createqueryeditmultiuse
-toolImage2(-ti2) string string createqueryeditmultiuse
-toolImage3(-ti3) string string createqueryeditmultiuse
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.
-style(-st) string createedit
The draw style of the control. Valid styles are "iconOnly", "textOnly", "iconAndTextHorizontal" and "iconAndTextVertical".
-onCommand(-onc) script createedit
Command executed when the control is turned on.
-offCommand(-ofc) script createedit
Command executed when the control is turned off.
-changeCommand(-cc) script createedit
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) string createedit
To explicitly add a tool button to a tool collection.
-doubleClickCommand(-dcc) script createedit
Command executed when the control is double clicked.
-select(-sl) createedit
Will set this button as the selected one. This flag also queries the select state of the control.
-tool(-t) string createqueryeditmultiuse
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.
-allowMultipleTools(-amt) boolean createquery
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.
-toolCount(-tc) query
This query only flag return the number of tools attached to the toolButton control.
-toolArray(-ta) query
This query only flag returns the names of all the tools attached to the toolButton control.
-popupIndicatorVisible(-piv) boolean createqueryedit
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.
-version(-ver) string createqueryedit
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.5 should be given as "2013").
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

  window;
      columnLayout;
      toolCollection;
      toolButton
          -tool       selectSuperContext
          -toolImage1 selectSuperContext "aselect.xpm";
      toolButton
          -tool       moveSuperContext
          -toolImage1 moveSuperContext "move_M.xpm";
      toolButton
          -tool       scaleSuperContext
          -toolImage1 scaleSuperContext  "scale_M.png";
  showWindow;

  // example showing how to create tool buttons for artisan tools
  //
  // create the contexts
  $selectCtx = `artSelectCtx` ;
  $puttyCtx = `artPuttyCtx` ;
  $setPaintCtx = `artSetPaintCtx` ;
  window;
      gridLayout;
      toolCollection;
      // create the tool buttons using the contexts returned
      toolButton
          -amt true
          -piv true
          -doubleClickCommand toolPropertyWindow
          -tool $selectCtx
          -tool $puttyCtx
          -tool $setPaintCtx
          -toolImage1 $selectCtx "artSelect.xpm"
          -toolImage2 $puttyCtx "putty.png"
          -toolImage3 $setPaintCtx "paintSetMembership.png"
          selectTool2;
  showWindow;