← Back to branch summary

~ubuntu-branches/ubuntu/dapper/evolution-data-server/dapper-updates

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libedata-cal/xml/e-cal-backend-cache.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2006-02-27 22:17:31 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20060227221731-8qmgp0o0d2ooncle
Tags: 1.5.92-0ubuntu1
* New upstream version
* debian/patches/01_weather_calendar_fix.patch:
  - fixed with the new version
* debian/patches/04_external_libdb_autoconf.patch:
  - updated

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libedata-cal/xml/e-cal-backend-cache.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="libedata-cal-ECalBackendCache">
5
5
<refmeta>
6
 
<refentrytitle id="top_of_page">ECalBackendCache</refentrytitle>
 
6
<refentrytitle>ECalBackendCache</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBEDATA-CAL Library</refmiscinfo>
9
9
</refmeta>
10
10
 
11
11
<refnamediv>
12
 
<refname>ECalBackendCache</refname>
13
 
<refpurpose>Cache for calendar backends.</refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
<refname>ECalBackendCache</refname><refpurpose>Cache for calendar backends.</refpurpose>
15
13
</refnamediv>
16
14
 
17
 
<refsynopsisdiv id="synopsis">
18
 
<title id="synopsis.title">Synopsis</title>
 
15
<refsynopsisdiv><title>Synopsis</title>
19
16
 
20
17
<synopsis>
21
18
 
70
67
 
71
68
 
72
69
 
73
 
<refsect1 id="desc">
74
 
<title id="desc.title">Description</title>
 
70
<refsect1>
 
71
<title>Description</title>
75
72
<para>
76
73
 
77
74
</para>
78
75
</refsect1>
79
76
 
80
 
<refsect1 id="details">
81
 
<title id="details.title">Details</title>
 
77
<refsect1>
 
78
<title>Details</title>
82
79
<refsect2>
83
 
<title><anchor id="ECalBackendCachePrivate" role="struct"/>ECalBackendCachePrivate</title>
 
80
<title><anchor id="ECalBackendCachePrivate"/>ECalBackendCachePrivate</title>
84
81
<indexterm><primary>ECalBackendCachePrivate</primary></indexterm><programlisting>typedef struct _ECalBackendCachePrivate ECalBackendCachePrivate;</programlisting>
85
82
<para>
86
83
 
87
84
</para></refsect2>
88
85
<refsect2>
89
 
<title><anchor id="e-cal-backend-cache-new" role="function"/>e_cal_backend_cache_new ()</title>
 
86
<title><anchor id="e-cal-backend-cache-new"/>e_cal_backend_cache_new ()</title>
90
87
<indexterm><primary>e_cal_backend_cache_new</primary></indexterm><programlisting><link linkend="ECalBackendCache">ECalBackendCache</link>* e_cal_backend_cache_new   (const <link linkend="char">char</link> *uri);</programlisting>
91
88
<para>
92
89
Creates a new <link linkend="ECalBackendCache"><type>ECalBackendCache</type></link> object, which implements a cache of
101
98
</simpara></listitem></varlistentry>
102
99
</variablelist></refsect2>
103
100
<refsect2>
104
 
<title><anchor id="e-cal-backend-cache-get-component" role="function"/>e_cal_backend_cache_get_component ()</title>
 
101
<title><anchor id="e-cal-backend-cache-get-component"/>e_cal_backend_cache_get_component ()</title>
105
102
<indexterm><primary>e_cal_backend_cache_get_component</primary></indexterm><programlisting><link linkend="ECalComponent">ECalComponent</link>* e_cal_backend_cache_get_component
106
103
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache,
107
104
                                             const <link linkend="char">char</link> *uid,
126
123
</simpara></listitem></varlistentry>
127
124
</variablelist></refsect2>
128
125
<refsect2>
129
 
<title><anchor id="e-cal-backend-cache-put-component" role="function"/>e_cal_backend_cache_put_component ()</title>
 
