MProgressWindow Class Reference
[OpenMayaUI - API module for user interface]

#include <MProgressWindow.h>

List of all members.


Detailed Description

Create and manipulate progress windows.

The MProgressWindow class manages a window containing a status message, a graphical progress gauge, and optionally a "Hit ESC to Cancel" label for interruptable operations.

Only a single progress window may be displayed at any time. To reserve the use of the progress window, use the reserve() method in this class. Any methods that change the state of the progress window will fail unless the progress window has first been successfully reserved.

The startProgress() and endProgress() functions show and hide the progress window. endProgress() also has the effect of unreserving the progress window, allowing it to be reserved for another use.

The MEL command "progressWindow" provides equivalent functionality to this class. Attempting to manipulate a progress window that is in use by MEL will cause the methods in this class to fail.


Static Public Member Functions

static bool  reserve ()
static MStatus  startProgress ()
static MStatus  endProgress ()
static MStatus  setProgressRange (const int minValue, const int maxValue)
static MStatus  setProgressMin (const int minValue)
static MStatus  setProgressMax (const int maxValue)
static int  progressMin (MStatus *ReturnStatus=NULL)
static int  progressMax (MStatus *ReturnStatus=NULL)
static MStatus  setProgress (const int progress)
static MStatus  advanceProgress (const int amount)
static int  progress (MStatus *ReturnStatus=NULL)
static MStatus  setTitle (const MString &title)
static MString  title (MStatus *ReturnStatus=NULL)
static MStatus  setProgressStatus (const MString &progressStatus)
static MString  progressStatus (MStatus *ReturnStatus=NULL)
static MStatus  setInterruptable (const bool value)
static bool  isInterruptable (MStatus *ReturnStatus=NULL)
static bool  isCancelled (MStatus *ReturnStatus=NULL)

Member Function Documentation

bool MProgressWindow::reserve (  )  [static]

Reserves a progress window for use through this class. This method must be called before setting progress window parameters or starting progress.

Returns:
true if the progress window was successfully reserved
Examples:

MStatus MProgressWindow::startProgress (  )  [static]

Displays the progress window on the screen.

Returns:
Status code
Status Codes:
Examples:

MStatus MProgressWindow::endProgress (  )  [static]

Destroys the progress window and removes it from the screen. This method also unreserves the progress window, making it available for future reservation.

Returns:
Status code
Status Codes:
Examples:

MStatus MProgressWindow::setProgressRange ( const int  minValue,
const int  maxValue  
) [static]

Sets the range (minValue, maxValue) of the progress indicator. When the progress value is set through setProgress() or advanceProgress(), it is checked against the minimum and maximum progress values. If the new progress value lies outside this range, it is clamped to a value in this range.

When the progress value is set to a value of minValue, the progress bar is displayed as empty. When the progress value is set to a value of maxValue, the progress bar is displayed as full. Intermediate progress values are displayed as intermediate positions of the progress bar.

Parameters:
[in]  minValue  Minimum progress value
[in]  maxValue  Maximum progress value
Returns:
Status code
Status Codes:
Examples:

MStatus MProgressWindow::setProgressMin ( const int  minValue  )  [static]

Sets the minimum value for the progress. Any progress value less then minValue will be set to minValue, with the progress bar displayed as empty.

Parameters:
[in]  minValue  Minimum progress value
Returns:
Status code
Status Codes:

MStatus MProgressWindow::setProgressMax ( const int  maxValue  )  [static]

Sets the maximum value for the progress. Any progress value greater then maxValue will be set to maxValue, with the progress bar displayed as full.

Parameters:
[in]  maxValue  Maximum progress value
Returns:
Status code
Status Codes:

int MProgressWindow::progressMin ( MStatus ReturnStatus = NULL  )  [static]

Get the minimum progress value.

Parameters:
[out]  ReturnStatus  Status code
Returns:
Minimum progress value. Returns -1 if query fails.
Examples:

int MProgressWindow::progressMax ( MStatus ReturnStatus = NULL  )  [static]

Get the maximum progress value.

Parameters:
[out]  ReturnStatus  Status code
Returns:
Maximum progress value. Returns -1 if query fails.
Examples:

MStatus MProgressWindow::setProgress ( const int  progress  )  [static]

Sets the progress value. If progress is not between progressMin() and progressMax() inclusively, it is set to whichever of progressMin() or progressMax() is closest.

Advancing the progress value updates the progress bar to show the new amount of progress.

Parameters:
[in]  progress  New progress value
Returns:
Status code
Status Codes:
Examples:

MStatus MProgressWindow::advanceProgress ( const int  amount  )  [static]

Increases the progress value by amount. If the resulting progress value is not between progressMin() and progressMax() inclusively, it is set to whichever of progressMin() or progressMax() is closest.

Advancing the progress value updates the progress bar to show the new amount of progress.

Parameters:
[in]  amount  Value to add to current progress
Returns:
Status code
Status Codes:
Examples:

int MProgressWindow::progress ( MStatus ReturnStatus = NULL  )  [static]

Get the progress value.

Parameters:
[out]  ReturnStatus  Status code
Returns:
Progress value. Returns -1 if query fails.
Examples:

MStatus MProgressWindow::setTitle ( const MString title  )  [static]

Sets the title of the progress window.

Parameters:
[in]  title  New title
Returns:
Status code
Status Codes:
Examples:

MString MProgressWindow::title ( MStatus ReturnStatus = NULL  )  [static]

Get the window title.

Parameters:
[out]  ReturnStatus  Status code
Returns:
Window title string.
Examples:

MStatus MProgressWindow::setProgressStatus ( const MString progressStatus  )  [static]

Sets the progress status string. This string is shown above the progress bar and usually is of the form "Performing operation: XXX" where XXX is a numerical indication of the amount completed.

Parameters:
[in]  progressStatus  New status string
Returns:
Status code
Status Codes:
Examples:

MString MProgressWindow::progressStatus ( MStatus ReturnStatus = NULL  )  [static]

Get the progress status string.

Parameters:
[out]  ReturnStatus  Status code
Returns:
Progress status string.

MStatus MProgressWindow::setInterruptable ( const bool  value  )  [static]

Sets whether the progress window is interruptable. An interruptable progress window can accept a signal from the user indicating that the operation should be cancelled.

isCancelled() is used to check if the user has tried to cancel an interruptable progress window.

Parameters:
[in]  value  True if the progress window should be made interruptable.
Returns:
Status code
Status Codes:
Examples:

bool MProgressWindow::isInterruptable ( MStatus ReturnStatus = NULL  )  [static]

Determine whether the progress window is interruptable.

Parameters:
[out]  ReturnStatus  Status code
Returns:
true when the progress window is interruptable
Examples:

bool MProgressWindow::isCancelled ( MStatus ReturnStatus = NULL  )  [static]

Determine whether the user has tried to cancel an interruptable progress window.

Parameters:
[out]  ReturnStatus  Status code
Returns:
true when user has tried to cancel progress. If the progress window is not interruptable, this method returns false.
Examples:

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6