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>
Country settings</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>
Country settings</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>
Country settings</h1>
</td>
<td class="filecell">modules/Timezone.ycp</td>
</tr>
<tr>
<td>Timezone related stuff</td>
</tr>
<tr>
<td>
<ul>
<li>Klaus Kaempf <kkaempf@suse.de></li>
<li> Thomas Roelz <tom@suse.de></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>Arch</li>
<li>HTML</li>
<li>Language</li>
<li>Misc</li>
<li>Mode</li>
<li>ProductFeatures</li>
<li>Stage</li>
<li>String</li>
</ul>
<h1>Global Variables</h1>
<ul>
<li>
<a href="#modified">modified</a>
</li>
<li>
<a href="#windows_partition">windows_partition</a>
</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#Export">Export ()</a>
</li>
<li>
<a href="#GetCountryForTimezone">GetCountryForTimezone (string tz)</a>
</li>
<li>
<a href="#GetDateTime">GetDateTime (boolean real_time, boolean locale_format)</a>
</li>
<li>
<a href="#GetDateTimeMap">GetDateTimeMap ()</a>
</li>
<li>
<a href="#GetLanguageForTimezone">GetLanguageForTimezone (string tz)</a>
</li>
<li>
<a href="#GetTimezoneCountry">GetTimezoneCountry (string zone)</a>
</li>
<li>
<a href="#GetTimezoneForLanguage">GetTimezoneForLanguage (string sys_language, string default_timezone)</a>
</li>
<li>
<a href="#Import">Import (map settings)</a>
</li>
<li>
<a href="#MakeProposal">MakeProposal (boolean force_reset, boolean language_changed)</a>
</li>
<li>
<a href="#Modified">Modified ()</a>
</li>
<li>
<a href="#PopVal">PopVal ()</a>
</li>
<li>
<a href="#ProposeLocaltime">ProposeLocaltime ()</a>
</li>
<li>
<a href="#PushVal">PushVal ()</a>
</li>
<li>
<a href="#Read">Read ()</a>
</li>
<li>
<a href="#Region">Region ()</a>
</li>
<li>
<a href="#ResetZonemap">ResetZonemap ()</a>
</li>
<li>
<a href="#Save">Save ()</a>
</li>
<li>
<a href="#Selection">Selection (integer num)</a>
</li>
<li>
<a href="#Set">Set (string zone, boolean really)</a>
</li>
<li>
<a href="#SetTime">SetTime (string year, string month, string day, string hour, string minute, string second)</a>
</li>
<li>
<a href="#SetTimezoneForLanguage">SetTimezoneForLanguage (string sys_language)</a>
</li>
<li>
<a href="#Summary">Summary ()</a>
</li>
<li>
<a href="#SystemTime2HWClock">SystemTime2HWClock ()</a>
</li>
<li>
<a href="#Timezone">Timezone ()</a>
</li>
<li>
<a href="#UpdateTimezone">UpdateTimezone (string tmz)</a>
</li>
<li>
<a href="#get_zonemap">get_zonemap ()</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#get_lang2tz">get_lang2tz ()</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="modified">global
<b>modified
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
if anyuthing was modified (currently for auto client only)</p>
<div class="sigbox">
<span class="sig" id="windows_partition">global
<b>windows_partition
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
If there is windows partition, assume that local time is used</p>
<div class="sigbox">
<span class="sig" id="get_lang2tz">local
<b>get_lang2tz ()
<span class="a"> -> </span>
<span class="t">map<string, string></span>
</b>
</span>
</div>
<p>
get_lang2tz()</p>
<p>
Get the language --> timezone conversion map.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">conversion map
</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>See</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><a href="#get_zonemap()">get_zonemap()</a></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="get_zonemap">global
<b>get_zonemap ()
<span class="a"> -> </span>
<span class="t">list<map<string,any> ></span>
</b>
</span>
</div>
<p>
get_zonemap()</p>
<p>
Get the timezone database.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">timezone DB (map)
</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>See</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><a href="#get_lang2tz()">get_lang2tz()</a></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Set">global
<b>Set (string zone, boolean really)
<span class="a"> -> </span>
<span class="t">integer</span>
</b>
</span>
</div>
<p>
Set()</p>
<p>
Set system to selected timezone.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">zone</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">really</span>
</td>
<td class="descbox"></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">the number of the region that contains the timezone
</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="UpdateTimezone">global
<b>UpdateTimezone (string tmz)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Convert the duplicated timezone to the only one supported
Temporary solution - a result of discussion of bug #47472</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">tmz</span>
</td>
<td class="descbox">current timezone</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Read">global
<b>Read ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Read timezone settings from sysconfig</p>
<div class="sigbox">
<span class="sig" id="Timezone">global
<b>Timezone ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Timezone()</p>
<p>
The module constructor.
Sets the proprietary module data defined globally for public access.
This is done only once (and automatically) when the module is loaded for the first time.
Calls Set() in initial mode.
Reads current timezone from sysconfig in normal mode.</p>
<dl>
<dt>
<b>See</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><a href="#Set()">Set()</a></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SetTime">global
<b>SetTime (string year, string month, string day, string hour, string minute, string second)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set the new time and date given by user</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">year</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">month</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">day</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">hour</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">minute</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">second</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SystemTime2HWClock">global
<b>SystemTime2HWClock ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set the Hardware Clock to the current System Time.</p>
<div class="sigbox">
<span class="sig" id="GetTimezoneForLanguage">global
<b>GetTimezoneForLanguage (string sys_language, string default_timezone)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
GetTimezoneForLanguage()</p>
<p>
Get the timezone for the given system language.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">sys_language</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">default_timezone</span>
</td>
<td class="descbox"></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">The timezone for this language, e.g. "US/Eastern"
or the default value if nothing found.
</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>See</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><a href="#-">-</a></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SetTimezoneForLanguage">global
<b>SetTimezoneForLanguage (string sys_language)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Set the timezone for the given system language.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">sys_language</span>
</td>
<td class="descbox"></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">the number of the region that contains the timezone</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetLanguageForTimezone">global
<b>GetLanguageForTimezone (string tz)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return the language code for given timezone (by reverse searching the
"language -> timezone" map)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">tz</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetCountryForTimezone">global
<b>GetCountryForTimezone (string tz)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return the country part of language code for given timezone</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">tz</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetTimezoneCountry">global
<b>GetTimezoneCountry (string zone)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Return translated country name of given timezone</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">zone</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetDateTime">global
<b>GetDateTime (boolean real_time, boolean locale_format)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
GetDateTime()</p>
<p>
Get the output of date "+%H:%M:%S - %Y-%m-%d" or in locale defined format</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">real_time</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">locale_format</span>
</td>
<td class="descbox"></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">The string output.
</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ResetZonemap">global
<b>ResetZonemap ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Clear the internal map with timezones, so the timezone data could be
retranslated next time when they are needed</p>
<div class="sigbox">
<span class="sig" id="ProposeLocaltime">global
<b>ProposeLocaltime ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Return true if localtime should be proposed as default
Based on current hardware configuration:
Win partitions present or 32bit Mac</p>
<div class="sigbox">
<span class="sig" id="MakeProposal">global
<b>MakeProposal (boolean force_reset, boolean language_changed)
<span class="a"> -> </span>
<span class="t">list<string></span>
</b>
</span>
</div>
<p>
Return proposal list of strings.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">force_reset</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">language_changed</span>
</td>
<td class="descbox"></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">user readable description.
If force_reset is true reset the module to the timezone
stored in default_timezone.</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Selection">global
<b>Selection (integer num)
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Selection()</p>
<p>
Return a map of ids and names to build up a selection list
for the user. The key is used later in the Set function
to select this timezone. The name is a translated string.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">num</span>
</td>
<td class="descbox"></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">map for timezones
'timezone_id' is used internally in Set and Probe
functions. 'timezone_name' is a user-readable string.
Uses Language::language for translation.</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>See</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><a href="#Set()">Set()</a></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Region">global
<b>Region ()
<span class="a"> -> </span>
<span class="t">list</span>
</b>
</span>
</div>
<p>
Return list of regions for timezone selection list</p>
<div class="sigbox">
<span class="sig" id="Save">global
<b>Save ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Save()</p>
<div class="sigbox">
<span class="sig" id="GetDateTimeMap">global
<b>GetDateTimeMap ()
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
Return current date and time in the map</p>
<div class="sigbox">
<span class="sig" id="PushVal">global
<b>PushVal ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
save the initial data</p>
<div class="sigbox">
<span class="sig" id="PopVal">global
<b>PopVal ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
restore the original data from internal map</p>
<div class="sigbox">
<span class="sig" id="Modified">global
<b>Modified ()
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
was anything modified?</p>
<div class="sigbox">
<span class="sig" id="Import">global
<b>Import (map settings)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
AutoYaST interface function: Get the Timezone configuration from a map.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">settings</span>
</td>
<td class="descbox">imported map</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">success</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Export">global
<b>Export ()
<span class="a"> -> </span>
<span class="t">map</span>
</b>
</span>
</div>
<p>
AutoYaST interface function: Return the Timezone configuration as a map.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">with the settings</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="Summary">global
<b>Summary ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
AutoYaST interface function: Return the summary of Timezone configuration as a map.</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">summary string (html)</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