progressBar is undoable, queryable, and editable.
Creates a progress bar control that graphically fills in as its
progress value increases.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
exists(ex) |
boolean |
|
|
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 |
|
|
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). |
|
visibleChangeCommand(vcc) |
script |
|
|
Command that gets executed when visible state of the control
changes. |
|
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. |
|
|
boolean |
|
|
Return the number of popup menus attached to this control. |
|
|
boolean |
|
|
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.
When setting backgroundColor, the background is automatically
enabled, unless enableBackground is also specified with a false
value. |
|
enableBackground(ebg) |
boolean |
|
|
Enables the background color of the control. |
|
docTag(dtg) |
string |
|
|
Add a documentation flag to the control. The documentation flag
has a directory structure like hierarchy. Eg. -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 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) |
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'") |
|
fullPathName(fpn) |
string |
|
|
Return the full path name of the widget, which includes all the
parents |
|
isCancelled(ic) |
boolean |
|
|
Returns true if the user has tried to cancel the operation.
Returns false otherwise. |
|
progress(pr) |
int |
|
|
The amount of progress currently shown on the control. The
value will always be between min and max. Default is equal to the
minimum when the control is created. |
|
step(s) |
int |
|
|
Increments the -pr/progress value by the amount specified. |
|
minValue(min) |
int |
|
|
The minimum or "starting" value of the progress indicator. If
the progress value is less than the -min/minValue, the progress
value will be set to the minimum. Default value is 0. |
|
maxValue(max) |
int |
|
|
The maximum or "ending" value of the progress indicator. If the
progress value is greater than the -max/maxValue, the progress
value will be set to the maximum. Default value is 100. |
|
isMainProgressBar(imp) |
boolean |
|
|
Determines whether this progressBar is used to show the
progress of all basic operations such as Open/Save file.The main
progressBar behaves very differently, in that it only shows itself
when there is an ongoing basic operation.Defaults to false, and
only one progress bar will be recognized as the "main" one. |
|
status(st) |
string |
|
|
Only valid for the main progress bar
Sets the contents of the helpLine control when the progressBar is
showing. Use this instead of setting the helpLine directly because
this will force a graphical refresh before returning. |
|
isInterruptable(ii) |
boolean |
|
|
Only valid for the main progress bar
Returns true if the isCancelled flag should respond to attempts to
cancel the operation. Setting this to true will put make the help
line display message to the user indicating that they can cancel
the operation. |
|
beginProgress(bp) |
boolean |
|
|
Only valid for the main progress bar
Shows the main progress bar (normally in the Help Line). This is
normally issued through MEL when a length computation is about to
occur. |
|
endProgress(ep) |
boolean |
|
|
Only valid for the main progress bar
Hides the progress bar. No other flags can be used at the same
time. This is normally issued through MEL in response to the
-ic/isCancelled flag being set or if the progress value reaches its
maximum. |
|