shelfLayout

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

Synopsis

shelfLayout [-alignment string] [-annotation string] [-backgroundColor float float float] [-cellHeight int] [-cellWidth int] [-cellWidthHeight int int] [-childArray] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-enable boolean] [-enableBackground boolean] [-exists] [-fullPathName] [-height int] [-highlightColor float float float] [-isObscured] [-ltVersion string] [-manage boolean] [-noBackground boolean] [-numberOfChildren] [-numberOfPopupMenus] [-parent string] [-popupMenuArray] [-position string int] [-preventOverride boolean] [-spacing int] [-style string] [-useTemplate string] [-version string] [-visible boolean] [-visibleChangeCommand script] [-width int] [string]

shelfLayout is undoable, queryable, and editable.

Return value

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

Flags

Long name (short name)	Argument types	Properties
-alignment(-aln)	string
Sets the alignment of the buttons in the layout. Valid options are "left" and "right".
-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.
-cellHeight(-ch)	int
Set or query the height of the items in the shelf.
-cellWidth(-cw)	int
Set or query the width of the items in the shelf.
-cellWidthHeight(-cwh)	int int
Set the width and height of the items in the shelf.
-childArray(-ca)
Returns a string array of the names of the layout's immediate children.
-defineTemplate(-dt)	string
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)	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'")
-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.
-enableBackground(-ebg)	boolean
Enables the background color of the control.
-exists(-ex)
Returns whether the specified object exists or not. Other flags are ignored.
-fullPathName(-fpn)
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.
-isObscured(-io)
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)	string
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. "2014", "2015"). Currently only accepts major version numbers (e.g. 2014.5 should be given as "2014").
-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.
-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.
-numberOfChildren(-nch)
Returns in an int the number of immediate children of the layout.
-numberOfPopupMenus(-npm)
Return the number of popup menus attached to this control.
-parent(-p)	string
The parent layout for this control.
-popupMenuArray(-pma)
Return the names of all the popup menus attached to this control.
-position(-pos)	string int
Specify the name of a child control in the grid layout along with a 1-based integer value indicating the desired position of the child. Positions increase from left to right within a row and then wrap around to the next row increasing from top to bottom. For example, a grid layout with 3 columns and 2 rows has 6 visible positions where 1, 2 and 3 occupy the first row and 4, 5 and 6 occupy the second.
-preventOverride(-po)	boolean
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
-spacing(-spa)	int
Sets the space between children.
-style(-st)	string
Set or query the current style of the items in the shelf. Valid styles are "iconOnly", "textOnly", "iconAndTextHorizontal" and "iconAndTextVertical".
-useTemplate(-ut)	string
Force the command to use a command template other than the current one.
-version(-ver)	string
Specify the version that this feature was introduced. The argument should be given as a string of the version number (e.g. "2014", "2015"). Currently only accepts major version numbers (e.g. 2014.5 should be given as "2014").
-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.
-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 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

// Create 4 shelves with 3 icons
window;
  tabLayout;
    string $sh1 = `shelfLayout -style "iconOnly" -backgroundColor .9 .2 .2 "First"`;
	string $sh1b1 = `shelfButton -image1 "textureEditor.png" -label "textureEditor" -annotation "textureEditor" -command "TextureViewWindow" -imageOverlayLabel "1" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor 1 .25 .25 .5`;
	string $sh1b2 = `shelfButton -image1 "undo.png" -label "undo" -annotation "undo" -command "undo" -imageOverlayLabel "1" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor 1 .25 .25 .5`;
	string $sh1b3 = `shelfButton -image1 "redo.png" -label "redo" -annotation "redo" -command "redo" -imageOverlayLabel "1" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor 1 .25 .25 .5`;
    setParent ..;

    string $sh2 = `shelfLayout -style "textOnly" -backgroundColor .2 .9 .2 "Second"`;
	string $sh2b1 = `shelfButton -image1 "textureEditor.png" -label "textureEditor" -annotation "textureEditor" -command "TextureViewWindow" -imageOverlayLabel "2" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 1 .25 .5`;
	string $sh2b2 = `shelfButton -image1 "undo.png" -label "undo" -annotation "undo" -command "undo" -imageOverlayLabel "2" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 1 .25 .5`;
	string $sh2b3 = `shelfButton -image1 "redo.png" -label "redo" -annotation "redo" -command "redo" -imageOverlayLabel "2" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 1 .25 .5`;
    setParent ..;

    string $sh3 = `shelfLayout -style "iconAndTextHorizontal" -backgroundColor .2 .2 .9 "Third"`;
	string $sh3b1 = `shelfButton -image1 "textureEditor.png" -label "textureEditor" -annotation "textureEditor" -command "TextureViewWindow" -imageOverlayLabel "3" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 .25 1 .5`;
	string $sh3b2 = `shelfButton -image1 "undo.png" -label "undo" -annotation "undo" -command "undo" -imageOverlayLabel "3" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 .25 1 .5`;
	string $sh3b3 = `shelfButton -image1 "redo.png" -label "redo" -annotation "redo" -command "redo" -imageOverlayLabel "3" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 .25 1 .5`;
    setParent ..;

    string $sh4 = `shelfLayout -style "iconAndTextVertical" "Fourth"`;
	string $sh4b1 = `shelfButton -image1 "textureEditor.png" -label "textureEditor" -annotation "textureEditor" -command "TextureViewWindow" -imageOverlayLabel "4" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 1 1 .5`;
	string $sh4b2 = `shelfButton -image1 "undo.png" -label "undo" -annotation "undo" -command "undo" -imageOverlayLabel "4" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 1 1 .5`;
	string $sh4b3 = `shelfButton -image1 "redo.png" -label "redo" -annotation "redo" -command "redo" -imageOverlayLabel "4" -overlayLabelColor .1 .1 .1 -overlayLabelBackColor .25 1 1 .5`;
    setParent ..;

  setParent ..;
showWindow;

// Move some icons around

// Move undo to the first position in shelf 1
shelfLayout -edit -position $sh1b2 1 $sh1;

// This does nothing
shelfLayout -edit -position $sh2b2 2 $sh2;

// Move undo to the last position in shelf 3
shelfLayout -edit -position $sh3b2 3 $sh3;

// Swap textureEditor and redo in shelf 4
shelfLayout -edit -position $sh4b1 3 -position $sh4b3 1 $sh4;