Go to: Synopsis. Return value. Flags. Python examples.
formLayout( [string] , [annotation=string], [attachControl=[string, string, int,
string]], [attachForm=[string,
string, int]], [attachNone=[string, string]],
[attachOppositeControl=[string,
string, int, string]], [attachOppositeForm=[string,
string, int]], [attachPosition=[string, string, int,
int]], [backgroundColor=[float, float,
float]], [childArray=boolean], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean],
[exists=boolean], [fullPathName=string], [height=int], [isObscured=boolean], [manage=boolean], [numberOfChildren=boolean],
[numberOfDivisions=int],
[numberOfPopupMenus=boolean],
[parent=string], [popupMenuArray=boolean], [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.
formLayout is undoable, queryable, and editable.
This command creates a form layout control. A form layout allows
absolute and relative positioning of the controls that are its
immediate children. Controls have four edges: top, left, bottom and
right. There are only two directions that children can be
positioned in, right-left and up-down. The attach flags take the
direction of an attachment from the argument that names the edge to
attach (the second argument). Any or all edges of a child may be
attached. There are six ways to attach them:
- Attach to Form - Attaches an edge to the relevant side of the
form layout. Thus -attachForm button3 "left" will attach the left
edge of the button to the left edge of the form.
- Attach to Opposite Side of Form - Attaches an edge relative to
the furthest side of the form layout.
- Attach to Another Control - Attaches an edge to the closest
edge of the other control named.
- Attach to Opposite Side of Another Control - Attaches an edge
relative to the furthest side of another control.
- Attach to Position - Attaches an edge to a position on the form
layout. The position is given as a fixed fraction of the
-nd/numDivisions value and as this value defaults to 100 it is
easiest to think of it as a percentage of the form's size.
- Attach to Nothing - Attaches an edge to nothing. The size of
the child control will determine this edge's position.
Each edge attachment may have an offset that acts to separate
controls visually. There is no default positioning relationship so
to have children appear in the form they must have at least one
edge attached in each direction. Note: In the flag
definitions the arguments follow these rules:
- control must be the name of an immediate child of the
form layout.
- edge must be one of "top", "left", "bottom", or
"right".
- position may range from 0 to the number of divisions as
specified with the -nd/numberOfDivisions flag and gives the
fraction of the width of the form as a measurement. This normally
means 0-100 so position may be thought of as a
percentage.
- offset is an integer value in pixels.
These are multi-use flags so any number of attachments may be made
in a single command. Note: More information on formLayouts
can be found in the online User-interface Creation manual.
| string |
The full name of the control. |
In query mode, return type is based on queried flag.
annotation, attachControl, attachForm, attachNone, attachOppositeControl, attachOppositeForm, attachPosition, backgroundColor, childArray, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, exists, fullPathName, height, isObscured,
manage, numberOfChildren, numberOfDivisions, numberOfPopupMenus, parent, popupMenuArray, preventOverride, useTemplate, visible, visibleChangeCommand, width
| 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. |
|
|
boolean |
|
|
Return the number of popup menus attached to this control. |
|
|
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. |
|
numberOfDivisions(nd) |
int |
|
|
Specify the number of horizontal and vertical divisions across
the form. Value must be greater than 0. |
|
attachForm(af) |
[string, string, int] |
 |
|
Arguments are: control, edge, offset. Valid edge values are:
"top" | "bottom" | "left" | "right". Attach the specified control
to the form, offset by the specified amount. |
|
attachOppositeForm(aof) |
[string, string, int] |
|
|
Arguments are: control, edge, offset. Valid edge values are:
"top" | "bottom" | "left" | "right". Attach a control to the
opposite side of the form. |
|
attachControl(ac) |
[string, string, int,
string] |
|
|
Arguments are: control, edge, offset, control Valid edge values
are: "top" | "bottom" | "left" | "right". Attach a control to
another control. |
|
attachOppositeControl(aoc) |
[string, string, int,
string] |
|
|
Arguments are: control, edge, offset, control Valid edge values
are: "top" | "bottom" | "left" | "right". Attach a control to the
opposite side of another control. |
|
attachPosition(ap) |
[string, string, int,
int] |
|
|
Arguments are: control, edge, offset, position Valid edge
values are: "top" | "bottom" | "left" | "right". Attach a control
to a position in the form. |
|
attachNone(an) |
[string, string] |
|
|
Arguments are: control, edge Valid edge values are: "top" |
"bottom" | "left" | "right". Attach a control to nothing. |
|
| 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. |
import maya.cmds as cmds
window = cmds.window()
form = cmds.formLayout(numberOfDivisions=100)
b1 = cmds.button()
b2 = cmds.button()
column = cmds.columnLayout()
cmds.button()
cmds.button()
cmds.button()
cmds.formLayout( form, edit=True, attachForm=[(b1, 'top', 5), (b1, 'left', 5), (b2, 'left', 5), (b2, 'bottom', 5), (b2, 'right', 5), (column, 'top', 5), (column, 'right', 5) ], attachControl=[(b1, 'bottom', 5, b2), (column, 'bottom', 5, b2)], attachPosition=[(b1, 'right', 5, 75), (column, 'left', 0, 75)], attachNone=(b2, 'top') )
cmds.showWindow( window )