evolution-data-server-doc 3.10.4-0ubuntu1.6 / usr / share / gtk-doc / html / libecal / ETimezoneCache.html

This file is indexed.

/usr/share/gtk-doc/html/libecal/ETimezoneCache.html is in evolution-data-server-doc 3.10.4-0ubuntu1.6.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evolution-Data-Server Manual: Calendar Client (libecal): ETimezoneCache</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
<link rel="prev" href="libecal-e-cal-check-timezones.html" title="e-cal-check-timezones">
<link rel="next" href="ch02.html" title="Deprecated Classes">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#ETimezoneCache.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#ETimezoneCache.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span> 
                  <a href="#ETimezoneCache.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span> 
                  <a href="#ETimezoneCache.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals"> <span class="dim">|</span> 
                  <a href="#ETimezoneCache.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libecal-e-cal-check-timezones.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ETimezoneCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ETimezoneCache.top_of_page"></a>ETimezoneCache</span></h2>
<p>ETimezoneCache — An interface for caching time zone data</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ETimezoneCache.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ETimezoneCache.html#e-timezone-cache-add-timezone" title="e_timezone_cache_add_timezone ()">e_timezone_cache_add_timezone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">icaltimezone</span> *
</td>
<td class="function_name">
<a class="link" href="ETimezoneCache.html#e-timezone-cache-get-timezone" title="e_timezone_cache_get_timezone ()">e_timezone_cache_get_timezone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="ETimezoneCache.html#e-timezone-cache-list-timezones" title="e_timezone_cache_list_timezones ()">e_timezone_cache_list_timezones</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ETimezoneCache.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ETimezoneCache.html#ETimezoneCache-timezone-added" title="The “timezone-added” signal">timezone-added</a></td>
<td class="signal_flags">Run First</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ETimezoneCache.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ETimezoneCache.html#ETimezoneCache-struct" title="ETimezoneCache">ETimezoneCache</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ETimezoneCache.html#ETimezoneCacheInterface" title="struct ETimezoneCacheInterface">ETimezoneCacheInterface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ETimezoneCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GInterface
    <span class="lineart">╰──</span> ETimezoneCache
</pre>
</div>
<div class="refsect1">
<a name="ETimezoneCache.prerequisites"></a><h2>Prerequisites</h2>
<p>
ETimezoneCache requires
 <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="ETimezoneCache.implementations"></a><h2>Known Implementations</h2>
<p>
ETimezoneCache is implemented by
 <a class="link" href="ECalClient.html" title="ECalClient">ECalClient</a>.</p>
</div>
<div class="refsect1">
<a name="ETimezoneCache.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libecal/libecal.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="ETimezoneCache.description"></a><h2>Description</h2>
<p>Several classes (both client-side and server-side) cache <span class="type">icaltimezone</span>
instances internally, indexed by their TZID strings.  Classes which do
this should implement <a class="link" href="ETimezoneCache.html#ETimezoneCacheInterface" title="struct ETimezoneCacheInterface"><span class="type">ETimezoneCacheInterface</span></a> to provide a consistent
API for accessing time zone data.</p>
</div>
<div class="refsect1">
<a name="ETimezoneCache.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-timezone-cache-add-timezone"></a><h3>e_timezone_cache_add_timezone ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_timezone_cache_add_timezone (<em class="parameter"><code><a class="link" href="ETimezoneCache.html" title="ETimezoneCache"><span class="type">ETimezoneCache</span></a> *cache</code></em>,
                               <em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>);</pre>
<p>Adds a copy of <em class="parameter"><code>zone</code></em>
 to <em class="parameter"><code>cache</code></em>
 and emits a
<a class="link" href="ETimezoneCache.html#ETimezoneCache-timezone-added" title="The “timezone-added” signal"><span class="type">“timezone-added”</span></a> signal.  The <em class="parameter"><code>cache</code></em>
 will use the TZID
string returned by <code class="function">icaltimezone_get_tzid()</code> as the lookup key, which can
be passed to <a class="link" href="ETimezoneCache.html#e-timezone-cache-get-timezone" title="e_timezone_cache_get_timezone ()"><code class="function">e_timezone_cache_get_timezone()</code></a> to obtain <em class="parameter"><code>zone</code></em>
 again.</p>
<p>If the <em class="parameter"><code>cache</code></em>
 already has an <span class="type">icaltimezone</span> with the same TZID string
as <em class="parameter"><code>zone</code></em>
, the <em class="parameter"><code>cache</code></em>
 will remain unchanged to avoid invalidating any
