YaST2 Developers Documentation: Common widget manipulation

Common widget manipulation

modules/CWMTab.ycp
Routines for tab widget handling

This module has an unstable interface.

Imports

  • CWM
  • Wizard

Global Functions

Local Variables

Local Functions

Info:

Empty tab (just to be used as fallback constant)

Info:

Fallback label for a tab if no is defined

local current_tab_id -> string

ID of the currently displayed tab

local previous_tab_id -> string

ID of previously selected tab

local current_tab_map -> map<string,any>

description map of the currently selected tab

local previous_tab_map -> map<string,any>

description map of the currently selected tab

local TabInit (map<string,any> tab) -> void

Initialize the widgets in the tab

Parameters:
tab a map describing the tab
local TabCleanup (map<string,any> tab) -> void

Clean up the widgets in the tab

Parameters:
tab a map describing the tab
local TabHandle (map<string,any> tab, map event) -> symbol

Handle events on the widgets inside the tab

Parameters:
tab a map describing the tab
event map event that caused the event handling
Return value:
for wizard sequencer or nil
local TabStore (map<string,any> tab, map event) -> void

Store settings of all widgets inside the tab

Parameters:
tab a map describing the tab
event map event that caused the saving process
local TabValidate (map<string,any> tab, map event) -> boolean

Validate settings of all widgets inside the tab

Parameters:
tab a map describing the tab
event map event that caused the validation process
Return value:
true if validation succeeded
local RedrawTab (map<string,any> tab) -> void

Redraw the whole tab

Parameters:
tab a map describing the tab
local RedrawHelp (map<string,any> widget, map<string,any> tab) -> void

Redraw the part of the help related to the tab widget

Parameters:
widget a map of the tab widget
tab a map describing the tab
local MarkCurrentTab () -> void

Make the currently selected tab be displayed a separate way

local InitNewTab (string new_tab_id, map<string,any> widget) -> void

Switch to a new tab

Parameters:
new_tab_id
widget tab set description
global Init (map<string,any> widget, string key) -> void

Init function of the widget

Parameters:
widget
key strnig the widget key
global CleanUp (string key) -> void

Clean up function of the widget

Parameters:
key the widget key (ignored)
global Handle (map<string,any> widget, string key, map event) -> symbol

Handle function of the widget

Parameters:
widget
key strnig the widget key
event map event to be handled
Return value:
for wizard sequencer or nil
global Store (string key, map event) -> void

Store function of the widget

Parameters:
key strnig the widget key
event map that caused widget data storing
global InitWrapper (string key) -> void

Init function of the widget

Parameters:
key strnig the widget key
global CurrentTab () -> string

Get the ID of the currently displayed tab

Return value:
the ID of the currently displayed tab
global HandleWrapper (string key, map event) -> symbol

Handle function of the widget

Parameters:
key strnig the widget key
event map event to be handled
Return value:
for wizard sequencer or nil
global Validate (string key, map event) -> boolean

Validate function of the widget

Parameters:
key strnig the widget key
event map that caused widget data storing
global CreateWidget (map settings) -> map<string,any>

Get the widget description map

Parameters:
settings
Return value:
the widget description map