shelfButton

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

Synopsis

shelfButton( [string] , [align=string], [annotation=string], [backgroundColor=[float, float, float]], [command=script], [commandRepeatable=boolean], [defineTemplate=string], [disabledImage=string], [docTag=string], [doubleClickCommand=script], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [exists=boolean], [flat=boolean], [font=string], [fullPathName=string], [handleNodeDropCallback=script], [height=int], [highlightImage=string], [image=string], [image1=string], [image2=string], [image3=string], [imageOverlayLabel=string], [isObscured=boolean], [label=string], [labelEditingCallback=script], [labelOffset=int], [manage=boolean], [marginHeight=uint], [marginWidth=uint], [noBackground=boolean], [numberOfPopupMenus=boolean], [overlayLabelBackColor=[float, float, float, float]], [overlayLabelColor=[float, float, float]], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [selectionImage=string], [sourceType=string], [style=string], [useTemplate=string], [version=string], [visible=boolean], [visibleChangeCommand=script], [width=int])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

shelfButton is undoable, queryable, and editable.

This command creates an iconTextButton that is designed to be on the shelf. The button contains a command that can be drag'n'dropped.

Return value

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

Flags

Long name (short name)	Argument types	Properties
exists(ex)	boolean
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
defineTemplate(dt)	string
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
Force the command to use a command template other than the current one.
parent(p)	string
The parent layout for this control.
enable(en)	boolean
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
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
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
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.
isObscured(io)	boolean
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
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)	boolean
Return the number of popup menus attached to this control.
popupMenuArray(pma)	boolean
Return the names of all the popup menus attached to this control.
preventOverride(po)	boolean
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
annotation(ann)	string
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.
noBackground(nbg)	boolean
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
Enables the background color of the control.
docTag(dtg)	string
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
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
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
Return the full path name of the widget, which includes all the parents
image1(i1)	string
image2(i2)	string
image3(i3)	string
This control supports three icons. The icon that best fits the current size of the control will be displayed.
image(i)	string
If you are not providing images with different sizes then you may use this flag for the control's image. If the "iconOnly" style is set, the icon will be scaled to the size of the control.
disabledImage(di)	string
Image used when the button is disabled. Image size must be the same as the image specified with the i/image flag. This is a Windows only flag.
imageOverlayLabel(iol)	string
A short string, up to 5 characters, representing a label that will be displayed on top of the image.
overlayLabelColor(olc)	[float, float, float]
The RGB color of the label defined by imageOverlayLabel. Default is a light grey: .8 .8 .8
overlayLabelBackColor(olb)	[float, float, float, float]
The RGBA color of the shadow behind the label defined by imageOverlayLabel. Default is 25% transparent black: 0 0 0 .25
label(l)	string
The text that appears in the control.
style(st)	string
The draw style of the control. Valid styles are "iconOnly", "textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and "iconAndTextCentered". (Note: "iconAndTextCentered" is only available on Windows). If the "iconOnly" style is set, the icon will be scaled to the size of the control.
align(al)	string
The label alignment. Alignment values are "left", "right", and "center". By default, the label is aligned "center". Currently only available when -st/style is set to "iconAndTextCentered".
labelOffset(lo)	int
The label offset. Default is 0. Currently only available when -st/style is set to "iconAndTextCentered".
marginWidth(mw)	uint
The number of pixels on either side of the control content. The default value is 1 pixel.
marginHeight(mh)	uint
The number of pixels above and below the control content. The default value is 1 pixel.
font(fn)	string
The font for the text. Valid values are "boldLabelFont", "smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont", "obliqueLabelFont", "smallObliqueLabelFont", "fixedWidthFont" and "smallFixedWidthFont".
version(ver)	string
Specify the version that this control 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").
command(c)	script
Command executed when the control is pressed.
doubleClickCommand(dcc)	script
Command executed when the control is double clicked.
sourceType(stp)	string
Sets the language type for the command script. Can only be used in conjunction with the c/command or dcc/doubleClickCommand flags. Valid values are "mel" (enabled by default), and "python".
selectionImage(si)	string
Image displayed while the control is selected. Image size must be the same as the image specified with the -i/image flag. This is a Windows only flag.
highlightImage(hi)	string
Highlight image displayed while the cursor is over the control. Image size must be the same as the image specified with the -i/image flag. This is a Windows only flag.
handleNodeDropCallback(hnd)	script
Specify a script callback which is called when a node is dropped on the control. The name of the node being dropped will be passed to the function (python callable) or appended to the end (script) to form the command to be executed.
labelEditingCallback(lec)	script
Specify a callback which is called after the user double clicks the label of the control to give it a new label. The new label string will be passed to the callback.
commandRepeatable(rpt)	boolean
Set if the MEL command specified in the command flag should be repeatable or not. The "g" key, by default, is the shortcut to repeat the last executed command.
flat(fla)	boolean
Sets whether the control will be a flat button (0 false, 1 true).

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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

#    Create a window with a shelf in it.  You can add more items to
#    this shelf by creating more 'shelfButton' objects or by dragging
#    other shelf items to the window.  Similary, you can delete the
#    shelf items with the 'deleteUI' command or by dragging the items
#    to the trash can located on the main Maya window shelf.
#
window = cmds.window( title = 'shelfButton Example')
tabs = cmds.tabLayout()
shelf = cmds.shelfLayout()

#    Create some shelf buttons...
#
#    1.  A button that prints a message to the Command Line.
#
cmds.shelfButton( annotation='Print "Hello".', image1='commandButton.png', command='print "Hello\\n"' )

#    2.  A button that will create a sphere.
#
cmds.shelfButton( annotation='Create a sphere.', image1='sphere.png', command='cmds.sphere()' )

#    3.  A button that will open the Attribute Editor window.
#
cmds.shelfButton(annotation='Show the Attribute Editor.', image1='menuIconWindow.png', command='import maya.mel; maya.mel.eval("openAEWindow")' )

#    4.  A button with a label that will create a cone
#
cmds.shelfButton(annotation='Create a cone.', image1='cone.png', command='cmds.cone()', imageOverlayLabel='4th')

#    5.  A button with a label and color that will call undo
#
cmds.shelfButton(annotation="Undo last operation.",
    image1="undo.png", command="undo", imageOverlayLabel="undo",
    overlayLabelColor=(1, .25, .25))

#    6.  A button with a label, color and background that will call redo
#
cmds.shelfButton(annotation="Redo last operation.",
    image1="redo.png", command="redo", imageOverlayLabel="redo",
    overlayLabelColor=(1, 1, .25), overlayLabelBackColor=(.15, .9, .1, .4))

cmds.tabLayout( tabs, edit=True, tabLabel=(shelf, 'Example Shelf') )

cmds.showWindow( window )