| 216. Progress | ||
|---|---|---|
 |  | |
| 216. Progress | ||
|---|---|---|
| | | |
Progress bar
List of Global Functions
CloseSuperior - Replaces stages of superior progress by an empty help text.
CurrentSubprogressType - Get current subprogress type
Finish - Moves progress bar to the end and marks all stages as completed.
New - New complex progress bar with stages.
NewProgressIcons - Function adds icon-support to progress dialog. Parameters are the same as for Progress::New() function with one parameter added.
NextStage - Advance stage, advance step by 1 and set progress bar caption to that defined in New.
NextStageStep - Jumps to the next stage and sets step to st.
NextStep - Some people say it is the best operating system ever. But now to the function. Advances progress bar value by 1.
OpenSuperior - Creates a higher-level progress bar made of stages. Currently it is placed instead of help text.
Simple - Create simple progress bar with no stages, only with progress bar.
Stage - Go to stage st, change progress bar title to title and set progress bar step to step.
Step - Changes progress bar value to st.
StepSuperior - Make one step in a superior progress bar.
SubprogressTitle - Set the label of the subprogress
SubprogressType - Create (or remove) a new subprogress above the progress bar, can be use for detailed progress of the current task
SubprogressValue - Set value of the subprogress
Title - Change progress bar title.
off - Turns progress bar off. All Progress:: calls return immediatelly.
on - Turns progress bar on after calling Progress::off.
set - Sets progress bar state: on = normal operation, off = All Progress:: calls return immediatelly.
status - Returns currently selected visibility status of all UI-modifying Progress:: functions.
List of Global Variables
Get current subprogress type
Return value
symbol - Current type of the subprogress widget - can be `progress, `tick or `none
New complex progress bar with stages.
Function parameters
string window_title
string progress_title
integer length
list<string> stg
list tits
string help_text
Return value
void
Function adds icon-support to progress dialog. Parameters are the same as for Progress::New() function with one parameter added.
Function parameters
string window_title
string progress_title
integer length
list<string> stg
list tits
string help_textmap
list <list <string> > icons_definition
Return value
void
icons_definition = $[
[ // first 'visible'
"/path/to/icon-highlighted.png"
"/path/to/another-icon-highlighted.png",
]
[ // then 'invisible'
"/path/to/icon-gryscale.png",
nil, // fallback icon will be used
],
]
See also:
Function Progress::New()
Advance stage, advance step by 1 and set progress bar caption to that defined in New.
Return value
void
Jumps to the next stage and sets step to st.
Function parameters
integer st
Return value
void
Some people say it is the best operating system ever. But now to the function. Advances progress bar value by 1.
Return value
void
Creates a higher-level progress bar made of stages. Currently it is placed instead of help text.
Function parameters
string title
list<string> stages
Return value
void
Create simple progress bar with no stages, only with progress bar.
Function parameters
string window_title
string progress_title
integer length
string help_text
Return value
void
Go to stage st, change progress bar title to title and set progress bar step to step.
Function parameters
integer st
string title
integer step
Return value
void
Set the label of the subprogress
Function parameters
string title
Return value
void
Create (or remove) a new subprogress above the progress bar, can be use for detailed progress of the current task
Function parameters
symbol type
integer max_value
Return value
void
Set value of the subprogress
Function parameters
integer value
Return value
void
Sets progress bar state: on = normal operation, off = All Progress:: calls return immediatelly.
Function parameters
boolean state
Return value
boolean - previous state
| | | |
| 215. ProfileManager |  | 217. Provider |