193. Progress

Progress bar

193.1. Summary of Module Globals

List of Global Functions

  • CloseSuperior - Replaces stages of superior progress by an empty help text.

  • Finish - Moves progress bar to the end and marks all stages as completed.

  • New - New complex progress bar with stages.

  • 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.

  • 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

    193.2. Global Functions

    193.2.1. CloseSuperior

    Replaces stages of superior progress by an empty help text.

    Return value

    • void

    193.2.2. Finish

    Moves progress bar to the end and marks all stages as completed.

    Return value

    • void

    193.2.3. New

    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

    193.2.4. NextStage

    Advance stage, advance step by 1 and set progress bar caption to that defined in New.

    Return value

    • void

    193.2.5. NextStageStep

    Jumps to the next stage and sets step to st.

    Function parameters

    • integer st

    Return value

    • void

    193.2.6. NextStep

    Some people say it is the best operating system ever. But now to the function. Advances progress bar value by 1.

    Return value

    • void

    193.2.7. OpenSuperior

    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

    193.2.8. Simple

    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

    193.2.9. Stage

    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

    193.2.10. Step

    Changes progress bar value to st.

    Function parameters

    • integer st

    Return value

    • void

    193.2.11. StepSuperior

    Make one step in a superior progress bar.

    Return value

    • void

    193.2.12. Title

    Change progress bar title.

    Function parameters

    • string t

    Return value

    • void

    193.2.13. off

    Turns progress bar off. All Progress:: calls return immediatelly.

    Return value

    • void

    193.2.14. on

    Turns progress bar on after calling Progress::off.

    Return value

    • void

    193.2.15. set

    Sets progress bar state: on = normal operation, off = All Progress:: calls return immediatelly.

    Function parameters

    • boolean state

    Return value

    • boolean - previous state

    193.2.16. status

    Returns currently selected visibility status of all UI-modifying Progress:: functions.

    Return value

    • boolean - whether the progress bar is used

    193.3. Global Variables

    193.4. Module Requirements

    193.4.1. Module Imports

    • CommandLine
    • Mode
    • Wizard

    193.4.2. Module Includes