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>
Handling of default desktop selection</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>
Handling of default desktop selection</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>
Handling of default desktop selection</h1>
</td>
<td class="filecell">DefaultDesktop.ycp</td>
</tr>
<tr>
<td></td>
</tr>
<tr>
<td>
<ul>
<li>Jiri Srain <jsrain@suse.cz></li>
<li> Lukas Ocilka <locilka@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>Installation</li>
<li>Mode</li>
<li>PackagesProposal</li>
<li>ProductControl</li>
<li>ProductFeatures</li>
</ul>
<h1>Structures</h1>
<ul>
<li>
<a href="#$[">$[</a>
</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#Description">Description ()</a>
</li>
<li>
<a href="#Desktop">Desktop ()</a>
</li>
<li>
<a href="#ForceReinit">ForceReinit ()</a>
</li>
<li>
<a href="#GetAllDesktopsMap">GetAllDesktopsMap ()</a>
</li>
<li>
<a href="#Init">Init ()</a>
</li>
<li>
<a href="#PatternsToDeselect">PatternsToDeselect ()</a>
</li>
<li>
<a href="#PatternsToSelect">PatternsToSelect ()</a>
</li>
<li>
<a href="#PrefferedWindowManager">PrefferedWindowManager ()</a>
</li>
<li>
<a href="#SelectedDesktops">SelectedDesktops ()</a>
</li>
<li>
<a href="#SetDesktop">SetDesktop (string new_desktop)</a>
</li>
</ul>
<h1>Local Variables</h1>
<ul>
<li>
<a href="#desktop">desktop</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="desktop">local
<b>desktop
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Desktop which was selected in the desktop selection dialog.
Must be defined in control file in section software->supported_desktops.</p>
<div class="sigbox">
<span class="sig" id="Init">global
<b>Init ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Initialize default desktop from control file if specified there</p>
<div class="sigbox">
<span class="sig" id="ForceReinit">global
<b>ForceReinit ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Forces new initialization...</p>
<div class="sigbox">
<span class="sig" id="GetAllDesktopsMap">global
<b>GetAllDesktopsMap ()
<span class="a"> -> </span>
<span class="t">map <string, map></span>
</b>
</span>
</div>
<p>
Returns map of pre-defined default system tasks</p>
<p>Structure
<b>
<a id="$[">$[</a>
</b>
</p>
<pre>
"desktop ID" : $[
"desktop" : "desktop to start", // DEFAULT_WM
"order" : integer,
"label" : _("Desktop Name Visible in Dialog (localized - initial localization)"),
"label_id" : _("Desktop Name Visible in Dialog (original)"),
"description" : _("Description text of the desktop (localized - initial localization)"),
"description_id" : _("Description text of the desktop (originale)"),
"patterns" : ["list", "of", "related", "patterns"],
"icon" : "some-icon", // filename from the 64x64 directory of the current theme (without .png suffix)
],
]</pre>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">all_system_tasks
</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SelectedDesktops">global
<b>SelectedDesktops ()
<span class="a"> -> </span>
<span class="t">list <string></span>
</b>
</span>
</div>
<p>
Return list installed desktops or desktop selected for installation.</p>
<dl>
<dt>
<b>See</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><a href="#GetAllDesktopsMap">GetAllDesktopsMap</a></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Desktop">global
<b>Desktop ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get the currently set default desktop, nil if none set</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">desktop or nil</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SetDesktop">global
<b>SetDesktop (string new_desktop)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set the default desktop</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">new_desktop</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="PrefferedWindowManager">global
<b>PrefferedWindowManager ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get preffered window/desktop manager for the selected desktop</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">preffered window/desktop manager, empty if no one</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="PatternsToSelect">global
<b>PatternsToSelect ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get patterns which should be selected for currently selected desktop</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list of patterns</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="PatternsToDeselect">global
<b>PatternsToDeselect ()
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Get patterns which should be NOT selected for currently selected desktop</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">a list of patterns</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Description">global
<b>Description ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Get the description of the currently selected desktop for the summary</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">the description of the desktop</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