208. SlideShow

208.1. Summary of Module Globals

List of Global Functions

  • AppendMessageToInstLog - Append message to the installation log

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

  • CloseSlideShowDialog - Close the slide show dialog.

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

  • InitPkgData - Initialize internal pacakge data, such as remaining package sizes and times. This may not be called before the pkginfo server is up and running, so this cannot be reliably done from the constructor in all cases.

  • InstallSlideShowCallbacks - Install callbacks for slideshow. Should be in SlideShowCallbacks but that doesn't work at the moment.

  • OpenSlideShowDialog - Open the slide show dialog.

  • RemoveSlideShowCallbacks - Remove callbacks for slideshow. Should be in SlideShowCallbacks but that doesn't work at the moment.

  • ResetTimer - Reset the internal (global) timer.

  • SetCurrentCdNo - Set the current source and CD number. Must be called for each CD change. src_no: 1...n cd_no: 1...n

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

  • SetMediaType - set media type "CD" or "DVD"

  • SetSlideDir - Set the slide show directory

  • SlideDisplayDone - package start display update - this is called at the end of a new package

  • SlideDisplayStart - package start display update - this is called at the beginning of a new package

  • SlideProvideStart - Package providal start

  • SlideShow - Constructor

  • StartTimer - Start the internal (global) timer.

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

  • StripPath - Get package file name from path

  • StripReleaseNo - Get version info for a package (without build no.)

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

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

  • UpdateAllCdProgress - Update progress widgets for all CDs. Uses global statistics variables.

  • UpdateCurrentCdProgress - Update progress widgets for the current CD: Label and ProgressBar. Use global statistics variables for that.

  • UpdateCurrentPackageProgress - Progress display update This is called via the packager's progress callbacks.

List of Global Variables

    208.2. Global Functions

    208.2.1. AppendMessageToInstLog

    Append message to the installation log

    Function parameters

    • string msg

    Return value

    • void

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

    208.2.3. CloseSlideShowDialog

    Close the slide show dialog.

    Return value

    • void

    208.2.4. HandleInput

    Process (slide show) input (button press).

    Function parameters

    • any button

    Return value

    • void

    208.2.5. InitPkgData

    Initialize internal pacakge data, such as remaining package sizes and times. This may not be called before the pkginfo server is up and running, so this cannot be reliably done from the constructor in all cases.

    Function parameters

    • boolean force

    Return value

    • void

    208.2.6. InstallSlideShowCallbacks

    Install callbacks for slideshow. Should be in SlideShowCallbacks but that doesn't work at the moment.

    Return value

    • void

    208.2.7. OpenSlideShowDialog

    Open the slide show dialog.

    Return value

    • void

    208.2.8. RemoveSlideShowCallbacks

    Remove callbacks for slideshow. Should be in SlideShowCallbacks but that doesn't work at the moment.

    Return value

    • void

    208.2.9. ResetTimer

    Reset the internal (global) timer.

    Return value

    • void

    208.2.10. SetCurrentCdNo

    Set the current source and CD number. Must be called for each CD change. src_no: 1...n cd_no: 1...n

    Function parameters

    • integer src_no

    • integer cd_no

    Return value

    • void

    208.2.11. SetLanguage

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

    Function parameters

    • string new_language

    Return value

    • void

    208.2.12. SetMediaType

    set media type "CD" or "DVD"

    Function parameters

    • string new_media_type

    Return value

    • void

    208.2.13. SetSlideDir

    Set the slide show directory

    Function parameters

    • string dir

    Return value

    • void

    208.2.14. SlideDisplayDone

    package start display update - this is called at the end of a new package

    Function parameters

    • string pkg_name

    • integer pkg_size

    • boolean deleting

    Return value

    • void

    208.2.15. SlideDisplayStart

    package start display update - this is called at the beginning of a new package

    Function parameters

    • string pkg_name

    • string pkg_summary

    • integer pkg_size

    • boolean deleting

    Return value

    • void

    208.2.16. SlideProvideStart

    Package providal start

    Function parameters

    • string pkg_name

    • integer sz

    • boolean remote

    Return value

    • void

    208.2.17. SlideShow

    Constructor

    Return value

    • void

    208.2.18. StartTimer

    Start the internal (global) timer.

    Return value

    • void

    208.2.19. StopTimer

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

    Return value

    • void

    208.2.20. StripPath

    Get package file name from path

    Function parameters

    • string pkg_name

    Return value

    • string - package file name

    208.2.21. StripReleaseNo

    Get version info for a package (without build no.)

    Function parameters

    • string pkg_name

    Return value

    • string - version string

    208.2.22. SwitchToDetailsView

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

    Return value

    • void

    208.2.23. SwitchToSlideView

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

    Return value

    • void

    208.2.24. UpdateAllCdProgress

    Update progress widgets for all CDs. Uses global statistics variables.

    Return value

    • void

    208.2.25. UpdateCurrentCdProgress

    Update progress widgets for the current CD: Label and ProgressBar. Use global statistics variables for that.

    Return value

    • void

    208.2.26. UpdateCurrentPackageProgress

    Progress display update This is called via the packager's progress callbacks.

    Function parameters

    • integer pkg_percent

    Return value

    • void

    208.3. Global Variables

    208.4. Module Requirements

    208.4.1. Module Imports

    • Installation
    • Label
    • Language
    • Stage
    • String
    • Wizard

    208.4.2. Module Includes