Wizard dialog
List of Global Functions
AbortAcceptButtonBox - Returns a button box with buttons "Abort", "Accept"
AbortApplyFinishButtonBox - Returns a button box with buttons "Abort", "Apply", "Finish"
AbortInstallationAcceptButtonBox - Returns a button box with buttons "Abort Installation", "Accept"
AcceptDialog - Returns a standard wizard dialog with buttons "Cancel", "Accept"
AddMenu - Add Menu
AddMenuEntry - Add Menu Entry
AddSubMenu - Add Sub Menu
AddTreeItem - Add Tree Item to tree enabled Wizard
BackAbortInstallationNextButtonBox - Returns a button box with buttons "Back", "Abort Installation", "Next"
BackAbortNextButtonBox - Returns a button box with buttons "Back", "Abort", "Next"
BackNextButtonBox - Returns a button box with buttons "Back", "Next"
CancelAcceptButtonBox - Returns a button box with buttons "Cancel", "Accept"
ClearContents - Clear the wizard contents.
ClearTitleIcon - Clear the wizard 'title' icon, i.e. replace it with nothing
CloseDialog - Close a wizard dialog.
CreateDialog - Create and open a typical installation wizard dialog.
CreateMenu - Create the menu in the dialog
CreateTree - Create the tree in the dialog, replaces helpspace with new tree widget
CreateTreeDialog - Create and open a Tree wizard dialog.
DeleteMenus - Delete Menu items
DeleteTreeItems - Delete Tree items
DisableAbortButton - Disable the wizard's "Abort" button.
DisableBackButton - Disable the wizard's "Back" button.
DisableCancelButton - Disable the wizard's "Cancel" button.
DisableNextButton - Disable the wizard's "Next" (or "Accept") button.
EnableAbortButton - Enable the wizard's "Abort" button.
EnableBackButton - Enable the wizard's "Back" button.
EnableCancelButton - Enable the wizard's "Cancel" button.
EnableNextButton - Enable the wizard's "Next" (or "Accept") button.
GenericDialog - Create a Generic Dialog
HideAbortButton - Hide the Wizard's "Abort" button. Restore it later with RestoreAbortButton():
HideBackButton - Hide the Wizard's "Back" button. Restore it later with RestoreBackButton():
HideNextButton - Hide the Wizard's "Next" button. Restore it later with RestoreNextButton():
HideReleaseNotesButton - Hide the "Release Notes" button, if there is any
IsWizardDialog - Check if the topmost dialog is a wizard dialog (i.e. has a widget with `id(`WizardDialog) )
NextBackDialog - Returns a standard wizard dialog with buttons "Next", "Back", "Abort".
OpenAbortApplyFinishDialog - Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".
OpenAcceptAbortStepsDialog - Open a dialog with "Accept", "Cancel" that will also accept workflow steps.
OpenAcceptDialog - Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".
OpenAcceptStepsDialog - Open a dialog with "Accept", "Cancel" that will also accept workflow steps.
OpenCustomDialog - Open a wizard dialog with simple layout
OpenDialog - Open any wizard dialog.
OpenNextBackDialog - Open a dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".
OpenNextBackStepsDialog - Open a dialog with "Back", "Next", "Abort" that will also accept workflow steps.
OpenTreeNextBackDialog - Open a Tree dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".
QueryTreeItem - Query Tree Item
ReplaceAbortButton - Replace the wizard 'abort' button with a custom widget. THIS FUNCTION IS DEPRECATED!
ReplaceBackButton - Replace the wizard 'back' button with a custom widget. THIS FUNCTION IS DEPRECATED!
ReplaceCustomHelp - Replace the help widget for dialogs opened with Wizard::OpenCustomDialog().
ReplaceHelp - Replace the wizard help subwindow with a custom widget.
ReplaceNextButton - Replace the wizard 'next' button with a custom widget. THIS FUNCTION IS DEPRECATED!
RestoreAbortButton - Restore the wizard 'abort' button.
RestoreBackButton - Restore the wizard 'back' button.
RestoreHelp - Restore the wizard help subwindow.
RestoreNextButton - Restore the wizard 'next' button.
RestoreScreenShotName - Restore the screenshot name.
RetranslateButtons - Retranslate the wizard buttons.
SelectTreeItem - Select Tree item
SetAbortButton - Set the dialog's "Abort" button with a new label and a new ID
SetBackButton - Set the dialog's "Back" button with a new label and a new ID
SetContents - Set the contents of a wizard dialog
SetContentsButtons - Set contents and Buttons of wizard dialog
SetDesktopIcon - Set Desktop Icon
SetFocusToBackButton - Set the keyboard focus to the wizard's "Back" (or "Cancel") button.
SetFocusToNextButton - Set the keyboard focus to the wizard's "Next" (or "Accept") button.
SetHelpText - Set a new help text.
SetNextButton - Set the dialog's "Next" button with a new label and a new ID
SetProductName - Set the product name for UI
SetScreenShotName - Declare a name for the current dialog
SetTitleIcon - Set the wizard 'title' icon
ShowHelp - Open a popup dialog that displays a help text (rich text format).
ShowReleaseNotesButton - Show a "Release Notes" button with the specified label and ID if there is a "steps" panel
UserInput - Substitute for UI::UserInput
List of Global Variables
Returns a button box with buttons "Abort", "Accept"
Return value
term - a widget tree
Returns a button box with buttons "Abort", "Apply", "Finish"
Return value
term - a widget tree
Returns a button box with buttons "Abort Installation", "Accept"
Return value
term - a widget tree
Returns a standard wizard dialog with buttons "Cancel", "Accept"
Return value
term - describing the dialog.
Add Menu
Function parameters
list<map> Menu
string title
string id
Return value
list<map> - Updated Menu Data
Add Menu Entry
Function parameters
list<map> Menu
string parent_id
string title
string id
Return value
list<map> - Updated Menu Data
Add Sub Menu
Function parameters
list<map> Menu
string parent_id
string title
string id
Return value
list<map> - Updated Menu Data
Add Tree Item to tree enabled Wizard
Function parameters
list<map> Tree
string parent
string title
string id
Return value
list<map> - Updated Tree Data
Returns a button box with buttons "Back", "Abort Installation", "Next"
Return value
term - a widget tree
Returns a button box with buttons "Back", "Abort", "Next"
Return value
term - a widget tree
Returns a button box with buttons "Back", "Next"
Return value
term - a widget tree
Returns a button box with buttons "Cancel", "Accept"
Return value
term - a widget tree
Clear the wizard 'title' icon, i.e. replace it with nothing
Return value
void
Create the tree in the dialog, replaces helpspace with new tree widget
Function parameters
list<map> Tree
string title
Return value
void
Create a Generic Dialog
Function parameters
term button_box
Return value
term - term describing the dialog.
Hide the Wizard's "Abort" button. Restore it later with RestoreAbortButton():
Return value
void
Hide the Wizard's "Back" button. Restore it later with RestoreBackButton():
Return value
void
Hide the Wizard's "Next" button. Restore it later with RestoreNextButton():
Return value
void
Check if the topmost dialog is a wizard dialog (i.e. has a widget with `id(`WizardDialog) )
Return value
boolean - True if topmost dialog is a wizard dialog, false otherwise
Returns a standard wizard dialog with buttons "Next", "Back", "Abort".
Return value
term - describing the dialog.
Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".
Return value
void
Open a dialog with "Accept", "Cancel" that will also accept workflow steps.
Return value
void
Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".
Return value
void
Open a dialog with "Accept", "Cancel" that will also accept workflow steps.
Return value
void
Open a wizard dialog with simple layout
Function parameters
term help_space_contents
term button_box
Return value
void
Open a dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".
Return value
void
Open a dialog with "Back", "Next", "Abort" that will also accept workflow steps.
Return value
void
Open a Tree dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".
Return value
void
Replace the wizard 'abort' button with a custom widget. THIS FUNCTION IS DEPRECATED!
Function parameters
term contents
Return value
void
Replace the wizard 'back' button with a custom widget. THIS FUNCTION IS DEPRECATED!
Function parameters
term contents
Return value
void
Replace the help widget for dialogs opened with Wizard::OpenCustomDialog().
Function parameters
term contents
Return value
void
Replace the wizard help subwindow with a custom widget.
Function parameters
term contents
Return value
void
Replace the wizard 'next' button with a custom widget. THIS FUNCTION IS DEPRECATED!
Function parameters
term contents
Return value
void
Restore the wizard help subwindow.
Function parameters
string help_text
Return value
void
Set the dialog's "Abort" button with a new label and a new ID
Function parameters
any id
string label
Return value
void
Set the dialog's "Back" button with a new label and a new ID
Function parameters
any id
string label
Return value
void
Set the contents of a wizard dialog
Function parameters
string title
term contents
string help_text
boolean has_back
boolean has_next
Return value
void
Set contents and Buttons of wizard dialog
Function parameters
string title
term contents
string help_text
string back_label
string next_label
Return value
void
Set Desktop Icon
Function parameters
string file
Return value
boolean - true on success
Set the keyboard focus to the wizard's "Back" (or "Cancel") button.
Return value
void
Set the keyboard focus to the wizard's "Next" (or "Accept") button.
Return value
void
Set a new help text.
Function parameters
string help_text
Return value
void
Set the dialog's "Next" button with a new label and a new ID
Function parameters
any id
string label
Return value
void
Declare a name for the current dialog
Function parameters
string s
Return value
void
Set the wizard 'title' icon
Function parameters
string icon_name
Return value
void
Open a popup dialog that displays a help text (rich text format).
Function parameters
string help_text
Return value
void
Show a "Release Notes" button with the specified label and ID if there is a "steps" panel
Function parameters
string label
any id
Return value
void