126
<title><anchor id="e-cal-backend-cache-put-component"/>e_cal_backend_cache_put_component ()</title>
130
127
<indexterm><primary>e_cal_backend_cache_put_component</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_backend_cache_put_component
131
128
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache,
132
129
                                             <link linkend="ECalComponent">ECalComponent</link> *comp);</programlisting>
147
144
</simpara></listitem></varlistentry>
148
145
</variablelist></refsect2>
149
146
<refsect2>
150
 
<title><anchor id="e-cal-backend-cache-remove-component" role="function"/>e_cal_backend_cache_remove_component ()</title>
 
147
<title><anchor id="e-cal-backend-cache-remove-component"/>e_cal_backend_cache_remove_component ()</title>
151
148
<indexterm><primary>e_cal_backend_cache_remove_component</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_backend_cache_remove_component
152
149
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache,
153
150
                                             const <link linkend="char">char</link> *uid,
171
168
</simpara></listitem></varlistentry>
172
169
</variablelist></refsect2>
173
170
<refsect2>
174
 
<title><anchor id="e-cal-backend-cache-get-components" role="function"/>e_cal_backend_cache_get_components ()</title>
 
171
<title><anchor id="e-cal-backend-cache-get-components"/>e_cal_backend_cache_get_components ()</title>
175
172
<indexterm><primary>e_cal_backend_cache_get_components</primary></indexterm><programlisting><link linkend="GList">GList</link>*      e_cal_backend_cache_get_components
176
173
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache);</programlisting>
177
174
<para>
187
184
</simpara></listitem></varlistentry>
188
185
</variablelist></refsect2>
189
186
<refsect2>
190
 
<title><anchor id="e-cal-backend-cache-get-timezone" role="function"/>e_cal_backend_cache_get_timezone ()</title>
 
187
<title><anchor id="e-cal-backend-cache-get-timezone"/>e_cal_backend_cache_get_timezone ()</title>
191
188
<indexterm><primary>e_cal_backend_cache_get_timezone</primary></indexterm><programlisting>const <link linkend="icaltimezone">icaltimezone</link>* e_cal_backend_cache_get_timezone
192
189
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache,
193
190
                                             const <link linkend="char">char</link> *tzid);</programlisting>
206
203
</simpara></listitem></varlistentry>
207
204
</variablelist></refsect2>
208
205
<refsect2>
209
 
<title><anchor id="e-cal-backend-cache-put-timezone" role="function"/>e_cal_backend_cache_put_timezone ()</title>
 
206
<title><anchor id="e-cal-backend-cache-put-timezone"/>e_cal_backend_cache_put_timezone ()</title>
210
207
<indexterm><primary>e_cal_backend_cache_put_timezone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_backend_cache_put_timezone
211
208
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache,
212
209
                                             const <link linkend="icaltimezone">icaltimezone</link> *zone);</programlisting>
226
223
</simpara></listitem></varlistentry>
227
224
</variablelist></refsect2>
228
225
<refsect2>
229
 
<title><anchor id="e-cal-backend-cache-remove-timezone" role="function"/>e_cal_backend_cache_remove_timezone ()</title>
 
226
<title><anchor id="e-cal-backend-cache-remove-timezone"/>e_cal_backend_cache_remove_timezone ()</title>
230
227
<indexterm><primary>e_cal_backend_cache_remove_timezone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_backend_cache_remove_timezone
231
228
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache,
232
229
                                             const <link linkend="char">char</link> *tzid);</programlisting>
245
242
</simpara></listitem></varlistentry>
246
243
</variablelist></refsect2>
247
244
<refsect2>
248
 
<title><anchor id="e-cal-backend-cache-put-default-timezone" role="function"/>e_cal_backend_cache_put_default_timezone ()</title>
 
245
<title><anchor id="e-cal-backend-cache-put-default-timezone"/>e_cal_backend_cache_put_default_timezone ()</title>
249
246
<indexterm><primary>e_cal_backend_cache_put_default_timezone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_backend_cache_put_default_timezone
250
247
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache,
251
248
                                             <link linkend="icaltimezone">icaltimezone</link> *default_zone);</programlisting>
