| 239. SlideShow | ||
|---|---|---|
 |  | |
| 239. SlideShow | ||
|---|---|---|
| | | |
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
Append message to the installation log.
Function parameters
string msg
Return value
void
Check if the current slide needs to be changed and do that if necessary.
Return value
void
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
Return the description for the current stage.
Return value
string - localized string description
Check for user button presses and handle them. Generic handling to be used in the progress handlers.
Return value
void
Returns the current setup defined by Setup().
Return value
map <string, map <string,any> > - stages
$[ stage_name : $[ stage_setup ], ... ]
See also:
Setup()
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)
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
Process (slide show) input (button press).
Function parameters
any button
Return value
void
Check if the dialog is currently set up so the user could switch to the slide page.
Return value
boolean
Move the global progress to the beginning of the given stage.
Function parameters
string stage_name
Return value
void
Rebuild the dialog. Useful if slides become available post-creating the dialog.
Return value
void
Return the current global progress label.
Function parameters
string text
Return value
void - current label
Set the curent language. Must be called once during initialization.
Function parameters
string new_language
Return value
void
Set the flag that user requested abort of the installation
Function parameters
boolean abort
Return value
void
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
Check if currently the "Details" page is shown
Return value
boolean - true if showing details, false otherwise
Check if currently the "Release Notes" page is shown
Return value
boolean - true if showing details, false otherwise
Check if currently the "Slide Show" page is shown
Return value
boolean - true if showing details, false otherwise
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
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
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
Switch from the 'slide show' view to the 'details' view.
Return value
void
Switch from the 'details' view to the 'slide show' view.
Return value
void
| | | |
| 238. SignatureCheckDialogs |  | 240. SlideShowCallbacks |