YaST2 Developers Documentation:

OSRProgress.ycp

This module has an unstable interface.

Imports

  • Mode

Global Variables

Global Functions

Local Variables

global length -> integer

The length of a ProgressBar

local progresses -> map

Data of all created ProgressBar and Downloadprogress

global Reset () -> void

Reset module settings.

global Create (symbol id, string label, integer steps, boolean downloadprogress) -> term

Create a new Progress Widget

Parameters:
id
label
steps
downloadprogress
global SetSteps (symbol id, integer steps) -> void

Set the Steps of a normal ProgressBar Widget.

Parameters:
id
steps
global Increase (symbol id) -> boolean

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

For internal use only.

Parameters:
id
Return value:
True if the progress value was increased successfully.
global SetLabel (symbol id, string new_label) -> boolean

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

Parameters:
id
new_label
Return value:
boolen True if the label was set correctly.
global Fill (symbol id) -> boolean

Fills the global-progress-bar with 100%.

Parameters:
id
Return value:
True if the progress value was increased successfully.
global DeleteFile (string file) -> boolean

Only for DownloadProgress !! Delete the progress file.

Parameters:
file
global SetFile (symbol id, string new_file) -> boolean

Specifies a new filename for the DownloadProgress widget.

Parameters:
id
new_file
Example
 OSRModuleProgress::SetFile("/tmp/YaST2-823/osr_lilo_progress");
global SetLength (symbol id, integer new_length) -> boolean

Set the length of a progress bar.

Parameters:
id
new_length