pymel.core.windows.rowColumnLayout

rowColumnLayout(*args, **kwargs)

This command creates a rowColumn layout. A rowColumn layout positions children in either a row or column format. A column layout, specified with the -nc/numberOfColumnsflag, allows you set text alignment, attachments and offsets for each column in the layout. Every member of a column will have the same alignment, attachment and offsets. Likewise the row format, specified by the -nr/numberOfRowsflag, allows setting of these attributes for each row in the layout. Every member of a row will have the same attributes. The layout must be either a row or column format. This layout does not support both, or the specification of attributes on an individual child basis. Some flags only make sense for one of either the row format or the column format. For example the -rh/rowHeightflag can only be specified in row format. In column format the row height is determined by the tallest child in the row, plus offsets.

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.
childArray (ca)		bool
	Returns a string array of the names of the layout’s immediate children.
columnAlign (cal)		int, unicode
	Alignment for text and pixmaps in the specified column. Values are: left, rightand center. Only valid for column format, ie. number of columns specified with -nc/numberOfColumnsflag.
columnAttach (cat)		int, unicode, 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, rightand both. The third argument must be greater than 0 and specifies the offset.
columnOffset (co)		int, unicode, 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, rightand 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)		unicode
	Puts a 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
dragCallback (dgc)		callable
	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)		callable
	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 true|false depending upon whether the specified object exists. 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.
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.
numberOfChildren (nch)		bool
	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/numRowsflag. Either one or the other can be specified.
numberOfPopupMenus (npm)		bool
	Return the number of popup menus attached to this control.
numberOfRows (nr)		int
	Number of rows. This flag is mutually exclusive to the -nc/numColumnsflag. Either one or the other can be specified.
parent (p)		unicode
	The parent layout for this control.
popupMenuArray (pma)		bool
	Return the names of all the popup menus attached to this control.
preventOverride (po)		bool
	If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
rowAlign (ral)		int, unicode
	Alignment for text and pixmaps in the specified row. Values are: left, rightand center. Only valid for row format, ie. number of rows specified with -nr/numberOfRowsflag.
rowAttach (rat)		int, unicode, 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, bottomand 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, unicode, 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, bottomand 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. Flag can have multiple arguments, passed either as a tuple or a list.
useTemplate (ut)		unicode
	Force the command to use a command template other than the current one.
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)		callable
	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.

Derived from mel command maya.cmds.rowColumnLayout

Example:

import pymel.core as pm

#    The following script will position the buttons in a single column.
#
#    +----+
#    | b1 |
#    +----+
#    +----+
#    | b2 |
#    +----+
#    +----+
#    | b3 |
#    +----+
#
pm.window()
# Result: ui.Window('window1') #
pm.rowColumnLayout( numberOfColumns=1 )
# Result: ui.RowColumnLayout('window1|rowColumnLayout1') #
pm.button()
# Result: ui.Button('window1|rowColumnLayout1|button4') #
pm.button()
# Result: ui.Button('window1|rowColumnLayout1|button5') #
pm.button()
# Result: ui.Button('window1|rowColumnLayout1|button6') #
pm.showWindow()

#    The following script will position the buttons in a single row.
#
#    +----++----++----+
#    | b1 || b2 || b3 |
#    +----++----++----+
#
pm.window()
# Result: ui.Window('window2') #
pm.rowColumnLayout( numberOfRows=1 )
# Result: ui.RowColumnLayout('window2|rowColumnLayout2') #
pm.button()
# Result: ui.Button('window2|rowColumnLayout2|button7') #
pm.button()
# Result: ui.Button('window2|rowColumnLayout2|button8') #
pm.button()
# Result: ui.Button('window2|rowColumnLayout2|button9') #
pm.showWindow()

#    The following script will position the buttons in 3 columns, each
#    column a different width.
#
#    +----++--------++------------+
#    | b1 ||   b2   ||     b3     |
#    +----++--------++------------+
#    +----++--------++------------+
#    | b4 ||   b5   ||     b6     |
#    +----++--------++------------+
#    +----+
#    | b7 |
#    +----+
#
pm.window()
# Result: ui.Window('window3') #
pm.rowColumnLayout( numberOfColumns=3, columnWidth=[(1, 60), (2, 80), (3, 100)] )
# Result: ui.RowColumnLayout('window3|rowColumnLayout3') #
pm.button()
# Result: ui.Button('window3|rowColumnLayout3|button10') #
pm.button()
# Result: ui.Button('window3|rowColumnLayout3|button11') #
pm.button()
# Result: ui.Button('window3|rowColumnLayout3|button12') #
pm.button()
# Result: ui.Button('window3|rowColumnLayout3|button13') #
pm.button()
# Result: ui.Button('window3|rowColumnLayout3|button14') #
pm.button()
# Result: ui.Button('window3|rowColumnLayout3|button15') #
pm.button()
# Result: ui.Button('window3|rowColumnLayout3|button16') #
pm.showWindow()

#    The following script will position the buttons in 2 rows, each
#    row a different height.
#
#    +----++----++----++----+
#    | b1 || b3 || b5 || b7 |
#    +----++----++----++----+
#    +----++----++----+
#    |    ||    ||    |
#    | b2 || b4 || b6 |
#    |    ||    ||    |
#    +----++----++----+
#
pm.window()
# Result: ui.Window('window4') #
pm.rowColumnLayout( numberOfRows=2, rowHeight=[(1, 30), (2, 60)] )
# Result: ui.RowColumnLayout('window4|rowColumnLayout4') #
pm.button()
# Result: ui.Button('window4|rowColumnLayout4|button17') #
pm.button()
# Result: ui.Button('window4|rowColumnLayout4|button18') #
pm.button()
# Result: ui.Button('window4|rowColumnLayout4|button19') #
pm.button()
# Result: ui.Button('window4|rowColumnLayout4|button20') #
pm.button()
# Result: ui.Button('window4|rowColumnLayout4|button21') #
pm.button()
# Result: ui.Button('window4|rowColumnLayout4|button22') #
pm.button()
# Result: ui.Button('window4|rowColumnLayout4|button23') #
pm.showWindow()