progressWindow

Go to: Synopsis. Flags. Return value. MEL examples.

Synopsis

progressWindow [-endProgress] [-isCancelled] [-isInterruptable] [-maxValue int] [-minValue int] [-progress int] [-status string] [-step int] [-title string]

progressWindow is undoable, queryable, and editable.

Only one progress window is allowed on screen at a time. While the window is visible, the busy cursor is shown.

Flags

Long name (short name)	[argument types]	Properties
-isCancelled(-ic)
Returns true if the user has tried to cancel the operation. Returns false otherwise. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-title(-t)	string
The window title. In query mode, this flag needs a value.
-status(-st)	string
The status text appearing above the progress gauge. In query mode, this flag needs a value.
-isInterruptable(-ii)
Returns true if the progress window should respond to attempts to cancel the operation. The cancel button is disabled if this is set to true. In query mode, this flag needs a value.
-endProgress(-ep)
Terminates the progress window. 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.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command

Return value

Query returns the appropriate flag value.

MEL examples

// +-+------------------+
// |-|  Doing Nothing   |
// +--------------------+
// | Sleeping: 40%      |
// |                    |
// | +----------------+ |
// | |||||||          | |
// | +----------------+ |
// |                    |
// | Hit ESC to Cancel  |
// +--------------------+

// Always use the progress dialog from a script, never directly
// from the Script Editor.

     int $amount = 0;

     progressWindow
         -title "Doing Nothing"
         -progress $amount
         -status "Sleeping: 0%"
         -isInterruptable true;

     while (true) {

         // Check if the dialog has been cancelled
         if ( `progressWindow -query -isCancelled` ) break;

         // Check if end condition has been reached
         if ( `progressWindow -query -progress` >= 100 ) break;

         $amount += 5;

         progressWindow -edit
             -progress $amount
             -status ("Sleeping: "+$amount+"%");

         pause -seconds 1;
     }

     progressWindow -endProgress;