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

Synopsis

shelfTabLayout( [string] , [annotation=string], [backgroundColor=[float, float, float]], [borderStyle=string], [changeCommand=script], [childArray=boolean], [childResizable=boolean], [closeTab=int], [closeTabCommand=script], [defineTemplate=string], [docTag=string], [doubleClickCommand=script], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [enableKeyboardFocus=boolean], [exists=boolean], [fullPathName=boolean], [height=int], [highlightColor=[float, float, float]], [horizontalScrollBarThickness=int], [image=string], [imageVisible=boolean], [innerMarginHeight=int], [innerMarginWidth=int], [isObscured=boolean], [manage=boolean], [minChildWidth=int], [moveTab=[int, int]], [newTabCommand=script], [noBackground=boolean], [numberOfChildren=boolean], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [postMenuCommand=script], [preSelectCommand=script], [preventOverride=boolean], [scrollable=boolean], [scrollableTabs=boolean], [selectCommand=script], [selectTab=string], [selectTabIndex=int], [showNewTab=boolean], [statusBarMessage=string], [tabIcon=[string, string]], [tabIconIndex=[int, string]], [tabLabel=[string, string]], [tabLabelIndex=[int, string]], [tabPosition=string], [tabTooltip=[string, string]], [tabTooltipIndex=[int, string]], [tabsClosable=boolean], [tabsVisible=boolean], [useTemplate=string], [verticalScrollBarThickness=int], [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.

shelfTabLayout is undoable, queryable, and editable.

This command creates/edits/queries a shelf tab group which is essentially a normal tabLayout with some drop behaviour in the tab bar. A garbage can icon can appear in the top right corner to dispose of buttons dragged to it from shelves.

Return value

stringThe name of the shelfTabLayout.

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

Flags

annotation, backgroundColor, borderStyle, changeCommand, childArray, childResizable, closeTab, closeTabCommand, defineTemplate, docTag, doubleClickCommand, dragCallback, dropCallback, enable, enableBackground, enableKeyboardFocus, exists, fullPathName, height, highlightColor, horizontalScrollBarThickness, image, imageVisible, innerMarginHeight, innerMarginWidth, isObscured, manage, minChildWidth, moveTab, newTabCommand, noBackground, numberOfChildren, numberOfPopupMenus, parent, popupMenuArray, postMenuCommand, preSelectCommand, preventOverride, scrollable, scrollableTabs, selectCommand, selectTab, selectTabIndex, showNewTab, statusBarMessage, tabIcon, tabIconIndex, tabLabel, tabLabelIndex, tabPosition, tabTooltip, tabTooltipIndex, tabsClosable, tabsVisible, useTemplate, verticalScrollBarThickness, visible, visibleChangeCommand, width
Long name (short name) Argument types Properties
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.
borderStyle(bs) string createqueryedit
Specify the style of the border for tab layout. Valid values are: "none", "top", "notop" and "full". By default, it will use "full" to draw a simple frame around the body area of the tab layout.
  • "none" - Do not draw borders around the body area of the tab layout
  • "top" - Only draw a simple line right below the tabs
  • "notop" - Draw a simple frame on the left/right/bottom (no top) of the tab layout
  • "full" - Draw a simple frame around the body area of the tab layout
changeCommand(cc) script createedit
Command executed when a tab is selected interactively. This command is only invoked when the selected tab changes. Re-selecting the current tab will not invoke this command.
childArray(ca) boolean query
Returns a string array of the names of the layout's immediate children.
childResizable(cr) boolean createquery
Set to true if you want the child of the control layout to be as wide as the scroll area. You may also indicate a minimum width for the child using the -mcw/minChildWidth flag.
closeTab(ct) int createedit
Close the tab at the given index.
closeTabCommand(ctc) script createedit
Specify a script to be executed when one of the tabs are closed by clicking on the header widget (MMB or X button).
defineTemplate(dt) string create
Puts the command in a mode where any other flags and arguments 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 createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -dt render/multiLister/createNode/material)
doubleClickCommand(dcc) script createedit
Command executed when a tab is double clicked on. Note that the first click will select the tab and the second click will execute the double click command. Double clicking the current tab will re-invoke the double click command.
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 CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + 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'")

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.
enableBackground(ebg) boolean createqueryedit
Enables the background color of the control.
enableKeyboardFocus(ekf) boolean createqueryedit
If enabled, the user can navigate to the control with the tab key and select values with the keyboard or mouse. This flag would typically be used to turn off focus support from controls that get it by default, like Edit and List controls. If disabled, text in text fields can still be selected with the mouse but cannot be copied (except on Linux when "Middle Click Paste" is enabled).
exists(ex) boolean create
Returns whether the specified object exists or not. Other flags are ignored.
fullPathName(fpn) boolean query
Return the full path name of the widget, which includes all the parents.
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.
highlightColor(hlc) [float, float, float] createqueryedit
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.
horizontalScrollBarThickness(hst) int createedit
Thickness of the horizontal scroll bar. Specify an integer value greater than or equal to zero. This flag has no effect on Windows systems.
image(i) string createqueryedit
Image appearing in top right corner of tab layout.
imageVisible(iv) boolean createqueryedit
Visibility of tab image.
innerMarginHeight(imh) int createquery
Margin height for all tab children.
innerMarginWidth(imw) int createquery
Margin width for all tab children.
isObscured(io) boolean 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.
minChildWidth(mcw) int createquery
Specify a positive non-zero integer value indicating the minimum width the tab layout's children. This flag only has meaning when the -cr/childResizable flag is set to true.
moveTab(mt) [int, int] createedit
Move the tab from the current index to a new index.
newTabCommand(ntc) script createedit
Command executed when the 'New Tab' button (on the tab bar) is clicked. Note: in order to show the new tab button use the -snt/showNewTab flag. Using this command will override any internal Maya logic for adding a new tab (only this command will be executed).
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.
numberOfChildren(nch) boolean query
Returns in an int the number of immediate children of the layout.
numberOfPopupMenus(npm) boolean query
Return the number of popup menus attached to this control.
parent(p) string createquery
The parent layout for this control.
popupMenuArray(pma) boolean query
Return the names of all the popup menus attached to this control.
postMenuCommand(pmc) script createedit
Specify a script to be executed when the popup menu is about to be shown.
preSelectCommand(psc) script createedit
Command executed when a tab is selected but before it's contents become visible. Re-selecting the current tab will not invoke this command. Note that this command is not executed by using either of the -st/selectTab or -sti/selectTabIndex flags.
preventOverride(po) boolean createqueryedit
If true, this flag prevents overriding the control's attribute via the control's right mouse button menu.
scrollable(scr) boolean createquery
Puts all children of this layout within a scroll area.
scrollableTabs(stb) boolean createqueryedit
If true, the active tab in the layout can be scrolled through with the mouse wheel. Default is true.
selectCommand(sc) script createqueryedit
Command executed when a tab is selected interactively This command will be invoked whenever a tab is selected, ie. re-selecting the current tab will invoke this command. Note that this command is not executed by using either of the -st/selectTab or -sti/selectTabIndex flags.
selectTab(st) string createqueryedit
The name, in short form, of the selected tab. An empty string is returned on query if there are no child tabs.
selectTabIndex(sti) int createqueryedit
Identical to the -st/selectTab flag except this flag takes a 1-based index to identify the selected tab. A value of 0 is returned on query if there are no child tabs.
showNewTab(snt) boolean createqueryedit
Set to true if you want to have a 'New Tab' button shown at the end of the tab bar. Note: use the -ntc/newTabCommand flag to set the command executed when this button is clicked.
statusBarMessage(sbm) string createedit
Extra string to display in the status bar when the mouse is over the control.
tabIcon(ti)
2023
 [string, string] createqueryeditmultiuse
Set an icon for a tab. The first argument is the name of a control that must be a child of the tab layout. The second argument is the icon file name.
tabIconIndex(tii)
2023
 [int, string] createqueryeditmultiuse
Identical to the -ti/tabIcon flag except this flag takes a 1-based index to identify the tab you want to set the icon for. If this flag is queried the tab icons for all the children are returned.
tabLabel(tl) [string, string] createqueryeditmultiuse
Set a tab label. The first argument is the name of a control that must be a child of the tab layout. The second argument is the label for the tab associated with that child. If this flag is queried then the tab labels for all the children are returned.
tabLabelIndex(tli) [int, string] createqueryeditmultiuse
Identical to the -tl/tabLabel flag except this flag takes a 1-based index to identify the tab you want to set the label for. If this flag is queried the tab labels for all the children are returned.
tabPosition(tp) string createqueryedit
Changes the tab position. The possible values are: "north", "east" and "west".
tabTooltip(tt) [string, string] createqueryeditmultiuse
Set a tab tooltip. The first argument is the name of a control that must be a child of the tab layout. The second argument is the tooltip for the tab associated with that child. If this flag is queried then the tab tooltips for all the children are returned.
tabTooltipIndex(tti) [int, string] createqueryeditmultiuse
Identical to the -tt/tabTooltip flag except this flag takes a 1-based index to identify the tab you want to set the tooltip for. If this flag is queried the tab tooltips for all the children are returned.
tabsClosable(tc) boolean createquery
Set to true if you want to have a close button icon on all created tabs.
tabsVisible(tv) boolean createqueryedit
Visibility of the tab labels.
useTemplate(ut) string create
Forces the command to use a command template other than the current one.
verticalScrollBarThickness(vst) int createedit
Thickness of the vertical scroll bar. Specify an integer value greater than or equal to zero. This flag has no effect on Windows systems.
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.
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.
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

cmds.window()
cmds.shelfTabLayout( 'mainShelfTab', image='smallTrash.png', imageVisible=True )
cmds.shelfLayout( 'Dynamics' )
cmds.setParent( '..' )
cmds.shelfLayout( 'Rendering' )
cmds.setParent( '..' )
cmds.shelfLayout( 'Animation' )
cmds.setParent( '..' )
cmds.showWindow()