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

« back to all changes in this revision

Viewing changes to doc/html/GWeatherTimezone.html

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-05-27 11:58:15 UTC
  • mfrom: (13.1.4 experimental)
  • Revision ID: package-import@ubuntu.com-20130527115815-l51yffuy20gbv9q0
Tags: 3.8.0-1ubuntu1
* Sync with Debian (LP: #1184168). Remaining changes: 
  - debian/control.in, debian/rules:
    + Run autoreconf
  - debian/rules:
    + Generate POT files on build
  - debian/patches/01_gettext_not_xml.patch: 
    + using gettext rather than add translations to the xml databases
  - debian/patches/02_no_external_gettext.patch:
    + Can't have both IT_PROG_INTLTOOL and AM_GNU_GETTEXT

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GWeatherTimezone</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 
7
<link rel="home" href="index.html" title="libgweather-3.0 Reference Manual">
 
8
<link rel="up" href="ch01.html" title="libgweather-3.0 Reference Manual">
 
9
<link rel="prev" href="GWeatherLocation.html" title="GWeatherLocation">
 
10
<link rel="next" href="libgweather-GWeatherInfo.html" title="GWeatherInfo">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="GWeatherLocation.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">libgweather-3.0 Reference Manual</th>
 
21
<td><a accesskey="n" href="libgweather-GWeatherInfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#GWeatherTimezone.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#GWeatherTimezone.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#GWeatherTimezone.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry">
 
32
<a name="GWeatherTimezone"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="GWeatherTimezone.top_of_page"></a>GWeatherTimezone</span></h2>
 
36
<p>GWeatherTimezone</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv">
 
41
<a name="GWeatherTimezone.synopsis"></a><h2>Synopsis</h2>
 
42
<pre class="synopsis">
 
43
#include &lt;libgweather/gweather.h&gt;
 
44
 
 
45
                    <a class="link" href="GWeatherTimezone.html#GWeatherTimezone-struct" title="GWeatherTimezone">GWeatherTimezone</a>;
 
46
<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>);
 
47
#define             <a class="link" href="GWeatherTimezone.html#GWEATHER-TYPE-TIMEZONE:CAPS" title="GWEATHER_TYPE_TIMEZONE">GWEATHER_TYPE_TIMEZONE</a>
 
48
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>);
 
49
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>);
 
50
<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>);
 
51
<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>);
 
52
<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>);
 
53
<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>);
 
54
<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>);
 
55
<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>);
 
56
</pre>
 
57
</div>
 
58
<div class="refsect1">
 
59
<a name="GWeatherTimezone.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
60
<pre class="synopsis">
 
61
  GBoxed
 
62
   +----GWeatherTimezone
 
63
</pre>
 
64
</div>
 
65
<div class="refsect1">
 
66
<a name="GWeatherTimezone.description"></a><h2>Description</h2>
 
67
<p>
 
68
A timezone.
 
69
</p>
 
70
<p>
 
71
There are no public methods for creating timezones; they can only
 
72
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
 
73
Locations.xml, and then calling various <a class="link" href="GWeatherLocation.html" title="GWeatherLocation"><span class="type">GWeatherLocation</span></a> methods
 
74
to extract relevant timezones from the location hierarchy.
 
75
</p>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="GWeatherTimezone.details"></a><h2>Details</h2>
 
79
<div class="refsect2">
 
80
<a name="GWeatherTimezone-struct"></a><h3>GWeatherTimezone</h3>
 
81
<pre class="programlisting">typedef struct _GWeatherTimezone GWeatherTimezone;</pre>
 
82
</div>
 
83
<hr>
 
84
<div class="refsect2">
 
85
<a name="gweather-timezone-get-type"></a><h3>gweather_timezone_get_type ()</h3>
 
86
<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>
 
87
</div>
 
88
<hr>
 
89
<div class="refsect2">
 
90
<a name="GWEATHER-TYPE-TIMEZONE:CAPS"></a><h3>GWEATHER_TYPE_TIMEZONE</h3>
 
91
<pre class="programlisting">#define GWEATHER_TYPE_TIMEZONE (gweather_timezone_get_type ())
 
92
</pre>
 
93
</div>
 
94
<hr>
 
95
<div class="refsect2">
 
96
<a name="gweather-timezone-get-name"></a><h3>gweather_timezone_get_name ()</h3>
 
97
<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>
 
98
<p>
 
99
Gets <em class="parameter"><code>zone</code></em>'s name; a translated, user-presentable string.
 
100
</p>
 
101
<p>
 
102
Note that the returned name might not be unique among timezones,
 
103
and may not make sense to the user unless it is presented along
 
104
with the timezone's country's name (or in some context where the
 
105
country is obvious).
 
106
</p>
 
107
<div class="variablelist"><table border="0" class="variablelist">
 
108
<colgroup>
 
109
<col align="left" valign="top">
 
110
<col>
 
111
</colgroup>
 
112
<tbody>
 
113
<tr>
 
114
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
 
115
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
 
116
</td>
 
117
</tr>
 
118
<tr>
 
119
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
120
<td>
 
121
<em class="parameter"><code>zone</code></em>'s name</td>
 
122
</tr>
 
123
</tbody>
 
124
</table></div>
 
125
</div>
 
126
<hr>
 
127
<div class="refsect2">
 
128
<a name="gweather-timezone-get-tzid"></a><h3>gweather_timezone_get_tzid ()</h3>
 
129
<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>
 
130
<p>
 
131
Gets <em class="parameter"><code>zone</code></em>'s tzdata identifier, eg "America/New_York".
 
132
</p>
 
133
<div class="variablelist"><table border="0" class="variablelist">
 
134
<colgroup>
 
135
<col align="left" valign="top">
 
