A data structure that provides information about a progress indicator.
| cancellable | Returns true if the progress indicator's associated event can be canceled. |
| description | Returns the progress indicator's description. |
| elapsedTime | Returns the number of seconds that the progress indicator has been running for. |
| exists | Checks whether the progress indicator exists. |
| finished | Returns true if the progress indicator is finished, but not removed. |
| id | Returns the progress indicator's unique identifier. |
| indefinite | Returns true if the progress indicator is indefinite. |
| name | Returns the progress indicator's name. |
| options | Returns the option flags used to start the progress indicator. |
| parentId | Returns the unique ID of the progress indicator's parent, or -1 if the progress indicator is not a child of another progress indicator. |
| progress | Returns the progress value of a progress indicator's associated task. |
| remainingTime | Returns this progress indicator's remaining time to completion. |
| responding | Returns true if progress is ongoing, false if the progress indicator has not received any progress report for more than 5 seconds. |
| running | Returns true if the progress indicator is running and active. |
| startTime | Returns the time when the progress indicator started. |
| status | Returns the progress indicator's status. |
| timeDisplayMode | Returns the progress indicator's time display mode. |
| updateTime | Returns the last time the progress indicator was updated. |
| Cancel | Cancels a running progress indicator. |
| ClearRemainingTime | Resets the computation of the progress indicator's remaining time. |
| Finish | Marks the progress indicator as finished. |
| RegisterCancelCallback | Registers a callback that is called when the user cancels a running progress indicator's associated task. |
| Remove | Finishes and removes an active progress indicator. |
| Report | Reports the progress indicator's current status. |
| SetDescription | Sets the progress indicator's description. To clear the description pass null. |
| SetRemainingTime | Sets the progress indicator's remaining time, in seconds. |
| SetTimeDisplayMode | Set a progress indicator's time display mode. |
| UnregisterCancelCallback | Unregisters a previously registered progress cancellation callback. |
Did you find this page useful? Please give it a rating: