239. SlideShow

239.1. Authors

  • Stefan Hundhammer <sh@suse.de>

  • Stanislav Visnovsky <visnov@suse.cz>

239.2. Summary of Module Globals

List of Global Functions

  • AppendMessageToInstLog - Append message to the installation log.

  • ChangeSlideIfNecessary - Check if the current slide needs to be changed and do that if necessary.

  • CheckForSlides - Check if the slide show is available. This must be called before trying to access any slides; some late initialization is done here.

  • CloseDialog - Close the slide show dialog.

  • CurrentStageDescription - Return the description for the current stage.

  • GenericHandleInput - Check for user button presses and handle them. Generic handling to be used in the progress handlers.

  • GetSetup - Returns the current setup defined by Setup().

  • GetUserAbort - Get the status of the flag that user requested abort of the installation

  • GlobalProgressStart - Restart the global progress of the slideshow. This means the label will be set to \param text, value to 0.

  • HandleInput - Process (slide show) input (button press).

  • HaveSlideWidget - Check if the dialog is currently set up so the user could switch to the slide page.

  • MoveToStage - Move the global progress to the beginning of the given stage.

  • OpenDialog - Open the slide show dialog.

  • RebuildDialog - Rebuild the dialog. Useful if slides become available post-creating the dialog.

  • Reset - Initialize generic data to default values

  • ResetTimer - Reset the internal (global) timer.

  • SetGlobalProgressLabel - Return the current global progress label.

  • SetLanguage - Set the curent language. Must be called once during initialization.

  • SetUserAbort - Set the flag that user requested abort of the installation

  • Setup - Prepare the stages for the global progressbar. Will compute the total estimate of time and partition the global 100% to given stages based on their estimates. Can compute out of time and size to download.

  • ShowingDetails - Check if currently the "Details" page is shown

  • ShowingRelNotes - Check if currently the "Release Notes" page is shown

  • ShowingSlide - Check if currently the "Slide Show" page is shown

  • StageProgress - Update the global progress according to the progress in the current stage. The new value will be set to the per cent of the current stage according to \param value.The value must be lower that 100 (or it's corrected to 100). If the \text is not nil, the label will be updated to this text as well. Otherwise label will not change.

  • StartTimer - Start the internal (global) timer.

  • StopTimer - Stop the internal (global) timer and account elapsed time.

  • SubProgress - Update status of subprogress of the slideshow. The new value will be set to \param value, if the \text is not nil, the label will be updated to this text as well. Otherwise label will not change.

  • SubProgressStart - Restart the subprogress of the slideshow. This means the label will be set to \param text, value to 0.

  • SwitchToDetailsView - Switch from the 'slide show' view to the 'details' view.

  • SwitchToReleaseNotesView - Switch to the 'release notes' view.

  • SwitchToSlideView - Switch from the 'details' view to the 'slide show' view.

  • TableItem - Create one single item for the CD statistics table

List of Global Variables

    239.3. Global Functions

    239.3.1. AppendMessageToInstLog

    Append message to the installation log.

    Function parameters

    • string msg

    Return value

    • void

    239.3.2. ChangeSlideIfNecessary

    Check if the current slide needs to be changed and do that if necessary.

    Return value

    • void

    239.3.3. CheckForSlides

    Check if the slide show is available. This must be called before trying to access any slides; some late initialization is done here.

    Return value

    • void

    239.3.4. CloseDialog

    Close the slide show dialog.

    Return value

    • void

    239.3.5. CurrentStageDescription

    Return the description for the current stage.

    Return value

    • string - localized string description

    239.3.6. GenericHandleInput

    Check for user button presses and handle them. Generic handling to be used in the progress handlers.

    Return value

    • void

    239.3.7. GetSetup

    Returns the current setup defined by Setup().

    Return value

    • map <string, map <string,any> > - stages

    $[ stage_name : $[ stage_setup ], ... ]

    See also:

    • Setup()

    239.3.8. GetUserAbort

    Get the status of the flag that user requested abort of the installation

    Return value

    • boolean - state of the abort requested flag (true = abort requested)

    239.3.9. GlobalProgressStart

    Restart the global progress of the slideshow. This means the label will be set to \param text, value to 0.

    Function parameters

    • string text

    Return value

    • void

    239.3.10. HandleInput

    Process (slide show) input (button press).

    Function parameters

    • any button

    Return value

    • void

    239.3.11. HaveSlideWidget

    Check if the dialog is currently set up so the user could switch to the slide page.

    Return value

    • boolean

    239.3.12. MoveToStage

    Move the global progress to the beginning of the given stage.

    Function parameters

    • string stage_name

    Return value

    • void

    239.3.13. OpenDialog

    Open the slide show dialog.

    Return value

    • void

    239.3.14. RebuildDialog

    Rebuild the dialog. Useful if slides become available post-creating the dialog.

    Return value

    • void

    239.3.15. Reset

    Initialize generic data to default values

    Return value

    • void

    239.3.16. ResetTimer

    Reset the internal (global) timer.

    Return value

    • void

    239.3.17. SetGlobalProgressLabel

    Return the current global progress label.

    Function parameters

    • string text

    Return value

    • void - current label

    239.3.18. SetLanguage

    Set the curent language. Must be called once during initialization.

    Function parameters

    • string new_language

    Return value

    • void

    239.3.19. SetUserAbort

    Set the flag that user requested abort of the installation

    Function parameters

    • boolean abort

    Return value

    • void

    239.3.20. Setup

    Prepare the stages for the global progressbar. Will compute the total estimate of time and partition the global 100% to given stages based on their estimates. Can compute out of time and size to download.

    Function parameters

    • list< map<string,any> > stages

    Return value

    • void

    239.3.21. ShowingDetails

    Check if currently the "Details" page is shown

    Return value

    • boolean - true if showing details, false otherwise

    239.3.22. ShowingRelNotes

    Check if currently the "Release Notes" page is shown

    Return value

    • boolean - true if showing details, false otherwise

    239.3.23. ShowingSlide

    Check if currently the "Slide Show" page is shown

    Return value

    • boolean - true if showing details, false otherwise

    239.3.24. StageProgress

    Update the global progress according to the progress in the current stage. The new value will be set to the per cent of the current stage according to \param value.The value must be lower that 100 (or it's corrected to 100). If the \text is not nil, the label will be updated to this text as well. Otherwise label will not change.

    Function parameters

    • integer value

    • string text

    Return value

    • void

    239.3.25. StartTimer

    Start the internal (global) timer.

    Return value

    • void

    239.3.26. StopTimer

    Stop the internal (global) timer and account elapsed time.

    Return value

    • void

    239.3.27. SubProgress

    Update status of subprogress of the slideshow. The new value will be set to \param value, if the \text is not nil, the label will be updated to this text as well. Otherwise label will not change.

    Function parameters

    • integer value

    • string text

    Return value

    • void

    239.3.28. SubProgressStart

    Restart the subprogress of the slideshow. This means the label will be set to \param text, value to 0.

    Function parameters

    • string text

    Return value

    • void

    239.3.29. SwitchToDetailsView

    Switch from the 'slide show' view to the 'details' view.

    Return value

    • void

    239.3.30. SwitchToReleaseNotesView

    Switch to the 'release notes' view.

    Return value

    • void

    239.3.31. SwitchToSlideView

    Switch from the 'details' view to the 'slide show' view.

    Return value

    • void

    239.3.32. TableItem

    Create one single item for the CD statistics table

    Function parameters

    • string id

    • string col1

    • string col2

    • string col3

    • string col4

    Return value

    • term

    239.4. Global Variables

    239.5. Module Requirements

    239.5.1. Module Imports

    • FileUtils
    • Installation
    • Label
    • Mode
    • Popup
    • Slides
    • Stage
    • String
    • Wizard

    239.5.2. Module Includes