YaST2 Developers Documentation: yast2



functions
files
intro

yast2

Wizard.ycp
Wizard dialog
Provides the wizard dialog (common screen for all YaST2 installation modules) and functions to set the contents, to replace and restore special widgets.

Imports

  • Directory
  • Label
  • Popup

Local Variables

Info:

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

Return value:
a widget tree

Info:

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

Return value:
a widget tree

Info:

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

Return value:
a widget tree

Info:

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

Return value:
a widget tree

Info:

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

Return value:
a widget tree

Info:

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

Return value:
a widget tree

Info:

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

Return value:
a widget tree

Info:

Returns a term describing a generic wizard dialog with a configurable button box.

Parameters:
button_box term that contains a `HBox() with buttons in it
Return value:
describing the dialog.

Info:

Check if the topmost dialog is a wizard dialog (i.e. has a widget with `id(`WizardDialog) )

Return value:
true, if topmost dialog is a wizard dialog, false otherwise

Info:

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

Parameters:
help_text the text to display

Info:

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

Return value:
describing the dialog.

Info:

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

Return value:
describing the dialog.

Info:

Open any wizard dialog.

Parameters:
dialog a wizard dialog, e.g. Wizard::GenericDialog()

Info:

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

Info:

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

Info:

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

Info:

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

Info:

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

Info:

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

Info:

Open a wizard dialog with simple layout - no graphics, no steps, only a help widget buttons (by default "Back", "Abort", "Next"). This is the only type of wizard dialog which still allows replacing the help space - either already upon opening it or later with Wizard::ReplaceCustomHelp(). If help_space_contents is 'nil', the normal help widget will remain. If button_box is 'nil', Wizard::BackAbortNextButtonBox() is used.

Info:

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

Info:

Close a wizard dialog.

Info:

Substitute for UI::UserInput that transparently handles different variations of the wizard layout. Returns `next if `next or `accept were clicked, `back if `back or `cancel were clicked. Simply replace ret = UI::UserInput() with ret = Wizard::UserInput()

Return value:
(maybe normalized) widget ID

Info:

Create and open a typical installation wizard dialog. For backwards compatibility only - don't use this any more in new modules.

Info:

how the general framework for the installation wizard should look like. This function creates and shows a dialog.

Info:

Clear the wizard contents. This may sound silly, but it gives much faster feedback to the user if used properly: Whenever the user clicks "Next" or "Back", call ClearContents() prior to any lengthy operation -> the user notices instant response, even though he may in fact still have to wait.

Info:

Set contents of wizard dialog + its title, help_text and buttons labels. Enables both back and next button.

Parameters:
back_label label of back button
contents contents of dialog
help_text help text
next_label label of next button
title title of window

Info:

Replace the wizard help subwindow with a custom widget. THIS FUNCTION IS DEPRECATED!

Info:

Set a new help text.

Info:

Restore the wizard help subwindow.

Info:

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

Info:

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

Info:

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

Info:

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

Info:

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

Info:

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

Info:

Restore the wizard 'back' button.

Info:

Restore the wizard 'next' button.

Info:

Restore the wizard 'abort' button.

Info:

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

Parameters:
contents a term describing the new contents

Info:

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

Info:

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

Info:

Set the wizard 'title' icon to the specified icon from the standard icon directory.

Parameters:
icon_name name (without path) of the new icon

Info:

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

Info:

Info:

PRIVATE - Replace the entire Wizard button box with a new one.

Info:

Enable the wizard's "Abort" button.

Info:

Disable the wizard's "Abort" button.

Info:

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

Info:

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

Info:

Disable the wizard's "Back" button.

Info:

Enable the wizard's "Back" button.

Info:

Disable the wizard's "Cancel" button.

Info:

Enable the wizard's "Cancel" button.

Info:

Retranslate the wizard buttons. This will revert button labels and IDs to the default that were used upon Wizard::CreateDialog(), Wizard::OpenNextBackDialog(), or Wizard::OpenAcceptDialog().

Info:

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

Info:

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

local screenshot_name -> string

Currently used screenshot name. Initially, it must match the UI default, "yast2"

local screenshot_name_stack -> list<string>

Screenshot names overriden by nested SetScreenShotName calls

Info:

Declare a name for the current dialog to ease making screenshots. By convention, the name is {rpm-name-without-yast2}-{sorting-prefix}-{description} The calls may be nested.

Parameters:
s eg. "mail-1-conntype"
See:
RestoreScreenShotName

Info:

Restore the screenshot name. If it does not match a SetScreenShotName, "yast2" is used and a y2error logged.

Info:

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

Info:

Create and open a Tree wizard dialog. For backwards compatibility only - don't use this any more in new modules.

Info:

Add Tree Item to tree enabled Wizard @param list Tree data

Parameters:
string id
Return value:
Updated Tree Data

Info:

Create the Tree Items @param list Tree data

Parameters:
string parent
Return value:
Tree Items

Info:

Create the tree in the dialog, replaces helpspace with new tree widget @param list Tree data

Parameters:
string tree title

Info:

Add Menu @param list Tree data

Parameters:
string id
Return value:
Updated Menu Data

Info:

Add Sub Menu @param list Tree data

Parameters:
string id
Return value:
Updated Menu Data

Info:

Add Menu Entry @param list Tree data

Parameters:
string id
Return value:
Updated Menu Data

Info:

Create the Menu Items @param list Menu data

Parameters:
string parent
Return value:
Menu Items

Info:

Create the menu in the dialog @param list Menu data


YaST2 Developers Documentation