rowColumnLayout is undoable, queryable, and editable.
This command creates a rowColumn layout. A rowColumn layout positions
children in either a row or column format. A column layout, specified
with the In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
|
adjustableColumn(adj)
|
int
|
|
|
Specifies which column has an adjustable size that changes
with the sizing of the layout.
|
|
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 attachments 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 arguments 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.
(e.g., -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 CTRL and
SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL,
3 == CTRL + 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.
|
|
enableKeyboardFocus(ekf)
|
boolean
|
|
|
If enabled, the user can navigate to the control with the tab key and select values with the keyboard or mouse.
This flag would typically be used to turn off focus support from controls that get it by default, like Edit and List controls.
If disabled, text in text fields can still be selected with the mouse but cannot be copied (except on Linux when "Middle Click Paste" is enabled).
|
|
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 prevents 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 attachments 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.
|
|
statusBarMessage(sbm)
|
string
|
|
|
Extra string to display in the status bar when the mouse is over the control.
|
|
useTemplate(ut)
|
string
|
|
|
Forces 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.
|
|