136
<col>
 
137
</colgroup>
 
138
<tbody>
 
139
<tr>
 
140
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
 
141
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
 
142
</td>
 
143
</tr>
 
144
<tr>
 
145
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
146
<td>
 
147
<em class="parameter"><code>zone</code></em>'s tzid</td>
 
148
</tr>
 
149
</tbody>
 
150
</table></div>
 
151
</div>
 
152
<hr>
 
153
<div class="refsect2">
 
154
<a name="gweather-timezone-get-offset"></a><h3>gweather_timezone_get_offset ()</h3>
 
155
<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>
 
156
<p>
 
157
Gets <em class="parameter"><code>zone</code></em>'s standard offset from UTC, in minutes. Eg, a value of
 
158
120 would indicate "GMT+2".
 
159
</p>
 
160
<div class="variablelist"><table border="0" class="variablelist">
 
161
<colgroup>
 
162
<col align="left" valign="top">
 
163
<col>
 
164
</colgroup>
 
165
<tbody>
 
166
<tr>
 
167
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
 
168
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
 
169
</td>
 
170
</tr>
 
171
<tr>
 
172
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
173
<td>
 
174
<em class="parameter"><code>zone</code></em>'s standard offset, in minutes</td>
 
175
</tr>
 
176
</tbody>
 
177
</table></div>
 
178
</div>
 
179
<hr>
 
180
<div class="refsect2">
 
181
<a name="gweather-timezone-has-dst"></a><h3>gweather_timezone_has_dst ()</h3>
 
182
<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>
 
183
<p>
 
184
Checks if <em class="parameter"><code>zone</code></em> observes daylight/summer time for part of the year.
 
185
</p>
 
186
<div class="variablelist"><table border="0" class="variablelist">
 
187
<colgroup>
 
188
<col align="left" valign="top">
 
189
<col>
 
190
</colgroup>
 
191
<tbody>
 
192
<tr>
 
193
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
 
194
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
 
195
</td>
 
196
</tr>
 
197
<tr>
 
198
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
199
<td>
 
200
<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>
 
201
</tr>
 
202
</tbody>
 
203
</table></div>
 
204
</div>
 
205
<hr>
 
206
<div class="refsect2">
 
207
<a name="gweather-timezone-get-dst-offset"></a><h3>gweather_timezone_get_dst_offset ()</h3>
 
208
<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>
 
209
<p>
 
210
Gets <em class="parameter"><code>zone</code></em>'s daylight/summer time offset from UTC, in minutes. Eg,
 
211
a value of 120 would indicate "GMT+2". This is only meaningful if
 
212
<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>.
 
213
</p>
 
214
<div class="variablelist"><table border="0" class="variablelist">
 
215
<colgroup>
 
216
<col align="left" valign="top">
 
217
<col>
 
218
</colgroup>
 
219
<tbody>
 
220
<tr>
 
221
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
 
222
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
 
223
</td>
 
224
</tr>
 
225
<tr>
 
226
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
227
<td>
 
228
<em class="parameter"><code>zone</code></em>'s daylight/summer time offset, in minutes</td>
 
229
</tr>
 
230
</tbody>
 
231
</table></div>
 
232
</div>
 
233
<hr>
 
234
<div class="refsect2">
 
235
<a name="gweather-timezone-ref"></a><h3>gweather_timezone_ref ()</h3>
 
236
<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>
 
237
<p>
 
238
Adds 1 to <em class="parameter"><code>zone</code></em>'s reference count.
 
239
</p>
 
240
<div class="variablelist"><table border="0" class="variablelist">
 
241
<colgroup>
 
242
<col align="left" valign="top">
 
243
<col>
 
244
</colgroup>
 
245
<tbody>
 
246
<tr>
 
247
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
 
248
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
 
249
</td>
 
250
</tr>
 
251
<tr>
 
252
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
253
<td><em class="parameter"><code>zone</code></em></td>
 
254
</tr>
 
255
</tbody>
 
256
</table></div>
 
257
</div>
 
258
<hr>
 
259
<div class="refsect2">
 
260
<a name="gweather-timezone-unref"></a><h3>gweather_timezone_unref ()</h3>
 
261
<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>
 
262
<p>
 
263
Subtracts 1 from <em class="parameter"><code>zone</code></em>'s reference count and frees it if it reaches 0.
 
264
</p>
 
265
<div class="variablelist"><table border="0" class="variablelist">
 
266
<colgroup>
 
267
<col align="left" valign="top">
 
268
<col>
 
269
</colgroup>
 
270
<tbody><tr>
 
271
<td><p><span class="term"><em class="parameter"><code>zone</code></em> :</span></p></td>
 
272
<td>a <a class="link" href="GWeatherTimezone.html" title="GWeatherTimezone"><span class="type">GWeatherTimezone</span></a>
 
273
</td>
 
274
</tr></tbody>
 
275
</table></div>
 
276
</div>
 
277
<hr>
 
278
<div class="refsect2">
 
279
<a name="gweather-timezone-get-utc"></a><h3>gweather_timezone_get_utc ()</h3>
 
280
<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>
 
281
<p>
 
282
Gets the UTC timezone.
 
283
</p>
 
284
<div class="variablelist"><table border="0" class="variablelist">
 
285
<colgroup>
 
286
<col align="left" valign="top">
 
287
<col>
 
288
</colgroup>
 
289
<tbody><tr>
 
290
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
291
<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>
 
292
</tr></tbody>
 
293
</table></div>
 
294
</div>
 
295
</div>
 
296
</div>
 
297
<div class="footer">
 
298
<hr>
 
299
          Generated by GTK-Doc V1.18</div>
 
300
</body>
 
301
</html>
 
 
b'\\ No newline at end of file'