| 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.
|
|
-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.
|
|
-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).
|
|
-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.
|
|
-numberOfPopupMenus
(-npm)
| | |
|
Return the number of popup menus attached to this control.
|
|
-popupMenuArray
(-pma)
| | |
|
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. (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
|
|
-dragCallback
(-dgc)
| string | |
|
Adds a callback that is called when the middle mouse button
is pressed. 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.
|
|
-dropCallback
(-dpc)
| string | |
|
Adds a callback that is called when a drag and drop
operation is released above the drop site. 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.
|
|
-numberOfChildren
(-nch)
| | |
|
Returns in an int the number of immediate children of the layout.
|
|
-childArray
(-ca)
| | |
|
Returns a string array of the names of the layout's
immediate children.
|
|
-horizontalScrollBarThickness
(-hst)
| int | |
|
Thickness of the horizontal scroll bar. Specify an
integer value of pixels greater than or equal to 0. Other
than setting the value to 0 to hide the scrollbar, this
flag has no effect on Windows systems.
|
|
-verticalScrollBarThickness
(-vst)
| int | |
|
Thickness of the vertical scroll bar. Specify an
integer value of pixels greater than or equal to 0.
This flag has no effect on Windows systems.
|
|
-childResizable
(-cr)
| boolean | |
|
Set to true if you want the child of the control layout to be
as wide as the scroll area. You may also indicate a minimum
width for the child using the -mcw/minimumChildWidth flag.
|
|
-scrollAreaWidth
(-saw)
| | |
|
Return the width of the scroll area (in pixels).
|
|
-scrollAreaHeight
(-sah)
| | |
|
Return the height of the scroll area (in pixels).
|
|
-scrollAreaValue
(-sav)
| | |
|
Return the vertical and horizontal values of the scroll
area (in pixels).
|
|
-minChildWidth
(-mcw)
| int | |
|
A positive non-zero integer value indicating the
minimum width the scroll layout's child. This flag only has
meaning when the -cr/childResizable flag is set to true.
|
|
-resizeCommand
(-rc)
| string | |
|
The command invoked when the scroll layout is resized.
|
|
-scrollPage
(-sp)
| string | |
|
Scroll the client area in the direction of the string.
Valid values are "up", "down", "left" or "right".
|
|
-scrollByPixel
(-sbp)
| string int | |
|
Scroll the client area in the direction of the string.
The int specifies the number of pixels.
|
|
Flag can be used more than once in a command