rowColumnLayout

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

Synopsis

rowColumnLayout( [string] , [annotation=string], [backgroundColor=[float, float, float]], [childArray=boolean], [columnAlign=[int, string]], [columnAttach=[int, string, int]], [columnOffset=[int, string, int]], [columnSpacing=[int, int]], [columnWidth=[int, int]], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [exists=boolean], [fullPathName=boolean], [height=int], [highlightColor=[float, float, float]], [isObscured=boolean], [manage=boolean], [noBackground=boolean], [numberOfChildren=boolean], [numberOfColumns=int], [numberOfPopupMenus=boolean], [numberOfRows=int], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [rowAlign=[int, string]], [rowAttach=[int, string, int]], [rowHeight=[int, int]], [rowOffset=[int, string, int]], [rowSpacing=[int, int]], [useTemplate=string], [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.

rowColumnLayout is undoable, queryable, and editable.

Some flags only make sense for one of either the row format or the column format. For example the -rh/rowHeight flag can only be specified in row format. In column format the row height is determined by the tallest child in the row, plus offsets.

Return value

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

Flags

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.
childArray(ca)	boolean
Returns a string array of the names of the layout's immediate children.
columnAlign(cal)	[int, string]
Alignment for text and pixmaps in the specified column. Values are: "left", "right" and "center". Only valid for column format, ie. number of columns specified with -nc/numberOfColumns flag.
columnAttach(cat)	[int, string, int]
The attachements and offsets for the children in the specified column. The first argument is the 1-based column index. The second argument is the attachment, valid values are "left", "right" and "both". The third argument must be greater than 0 and specifies the offset.
columnOffset(co)	[int, string, int]
The attachment offset for the specified column. The first argument is the 1-based column index. The second argument is the attachment, valid values are "left", "right" and "both". The third argument must be greater than 0 and specifies the offset.
columnSpacing(cs)	[int, int]
The space between columns in pixels. In column format this flag specifies that the space be to the left of the given column. In row format it specifies the space between all columns, however a valid column index is still required. The first argument is the 1-based column index. The second argument must be greater than 0 and specifies the spacing.
columnWidth(cw)	[int, int]
Width of a column. This flag is valid only in column format. The column width must be greater than 0. The first argument is the 1-based column index. The second argument must be greater than 0 and specifies the column width.
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)	boolean
Returns whether the specified object exists or not. Other flags are ignored.
fullPathName(fpn)	boolean
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)	boolean
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.
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)	boolean
Returns in an int the number of immediate children of the layout.
numberOfColumns(nc)	int
Number of columns. This flag is mutually exclusive to the -nr/numRows flag. Either one or the other can be specified.
numberOfPopupMenus(npm)	boolean
Return the number of popup menus attached to this control.
numberOfRows(nr)	int
Number of rows. This flag is mutually exclusive to the -nc/numColumns flag. Either one or the other can be specified.
parent(p)	string
The parent layout for this control.
popupMenuArray(pma)	boolean
Return the names of all the popup menus attached to this control.
preventOverride(po)	boolean
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
rowAlign(ral)	[int, string]
Alignment for text and pixmaps in the specified row. Values are: "left", "right" and "center". Only valid for row format, ie. number of rows specified with -nr/numberOfRows flag.
rowAttach(rat)	[int, string, int]
The attachements and offsets for the children in the specified row. The first argument is the 1-based row index. The second argument is the attachment, valid values are "top", "bottom" and "both". The third argument must be greater than 0 and specifies the offset.
rowHeight(rh)	[int, int]
Height of a row. This flag is only valid in row format. The row height must be greater than 0. The first argument is the 1-based row index. The second argument must be greater than 0 and specifies the row height.
rowOffset(ro)	[int, string, int]
The attachment offset for the specified row. The first argument is the 1-based row index. The second argument is the attachment, valid values are "top", "bottom" and "both". The third argument must be greater than 0 and specifies the offset.
rowSpacing(rs)	[int, int]
The space between rows, in pixels. In row format this specifies the space above the specified row. In column format it specifies the space between all rows, however a valid row index is still required. The first argument is the 1-based row index. The second argument must be greater than 0 and specifies the spacing.
useTemplate(ut)	string
Force the command to use a command template other than the current one.
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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

#    The following script will position the buttons in a single column.
#
#    +----+
#    | b1 |
#    +----+
#    +----+
#    | b2 |
#    +----+
#    +----+
#    | b3 |
#    +----+
#
cmds.window()
cmds.rowColumnLayout( numberOfColumns=1 )
cmds.button()
cmds.button()
cmds.button()
cmds.showWindow()

#    The following script will position the buttons in a single row.
#
#    +----++----++----+
#    | b1 || b2 || b3 |
#    +----++----++----+
#
cmds.window()
cmds.rowColumnLayout( numberOfRows=1 )
cmds.button()
cmds.button()
cmds.button()
cmds.showWindow()

#    The following script will position the buttons in 3 columns, each
#    column a different width.
#
#    +----++--------++------------+
#    | b1 ||   b2   ||     b3     |
#    +----++--------++------------+
#    +----++--------++------------+
#    | b4 ||   b5   ||     b6     |
#    +----++--------++------------+
#    +----+
#    | b7 |
#    +----+
#
cmds.window()
cmds.rowColumnLayout( numberOfColumns=3, columnWidth=[(1, 60), (2, 80), (3, 100)] )
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.showWindow()

#    The following script will position the buttons in 2 rows, each
#    row a different height.
#
#    +----++----++----++----+
#    | b1 || b3 || b5 || b7 |
#    +----++----++----++----+
#    +----++----++----+
#    |    ||    ||    |
#    | b2 || b4 || b6 |
#    |    ||    ||    |
#    +----++----++----+
#
cmds.window()
cmds.rowColumnLayout( numberOfRows=2, rowHeight=[(1, 30), (2, 60)] )
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.showWindow()