1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KSystemTimeZones</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KSystemTimeZones Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>
Inherits: QObject<br />
<h2>Detailed Description</h2>
<dl class="abstract" compact><dt><b>Abstract class:</b></dt>
<dd>This class can be used as a base class for new classes, but can not be instantiated directly.</dd></dl>
<p>The KSystemTimeZones class represents the system time zone database, consisting
of a collection of individual system time zone definitions, indexed by name.
Each individual time zone is defined in a KSystemTimeZone or KTzfileTimeZone
instance. Additional time zones (of any class derived from KTimeZone) may be
added if desired.
</p>
<p>
At initialisation, KSystemTimeZones on UNIX systems reads the zone.tab file
to obtain the list of system time zones, and creates a KTzfileTimeZone
instance for each one.
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> KSystemTimeZones gets the system's time zone configuration, including
the current local system time zone and the location of zone.tab, from the KDE
time zone daemon, ktimezoned. If ktimezoned cannot be started, KSystemTimeZones
will only know about the UTC time zone.
</dd></dl> </p>
<p>
Note that KSystemTimeZones is not derived from KTimeZones, but instead contains
a KTimeZones instance which holds the system time zone database. Convenience
static methods are defined to access its data, or alternatively you can access
the KTimeZones instance directly via the timeZones() method.
</p>
<p>
As an example, find the local time in Oman corresponding to the local system
time of 12:15:00 on 13th November 1999:
<pre class="fragment">
QDateTime sampleTime(QDate(1999,11,13), QTime(12,15,0), Qt.LocalTime);
KTimeZone local = KSystemTimeZones.local();
KTimeZone oman = KSystemTimeZones.zone("Asia/Muscat");
QDateTime omaniTime = local.convert(oman, sampleTime);
</pre>
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> KTzfileTimeZone is used in preference to KSystemTimeZone on UNIX
systems since use of the standard system libraries by KSystemTimeZone
requires the use of tzset() in several methods. That function reads and
parses the local system time zone definition file every time it is called,
and this has been observed to make applications hang for many seconds when
a large number of KSystemTimeZone calls are made in succession.
</dd></dl> </p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> This class provides a facility to simulate the local system time
zone. This facility is provided for testing purposes only, and is only
available if the library is compiled with debug enabled. In release mode,
simulation is inoperative and the real local system time zone is used at all
times.
</dd></dl> </p>
<p>
System time zone access
<dl class="see" compact><dt><b>See also:</b></dt><dd> KTimeZones, KSystemTimeZone, KSystemTimeZoneSource, KTzfileTimeZone
</dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> David Jarvie <djarvie@kde.org>. </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> S.R.Haque <srhaque@iee.org>. </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KSystemTimeZones">__init__</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSimulated">isSimulated</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isTimeZoneDaemonAvailable">isTimeZoneDaemonAvailable</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KTimeZone.html">KTimeZone</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#local">local</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KTimeZone.html">KTimeZone</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#readZone">readZone</a> (QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KTimeZone.html">KTimeZone</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#realLocalZone">realLocalZone</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setLocalZone">setLocalZone</a> (<a href="../kdecore/KTimeZone.html">KTimeZone</a> tz)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KTimeZones.html">KTimeZones</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#timeZones">timeZones</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KTimeZone.html">KTimeZone</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#zone">zone</a> (QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#zoneinfoDir">zoneinfoDir</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">{QString:<a href="../kdecore/KTimeZone.html">KTimeZone</a>} </td><td class="memItemRight" valign="bottom"><a class="el" href="#zones">zones</a> ()</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KSystemTimeZones"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="isSimulated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isSimulated</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Check whether there is a simulated local system time zone.
</p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> This method is provided only for testing purposes, and should
not be used in released code. If the library is compiled without
debug enabled, isSimulated() always returns false.
To avoid confusion, it is recommended that calls to it should be
conditionally compiled, e.g.:
</dd></dl> <pre class="fragment">
#ifndef NDEBUG
if (KSystemTimeZones.isSimulated())
{
...
}
#endif
</pre>
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setLocalZone()
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="isTimeZoneDaemonAvailable"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isTimeZoneDaemonAvailable</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Return whether the KDE time zone daemon, ktimezoned, appears to be
available and working. If not, UTC will be the only recognized time
zone.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="local"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KTimeZone.html">KTimeZone</a> local</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the current local system time zone.
</p>
<p>
The idea of this routine is to provide a robust lookup of the local time
zone. On Unix systems, there are a variety of mechanisms for setting this
information, and no well defined way of getting it. For example, if you
set your time zone to "Europe/London", then the tzname[] maintained by
tzset() typically returns { "GMT", "BST" }. The function of this routine
is to actually return "Europe/London" (or rather, the corresponding
KTimeZone).
</p>
<p>
Note that depending on how the system stores its current time zone, this
routine may return a synonym of the expected time zone. For example,
"Europe/London", "Europe/Guernsey" and some other time zones are all
identical and there may be no way for the routine to distinguish which
of these is the correct zone name from the user's point of view.
</p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> For testing purposes, if the library is compiled with debug
enabled, this method returns any simulated local system time
zone set by setLocalZone(). If the library is compiled in
release mode, it always returns the real local system time zone.
</dd></dl> </p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> local system time zone. If necessary, we will use a series of
heuristics which end by returning UTC. We will never return NULL.
Note that if UTC is returned as a default, it may not belong to the
the collection returned by KSystemTimeZones.zones().
</dd></dl>
</p></div></div><a class="anchor" name="readZone"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KTimeZone.html">KTimeZone</a> readZone</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the time zone with the given name, containing the full time zone
definition read directly from the system time zone database. This may
incur a higher overhead than zone(), but will provide whatever historical
data the system holds.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> name of time zone
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> time zone (usually a KTzfileTimeZone instance), or invalid if not found
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> zone()
</dd></dl>
</p></div></div><a class="anchor" name="realLocalZone"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KTimeZone.html">KTimeZone</a> realLocalZone</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Return the real (not simulated) local system time zone.
</p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> This method is provided only for testing purposes, and should
not be used in released code. If the library is compiled without
debug enabled, local() and realLocalZone() both return the real
local system time zone.
To avoid confusion, it is recommended that calls to
realLocalZone() should be conditionally compiled, e.g.:
</dd></dl> <pre class="fragment">
#ifndef NDEBUG
tz = KSystemTimeZones.realLocalZone();
#endif
</pre>
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setLocalZone()
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="setLocalZone"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setLocalZone</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KTimeZone.html">KTimeZone</a> </td>
<td class="paramname"><em>tz</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set or clear the simulated local system time zone.
</p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> This method is provided only for testing purposes, and should
not be used in released code. If the library is compiled without
debug enabled, setLocalZone() has no effect.
To avoid confusion, it is recommended that calls to it should be
conditionally compiled, e.g.:
</dd></dl> <pre class="fragment">
#ifndef NDEBUG
KSystemTimeZones.setLocalZone(tz);
#endif
</pre>
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>tz</em> </td><td> the time zone to simulate, or an invalid KTimeZone instance
(i.e. <pre class="fragment"> tz.isValid() == false \endcode) to cancel
simulation
@since 4.3
</p></div></div><a class="anchor" name="timeZones"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KTimeZones.html">KTimeZones</a> timeZones</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the unique KTimeZones instance containing the system time zones
collection. It is first created if it does not already exist.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> time zones.
</dd></dl>
</p></div></div><a class="anchor" name="zone"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KTimeZone.html">KTimeZone</a> zone</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the time zone with the given name.
</p>
<p>
The time zone definition is obtained using system library calls, and may
not contain historical data. If you need historical time change data,
use the potentially slower method readZone().
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> name of time zone
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> time zone (usually a KSystemTimeZone instance), or invalid if not found
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> readZone()
</dd></dl>
</p></div></div><a class="anchor" name="zoneinfoDir"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString zoneinfoDir</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the location of the system time zone zoneinfo database.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> path of directory containing the zoneinfo database
</dd></dl>
</p></div></div><a class="anchor" name="zones"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">{QString:<a href="../kdecore/KTimeZone.html">KTimeZone</a>} zones</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns all the time zones defined in this collection.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> time zone collection
</dd></dl>
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
|