264
261
</simpara></listitem></varlistentry>
265
262
</variablelist></refsect2>
266
263
<refsect2>
267
 
<title><anchor id="e-cal-backend-cache-get-default-timezone" role="function"/>e_cal_backend_cache_get_default_timezone ()</title>
 
264
<title><anchor id="e-cal-backend-cache-get-default-timezone"/>e_cal_backend_cache_get_default_timezone ()</title>
268
265
<indexterm><primary>e_cal_backend_cache_get_default_timezone</primary></indexterm><programlisting><link linkend="icaltimezone">icaltimezone</link>* e_cal_backend_cache_get_default_timezone
269
266
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache);</programlisting>
270
267
<para>
280
277
</simpara></listitem></varlistentry>
281
278
</variablelist></refsect2>
282
279
<refsect2>
283
 
<title><anchor id="e-cal-backend-cache-get-keys" role="function"/>e_cal_backend_cache_get_keys ()</title>
 
280
<title><anchor id="e-cal-backend-cache-get-keys"/>e_cal_backend_cache_get_keys ()</title>
284
281
<indexterm><primary>e_cal_backend_cache_get_keys</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*     e_cal_backend_cache_get_keys    (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache);</programlisting>
285
282
<para>
286
283
Gets the list of unique keys in the cache file.</para>
295
292
</simpara></listitem></varlistentry>
296
293
</variablelist></refsect2>
297
294
<refsect2>
298
 
<title><anchor id="e-cal-backend-cache-get-marker" role="function"/>e_cal_backend_cache_get_marker ()</title>
 
295
<title><anchor id="e-cal-backend-cache-get-marker"/>e_cal_backend_cache_get_marker ()</title>
299
296
<indexterm><primary>e_cal_backend_cache_get_marker</primary></indexterm><programlisting>const <link linkend="char">char</link>* e_cal_backend_cache_get_marker  (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache);</programlisting>
300
297
<para>
301
298
Gets the marker of the cache. If this field is present, it means the
310
307
</simpara></listitem></varlistentry>
311
308
</variablelist></refsect2>
312
309
<refsect2>
313
 
<title><anchor id="e-cal-backend-cache-set-marker" role="function"/>e_cal_backend_cache_set_marker ()</title>
 
310
<title><anchor id="e-cal-backend-cache-set-marker"/>e_cal_backend_cache_set_marker ()</title>
314
311
<indexterm><primary>e_cal_backend_cache_set_marker</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_backend_cache_set_marker  (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache);</programlisting>
315
312
<para>
316
313
Marks the cache as populated, to discriminate between an empty calendar
323
320
</simpara></listitem></varlistentry>
324
321
</variablelist></refsect2>
325
322
<refsect2>
326
 
<title><anchor id="e-cal-backend-cache-put-server-utc-time" role="function"/>e_cal_backend_cache_put_server_utc_time ()</title>
 
323
<title><anchor id="e-cal-backend-cache-put-server-utc-time"/>e_cal_backend_cache_put_server_utc_time ()</title>
327
324
<indexterm><primary>e_cal_backend_cache_put_server_utc_time</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_backend_cache_put_server_utc_time
328
325
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache,
329
326
                                             const <link linkend="char">char</link> *utc_str);</programlisting>
342
339
</simpara></listitem></varlistentry>
343
340
</variablelist></refsect2>
344
341
<refsect2>
345
 
<title><anchor id="e-cal-backend-cache-get-server-utc-time" role="function"/>e_cal_backend_cache_get_server_utc_time ()</title>
 
342
<title><anchor id="e-cal-backend-cache-get-server-utc-time"/>e_cal_backend_cache_get_server_utc_time ()</title>
346
343
<indexterm><primary>e_cal_backend_cache_get_server_utc_time</primary></indexterm><programlisting>const <link linkend="char">char</link>* e_cal_backend_cache_get_server_utc_time
347
344
                                            (<link linkend="ECalBackendCache">ECalBackendCache</link> *cache);</programlisting>
348
345
<para>