rowLayout is undoable, queryable, and editable.
This command creates a layout capable of positioning children into
a single horizontal row.
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.
|
|
-adjustableColumn1(-ad1)
|
int
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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)
|
|
|
|
Returns a string array of the names of the layout's
immediate children.
|
|
-columnAlign(-cal)
|
int string
|
|
|
Text alignment for the specified column.
Valid values are "left", "right", and "center"
|
|
-columnAlign1(-cl1)
|
string
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
Attachment type for all six columns. Ignored if there isn't
exactly six columns. Valid values are "left", "right", and "both".
|
|
-columnOffset1(-co1)
|
int
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
|
|
|
Width for the first column. Ignored if there isn't exactly
one column.
|
|
-columnWidth2(-cw2)
|
int int
|
|
|
Widths for both columns. Ignored if there isn't
exactly two columns.
|
|
-columnWidth3(-cw3)
|
int int int
|
|
|
Widths for all three columns. Ignored if there isn't
exactly three columns.
|
|
-columnWidth4(-cw4)
|
int int int int
|
|
|
Widths for all four columns. Ignored if there isn't
exactly four columns.
|
|
-columnWidth5(-cw5)
|
int int int int int
|
|
|
Widths for all five columns. Ignored if there isn't
exactly five columns.
|
|
-columnWidth6(-cw6)
|
int int int int int int
|
|
|
Widths for all six columns. Ignored if there isn't
exactly six columns.
|
|
-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)
|
|
|
|
Returns whether the
specified object exists or not. Other flags are ignored.
|
|
-fullPathName(-fpn)
|
|
|
|
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)
|
|
|
|
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)
|
|
|
|
Returns in an int the number of immediate children of the layout.
|
|
-numberOfColumns(-nc)
|
int
|
|
|
Number of columns in the row. The specified number of
columns must be a value greater than 0.
|
|
-numberOfPopupMenus(-npm)
|
|
|
|
Return the number of popup menus attached to this control.
|
|
-parent(-p)
|
string
|
|
|
The parent layout for this control.
|
|
-popupMenuArray(-pma)
|
|
|
|
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.
|
|
-rowAttach(-rat)
|
int string int
|
|
|
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.
|
|
-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.
|
|