<span class="type">icaltimezone</span> pointers which may have already been returned through
<a class="link" href="ETimezoneCache.html#e-timezone-cache-get-timezone" title="e_timezone_cache_get_timezone ()"><code class="function">e_timezone_cache_get_timezone()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.10.11.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="ETimezoneCache.html" title="ETimezoneCache"><span class="type">ETimezoneCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>zone</p></td>
<td class="parameter_description"><p>an <span class="type">icaltimezone</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-timezone-cache-get-timezone"></a><h3>e_timezone_cache_get_timezone ()</h3>
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *
e_timezone_cache_get_timezone (<em class="parameter"><code><a class="link" href="ETimezoneCache.html" title="ETimezoneCache"><span class="type">ETimezoneCache</span></a> *cache</code></em>,
                               <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tzid</code></em>);</pre>
<p>Obtains an <span class="type">icaltimezone</span> by its TZID string.  If no match is found,
the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.  The returned <span class="type">icaltimezone</span> is owned by
the <em class="parameter"><code>cache</code></em>
 and should not be modified or freed.</p>
<div class="refsect3">
<a name="id-1.2.10.11.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="ETimezoneCache.html" title="ETimezoneCache"><span class="type">ETimezoneCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tzid</p></td>
<td class="parameter_description"><p>the TZID of a timezone</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.10.11.3.6"></a><h4>Returns</h4>
<p> an <span class="type">icaltimezone</span>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-timezone-cache-list-timezones"></a><h3>e_timezone_cache_list_timezones ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
e_timezone_cache_list_timezones (<em class="parameter"><code><a class="link" href="ETimezoneCache.html" title="ETimezoneCache"><span class="type">ETimezoneCache</span></a> *cache</code></em>);</pre>
<p>Returns a list of <span class="type">icaltimezone</span> instances that were explicitly added to
the <em class="parameter"><code>cache</code></em>
 through <a class="link" href="ETimezoneCache.html#e-timezone-cache-add-timezone" title="e_timezone_cache_add_timezone ()"><code class="function">e_timezone_cache_add_timezone()</code></a>.  In particular, any
built-in time zone data that <a class="link" href="ETimezoneCache.html#e-timezone-cache-get-timezone" title="e_timezone_cache_get_timezone ()"><code class="function">e_timezone_cache_get_timezone()</code></a> may use to
match a TZID string is excluded from the returned list.</p>
<p>Free the returned list with <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.  The list elements are owned
by the <em class="parameter"><code>cache</code></em>
 and should not be modified or freed.</p>
<div class="refsect3">
<a name="id-1.2.10.11.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="ETimezoneCache.html" title="ETimezoneCache"><span class="type">ETimezoneCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.10.11.4.7"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
<span class="type">icaltimezone</span> instances. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> icaltimezone]</span></p>
</div>
<p class="since">Since 3.8</p>
</div>
</div>
<div class="refsect1">
<a name="ETimezoneCache.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ETimezoneCache-struct"></a><h3>ETimezoneCache</h3>
<pre class="programlisting">typedef struct _ETimezoneCache ETimezoneCache;</pre>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="ETimezoneCacheInterface"></a><h3>struct ETimezoneCacheInterface</h3>
<pre class="programlisting">struct ETimezoneCacheInterface {
	GTypeInterface parent_interface;

	/* Methods */
	void		(*add_timezone)		(ETimezoneCache *cache,
						 icaltimezone *zone);
	icaltimezone * (*get_timezone)		(ETimezoneCache *cache,
						 const gchar *tzid);
	GList *		(*list_timezones) (ETimezoneCache *cache);

	/* Signals */
	void		(*timezone_added) (ETimezoneCache *cache,
						 icaltimezone *zone);
};
</pre>
<p class="since">Since 3.8</p>
</div>
</div>
<div class="refsect1">
<a name="ETimezoneCache.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ETimezoneCache-timezone-added"></a><h3>The <code class="literal">“timezone-added”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ETimezoneCache.html" title="ETimezoneCache"><span class="type">ETimezoneCache</span></a> *cache,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        zone,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)</pre>
<p>Emitted when a new <span class="type">icaltimezone</span> is added to <em class="parameter"><code>cache</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.10.13.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>the <a class="link" href="ETimezoneCache.html" title="ETimezoneCache"><span class="type">ETimezoneCache</span></a> which emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>zone</p></td>
<td class="parameter_description"><p>the newly-added <span class="type">icaltimezone</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.