attrNavigationControlGrp is undoable, queryable, and editable.
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. The column value is a 1-based index.
Passing 0 as argument turns 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 are 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 are 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 are 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 are 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 are not exactly
six columns.
|
|
-annotation(-ann)
|
string
|
|
|
Annotate the control with an extra string value.
|
|
-attrNavDecision(-and)
|
name string
|
|
|
The first argument is the name of an attribute.
The button will be attached to the attribute so the button
can be kept in synch with the attribute. The second
argument is the navigatorDecisionString that can guide the
behaviour that the navigator implements.
|
|
-attribute(-at)
|
name
|
|
|
The name of an attribute. The button will be attached
to the attribute so the button can be kept in synch
with the attribute.
|
|
-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.
|
|
-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 are not
exactly two columns. Valid values are "left", "right", and "center".
|
|
-columnAlign3(-cl3)
|
string string string
|
|
|
Sets the text alignment for all three columns. Ignored if there are not
exactly three columns. Valid values are "left", "right", and "center".
|
|
-columnAlign4(-cl4)
|
string string string string
|
|
|
Sets the text alignment for all four columns. Ignored if there are not
exactly four columns. Valid values are "left", "right", and "center".
|
|
-columnAlign5(-cl5)
|
string string string string string
|
|
|
Sets the text alignment for all five columns. Ignored if there are not
exactly five columns. Valid values are "left", "right", and "center".
|
|
-columnAlign6(-cl6)
|
string string string string string string
|
|
|
Sets the text alignment for all six columns. Ignored if there are not
exactly six columns. Valid values are "left", "right", and "center".
|
|
-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 are not
exactly two columns. Valid values are "left", "right", and "both".
|
|
-columnAttach3(-ct3)
|
string string string
|
|
|
Sets the attachment type for all three columns. Ignored if there are not
exactly three columns. Valid values are "left", "right", and "both".
|
|
-columnAttach4(-ct4)
|
string string string string
|
|
|
Sets the attachment type for all four columns. Ignored if there are not
exactly four columns. Valid values are "left", "right", and "both".
|
|
-columnAttach5(-ct5)
|
string string string string string
|
|
|
Sets the attachment type for all five columns. Ignored if there are not
exactly five columns. Valid values are "left", "right", and "both".
|
|
-columnAttach6(-ct6)
|
string string string string string string
|
|
|
Sets the attachment type for all six columns. Ignored if there are not
exactly six 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 are 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 are 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 are 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 are 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 are not exactly
six columns.
|
|
-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 are not
exactly two columns.
|
|
-columnWidth3(-cw3)
|
int int int
|
|
|
Sets the column widths for all 3 columns. Ignored if there are not
exactly 3 columns.
|
|
-columnWidth4(-cw4)
|
int int int int
|
|
|
Sets the column widths for all 4 columns. Ignored if there are not
exactly 4 columns.
|
|
-columnWidth5(-cw5)
|
int int int int int
|
|
|
Sets the column widths for all 5 columns. Ignored if there are not
exactly 5 columns.
|
|
-columnWidth6(-cw6)
|
int int int int int int
|
|
|
Sets the column widths for all 6 columns. Ignored if there are not
exactly 6 columns.
|
|
-connectAttrToDropped(-cad)
|
script
|
|
|
The script to execute when a node is dragged and dropped
onto an attribute (multilister dnd attribute editor).
Your script should take in two arguments: the source node
and destination attribute respectively.
|
|
-connectNodeToDropped(-cnd)
|
script
|
|
|
The script to execute when a node is dragged and dropped
onto a node (the multilister issues this). Your script
should take in two arguments: the source node and
destination node respectively.
|
|
-connectToExisting(-ce)
|
script
|
|
|
The script to execute when a connection should be
made to an existing node.
|
|
-createNew(-cn)
|
script
|
|
|
The script to execute when a new "connection" is
requested.
|
|
-defaultTraversal(-dtv)
|
script
|
|
|
The script to execute to find out the name of the default
traversal node. The script you attach should be able to
take in one argument (the attribute) and return the name
of the node that is the default traversal node.
|
|
-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.
|
|
-delete(-del)
|
string
|
|
|
The script to execute when the connection (and the node
connected to) should be deleted.
|
|
-disconnect(-d)
|
script
|
|
|
The script to execute when a "disconnection" is
requested.
|
|
-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.
|
|
-extraButton(-eb)
|
boolean
|
|
|
Add an extra icon button to the last of this control.
|
|
-extraButtonCommand(-ebc)
|
script
|
|
|
The command string is executed when the extra button is clicked.
|
|
-extraButtonIcon(-ebi)
|
string
|
|
|
The icon file name of the extra button.
|
|
-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.
|
|
-ignore(-i)
|
script
|
|
|
The script to execute when the connection should be
ignored.
|
|
-ignoreNotSupported(-ins)
|
|
|
|
Obsolete flag; has no effect.
|
|
-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.
|
|
-label(-l)
|
string
|
|
|
-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.
|
|
-noIgnorableMenu(-nim)
|
boolean
|
|
|
Not show ignorable related popup menu when right click the label.
|
|
-noKeyableMenu(-nkm)
|
boolean
|
|
|
Not show keyable related popup menu when right click the label.
|
|
-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.
|
|
-relatedNodes(-ren)
|
script
|
|
|
The script to execute to find out what the related
nodes are. The script you attach should be able to
take in one argument (the attribute) and return a list
of strings that are the name of the nodes that are
related.
|
|
-rowAttach(-rat)
|
int string int
|
|
|
Arguments are : column, attachment type, offset.
Possible attachments are: top | bottom | both.
Specifies attachment types and offsets for the entire row.
|
|
-statusBarMessage(-sbm)
|
string
|
|
|
Extra string to display in the status bar when the mouse is over the control.
|
|
-unignore(-u)
|
script
|
|
|
The script to execute when the connection should be
unignored.
|
|
-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.
|
|