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

Synopsis

shelfButton [-align string] [-annotation string] [-backgroundColor float float float] [-command string] [-defineTemplate string] [-disabledImage string] [-docTag] [-doubleClickCommand string] [-dragCallback string] [-dropCallback string] [-edit] [-enable boolean] [-exists] [-font string] [-handleNodeDropCallback string] [-height int] [-highlightImage string] [-image string] [-image1 string] [-image2 string] [-image3 string] [-imageOverlayLabel string] [-isObscured] [-label string] [-labelEditingCallback string] [-labelOffset int] [-manage boolean] [-marginHeight int] [-marginWidth int] [-numberOfPopupMenus] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-query] [-selectionImage string] [-sourceType string] [-style string] [-useTemplate string] [-visible boolean] [-width int] [shelfButtonName]

shelfButton is undoable, queryable, and editable.

This control supports up to 3 icon images and 4 different display styles. The icon image displayed is the one that best fits the current size of the control given its current style. This command creates an iconTextButton that is designed to be on the shelf. The button contains a command that can be drag'n'dropped.

Flags

align, annotation, backgroundColor, command, defineTemplate, disabledImage, docTag, doubleClickCommand, dragCallback, dropCallback, edit, enable, exists, font, handleNodeDropCallback, height, highlightImage, image, image1, image2, image3, imageOverlayLabel, isObscured, label, labelEditingCallback, labelOffset, manage, marginHeight, marginWidth, numberOfPopupMenus, parent, popupMenuArray, preventOverride, query, selectionImage, sourceType, style, useTemplate, visible, width
Long name (short name) [argument types] Properties
-query(-q) query
Puts the command in query mode so that it will return the value of the specified flag.

In query mode, this flag needs a value.
-edit(-e) edit
Puts the command in edit mode so that it will change the values of the specified flags
-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
Will force the command to use a command template other than the current one.
-parent(-p) string create
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.

In query mode, this flag needs a value.
-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.

In query mode, this flag needs a value.
-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.

In query mode, this flag needs a value.
-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).

In query mode, this flag needs a value.
-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.

In query mode, this flag needs a value.
-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.

In query mode, this flag needs a value.
-numberOfPopupMenus(-npm) query
Return the number of popup menus attached to this control.

In query mode, this flag needs a value.
-popupMenuArray(-pma) query
Return the names of all the popup menus attached to this control.

In query mode, this flag needs a value.
-preventOverride(-po) boolean createqueryedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.

In query mode, this flag needs a value.
-annotation(-ann) string createqueryedit
Annotate the control with an extra string value.

In query mode, this flag needs a value.
-backgroundColor(-bgc) float float float createedit
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. (Windows only flag)
-docTag(-dt) createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

In query mode, this flag needs a value.
-dragCallback(-dgc) string 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) string 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'")

-image1(-i1) string createqueryedit

In query mode, this flag needs a value.
-image2(-i2) string createqueryedit

In query mode, this flag needs a value.
-image3(-i3) string createqueryedit
This control supports three icons. The icon that best fits the current size of the control will be displayed.

In query mode, this flag needs a value.
-image(-i) string createqueryedit
If you are not providing images with different sizes then you may use this flag for the control's image.

In query mode, this flag needs a value.
-disabledImage(-di) string createqueryedit
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.

In query mode, this flag needs a value.
-imageOverlayLabel(-iol) string createqueryedit
A short string (5 characters) label that will be displayed on top of the image.

In query mode, this flag needs a value.
-label(-l) string createqueryedit
The text that appears in the control.

In query mode, this flag needs a value.
-style(-st) string createqueryedit
The draw style of the control. Valid styles are "iconOnly", "textOnly", "iconAndTextHorizontal", "iconAndTextVertical", and "iconAndTextCentered". (Note: "iconAndTextCentered" is only available on Windows)

In query mode, this flag needs a value.
-align(-al) string createqueryedit
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".

In query mode, this flag needs a value.
-labelOffset(-lo) int createqueryedit
The label offset. Default is 0. Currently only available when -st/style is set to "iconAndTextCentered".

In query mode, this flag needs a value.
-marginWidth(-mw) int createqueryedit
The number of pixels on either side of the control content. The default value is 1 pixel.

In query mode, this flag needs a value.
-marginHeight(-mh) int createqueryedit
The number of pixels above and below the control content. The default value is 1 pixel.

In query mode, this flag needs a value.
-font(-fn) string createqueryedit
The font for the text. Valid values are "boldLabelFont", "smallBoldLabelFont", "tinyBoldLabelFont", "plainLabelFont", "smallPlainLabelFont", "obliqueLabelFont", "smallObliqueLabelFont", "fixedWidthFont" and "smallFixedWidthFont".

In query mode, this flag needs a value.
-command(-c) string createqueryedit
Command executed when the control is pressed.

In query mode, this flag needs a value.
-sourceType(-stp) string createedit
Force sets the language type for the command script. Can only be used in conjunction with the -command flag. Currently supports values "mel" (enabled by default), and "python".
-doubleClickCommand(-dcc) string createqueryedit
Command executed when the control is double clicked.

In query mode, this flag needs a value.
-selectionImage(-si) string createqueryedit
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.

In query mode, this flag needs a value.
-highlightImage(-hi) string createqueryedit
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.

In query mode, this flag needs a value.
-handleNodeDropCallback(-hnd) string createedit
Specify a MEL script callback when a node is dropped on the control. The name of the node being dropped will be added to the end of the callback to form the MEL command to be executed.
-labelEditingCallback(-lec) string createedit
Specify a MEL script callback after the user double click the label of the control and give it a new label. The new label will be added to the end of the callback to form the MEL command to be executed.
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

Return value


The full name of the button on creation, otherwise the queried value.

MEL examples

//    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.
//
string $window = `window -title "shelfButton Example"`;
string $tabs = `tabLayout`;
string $shelf = `shelfLayout`;

//    Create some shelf buttons...
//
//    1.  A button that prints a message to the Command Line.
//
shelfButton -annotation "Print \"Hello\"."
    -image1 "commandButton.xpm" -command ("print \"Hello\\n\"");

//    2.  A button that will create a sphere.
//
shelfButton -annotation "Create a sphere."
    -image1 "sphere.xpm" -command ("sphere");

//    3.  A button that will open the Attribute Editor window.
//
shelfButton -annotation "Show the Attribute Editor."
    -image1 "menuIconWindow.xpm" -command ("openAEWindow");
tabLayout -edit -tabLabel $shelf "Example Shelf" $tabs;

showWindow $window;