~ubuntu-branches/ubuntu/trusty/libgweather/trusty-updates

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GWeatherTimezone</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libgweather-3.0 Reference Manual">
<link rel="up" href="ch01.html" title="libgweather-3.0 Reference Manual">
<link rel="prev" href="GWeatherLocation.html" title="GWeatherLocation">
<link rel="next" href="libgweather-GWeatherInfo.html" title="GWeatherInfo">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GWeatherLocation.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libgweather-3.0 Reference Manual</th>
<td><a accesskey="n" href="libgweather-GWeatherInfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GWeatherTimezone.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GWeatherTimezone.description" class="shortcut">Description</a>
                   | 
                  <a href="#GWeatherTimezone.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GWeatherTimezone"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GWeatherTimezone.top_of_page"></a>GWeatherTimezone</span></h2>
<p>GWeatherTimezone</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GWeatherTimezone.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgweather/gweather.h&gt;

                    <a class="link" href="GWeatherTimezone.html#GWeatherTimezone-struct" title="GWeatherTimezone">GWeatherTimezone</a>;
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="GWeatherTimezone.html#gweather-timezone-get-type" title="gweather_timezone_get_type ()">gweather_timezone_get_type</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
#define             <a class="link" href="GWeatherTimezone.html#GWEATHER-TYPE-TIMEZONE:CAPS" title="GWEATHER_TYPE_TIMEZONE">GWEATHER_TYPE_TIMEZONE</a>
const <span class="returnvalue">char</span> *        <a class="link" href="GWeatherTimezone.html#gweather-timezone-get-name" title="gweather_timezone_get_name ()">gweather_timezone_get_name</a>          (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="GWeatherTimezone.html#gweather-timezone-get-tzid" title="gweather_timezone_get_tzid ()">gweather_timezone_get_tzid</a>          (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="GWeatherTimezone.html#gweather-timezone-get-offset" title="gweather_timezone_get_offset ()">gweather_timezone_get_offset</a>        (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GWeatherTimezone.html#gweather-timezone-has-dst" title="gweather_timezone_has_dst ()">gweather_timezone_has_dst</a>           (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="GWeatherTimezone.html#gweather-timezone-get-dst-offset" title="gweather_timezone_get_dst_offset ()">gweather_timezone_get_dst_offset</a>    (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);
<a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="returnvalue">GWeatherTimezone</span></a> *  <a class="link" href="GWeatherTimezone.html#gweather-timezone-ref" title="gweather_timezone_ref ()">gweather_timezone_ref</a>               (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GWeatherTimezone.html#gweather-timezone-unref" title="gweather_timezone_unref ()">gweather_timezone_unref</a>             (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);
<a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="returnvalue">GWeatherTimezone</span></a> *  <a class="link" href="GWeatherTimezone.html#gweather-timezone-get-utc" title="gweather_timezone_get_utc ()">gweather_timezone_get_utc</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GWeatherTimezone.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GBoxed
   +----GWeatherTimezone
</pre>
</div>
<div class="refsect1">
<a name="GWeatherTimezone.description"></a><h2>Description</h2>
<p>
A timezone.
</p>
<p>
There are no public methods for creating timezones; they can only
be created by calling <a class="link" href="GWeatherLocation.html#gweather-location-new-world" title="gweather_location_new_world ()"><code class="function">gweather_location_new_world()</code></a> to parse
Locations.xml, and then calling various <a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> methods
to extract relevant timezones from the location hierarchy.
</p>
</div>
<div class="refsect1">
<a name="GWeatherTimezone.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GWeatherTimezone-struct"></a><h3>GWeatherTimezone</h3>
<pre class="programlisting">typedef struct _GWeatherTimezone GWeatherTimezone;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-get-type"></a><h3>gweather_timezone_get_type ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               gweather_timezone_get_type          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="GWEATHER-TYPE-TIMEZONE:CAPS"></a><h3>GWEATHER_TYPE_TIMEZONE</h3>
<pre class="programlisting">#define GWEATHER_TYPE_TIMEZONE (gweather_timezone_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-get-name"></a><h3>gweather_timezone_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        gweather_timezone_get_name          (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);</pre>
<p>
Gets <em class="parameter"><code>zone</code></em>'s name; a translated, user-presentable string.
</p>
<p>
Note that the returned name might not be unique among timezones,
and may not make sense to the user unless it is presented along
with the timezone's country's name (or in some context where the
country is obvious).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>zone</code></em>'s name</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-get-tzid"></a><h3>gweather_timezone_get_tzid ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        gweather_timezone_get_tzid          (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);</pre>
<p>
Gets <em class="parameter"><code>zone</code></em>'s tzdata identifier, eg "America/New_York".
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>zone</code></em>'s tzid</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-get-offset"></a><h3>gweather_timezone_get_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 gweather_timezone_get_offset        (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);</pre>
<p>
Gets <em class="parameter"><code>zone</code></em>'s standard offset from UTC, in minutes. Eg, a value of
120 would indicate "GMT+2".
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>zone</code></em>'s standard offset, in minutes</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-has-dst"></a><h3>gweather_timezone_has_dst ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gweather_timezone_has_dst           (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);</pre>
<p>
Checks if <em class="parameter"><code>zone</code></em> observes daylight/summer time for part of the year.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>zone</code></em> observes daylight/summer time.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-get-dst-offset"></a><h3>gweather_timezone_get_dst_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 gweather_timezone_get_dst_offset    (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);</pre>
<p>
Gets <em class="parameter"><code>zone</code></em>'s daylight/summer time offset from UTC, in minutes. Eg,
a value of 120 would indicate "GMT+2". This is only meaningful if
<a class="link" href="GWeatherTimezone.html#gweather-timezone-has-dst" title="gweather_timezone_has_dst ()"><code class="function">gweather_timezone_has_dst()</code></a> returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>zone</code></em>'s daylight/summer time offset, in minutes</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-ref"></a><h3>gweather_timezone_ref ()</h3>
<pre class="programlisting"><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="returnvalue">GWeatherTimezone</span></a> *  gweather_timezone_ref               (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);</pre>
<p>
Adds 1 to <em class="parameter"><code>zone</code></em>'s reference count.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td><em class="parameter"><code>zone</code></em></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-unref"></a><h3>gweather_timezone_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gweather_timezone_unref             (<em class="parameter"><code><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> *zone</code></em>);</pre>
<p>
Subtracts 1 from <em class="parameter"><code>zone</code></em>'s reference count and frees it if it reaches 0.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gweather-timezone-get-utc"></a><h3>gweather_timezone_get_utc ()</h3>
<pre class="programlisting"><a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="returnvalue">GWeatherTimezone</span></a> *  gweather_timezone_get_utc           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the UTC timezone.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a> for UTC, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>