radioButtonGrp is undoable, queryable, and editable.
| Long name (short name) |
[argument types] |
Properties |
-query(-q)
|
|
|
|
Puts the command in query mode so that it will return the
value of the specified flag.
In query mode, this flag needs a value.
|
|
-edit(-e)
|
|
|
|
Puts the command in edit mode so that it will
change the values of the specified flags
|
|
-exists(-ex)
|
|
|
|
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
|
|
|
Will 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.
In query mode, this flag needs a value.
|
|
-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.
In query mode, this flag needs a value.
|
|
-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.
In query mode, this flag needs a value.
|
|
-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).
In query mode, this flag needs a value.
|
|
-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.
In query mode, this flag needs a value.
|
|
-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.
In query mode, this flag needs a value.
|
|
-numberOfPopupMenus(-npm)
|
|
|
|
Return the number of popup menus attached to this control.
In query mode, this flag needs a value.
|
|
-popupMenuArray(-pma)
|
|
|
|
Return the names of all the popup menus attached to this
control.
In query mode, this flag needs a value.
|
|
-preventOverride(-po)
|
boolean
|
|
|
If true, this flag disallows overriding the control's
attribute via the control's right mouse button menu.
In query mode, this flag needs a value.
|
|
-annotation(-ann)
|
string
|
|
|
Annotate the control with an extra string value.
In query mode, this flag needs a 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. (Windows only flag)
|
|
-docTag(-dt)
|
|
|
|
Add a documentation flag to the control. The documentation flag
has a directory structure like hierarchy.
Eg. -dt render/multiLister/createNode/material
In query mode, this flag needs a value.
|
|
-dragCallback(-dgc)
|
string
|
|
|
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)
|
string
|
|
|
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'")
|
|
-columnWidth(-cw)
|
int int
|
|
|
Arguments are : column number, column width.
Sets the width of the specified column where the first parameter specifies
the column (1 based index) and the second parameter specifies the width.
|
|
-columnWidth1(-cw1)
|
int
|
|
|
Sets the width of the first column. Ignored if there is not
exactly one column.
|
|
-columnWidth2(-cw2)
|
int int
|
|
|
Sets the column widths of both columns. Ignored if there is not
exactly two columns.
|
|
-columnWidth3(-cw3)
|
int int int
|
|
|
Sets the column widths for all 3 columns. Ignored if there is not
exactly 3 columns.
|
|
-columnWidth4(-cw4)
|
int int int int
|
|
|
Sets the column widths for all 4 columns. Ignored if there is not
exactly 4 columns.
|
|
-columnWidth5(-cw5)
|
int int int int int
|
|
|
Sets the column widths for all 5 columns. Ignored if there is not
exactly 5 columns.
|
|
-columnWidth6(-cw6)
|
int int int int int int
|
|
|
Sets the column widths for all 6 columns. Ignored if there is not
exactly 6 columns.
|
|
-columnAttach(-cat)
|
int string int
|
|
|
Arguments are : column number, attachment type, and offset.
Possible attachments are: left | right | both.
Specifies column attachment types and offets.
|
|
-columnAttach2(-ct2)
|
string string
|
|
|
Sets the attachment type of both columns. Ignored if there is not
exactly two columns. Valid values are "left", "right", and "both".
|
|
-columnAttach3(-ct3)
|
string string string
|
|
|
Sets the attachment type for all 3 columns. Ignored if there is not
exactly 3 columns. Valid values are "left", "right", and "both".
|
|
-columnAttach4(-ct4)
|
string string string string
|
|
|
Sets the attachment type for all 4 columns. Ignored if there is not
exactly 4 columns. Valid values are "left", "right", and "both".
|
|
-columnAttach5(-ct5)
|
string string string string string
|
|
|
Sets the attachment type for all 5 columns. Ignored if there is not
exactly 5 columns. Valid values are "left", "right", and "both".
|
|
-columnAttach6(-ct6)
|
string string string string string string
|
|
|
Sets the attachment type for all 6 columns. Ignored if there is not
exactly 6 columns. Valid values are "left", "right", and "both".
|
|
-columnOffset2(-co2)
|
int int
|
|
|
This flag is used in conjunction with the -columnAttach2 flag. If that
flag is not used then this flag will be ignored. It sets the offset for
the two columns. The offsets applied are based on the attachments
specified with the -columnAttach2 flag. Ignored if there is not exactly
two columns.
|
|
-columnOffset3(-co3)
|
int int int
|
|
|
This flag is used in conjunction with the -columnAttach3 flag. If that
flag is not used then this flag will be ignored. It sets the offset for
the three columns. The offsets applied are based on the attachments
specified with the -columnAttach3 flag. Ignored if there is not exactly
three columns.
|
|
-columnOffset4(-co4)
|
int int int int
|
|
|
This flag is used in conjunction with the -columnAttach4 flag. If that
flag is not used then this flag will be ignored. It sets the offset for
the four columns. The offsets applied are based on the attachments
specified with the -columnAttach4 flag. Ignored if there is not exactly
four columns.
|
|
-columnOffset5(-co5)
|
int int int int int
|
|
|
This flag is used in conjunction with the -columnAttach5 flag. If that
flag is not used then this flag will be ignored. It sets the offset for
the five columns. The offsets applied are based on the attachments
specified with the -columnAttach5 flag. Ignored if there is not exactly
five columns.
|
|
-columnOffset6(-co6)
|
int int int int int int
|
|
|
This flag is used in conjunction with the -columnAttach6 flag. If that
flag is not used then this flag will be ignored. It sets the offset for
the six columns. The offsets applied are based on the attachments
specified with the -columnAttach6 flag. Ignored if there is not exactly
six columns.
|
|
-rowAttach(-rat)
|
string int
|
|
|
Arguments are : attachment type, offset.
Possible attachments are: top | bottom | both.
Specifies attachment types and offsets for the entire row.
|
|
-columnAlign(-cal)
|
int string
|
|
|
Arguments are : column number, alignment type.
Possible alignments are: left | right | center.
Specifies alignment type for the specified column.
|
|
-columnAlign2(-cl2)
|
string string
|
|
|
Sets the text alignment of both columns. Ignored if there is not
exactly two columns. Valid values are "left", "right", and "center".
|
|
-columnAlign3(-cl3)
|
string string string
|
|
|
Sets the text alignment for all 3 columns. Ignored if there is not
exactly 3 columns. Valid values are "left", "right", and "center".
|
|
-columnAlign4(-cl4)
|
string string string string
|
|
|
Sets the text alignment for all 4 columns. Ignored if there is not
exactly 4 columns. Valid values are "left", "right", and "center".
|
|
-columnAlign5(-cl5)
|
string string string string string
|
|
|
Sets the text alignment for all 5 columns. Ignored if there is not
exactly 5 columns. Valid values are "left", "right", and "center".
|
|
-columnAlign6(-cl6)
|
string string string string string string
|
|
|
Sets the text alignment for all 6 columns. Ignored if there is not
exactly 6 columns. Valid values are "left", "right", and "center".
|
|
-adjustableColumn(-adj)
|
int
|
|
|
Specifies which column has an adjustable size that changes with the
sizing of the layout. The column value is a 1-based index. You may
also specify 0 to turn off the previous adjustable column.
|
|
-adjustableColumn2(-ad2)
|
int
|
|
|
Specifies which column has an adjustable size that changes with
the size of the parent layout. Ignored if there is not exactly
two columns.
|
|
-adjustableColumn3(-ad3)
|
int
|
|
|
Specifies that the column has an adjustable size that changes with
the size of the parent layout. Ignored if there is not exactly
three columns.
|
|
-adjustableColumn4(-ad4)
|
int
|
|
|
Specifies which column has an adjustable size that changes with
the size of the parent layout. Ignored if there is not exactly
four columns.
|
|
-adjustableColumn5(-ad5)
|
int
|
|
|
Specifies which column has an adjustable size that changes with
the size of the parent layout. Ignored if there is not exactly
five columns.
|
|
-adjustableColumn6(-ad6)
|
int
|
|
|
Specifies which column has an adjustable size that changes with
the size of the parent layout. Ignored if there is not exactly
six columns.
|
|
-numberOfRadioButtons(-nrb)
|
int
|
|
|
Number of radio buttons in the group (1 - 4).
|
|
-shareCollection(-scl)
|
string
|
|
|
Specify the radioButtonGrp that this radio group is to be
associated with. By default the radio group will be a separate
collection.
|
|
-select(-sl)
|
int
|
|
|
Selected radio button. The argument is a 1 based integer.
In query mode, this flag needs a value.
|
|
-label(-l)
|
string
|
|
|
When present on creation an optional text label will be
built with the group. The string specifes the label text.
In query mode, this flag needs a value.
|
|
-label1(-l1)
|
string
|
|
|
|
-label2(-l2)
|
string
|
|
|
|
-label3(-l3)
|
string
|
|
|
|
-label4(-l4)
|
string
|
|
|
Specify label strings for the respective radio buttons in
the group.
In query mode, this flag needs a value.
|
|
-labelArray2(-la2)
|
string string
|
|
|
|
-labelArray3(-la3)
|
string string string
|
|
|
|
-labelArray4(-la4)
|
string string string string
|
|
|
Specify multiple labels in a single flag. These flags
are ignored if the number of radio buttons doesn't match.
|
|
-changeCommand(-cc)
|
string
|
|
|
Command executed whenever the group changes state.
|
|
-changeCommand1(-cc1)
|
string
|
|
|
|
-changeCommand2(-cc2)
|
string
|
|
|
|
-changeCommand3(-cc3)
|
string
|
|
|
|
-changeCommand4(-cc4)
|
string
|
|
|
Specify a changed state command for each respective radio
button.
|
|
-onCommand(-onc)
|
string
|
|
|
Command executed when any radio button turns on.
|
|
-onCommand1(-on1)
|
string
|
|
|
|
-onCommand2(-on2)
|
string
|
|
|
|
-onCommand3(-on3)
|
string
|
|
|
|
-onCommand4(-on4)
|
string
|
|
|
On command for each respective radio button.
|
|
-offCmd(-ofc)
|
string
|
|
|
Command executed when any radio button turns off.
|
|
-offCommand1(-of1)
|
string
|
|
|
|
-offCommand2(-of2)
|
string
|
|
|
|
-offCommand3(-of3)
|
string
|
|
|
|
-offCommand4(-of4)
|
string
|
|
|
Off command for each respective radio button.
|
|
-enable1(-en1)
|
boolean
|
|
|
|
-enable2(-en2)
|
boolean
|
|
|
|
-enable3(-en3)
|
boolean
|
|
|
|
-enable4(-en4)
|
boolean
|
|
|
Enable state of the individual radio buttons.
In query mode, this flag needs a value.
|
|
-data1(-da1)
|
int
|
|
|
|
-data2(-da2)
|
int
|
|
|
|
-data3(-da3)
|
int
|
|
|
|
-data4(-da4)
|
int
|
|
|
Internal data associated with each radio button.
In query mode, this flag needs a value.
|
|
-editable(-ed)
|
boolean
|
|
|
The edit state of the group. By default, this flag
is set to true and the radio button values may be changed by
clicking on them. If false then the radio buttons are 'read only'
and can not be clicked on. The value of the radio button can
always be changed with the -sl/select flags regardless of
the state of the -ed/editable flag.
In query mode, this flag needs a value.
|
|
-vertical(-vr)
|
|
|
|
Whether the orientation of the radio buttons in this group
are horizontal (default) or vertical.
In query mode, this flag needs a value.
|
|
Flag can be used more than once in a command