tabLayout is undoable, queryable, and editable.
This command creates a tab group. Tab groups are a specialized form of
control layouts that contain only control layouts.
Whenever a control layout is added to a tab group it will have a tab
provided for it that allows selection of that group
from amongst other tabbed control groups. Only one child of a tab
layout is visible at a time.
In query mode, return type is based on queried flag.
| Long name (short name) |
Argument types |
Properties |
|
-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.
|
|
-borderStyle(-bs)
|
string
|
|
|
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
|
|
|
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)
|
|
|
|
Returns a string array of the names of the layout's
immediate children.
|
|
-childResizable(-cr)
|
boolean
|
|
|
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
|
|
|
Close the tab at the given index.
|
|
-closeTabCommand(-ctc)
|
script
|
|
|
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
|
|
|
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
|
|
|
Add a documentation flag to the control. The documentation flag
has a directory structure.
(e.g., -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 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
|
|
|
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.
|
|
-enableKeyboardFocus(-ekf)
|
boolean
|
|
|
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)
|
|
|
|
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.
|
|
-generalSpacing(-gsp) 2024
|
int
|
|
|
Sets the spacing for this layout.
|
|
-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)
|
string
|
|
|
Image appearing in top right corner of tab layout.
|
|
-imageVisible(-iv)
|
boolean
|
|
|
|
-innerMarginHeight(-imh)
|
int
|
|
|
Margin height for all tab children.
|
|
-innerMarginWidth(-imw)
|
int
|
|
|
Margin width for all tab children.
|
|
-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.
|
|
-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.
|
|
-margins(-mar) 2024
|
int
|
|
|
Sets the content margins for this layout.
|
|
-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/childResizable flag 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/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
|
|
|
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.
|
|
-postMenuCommand(-pmc)
|
script
|
|
|
Specify a script to be executed when the popup menu is about to be shown.
|
|
-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/selectTab
or -sti/selectTabIndex flags.
|
|
-preventOverride(-po)
|
boolean
|
|
|
If true, this flag prevents overriding the control's
attribute via the control's right mouse button menu.
|
|
-scrollable(-scr)
|
boolean
|
|
|
Puts all children of this layout within a scroll area.
|
|
-scrollableTabs(-stb)
|
boolean
|
|
|
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/selectTab or -sti/selectTabIndex flags.
|
|
-selectTab(-st)
|
string
|
|
|
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/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
|
|
|
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
|
|
|
Extra string to display in the status bar when the mouse is over the control.
|
|
-tabIcon(-ti)
|
string string
|
|
|
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)
|
int string
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
Changes the tab position. The possible values are: "north", "east" and "west".
|
|
-tabTooltip(-tt)
|
string string
|
|
|
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
|
|
|
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
|
|
|
Set to true if you want to have a close button icon on all created tabs.
|
|
-tabsVisible(-tv)
|
boolean
|
|
|
Visibility of the tab labels.
|
|
-useTemplate(-ut)
|
string
|
|
|
Forces 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)
|
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.
|
|