291. Wizard

291.1. Summary of Module Globals

List of Global Functions

List of Global Variables

    291.2. Global Functions

    291.2.1. AbortAcceptButtonBox

    Returns a button box with buttons "Abort", "Accept"

    Return value

    • term - a widget tree

    291.2.2. AbortApplyFinishButtonBox

    Returns a button box with buttons "Abort", "Apply", "Finish"

    Return value

    • term - a widget tree

    291.2.3. AbortInstallationAcceptButtonBox

    Returns a button box with buttons "Abort Installation", "Accept"

    Return value

    • term - a widget tree

    291.2.4. AcceptDialog

    Returns a standard wizard dialog with buttons "Cancel", "Accept"

    Return value

    • term - describing the dialog.

    291.2.5. AddMenu

    Add Menu

    Function parameters

    • list<map> Menu

    • string title

    • string id

    Return value

    • list<map> - Updated Menu Data

    291.2.6. AddMenuEntry

    Add Menu Entry

    Function parameters

    • list<map> Menu

    • string parent_id

    • string title

    • string id

    Return value

    • list<map> - Updated Menu Data

    291.2.7. AddSubMenu

    Add Sub Menu

    Function parameters

    • list<map> Menu

    • string parent_id

    • string title

    • string id

    Return value

    • list<map> - Updated Menu Data

    291.2.8. AddTreeItem

    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

    291.2.9. BackAbortInstallationNextButtonBox

    Returns a button box with buttons "Back", "Abort Installation", "Next"

    Return value

    • term - a widget tree

    291.2.10. BackAbortNextButtonBox

    Returns a button box with buttons "Back", "Abort", "Next"

    Return value

    • term - a widget tree

    291.2.11. BackNextButtonBox

    Returns a button box with buttons "Back", "Next"

    Return value

    • term - a widget tree

    291.2.12. CancelAcceptButtonBox

    Returns a button box with buttons "Cancel", "Accept"

    Return value

    • term - a widget tree

    291.2.13. CancelOKButtonBox

    Returns a button box with buttons "Cancel", "OK"

    Return value

    • term - a widget tree

    291.2.14. ClearContents

    Clear the wizard contents.

    Return value

    • void

    291.2.15. ClearTitleIcon

    Clear the wizard 'title' icon, i.e. replace it with nothing

    Return value

    • void

    291.2.16. CloseDialog

    Close a wizard dialog.

    Return value

    • void

    291.2.17. CreateDialog

    Create and open a typical installation wizard dialog.

    Return value

    • void

    291.2.18. CreateMenu

    Create the menu in the dialog

    Function parameters

    • list<map> Menu

    Return value

    • void

    291.2.19. CreateTree

    Create the tree in the dialog, replaces helpspace with new tree widget

    Function parameters

    • list<map> Tree

    • string title

    Return value

    • void

    291.2.20. CreateTreeDialog

    Create and open a Tree wizard dialog.

    Return value

    • void

    291.2.21. DeleteMenus

    Delete Menu items

    Return value

    • void

    291.2.22. DeleteTreeItems

    Delete Tree items

    Return value

    • void

    291.2.23. DisableAbortButton

    Disable the wizard's "Abort" button.

    Return value

    • void

    291.2.24. DisableBackButton

    Disable the wizard's "Back" button.

    Return value

    • void

    291.2.25. DisableCancelButton

    Disable the wizard's "Cancel" button.

    Return value

    • void

    291.2.26. DisableNextButton

    Disable the wizard's "Next" (or "Accept") button.

    Return value

    • void

    291.2.27. EnableAbortButton

    Enable the wizard's "Abort" button.

    Return value

    • void

    291.2.28. EnableBackButton

    Enable the wizard's "Back" button.

    Return value

    • void

    291.2.29. EnableCancelButton

    Enable the wizard's "Cancel" button.

    Return value

    • void

    291.2.30. EnableNextButton

    Enable the wizard's "Next" (or "Accept") button.

    Return value

    • void

    291.2.31. GenericDialog

    Create a Generic Dialog

    Function parameters

    • term button_box

    Return value

    • term - term describing the dialog.

    291.2.32. GenericTreeDialog

    Create a Generic Tree Dialog

    Function parameters

    • term button_box

    Return value

    • term - term describing the dialog.

    291.2.33. HideAbortButton

    Hide the Wizard's "Abort" button. Restore it later with RestoreAbortButton():

    Return value

    • void

    291.2.34. HideBackButton

    Hide the Wizard's "Back" button. Restore it later with RestoreBackButton():

    Return value

    • void

    291.2.35. HideNextButton

    Hide the Wizard's "Next" button. Restore it later with RestoreNextButton():

    Return value

    • void

    291.2.36. HideReleaseNotesButton

    Hide the "Release Notes" button, if there is any

    Return value

    • void

    291.2.37. IsWizardDialog

    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

    291.2.38. NextBackDialog

    Returns a standard wizard dialog with buttons "Next", "Back", "Abort".

    Return value

    • term - describing the dialog.

    291.2.39. OKDialog

    Returns a standard wizard dialog with buttons "Cancel", "OK"

    Return value

    • term - describing the dialog.

    291.2.40. OpenAbortApplyFinishDialog

    Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".

    Return value

    • void

    291.2.41. OpenAcceptAbortStepsDialog

    Open a dialog with "Accept", "Cancel" that will also accept workflow steps.

    Return value

    • void

    291.2.42. OpenAcceptDialog

    Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".

    Return value

    • void

    291.2.43. OpenAcceptStepsDialog

    Open a dialog with "Accept", "Cancel" that will also accept workflow steps.

    Return value

    • void

    291.2.44. OpenCustomDialog

    Open a wizard dialog with simple layout

    Function parameters

    • term help_space_contents

    • term button_box

    Return value

    • void

    291.2.45. OpenDialog

    Open any wizard dialog.

    Function parameters

    • term dialog

    Return value

    • void

    291.2.46. OpenNextBackDialog

    Open a dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".

    Return value

    • void

    291.2.47. OpenNextBackStepsDialog

    Open a dialog with "Back", "Next", "Abort" that will also accept workflow steps.

    Return value

    • void

    291.2.48. OpenOKDialog

    Open a dialog with "OK", "Cancel" and set the keyboard focus to "OK".

    Return value

    • void

    291.2.49. OpenTreeNextBackDialog

    Open a Tree dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".

    Return value

    • void

    291.2.50. QueryTreeItem

    Query Tree Item

    Return value

    • string - Tree Item

    291.2.51. ReplaceAbortButton

    Replace the wizard 'abort' button with a custom widget. THIS FUNCTION IS DEPRECATED!

    Function parameters

    • term contents

    Return value

    • void

    291.2.52. ReplaceBackButton

    Replace the wizard 'back' button with a custom widget. THIS FUNCTION IS DEPRECATED!

    Function parameters

    • term contents

    Return value

    • void

    291.2.53. ReplaceCustomHelp

    Replace the help widget for dialogs opened with Wizard::OpenCustomDialog().

    Function parameters

    • term contents

    Return value

    • void

    291.2.54. ReplaceHelp

    Replace the wizard help subwindow with a custom widget.

    Function parameters

    • term contents

    Return value

    • void

    291.2.55. ReplaceNextButton

    Replace the wizard 'next' button with a custom widget. THIS FUNCTION IS DEPRECATED!

    Function parameters

    • term contents

    Return value

    • void

    291.2.56. RestoreAbortButton

    Restore the wizard 'abort' button.

    Return value

    • void

    291.2.57. RestoreBackButton

    Restore the wizard 'back' button.

    Return value

    • void

    291.2.58. RestoreHelp

    Restore the wizard help subwindow.

    Function parameters

    • string help_text

    Return value

    • void

    291.2.59. RestoreNextButton

    Restore the wizard 'next' button.

    Return value

    • void

    291.2.60. RestoreScreenShotName

    Restore the screenshot name.

    Return value

    • void

    291.2.61. RetranslateButtons

    Retranslate the wizard buttons.

    Return value

    • void

    291.2.62. SelectTreeItem

    Select Tree item

    Function parameters

    • string tree_item

    Return value

    • void

    291.2.63. SetAbortButton

    Set the dialog's "Abort" button with a new label and a new ID

    Function parameters

    • any id

    • string label

    Return value

    • void

    291.2.64. SetBackButton

    Set the dialog's "Back" button with a new label and a new ID

    Function parameters

    • any id

    • string label

    Return value

    • void

    291.2.65. SetContents

    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

    291.2.66. SetContentsButtons

    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

    291.2.67. SetContentsFocus

    Set the contents of a wizard dialog and define if to move focus to next button

    Function parameters

    • string title

    • term contents

    • string help_text

    • boolean has_back

    • boolean has_next

    • boolean set_focus

    Return value

    • void

    291.2.68. SetDesktopIcon

    Set the icon specified in a .desktop file

    Function parameters

    • string file

    Return value

    • boolean - true on success

    291.2.69. SetFocusToBackButton

    Set the keyboard focus to the wizard's "Back" (or "Cancel") button.

    Return value

    • void

    291.2.70. SetFocusToNextButton

    Set the keyboard focus to the wizard's "Next" (or "Accept") button.

    Return value

    • void

    291.2.71. SetHelpText

    Set a new help text.

    Function parameters

    • string help_text

    Return value

    • void

    Example 139. 

     Wizard::SetHelpText("This is a help Text");


    291.2.72. SetNextButton

    Set the dialog's "Next" button with a new label and a new ID

    Function parameters

    • any id

    • string label

    Return value

    • void

    291.2.73. SetProductName

    Set the product name for UI

    Function parameters

    • string name

    Return value

    • void

    291.2.74. SetScreenShotName

    Set a name for the current dialog:

    Function parameters

    • string name

    Return value

    • void

    291.2.75. SetTitleIcon

    Set the wizard 'title' icon

    Function parameters

    • string icon_name

    Return value

    • void

    291.2.76. ShowHelp

    Open a popup dialog that displays a help text (rich text format).

    Function parameters

    • string help_text

    Return value

    • void

    291.2.77. ShowReleaseNotesButton

    Show a "Release Notes" button with the specified label and ID if there is a "steps" panel

    Function parameters

    • string label

    • string id

    Return value

    • void

    291.2.78. TimeoutUserInput

    Substitute for UI::TimeoutUserInput

    Function parameters

    • integer timeout_millisec

    Return value

    • any

    291.2.79. UserInput

    Substitute for UI::UserInput

    Return value

    • any - (maybe normalized) widget ID

    291.2.80. WaitForEvent

    Substitute for UI::WaitForEvent

    Function parameters

    • integer timeout_millisec

    Return value

    • map

    291.3. Global Variables

    291.4. Module Requirements

    291.4.1. Module Imports

    • Directory
    • Label
    • Popup
    • SuSERelease

    291.4.2. Module Includes