Unknown YCP Module |
This module has an unstable interface. |
File: Wizard.ycp
Package: yast2
Author: Stefan Hundhammer
Returns a button box with buttons "Back", "Abort", "Next"
- Return value:
-
a widget tree
Returns a button box with buttons "Back", "Abort Installation", "Next"
- Return value:
-
a widget tree
Returns a button box with buttons "Back", "Next"
- Return value:
-
a widget tree
Returns a button box with buttons "Cancel", "Accept"
- Return value:
-
a widget tree
Returns a button box with buttons "Cancel", "OK"
- Return value:
-
a widget tree
Returns a button box with buttons "Abort", "Accept"
- Return value:
-
a widget tree
Returns a button box with buttons "Abort Installation", "Accept"
- Return value:
-
a widget tree
Returns a button box with buttons "Abort", "Apply", "Finish"
- Return value:
-
a widget tree
Create a Generic Dialog
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:
-
term describing the dialog.
Create a Generic Tree Dialog
Returns a term describing a wizard dialog with left menu tree, right contents and a configurable button box.
- Parameters:
-
button_box term that contains a `HBox() with buttons in it
- Return value:
-
term describing the dialog.
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
Open a popup dialog that displays a help text (rich text format).
- Parameters:
-
help_text the text to display
Returns a standard wizard dialog with buttons "Next", "Back", "Abort".
- Return value:
-
describing the dialog.
Returns a standard wizard dialog with buttons "Cancel", "Accept"
- Return value:
-
describing the dialog.
Returns a standard wizard dialog with buttons "Cancel", "OK"
- Return value:
-
describing the dialog.
Open any wizard dialog.
- Parameters:
-
dialog a wizard dialog, e.g. Wizard::GenericDialog()
Open a dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".
Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".
Open a dialog with "OK", "Cancel" and set the keyboard focus to "OK".
Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".
Open a dialog with "Accept", "Cancel" that will also accept workflow steps.
Open a dialog with "Accept", "Cancel" that will also accept workflow steps.
Open a dialog with "Back", "Next", "Abort" that will also accept workflow steps.
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.
- Parameters:
-
help_space_contents Help space contents button_box Buttom Box
- See
-
CloseDialog
Replace the help widget for dialogs opened with Wizard::OpenCustomDialog().
- Parameters:
-
contents Replace custom help with supplied contents
Close a wizard dialog.
Substitute for UI::UserInput
This function 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
Substitute for UI::TimeoutUserInput
Analogical to Wizard::UserInput.
- Parameters:
-
timeout_millisec
Substitute for UI::WaitForEvent
Substitute for UI::WaitForEvent with timeout
- Parameters:
-
timeout_millisec
Set a new help text.
- Parameters:
-
help_text Help text
- Example
-
Wizard::SetHelpText("This is a help Text");
This function is deprecated.
Replace the wizard help subwindow with a custom widget.
- Parameters:
-
contents Replace Help with contents
Restore the wizard help subwindow.
- Parameters:
-
help_text Help text
Create and open a typical installation wizard dialog.
Set the contents of a wizard dialog and define if to move focus to next button
How the general framework for the installation wizard should look like. This function creates and shows a dialog.
- Parameters:
-
title Dialog Title contents The Dialog contents help_text Help text has_back Is the Back button enabled? has_next Is the Next button enabled? set_focus Should the focus be set to Next button?
Set the contents of a wizard dialog
How the general framework for the installation wizard should look like. This function creates and shows a dialog.
- Parameters:
-
title Dialog Title contents The Dialog contents help_text Help text has_back Is the Back button enabled? has_next Is the Next button enabled?
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.
Set the dialog's "Next" button with a new label and a new ID
- Parameters:
-
id Button ID label Button Label
Set the dialog's "Back" button with a new label and a new ID
- Parameters:
-
id Button ID label Button Label
Set the dialog's "Abort" button with a new label and a new ID
- Parameters:
-
id Button ID label Button Label
Hide the Wizard's "Next" button. Restore it later with RestoreNextButton():
Hide the Wizard's "Back" button. Restore it later with RestoreBackButton():
Overview Dialog http://en.opensuse.org/YaST/Style_Guide#Single_Configuration.2FOverview.2FEdit_Dialog dialog with Cancel and OK buttons (cancel has function as abort)
Hide the Wizard's "Abort" button. Restore it later with RestoreAbortButton():
Restore the wizard 'back' button.
- See
-
HideBackButton
Restore the wizard 'next' button.
- See
-
HideNextButton
Restore the wizard 'abort' button.
- See
-
HideAbortButton
Set contents and Buttons of wizard dialog
Additionally set its title, help_text and buttons labels. Enables both back and next button.
- Parameters:
-
title title of window contents contents of dialog help_text help text back_label label of back button next_label label of next button
Sets the dialog title shown in the window manager's title bar.
- Parameters:
-
titleText title of the dialog
- Example
-
SetDialogTitle ("DNS Server Configuration");
Sets the wizard 'title' icon to the specified icon from the standard icon directory.
- Parameters:
-
icon_name name (without path) of the new icon
- Example
-
SetTitleIcon ("yast-dns-server");
- See
-
ClearTitleIcon
Clear the wizard 'title' icon, i.e. replace it with nothing
- See
-
SetTitleIcon
Sets the window title according to the name specified in a .desktop file got as parameter. Desktop file is placed in a special directory (/usr/share/applications/YaST2). Parameter file is realative to that directory without ".desktop" suffix.
- Parameters:
-
file desktop file
- Return value:
-
true on success
- Example
-
// Opens /usr/share/applications/YaST2/lan.desktop // Reads (localized) "name" entry from there // Sets the window title. SetDesktopTitle ("lan")
Sets the icon specified in a .desktop file got as parameter. Desktop file is placed in a special directory (/usr/share/applications/YaST2). Parameter file is realative to that directory without ".desktop" suffix. Warning: There are no desktop files in inst-sys. Use "SetTitleIcon" instead.
- Parameters:
-
file Icon name
- Return value:
-
true on success
- Example
-
// Opens /usr/share/applications/YaST2/lan.desktop // Reads "Icon" entry from there // Sets the icon. SetDesktopIcon ("lan")
Convenience function to avoid 2 calls if application needs to set both dialog title and icon from desktop file specified as parameter. Desktop file is placed in a special directory (/usr/share/applications/YaST2). Parameter file is realative to that directory without ".desktop" suffix. Warning: There are no desktop files in inst-sys.
- Parameters:
-
file desktop file name
- Return value:
-
true on success
- Example
-
// Opens /usr/share/applications/YaST2/lan.desktop // Reads "Icon" and "Name" entries from there // Sets the icon, sets the dialog title SetDialogTitleAndIcon ("lan")
PRIVATE - Replace the entire Wizard button box with a new one.
- Parameters:
-
button_box Button Box term
Enable the wizard's "Abort" button.
Disable the wizard's "Abort" button.
Disable the wizard's "Next" (or "Accept") button.
- See
-
EnableNextButton
Enable the wizard's "Next" (or "Accept") button.
Disable the wizard's "Back" button.
- See
-
EnableBackButton
Enable the wizard's "Back" button.
Disable the wizard's "Cancel" button.
Enable the wizard's "Cancel" button.
Returns whether the `Wizard widget is available.
- Return value:
-
available
- See
-
bnc #367213.
Show a "Release Notes" button with the specified label and ID if there is a "steps" panel
- Parameters:
-
label id
Hide the "Release Notes" button, if there is any
Retranslate the wizard buttons.
Set the keyboard focus to the wizard's "Next" (or "Accept") button.
Set the keyboard focus to the wizard's "Back" (or "Cancel") button.
Currently used screenshot name. Initially, it must match the UI default, "yast2"
Screenshot names overriden by nested SetScreenShotName calls
Set a name for the current dialog:
- Parameters:
-
name
Restore the screenshot name.
Open a Tree dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".
Create and open a Tree wizard dialog.
Add Tree Item to tree enabled Wizard
- Parameters:
-
Tree Tree Data parent Parent of this item title Item Title id Item ID
- Return value:
-
Updated Tree Data
Create the Tree Items
- Parameters:
-
Tree Tree data parent Parent of current Item
- Return value:
-
Tree Items
Query Tree Item
- Return value:
-
Tree Item
Create the tree in the dialog, replaces helpspace with new tree widget
- Parameters:
-
Tree Tree data title Tree title
Select Tree item
- Parameters:
-
tree_item tree item
Delete Tree items
Delete Menu items
Add Menu
- Parameters:
-
Menu Menu data title Menu Title id Menu ID
- Return value:
-
Updated Menu Data
Add Sub Menu
- Parameters:
-
Menu Menu data parent_id Menu Parent title Menu Title id Menu ID
- Return value:
-
Updated Menu Data
Add Menu Entry
- Parameters:
-
Menu Menu data parent_id Menu Parent title Menu Title id Menu ID
- Return value:
-
Updated Menu Data
Create the Menu Items
- Parameters:
-
Menu Menu data parent Menu Parent
- Return value:
-
Menu Items
Create the menu in the dialog
- Parameters:
-
Menu Menu data
Set the product name for UI
- Parameters:
-
name the product name