YaST2 Developers Documentation: Common widget manipulation
YaST

functions
files
intro

Common widget manipulation

 modules/DialogTree.ycp
Routines for handling the dialog with tree on the left side

Imports

  • CWM
  • Label
  • Wizard

Global Functions

Local Variables

Local Functions

local selected_screen -> string

Currently selected item in the tree

local previous_screen -> string

Previously selected item in the tree

local DialogTreeInit (string key) -> void

Init function of virtual DialogTree widget

Parameters:
key string widget key
local DialogTreeHandle (string key, map event) -> symbol

Handle function of virtual DialogTree widget

Parameters:
key string widget key
event map event that caused handler call
Return value:
for wizard sequencer or nil
local GetVirtualDialogTreeWidget (list<string> ids) -> map<string,any>

Get the map of the virtal left tree widget

Parameters:
ids a list of widget ids of all tree items
Return value:
tree of the widget
local DrawScreen (map<string,any> current_screen, map<string,map<string,any> > widget_descr, map<string,any> extra_widget) -> list<map<string,any> >

Draw the screen related to the particular tree item

Parameters:
current_screen a map describing the current screen
widget_descr a map describing all widgets that may be present in the screen extra_widget a map of the additional widget to be added at the end of the list of widgets
extra_widget
Return value:
a list of preprocessed widgets that appear in this dialog
global ShowFlat (list<string> ids_order, map<string,map<string,any> > screens) -> void

Draw the dialog with the flat tree (only single level of the tree entries)

Parameters:
ids_order a list of IDs in the same order as they are expected to be in the left menu
screens map of all screens (key is screen ID, value is screen description map
global ShowTree () -> void

Draw the dialog with multi-level tree

global AdjustButtons (map<string,string> buttons) -> void

Adjust buttons at the bottom of the dialog

Parameters:
buttons a map with keys "abort_button", "back_button" and "next_button" adn values labels of appropriate buttons
global AdjustButtonsAny (map<string,any> buttons) -> void

Adjust buttons at the bottom of the dialog

Parameters:
buttons a map with keys "abort_button", "back_button" and "next_button" adn values labels of appropriate buttons, other keys with values of other types are possible
global Run (map<string,any> settings) -> symbol

Generic function to create dialog and handle it's events. Run the event loop over the dialog with the left tree.

Parameters:
settings
Return value:
wizard sequencer symbol
global RunAndHide (map<string,any> settings) -> symbol

Run the event loop over the dialog with the left tree. After finished, run UI::CloseDialog

Parameters:
settings
Return value:
wizard sequencer symbol
global ShowAndRun (map<string,any> settings) -> symbol

Display the dialog and run its event loop

Parameters:
settings
Return value:
wizard sequencer symbol
YaST2 Developers Documentation