192. OSRProgress

192.1. Authors

  • Johannes Buchhold <jbuch@suse.de>

192.2. Summary of Module Globals

List of Global Functions

  • Create - Create a new Progress Widget

  • DeleteFile - Only for DownloadProgress !! Delete the progress file.

  • Fill - Fills the global-progress-bar with 100%.

  • Increase - This method is called after one detection function is successfully executed. It shows the continuous progress to the user with the global progress bar.

  • Reset - Reset module settings.

  • SetFile - Specifies a new filename for the DownloadProgress widget.

  • SetLabel - Set the label of a progress-bar to the specified one.

  • SetLength - Set the length of a progress bar.

  • SetSteps - Set the Steps of a normal ProgressBar Widget.

List of Global Variables

  • length - The length of a ProgressBar

192.3. Global Functions

192.3.1. Create

Create a new Progress Widget

Function parameters

  • symbol id

  • string label

  • integer steps

  • boolean downloadprogress

Return value

  • term

192.3.2. DeleteFile

Only for DownloadProgress !! Delete the progress file.

Function parameters

  • string file

Return value

  • boolean

192.3.3. Fill

Fills the global-progress-bar with 100%.

Function parameters

  • symbol id

Return value

  • boolean - True if the progress value was increased successfully.

192.3.4. Increase

This method is called after one detection function is successfully executed. It shows the continuous progress to the user with the global progress bar.

Function parameters

  • symbol id

Return value

  • boolean - True if the progress value was increased successfully.

192.3.5. Reset

Reset module settings.

Return value

  • void

192.3.6. SetFile

Specifies a new filename for the DownloadProgress widget.

Function parameters

  • symbol id

  • string new_file

Return value

  • boolean

Example 47. 

 OSRModuleProgress::SetFile("/tmp/YaST2-823/osr_lilo_progress");


192.3.7. SetLabel

Set the label of a progress-bar to the specified one.

Function parameters

  • symbol id

  • string new_label

Return value

  • boolean - boolen True if the label was set correctly.

192.3.8. SetLength

Set the length of a progress bar.

Function parameters

  • symbol id

  • integer new_length

Return value

  • boolean

192.3.9. SetSteps

Set the Steps of a normal ProgressBar Widget.

Function parameters

  • symbol id

  • integer steps

Return value

  • void

192.4. Global Variables

192.4.1. length

The length of a ProgressBar

192.5. Module Requirements

192.5.1. Module Imports

  • Mode

192.5.2. Module Includes