pymel.core.windows.shelfTabLayout¶

shelfTabLayout(*args, **kwargs)¶

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.

Flags:

Long Name / Short Name		Argument Types	Properties
annotation / ann		unicode
	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.
borderStyle / bs		unicode
	Specify the style of the border for tab layout. Valid values are: none, top, notopand full. By default, it will use fullto draw a simple frame around the body area of the tab layout. none- Do not draw borders around the body area of the tab layouttop- Only draw a simple line right below the tabsnotop- Draw a simple frame on the left/right/bottom (no top) of the tab layoutfull- Draw a simple frame around the body area of the tab layout
changeCommand / cc		script
	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		bool
	Returns a string array of the names of the layout’s immediate children.
childResizable / cr		bool
	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/minChildWidthflag.
defineTemplate / dt		unicode
	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		unicode
	Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
doubleClickCommand / dcc		script
	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
	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 dragControlvalue 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 dragControlvalue 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		bool
	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		bool
	Enables the background color of the control.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
fullPathName / fpn		bool
	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.
horizontalScrollBarThickness / hst		int
	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		unicode
	Image appearing in top right corner of tab layout.
imageVisible / iv		bool
	Visibility of tab image.
innerMarginHeight / imh		int
	Margin height for all tab children.
innerMarginWidth / imw		int
	Margin width for all tab children.
isObscured / io		bool
	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		bool
	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
	Specify a positive non-zero integer value indicating the minimum width the tab layout’s children. This flag only has meaning when the -cr/childResizableflag is set to true.
moveTab / mt		int, int
	Move the tab from the current index to a new index.
newTabCommand / ntc		script
	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/showNewTabflag. Using this command will override any internal Maya logic for adding a new tab (only this command will be executed).
noBackground / nbg		bool
	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		bool
	Returns in an int the number of immediate children of the layout.
numberOfPopupMenus / npm		bool
	Return the number of popup menus attached to this control.
parent / p		unicode
	The parent layout for this control.
popupMenuArray / pma		bool
	Return the names of all the popup menus attached to this control.
preSelectCommand / psc		script
	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/selectTabor -sti/selectTabIndexflags.
preventOverride / po		bool
	If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
scrollable / scr		bool
	Puts all children of this layout within a scroll area.
scrollableTabs / stb		bool
	If true, the active tab in the layout can be scrolled through with the mouse wheel. Default is true.
selectCommand / sc		script
	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/selectTabor -sti/selectTabIndexflags.
selectTab / st		unicode
	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
	Identical to the -st/selectTabflag except this flag takes a 1-based index to identify the selected tab. A value of 0 is returned on query if there are not child tabs.
showNewTab / snt		bool
	Set to true if you want to have a ‘New Tab’ button shown at the end of the tab bar. Note: use the -ntc/newTabCommandflag to set the command executed when this button is clicked.
tabLabel / tl		unicode, unicode
	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, unicode
	Identical to the -tl/tabLabelflag 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.
tabsClosable / tc		bool
	Set to true if you want to have a close button icon on all created tabs.
tabsVisible / tv		bool
	Visibility of the tab labels.
useTemplate / ut		unicode
	Force the command to use a command template other than the current one.
verticalScrollBarThickness / vst		int
	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		bool
	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 have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.shelfTabLayout

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.shelfTabLayout( 'mainShelfTab', image='smallTrash.png', imageVisible=True )
# Result: ui.ShelfTabLayout('window1|mainShelfTab') #
pm.shelfLayout( 'Dynamics' )
# Result: ui.ShelfLayout('window1|mainShelfTab|Dynamics') #
pm.setParent( '..' )
# Result: u'window1|mainShelfTab' #
pm.shelfLayout( 'Rendering' )
# Result: ui.ShelfLayout('window1|mainShelfTab|Rendering') #
pm.setParent( '..' )
# Result: u'window1|mainShelfTab' #
pm.shelfLayout( 'Animation' )
# Result: ui.ShelfLayout('window1|mainShelfTab|Animation') #
pm.setParent( '..' )
# Result: u'window1|mainShelfTab' #
pm.showWindow()