gridLayout

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

Synopsis

gridLayout( [string] , [allowEmptyCells=boolean], [annotation=string], [autoGrow=boolean], [backgroundColor=[float, float, float]], [cellHeight=int], [cellWidth=int], [cellWidthHeight=[int, int]], [childArray=boolean], [columnsResizable=boolean], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [exists=boolean], [fullPathName=string], [gridOrder=boolean], [height=int], [isObscured=boolean], [manage=boolean], [numberOfChildren=boolean], [numberOfColumns=int], [numberOfPopupMenus=boolean], [numberOfRows=int], [numberOfRowsColumns=[int, int]], [parent=string], [popupMenuArray=boolean], [position=[string, int]], [preventOverride=boolean], [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.

gridLayout is undoable, queryable, and editable.

Return value

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

Flags

Long name (short name)	Argument types	Properties
exists(ex)	boolean
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
defineTemplate(dt)	string
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.
useTemplate(ut)	string
Force the command to use a command template other than the current one.
parent(p)	string
The parent layout for this control.
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.
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.
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.
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.
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.
numberOfPopupMenus(npm)	boolean
Return the number of popup menus attached to 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.
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.
enableBackground(ebg)	boolean
Enables the background color of the control.
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'")
fullPathName(fpn)	string
Return the full path name of the widget, which includes all the parents
numberOfChildren(nch)	boolean
Returns in an int the number of immediate children of the layout.
childArray(ca)	boolean
Returns a string array of the names of the layout's immediate children.
columnsResizable(cr)	boolean
Specify true if you want the number of columns to adjust according to the width of the layout. Set to false if you want the number of columns to remain fixed when the width of the layout is changed. The default is false.
allowEmptyCells(aec)	boolean
Specify true if you want free positioning of the children in the layout and potentially leaving empty cells between children. Set to false if you want the children to always be packed together. The default is true.
autoGrow(ag)	boolean
Specify true if you want the grid layout size to grow as children are added. For example, if the grid layout has 2 columns and 2 rows then adding a fifth child will cause the grid to expand to 3 rows if this flag is true, otherwise the grid will remain the same size and the new child will be hidden from view until you expand the size of the grid using the appropriate flags. The default is true.
numberOfRowsColumns(nrc)	[int, int]
Two positive non-zero integer values for the number of rows and columns, respectively, in the grid layout.
numberOfRows(nr)	int
A positive non-zero integer value indicating the number of rows in the grid layout.
numberOfColumns(nc)	int
A positive non-zero integer value indicating the number of columns in the grid layout.
cellWidthHeight(cwh)	[int, int]
Two positive non-zero integer values for indicating the width and height, respectively, of the cells in the grid layout.
cellWidth(cw)	int
A positive non-zero integer value indicating the width of cells in the grid layout.
cellHeight(ch)	int
A positive non-zero integer value indicating the height of cells in the grid layout.
gridOrder(go)	boolean
As opposed to the childArray flag, the gridOrder flag returns the children of the grid Layout in the order they are diplayed in the window.
position(pos)	[string, int]
Specify the name of a child control in the grid layout along with a 1-based integer value indicating the desired position of the child. Positions increase from left to right within a row and then wrap around to the next row increasing from top to bottom. For example, a grid layout with 3 columns and 2 rows has 6 visible positions where 1, 2 and 3 occupy the first row and 4, 5 and 6 occupy the second.

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

cmds.window()
cmds.gridLayout( numberOfColumns=2, cellWidthHeight=(50, 50) )
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.button()
cmds.showWindow()