ACC SHELL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>
Configuration of sysconfig</title>
<style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
</head>
<body>
<div class="header">
<i>YaST2 Developers Documentation:</i>
<a href="index.html">
<b>
Configuration of sysconfig</b>
</a>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
<hr />
</div>
<div class="menu">
<img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
<br />
<br />
<a href="index.html">functions</a>
<br />
<a href="files.html">files</a>
<br />
<a href="intro.html">intro</a>
</div>
<div class="main">
<div class="sigbox">
<table class="padtbl">
<tr>
<td>
<h1>
Configuration of sysconfig</h1>
</td>
<td class="filecell">include/sysconfig/complex.ycp</td>
</tr>
<tr>
<td>Dialogs definitions</td>
</tr>
<tr>
<td>
<ul>
<li>Ladislav Slezak <lslezak@suse.cz></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
<h1>Imports</h1>
<ul>
<li>Label</li>
<li>Mode</li>
<li>Popup</li>
<li>String</li>
<li>Sysconfig</li>
<li>Wizard</li>
</ul>
<h1>Includes</h1>
<ul>
<li>sysconfig/dialogs.ycp</li>
<li>sysconfig/helps.ycp</li>
<li>sysconfig/routines.ycp</li>
</ul>
<h1>Local Variables</h1>
<ul>
<li>
<a href="#selected_variable">selected_variable</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#MainDialog">MainDialog ()</a>
</li>
<li>
<a href="#Modified">Modified ()</a>
</li>
<li>
<a href="#ReadDialog">ReadDialog ()</a>
</li>
<li>
<a href="#WriteDialog">WriteDialog ()</a>
</li>
<li>
<a href="#add_if_missing">add_if_missing (list l, string v)</a>
</li>
<li>
<a href="#backslash_add">backslash_add (string input)</a>
</li>
<li>
<a href="#backslash_remove">backslash_remove (string input)</a>
</li>
<li>
<a href="#check_set_current_value">check_set_current_value (boolean force_change)</a>
</li>
<li>
<a href="#combo_editable">combo_editable (map description)</a>
</li>
<li>
<a href="#combo_list">combo_list (map<string, any> description, boolean set_default)</a>
</li>
<li>
<a href="#create_description">create_description (map<string, any> description, boolean richtext)</a>
</li>
<li>
<a href="#create_table_content">create_table_content (list<string> varids)</a>
</li>
<li>
<a href="#is_node">is_node (string id)</a>
</li>
<li>
<a href="#possible_values">possible_values (map description, boolean richtext)</a>
</li>
<li>
<a href="#update_button_state">update_button_state (map<string, any> description)</a>
</li>
<li>
<a href="#update_combo">update_combo (map<string, any> description, boolean set_default)</a>
</li>
<li>
<a href="#update_location">update_location (map description)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="selected_variable">local
<b>selected_variable
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
current selected variable in the tree widget</p>
<div class="sigbox">
<span class="sig" id="Modified">local
<b>Modified ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Return a modification status</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">true if data was modified</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ReadDialog">local
<b>ReadDialog ()
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Read settings dialog</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">`abort if aborted and `next otherwise</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="WriteDialog">local
<b>WriteDialog ()
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Write settings dialog</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">`abort if aborted and `next otherwise</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="possible_values">local
<b>possible_values (map description, boolean richtext)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get string representation of type definition. Used at richtext description.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox">Variable description</td>
</tr>
<tr>
<td class="pbox">
<span class="p">richtext</span>
</td>
<td class="descbox">result is rich/plain text</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Textual description of the type</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="create_description">local
<b>create_description (map<string, any> description, boolean richtext)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Create rich text description string from description values</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox">Description</td>
</tr>
<tr>
<td class="pbox">
<span class="p">richtext</span>
</td>
<td class="descbox">if true result is rich text, if false result is plain text</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Rich text string</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="combo_editable">local
<b>combo_editable (map description)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Get combo box editable status - depends on Type value</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox">Description of variable</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">True if combo box should be editable</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="add_if_missing">local
<b>add_if_missing (list l, string v)
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Generic list function - add value to the list if it isn't already there</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">l</span>
</td>
<td class="descbox">Input list</td>
</tr>
<tr>
<td class="pbox">
<span class="p">v</span>
</td>
<td class="descbox">Input value</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">List with value v</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="backslash_add">local
<b>backslash_add (string input)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Escape double quotes and back slash characters by back slash</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">input</span>
</td>
<td class="descbox">String to escape</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Escaped string</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="backslash_remove">local
<b>backslash_remove (string input)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Remove backslashes from string - opposite funtion to the backslash_add function.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">input</span>
</td>
<td class="descbox">Escaped string</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">String without escape chars</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="combo_list">local
<b>combo_list (map<string, any> description, boolean set_default)
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Create list of values for combo box widget</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox">Variable description</td>
</tr>
<tr>
<td class="pbox">
<span class="p">set_default</span>
</td>
<td class="descbox">If true add default value to the list</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">List of values for combo box widget</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="update_combo">local
<b>update_combo (map<string, any> description, boolean set_default)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update combo box in dialog</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox">Variable description</td>
</tr>
<tr>
<td class="pbox">
<span class="p">set_default</span>
</td>
<td class="descbox">Set to true ifdefault value should be in the combo box</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="update_button_state">local
<b>update_button_state (map<string, any> description)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update "Default" button state (enable/disable) in the dialog</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox">Variable description</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="update_location">local
<b>update_location (map description)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Update location text in the dialog</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox">Variable description</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="is_node">local
<b>is_node (string id)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Is selected item in the tree widget leaf node?</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">id</span>
</td>
<td class="descbox">Value from tree widget</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">True if node is not leaf-node</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="check_set_current_value">local
<b>check_set_current_value (boolean force_change)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set new value for variable, warn user if new value does not match type definition.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">force_change</span>
</td>
<td class="descbox">force value as changed even if it is equal to the old one</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="create_table_content">local
<b>create_table_content (list<string> varids)
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Create table content list for selected variables</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">varids</span>
</td>
<td class="descbox">Variables which will be contained in the table</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">Table content</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="MainDialog">local
<b>MainDialog ()
<span class="a"> -> </span>
<span class="t">symbol</span>
</b>
</span>
</div>
<p>
Display main configuration dialog</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">dialog result</td>
</tr>
</table>
</dd>
</dl>
</div>
<div class="footer">
<hr />
<i>YaST2 Developers Documentation</i>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
</div>
</body>
</html>
ACC SHELL 2018