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

Synopsis

rowLayout( [string] , [adjustableColumn=int], [adjustableColumn1=int], [adjustableColumn2=int], [adjustableColumn3=int], [adjustableColumn4=int], [adjustableColumn5=int], [adjustableColumn6=int], [annotation=string], [backgroundColor=[float, float, float]], [childArray=boolean], [columnAlign=[int, string]], [columnAlign1=string], [columnAlign2=[string, string]], [columnAlign3=[string, string, string]], [columnAlign4=[string, string, string, string]], [columnAlign5=[string, string, string, string, string]], [columnAlign6=[string, string, string, string, string, string]], [columnAttach=[int, string, int]], [columnAttach1=string], [columnAttach2=[string, string]], [columnAttach3=[string, string, string]], [columnAttach4=[string, string, string, string]], [columnAttach5=[string, string, string, string, string]], [columnAttach6=[string, string, string, string, string, string]], [columnOffset1=int], [columnOffset2=[int, int]], [columnOffset3=[int, int, int]], [columnOffset4=[int, int, int, int]], [columnOffset5=[int, int, int, int, int]], [columnOffset6=[int, int, int, int, int, int]], [columnWidth=[int, int]], [columnWidth1=int], [columnWidth2=[int, int]], [columnWidth3=[int, int, int]], [columnWidth4=[int, int, int, int]], [columnWidth5=[int, int, int, int, int]], [columnWidth6=[int, int, int, int, 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], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [rowAttach=[int, string, 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.

rowLayout is undoable, queryable, and editable.

This command creates a layout capable of positioning children into a single horizontal row.

Return value

stringFull path name to the control.

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

Flags

adjustableColumn, adjustableColumn1, adjustableColumn2, adjustableColumn3, adjustableColumn4, adjustableColumn5, adjustableColumn6, annotation, backgroundColor, childArray, columnAlign, columnAlign1, columnAlign2, columnAlign3, columnAlign4, columnAlign5, columnAlign6, columnAttach, columnAttach1, columnAttach2, columnAttach3, columnAttach4, columnAttach5, columnAttach6, columnOffset1, columnOffset2, columnOffset3, columnOffset4, columnOffset5, columnOffset6, columnWidth, columnWidth1, columnWidth2, columnWidth3, columnWidth4, columnWidth5, columnWidth6, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, exists, fullPathName, height, highlightColor, isObscured, manage, noBackground, numberOfChildren, numberOfColumns, numberOfPopupMenus, parent, popupMenuArray, preventOverride, rowAttach, useTemplate, visible, visibleChangeCommand, width
Long name (short name) Argument types Properties
adjustableColumn(adj) int createedit
Specifies which column has an adjustable size that changes with the sizing of the layout.
adjustableColumn1(ad1) int create
Specifies that the first column has an adjustable size that changes with the size of the parent layout. Ignored if there isn't exactly one column.
adjustableColumn2(ad2) int create
Specifies which of the two columns has an adjustable size that changes with the size of the parent layout. Ignored if there isn't exactly two columns.
adjustableColumn3(ad3) int create
Specifies which of the three columns has an adjustable size that changes with the size of the parent layout. Ignored if there isn't exactly three columns.
adjustableColumn4(ad4) int create
Specifies which of the four columns has an adjustable size that changes with the size of the parent layout. Ignored if there isn't exactly four columns.
adjustableColumn5(ad5) int create
Specifies which of the five columns has an adjustable size that changes with the size of the parent layout. Ignored if there isn't exactly five columns.
adjustableColumn6(ad6) int create
Specifies which of the six columns has an adjustable size that changes with the size of the parent layout. Ignored if there isn't exactly six columns.
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.
childArray(ca) boolean query
Returns a string array of the names of the layout's immediate children.
columnAlign(cal) [int, string] createeditmultiuse
Text alignment for the specified column. Valid values are "left", "right", and "center"
columnAlign1(cl1) string create
Text alignment for the first column. Valid values are "left", "right", and "center". Ignored if there isn't exactly one column.
columnAlign2(cl2) [string, string] create
Text alignment for both columns. Valid values are "left", "right", and "center". Ignored if there isn't exactly two columns.
columnAlign3(cl3) [string, string, string] create
Text alignment for all three columns. Valid values are "left", "right", and "center". Ignored if there isn't exactly three columns.
columnAlign4(cl4) [string, string, string, string] create
Text alignment for all four columns. Valid values are "left", "right", and "center". Ignored if there isn't exactly four columns.
columnAlign5(cl5) [string, string, string, string, string] create
Text alignment for all five columns. Valid values are "left", "right", and "center". Ignored if there isn't exactly five columns.
columnAlign6(cl6) [string, string, string, string, string, string] create
Text alignment for all six columns. Valid values are "left", "right", and "center". Ignored if there isn't exactly six columns.
columnAttach(cat) [int, string, int] createeditmultiuse
Horizontally attach a particular column. The first argument is a 1-based index specifying the column. The second argument is the attachment, valid values are "left", "right", and "both". The third argument is the offset value.
columnAttach1(ct1) string create
Attachment type for the first column. Ignored if there isn't exactly one column. Valid values are "left", "right", and "both".
columnAttach2(ct2) [string, string] create
Attachment type for both columns. Ignored if there isn't exactly two columns. Valid values are "left", "right", and "both".
columnAttach3(ct3) [string, string, string] create
Attachment type for all three columns. Ignored if there isn't exactly three columns. Valid values are "left", "right", and "both".
columnAttach4(ct4) [string, string, string, string] create
Attachment type for all four columns. Ignored if there isn't exactly four columns. Valid values are "left", "right", and "both".
columnAttach5(ct5) [string, string, string, string, string] create
Attachment type for all five columns. Ignored if there isn't exactly five columns. Valid values are "left", "right", and "both".
columnAttach6(ct6) [string, string, string, string, string, string] create
Attachment type for all six columns. Ignored if there isn't exactly six columns. Valid values are "left", "right", and "both".
columnOffset1(co1) int create
Used in conjunction with the -columnAttach1 flag. If that flag is not used then this flag will be ignored. Sets the offset for the first column. The offsets applied are based on the attachments specified with the -columnAttach1 flag. Ignored if there isn't exactly one column.
columnOffset2(co2) [int, int] create
Used in conjunction with the -columnAttach2 flag. If that flag is not used then this flag will be ignored. Sets the offset for both columns. The offsets applied are based on the attachments specified with the -columnAttach2 flag. Ignored if there isn't exactly two columns.
columnOffset3(co3) [int, int, int] create
Used in conjunction with the -columnAttach3 flag. If that flag is not used then this flag will be ignored. Sets the offset for all three columns. The offsets applied are based on the attachments specified with the -columnAttach3 flag. Ignored if there isn't exactly three columns.
columnOffset4(co4) [int, int, int, int] create
Used in conjunction with the -columnAttach4 flag. If that flag is not used then this flag will be ignored. Sets the offset for all four columns. The offsets applied are based on the attachments specified with the -columnAttach4 flag. Ignored if there isn't exactly four columns.
columnOffset5(co5) [int, int, int, int, int] create
Used in conjunction with the -columnAttach5 flag. If that flag is not used then this flag will be ignored. Sets the offset for all five columns. The offsets applied are based on the attachments specified with the -columnAttach5 flag. Ignored if there isn't exactly five columns.
columnOffset6(co6) [int, int, int, int, int, int] create
Used in conjunction with the -columnAttach6 flag. If that flag is not used then this flag will be ignored. Sets the offset for all six columns. The offsets applied are based on the attachments specified with the -columnAttach6 flag. Ignored if there isn't exactly six columns.
columnWidth(cw) [int, int] createeditmultiuse
Width of a particular column. The first argument is a 1-based index specifying the column. The second argument is the width value.
columnWidth1(cw1) int create
Width for the first column. Ignored if there isn't exactly one column.
columnWidth2(cw2) [int, int] create
Widths for both columns. Ignored if there isn't exactly two columns.
columnWidth3(cw3) [int, int, int] create
Widths for all three columns. Ignored if there isn't exactly three columns.
columnWidth4(cw4) [int, int, int, int] create
Widths for all four columns. Ignored if there isn't exactly four columns.
columnWidth5(cw5) [int, int, int, int, int] create
Widths for all five columns. Ignored if there isn't exactly five columns.
columnWidth6(cw6) [int, int, int, int, int, int] create
Widths for all six columns. Ignored if there isn't exactly six columns.
defineTemplate(dt) string create
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 createqueryedit
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 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 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 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.
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.
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.
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.
numberOfColumns(nc) int createquery
Number of columns in the row. The specified number of columns must be a value greater than 0.
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.
preventOverride(po) boolean createqueryedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
rowAttach(rat) [int, string, int] createeditmultiuse
Vertically attach a particular column. The first argument is a 1-based index specifying the column. The second argument is the attachment, valid values are "top", "bottom", and "both". The third argument is the offset value.
useTemplate(ut) string create
Force the command to use a command template other than the current one.
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

#    Layout a label, field and slider such that the label is right
#    justified and the field adjusts in size as the window is resized.
#
cmds.window()
cmds.rowLayout( numberOfColumns=3, columnWidth3=(80, 75, 150), adjustableColumn=2, columnAlign=(1, 'right'), columnAttach=[(1, 'both', 0), (2, 'both', 0), (3, 'both', 0)] )
cmds.text()
cmds.intField()
cmds.intSlider()
cmds.showWindow()