Gui::progress_bar()

Syntax

Understand::Gui::progress_bar(percent [,allow_cancel]) 

Description

Displays the progress bar, if percent is 0.0 or greater. If it is less than 0.0, the progress bar is hidden, if it is currently displayed. If it is greater than 1.0, then 1.0 is assumed.

Arguments

If $allow_cancel is specified, a value of 1 indicates a cancel button should be displayed on the progress bar. If allow_cancel is not specified, the default value is 0, which means no cancel button is displayed.

Return Values

If the cancel button is displayed and the user presses it, this call returns 1. Otherwise, it returns 0.


Scientific Toolworks, Inc.
http://www.scitools.com