pymel.core.uitypes.ShelfTabLayout

class ShelfTabLayout

class counterpart of mel function shelfTabLayout

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.

changeCommand(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

doubleClickCommand(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

dragCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.shelfTabLayout

dropCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.shelfTabLayout

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.shelfTabLayout

getBackgroundColor(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getChildArray(**kwargs)

Returns a string array of the names of the layout’s immediate children.

Derived from mel command maya.cmds.shelfTabLayout

getChildResizable(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getDocTag(**kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.shelfTabLayout

getEnable(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.shelfTabLayout

getFullPathName(**kwargs)

Return the full path name of the widget, which includes all the parents

Derived from mel command maya.cmds.shelfTabLayout

getHeight(**kwargs)

The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.shelfTabLayout

getImage(**kwargs)

Image appearing in top right corner of tab layout.

Derived from mel command maya.cmds.shelfTabLayout

getImageVisible(**kwargs)

Visibility of tab image.

Derived from mel command maya.cmds.shelfTabLayout

getInnerMarginHeight(**kwargs)

Margin height for all tab children.

Derived from mel command maya.cmds.shelfTabLayout

getInnerMarginWidth(**kwargs)

Margin width for all tab children.

Derived from mel command maya.cmds.shelfTabLayout

getIsObscured(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getManage(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getMinChildWidth(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getNumberOfChildren(**kwargs)

Returns in an int the number of immediate children of the layout.

Derived from mel command maya.cmds.shelfTabLayout

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.shelfTabLayout

getPopupMenuArray(**kwargs)

Return the names of all the popup menus attached to this control.

Derived from mel command maya.cmds.shelfTabLayout

getPreventOverride(**kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.shelfTabLayout

getScrollable(**kwargs)

Puts all children of this layout within a scroll area.

Derived from mel command maya.cmds.shelfTabLayout

getSelectCommand(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getSelectTab(**kwargs)

The name, in short form, of the selected tab. An empty string is returned on query if there are no child tabs.

Derived from mel command maya.cmds.shelfTabLayout

getSelectTabIndex(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getTabLabel(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getTabLabelIndex(**kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

getTabsVisible(**kwargs)

Visibility of the tab labels.

Derived from mel command maya.cmds.shelfTabLayout

getVisible(**kwargs)

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).

Derived from mel command maya.cmds.shelfTabLayout

getVisibleChangeCommand(**kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.shelfTabLayout

getWidth(**kwargs)

The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.shelfTabLayout

horizontalScrollBarThickness(val=True, **kwargs)

Thickness of the horizontal scroll bar. Specify an integer value greater than or equal to zero. This flag has no effect on Windows systems.

Derived from mel command maya.cmds.shelfTabLayout

moveTab(val=True, **kwargs)

Move the tab from the current index to a new index.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.shelfTabLayout

preSelectCommand(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.shelfTabLayout

setBackgroundColor(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

setDocTag(val=True, **kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.shelfTabLayout

setEnable(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.shelfTabLayout

setHeight(val=True, **kwargs)

The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.shelfTabLayout

setImage(val=True, **kwargs)

Image appearing in top right corner of tab layout.

Derived from mel command maya.cmds.shelfTabLayout

setImageVisible(val=True, **kwargs)

Visibility of tab image.

Derived from mel command maya.cmds.shelfTabLayout

setManage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

setPreventOverride(val=True, **kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.shelfTabLayout

setSelectCommand(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

setSelectTab(val=True, **kwargs)

The name, in short form, of the selected tab. An empty string is returned on query if there are no child tabs.

Derived from mel command maya.cmds.shelfTabLayout

setSelectTabIndex(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

setTabLabel(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

setTabLabelIndex(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shelfTabLayout

setTabsVisible(val=True, **kwargs)

Visibility of the tab labels.

Derived from mel command maya.cmds.shelfTabLayout

setVisible(val=True, **kwargs)

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).

Derived from mel command maya.cmds.shelfTabLayout

setVisibleChangeCommand(val=True, **kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.shelfTabLayout

setWidth(val=True, **kwargs)

The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.

Derived from mel command maya.cmds.shelfTabLayout

verticalScrollBarThickness(val=True, **kwargs)

Thickness of the vertical scroll bar. Specify an integer value greater than or equal to zero. This flag has no effect on Windows systems.

Derived from mel command maya.cmds.shelfTabLayout