~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libecal/html/ECal.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ECal</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
9
9
<link rel="prev" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
30
30
                  <a href="#ECal.signals" class="shortcut">Signals</a>
31
31
</td></tr>
32
32
</table>
33
 
<div class="refentry" lang="en">
 
33
<div class="refentry" title="ECal">
34
34
<a name="ECal"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
42
 
<div class="refsynopsisdiv">
 
42
<div class="refsynopsisdiv" title="Synopsis">
43
43
<a name="ECal.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">                    <a class="link" href="ECal.html#ECal-struct" title="ECal">ECal</a>;
45
45
#define             <a class="link" href="ECal.html#E-CAL-SET-MODE-STATUS-ENUM-TYPE:CAPS" title="E_CAL_SET_MODE_STATUS_ENUM_TYPE">E_CAL_SET_MODE_STATUS_ENUM_TYPE</a>
55
55
<span class="returnvalue">GType</span>               <a class="link" href="ECal.html#e-cal-source-type-enum-get-type" title="e_cal_source_type_enum_get_type ()">e_cal_source_type_enum_get_type</a>     (<em class="parameter"><code><span class="type">void</span></code></em>);
56
56
<span class="returnvalue">GType</span>               <a class="link" href="ECal.html#e-cal-set-mode-status-enum-get-type" title="e_cal_set_mode_status_enum_get_type ()">e_cal_set_mode_status_enum_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
57
57
<span class="returnvalue">GType</span>               <a class="link" href="ECal.html#cal-mode-enum-get-type" title="cal_mode_enum_get_type ()">cal_mode_enum_get_type</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
58
 
<a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              <a class="link" href="ECal.html#e-cal-new" title="e_cal_new ()">e_cal_new</a>                           (<em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>,
 
58
<a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              <a class="link" href="ECal.html#e-cal-new" title="e_cal_new ()">e_cal_new</a>                           (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
59
59
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>);
60
60
<a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              <a class="link" href="ECal.html#e-cal-new-from-uri" title="e_cal_new_from_uri ()">e_cal_new_from_uri</a>                  (<em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
61
61
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>);
70
70
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
71
71
<span class="returnvalue">void</span>                <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()">e_cal_open_async</a>                    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
72
72
                                                         <em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>);
 
73
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-refresh" title="e_cal_refresh ()">e_cal_refresh</a>                       (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
 
74
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
73
75
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-remove" title="e_cal_remove ()">e_cal_remove</a>                        (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
74
76
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
75
77
<span class="returnvalue">GList</span> *             <a class="link" href="ECal.html#e-cal-uri-list" title="e_cal_uri_list ()">e_cal_uri_list</a>                      (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
76
78
                                                         <em class="parameter"><code><a class="link" href="libecal-e-cal-util.html#CalMode" title="enum CalMode"><span class="type">CalMode</span></a> mode</code></em>);
77
79
<a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="returnvalue">ECalSourceType</span></a>      <a class="link" href="ECal.html#e-cal-get-source-type" title="e_cal_get_source_type ()">e_cal_get_source_type</a>               (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);
78
80
<a class="link" href="ECal.html#ECalLoadState" title="enum ECalLoadState"><span class="returnvalue">ECalLoadState</span></a>       <a class="link" href="ECal.html#e-cal-get-load-state" title="e_cal_get_load_state ()">e_cal_get_load_state</a>                (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);
79
 
<a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           <a class="link" href="ECal.html#e-cal-get-source" title="e_cal_get_source ()">e_cal_get_source</a>                    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);
 
81
<span class="returnvalue">ESource</span> *           <a class="link" href="ECal.html#e-cal-get-source" title="e_cal_get_source ()">e_cal_get_source</a>                    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);
80
82
const <span class="returnvalue">gchar</span> *       <a class="link" href="ECal.html#e-cal-get-uri" title="e_cal_get_uri ()">e_cal_get_uri</a>                       (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);
81
83
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-is-read-only" title="e_cal_is_read_only ()">e_cal_is_read_only</a>                  (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
82
84
                                                         <em class="parameter"><code><span class="type">gboolean</span> *read_only</code></em>,
96
98
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-get-static-capability" title="e_cal_get_static_capability ()">e_cal_get_static_capability</a>         (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
97
99
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *cap</code></em>);
98
100
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-get-organizer-must-accept" title="e_cal_get_organizer_must_accept ()">e_cal_get_organizer_must_accept</a>     (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);
 
101
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-get-refresh-supported" title="e_cal_get_refresh_supported ()">e_cal_get_refresh_supported</a>         (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);
99
102
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-set-mode" title="e_cal_set_mode ()">e_cal_set_mode</a>                      (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
100
103
                                                         <em class="parameter"><code><a class="link" href="libecal-e-cal-util.html#CalMode" title="enum CalMode"><span class="type">CalMode</span></a> mode</code></em>);
101
104
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-get-default-object" title="e_cal_get_default_object ()">e_cal_get_default_object</a>            (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
204
207
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
205
208
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-set-default" title="e_cal_set_default ()">e_cal_set_default</a>                   (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
206
209
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
207
 
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-set-default-source" title="e_cal_set_default_source ()">e_cal_set_default_source</a>            (<em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>,
 
210
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-set-default-source" title="e_cal_set_default_source ()">e_cal_set_default_source</a>            (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
208
211
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>,
209
212
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
210
 
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-get-sources" title="e_cal_get_sources ()">e_cal_get_sources</a>                   (<em class="parameter"><code><a href="../libedataserver/ESourceList.html"><span class="type">ESourceList</span></a> **sources</code></em>,
 
213
<span class="returnvalue">gboolean</span>            <a class="link" href="ECal.html#e-cal-get-sources" title="e_cal_get_sources ()">e_cal_get_sources</a>                   (<em class="parameter"><code><span class="type">ESourceList</span> **sources</code></em>,
211
214
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>,
212
215
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
213
216
const <span class="returnvalue">gchar</span> *       <a class="link" href="ECal.html#e-cal-get-local-attachment-store" title="e_cal_get_local_attachment_store ()">e_cal_get_local_attachment_store</a>    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);
219
222
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
220
223
</pre>
221
224
</div>
222
 
<div class="refsect1" lang="en">
 
225
<div class="refsect1" title="Object Hierarchy">
223
226
<a name="ECal.object-hierarchy"></a><h2>Object Hierarchy</h2>
224
227
<pre class="synopsis">
225
228
  GObject
226
229
   +----ECal
227
230
</pre>
228
231
</div>
229
 
<div class="refsect1" lang="en">
 
232
<div class="refsect1" title="Signals">
230
233
<a name="ECal.signals"></a><h2>Signals</h2>
231
234
<pre class="synopsis">
232
235
  "<a class="link" href="ECal.html#ECal-backend-died" title='The "backend-died" signal'>backend-died</a>"                                   : Run First
235
238
  "<a class="link" href="ECal.html#ECal-cal-set-mode" title='The "cal-set-mode" signal'>cal-set-mode</a>"                                   : Run First
236
239
</pre>
237
240
</div>
238
 
<div class="refsect1" lang="en">
 
241
<div class="refsect1" title="Description">
239
242
<a name="ECal.description"></a><h2>Description</h2>
240
243
<p>
241
244
Represents an entire calendar or task list, not individual items within them.2
242
245
</p>
243
246
</div>
244
 
<div class="refsect1" lang="en">
 
247
<div class="refsect1" title="Details">
245
248
<a name="ECal.details"></a><h2>Details</h2>
246
 
<div class="refsect2" lang="en">
 
249
<div class="refsect2" title="ECal">
247
250
<a name="ECal-struct"></a><h3>ECal</h3>
248
251
<pre class="programlisting">typedef struct _ECal ECal;</pre>
249
252
<p>
250
253
</p>
251
254
</div>
252
255
<hr>
253
 
<div class="refsect2" lang="en">
 
256
<div class="refsect2" title="E_CAL_SET_MODE_STATUS_ENUM_TYPE">
254
257
<a name="E-CAL-SET-MODE-STATUS-ENUM-TYPE:CAPS"></a><h3>E_CAL_SET_MODE_STATUS_ENUM_TYPE</h3>
255
258
<pre class="programlisting">#define E_CAL_SET_MODE_STATUS_ENUM_TYPE (e_cal_set_mode_status_enum_get_type ())
256
259
</pre>
258
261
</p>
259
262
</div>
260
263
<hr>
261
 
<div class="refsect2" lang="en">
 
264
<div class="refsect2" title="CAL_MODE_ENUM_TYPE">
262
265
<a name="CAL-MODE-ENUM-TYPE:CAPS"></a><h3>CAL_MODE_ENUM_TYPE</h3>
263
266
<pre class="programlisting">#define CAL_MODE_ENUM_TYPE                   (cal_mode_enum_get_type ())
264
267
</pre>
266
269
</p>
267
270
</div>
268
271
<hr>
269
 
<div class="refsect2" lang="en">
 
272
<div class="refsect2" title="enum ECalSourceType">
270
273
<a name="ECalSourceType"></a><h3>enum ECalSourceType</h3>
271
274
<pre class="programlisting">typedef enum {
272
275
        E_CAL_SOURCE_TYPE_EVENT,
279
282
</p>
280
283
</div>
281
284
<hr>
282
 
<div class="refsect2" lang="en">
 
285
<div class="refsect2" title="enum ECalSetModeStatus">
283
286
<a name="ECalSetModeStatus"></a><h3>enum ECalSetModeStatus</h3>
284
287
<pre class="programlisting">typedef enum {
285
288
        E_CAL_SET_MODE_SUCCESS,
291
294
</p>
292
295
</div>
293
296
<hr>
294
 
<div class="refsect2" lang="en">
 
297
<div class="refsect2" title="enum ECalLoadState">
295
298
<a name="ECalLoadState"></a><h3>enum ECalLoadState</h3>
296
299
<pre class="programlisting">typedef enum {
297
300
        E_CAL_LOAD_NOT_LOADED,
304
307
</p>
305
308
</div>
306
309
<hr>
307
 
<div class="refsect2" lang="en">
 
310
<div class="refsect2" title="ECalAuthFunc ()">
308
311
<a name="ECalAuthFunc"></a><h3>ECalAuthFunc ()</h3>
309
312
<pre class="programlisting"><span class="returnvalue">gchar</span> *             (*ECalAuthFunc)                     (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
310
313
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prompt</code></em>,
344
347
</table></div>
345
348
</div>
346
349
<hr>
347
 
<div class="refsect2" lang="en">
 
350
<div class="refsect2" title="e_cal_open_status_enum_get_type ()">
348
351
<a name="e-cal-open-status-enum-get-type"></a><h3>e_cal_open_status_enum_get_type ()</h3>
349
352
<pre class="programlisting"><span class="returnvalue">GType</span>               e_cal_open_status_enum_get_type     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
350
353
<p>
359
362
</table></div>
360
363
</div>
361
364
<hr>
362
 
<div class="refsect2" lang="en">
 
365
<div class="refsect2" title="e_cal_source_type_enum_get_type ()">
363
366
<a name="e-cal-source-type-enum-get-type"></a><h3>e_cal_source_type_enum_get_type ()</h3>
364
367
<pre class="programlisting"><span class="returnvalue">GType</span>               e_cal_source_type_enum_get_type     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
365
368
<p>
366
 
Registers the <span class="type">ECalSourceTypeEnum</span> type with glib.</p>
 
369
Registers the <span class="type">ECalSourceTypeEnum</span> type with glib.
 
370
</p>
367
371
<div class="variablelist"><table border="0">
368
372
<col align="left" valign="top">
369
373
<tbody><tr>
374
378
</table></div>
375
379
</div>
376
380
<hr>
377
 
<div class="refsect2" lang="en">
 
381
<div class="refsect2" title="e_cal_set_mode_status_enum_get_type ()">
378
382
<a name="e-cal-set-mode-status-enum-get-type"></a><h3>e_cal_set_mode_status_enum_get_type ()</h3>
379
383
<pre class="programlisting"><span class="returnvalue">GType</span>               e_cal_set_mode_status_enum_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
380
384
<p>
381
 
Registers the <span class="type">ECalSetModeStatusEnum</span> type with glib.</p>
 
385
Registers the <span class="type">ECalSetModeStatusEnum</span> type with glib.
 
386
</p>
382
387
<div class="variablelist"><table border="0">
383
388
<col align="left" valign="top">
384
389
<tbody><tr>
389
394
</table></div>
390
395
</div>
391
396
<hr>
392
 
<div class="refsect2" lang="en">
 
397
<div class="refsect2" title="cal_mode_enum_get_type ()">
393
398
<a name="cal-mode-enum-get-type"></a><h3>cal_mode_enum_get_type ()</h3>
394
399
<pre class="programlisting"><span class="returnvalue">GType</span>               cal_mode_enum_get_type              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
395
400
<p>
396
 
Registers the <span class="type">CalModeEnum</span> type with glib.</p>
 
401
Registers the <span class="type">CalModeEnum</span> type with glib.
 
402
</p>
397
403
<div class="variablelist"><table border="0">
398
404
<col align="left" valign="top">
399
405
<tbody><tr>
404
410
</table></div>
405
411
</div>
406
412
<hr>
407
 
<div class="refsect2" lang="en">
 
413
<div class="refsect2" title="e_cal_new ()">
408
414
<a name="e-cal-new"></a><h3>e_cal_new ()</h3>
409
 
<pre class="programlisting"><a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              e_cal_new                           (<em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>,
 
415
<pre class="programlisting"><a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              e_cal_new                           (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
410
416
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>);</pre>
411
417
<p>
412
418
Creates a new calendar client. This does not open the calendar itself,
413
 
for that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.</p>
 
419
for that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.
 
420
</p>
414
421
<div class="variablelist"><table border="0">
415
422
<col align="left" valign="top">
416
423
<tbody>
417
424
<tr>
418
425
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
419
 
<td>An <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> to be used for the client.
 
426
<td>An <span class="type">ESource</span> to be used for the client.
420
427
</td>
421
428
</tr>
422
429
<tr>
434
441
</table></div>
435
442
</div>
436
443
<hr>
437
 
<div class="refsect2" lang="en">
 
444
<div class="refsect2" title="e_cal_new_from_uri ()">
438
445
<a name="e-cal-new-from-uri"></a><h3>e_cal_new_from_uri ()</h3>
439
446
<pre class="programlisting"><a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              e_cal_new_from_uri                  (<em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
440
447
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>);</pre>
441
448
<p>
442
449
Creates a new calendar client. This does not open the calendar itself,
443
 
for that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.</p>
 
450
for that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.
 
451
</p>
444
452
<div class="variablelist"><table border="0">
445
453
<col align="left" valign="top">
446
454
<tbody>
464
472
</table></div>
465
473
</div>
466
474
<hr>
467
 
<div class="refsect2" lang="en">
 
475
<div class="refsect2" title="e_cal_new_system_calendar ()">
468
476
<a name="e-cal-new-system-calendar"></a><h3>e_cal_new_system_calendar ()</h3>
469
477
<pre class="programlisting"><a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              e_cal_new_system_calendar           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
470
478
<p>
471
479
Create a calendar client for the system calendar, which should always be present in
472
480
all Evolution installations. This does not open the calendar itself,
473
 
for that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.</p>
 
481
for that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.
 
482
</p>
474
483
<div class="variablelist"><table border="0">
475
484
<col align="left" valign="top">
476
485
<tbody><tr>
482
491
</table></div>
483
492
</div>
484
493
<hr>
485
 
<div class="refsect2" lang="en">
 
494
<div class="refsect2" title="e_cal_new_system_tasks ()">
486
495
<a name="e-cal-new-system-tasks"></a><h3>e_cal_new_system_tasks ()</h3>
487
496
<pre class="programlisting"><a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              e_cal_new_system_tasks              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
488
497
<p>
489
498
Create a calendar client for the system task list, which should always be present in
490
499
all Evolution installations. This does not open the tasks list itself,
491
 
for that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.</p>
 
500
for that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.
 
501
</p>
492
502
<div class="variablelist"><table border="0">
493
503
<col align="left" valign="top">
494
504
<tbody><tr>
500
510
</table></div>
501
511
</div>
502
512
<hr>
503
 
<div class="refsect2" lang="en">
 
513
<div class="refsect2" title="e_cal_new_system_memos ()">
504
514
<a name="e-cal-new-system-memos"></a><h3>e_cal_new_system_memos ()</h3>
505
515
<pre class="programlisting"><a class="link" href="ECal.html" title="ECal"><span class="returnvalue">ECal</span></a> *              e_cal_new_system_memos              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
506
516
<p>
507
517
Create a calendar client for the system memos, which should always be present
508
518
in all Evolution installations. This does not open the memos itself, for
509
 
that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.</p>
 
519
that, <a class="link" href="ECal.html#e-cal-open" title="e_cal_open ()"><span class="type">e_cal_open</span></a> or <a class="link" href="ECal.html#e-cal-open-async" title="e_cal_open_async ()"><span class="type">e_cal_open_async</span></a> needs to be called.
 
520
</p>
510
521
<div class="variablelist"><table border="0">
511
522
<col align="left" valign="top">
512
523
<tbody><tr>
518
529
</table></div>
519
530
</div>
520
531
<hr>
521
 
<div class="refsect2" lang="en">
 
532
<div class="refsect2" title="e_cal_set_auth_func ()">
522
533
<a name="e-cal-set-auth-func"></a><h3>e_cal_set_auth_func ()</h3>
523
534
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_set_auth_func                 (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
524
535
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalAuthFunc" title="ECalAuthFunc ()"><span class="type">ECalAuthFunc</span></a> func</code></em>,
544
555
gchar * auth_func (ECal *ecal,
545
556
                  const gchar *prompt,
546
557
                  const gchar *key,
547
 
                  gpointer user_data)</p>
 
558
                  gpointer user_data)
 
559
</p>
548
560
<div class="variablelist"><table border="0">
549
561
<col align="left" valign="top">
550
562
<tbody>
567
579
</table></div>
568
580
</div>
569
581
<hr>
570
 
<div class="refsect2" lang="en">
 
582
<div class="refsect2" title="e_cal_open ()">
571
583
<a name="e-cal-open"></a><h3>e_cal_open ()</h3>
572
584
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_open                          (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
573
585
                                                         <em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>,
575
587
<p>
576
588
Makes a calendar client initiate a request to open a calendar.  The calendar
577
589
client will emit the "cal_opened" signal when the response from the server is
578
 
received.</p>
 
590
received.
 
591
</p>
579
592
<div class="variablelist"><table border="0">
580
593
<col align="left" valign="top">
581
594
<tbody>
606
619
</table></div>
607
620
</div>
608
621
<hr>
609
 
<div class="refsect2" lang="en">
 
622
<div class="refsect2" title="e_cal_open_async ()">
610
623
<a name="e-cal-open-async"></a><h3>e_cal_open_async ()</h3>
611
624
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_open_async                    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
612
625
                                                         <em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>);</pre>
617
630
<p>
618
631
Because this operation runs in another thread, any authentication
619
632
callback set on the calendar will be called from this other thread.
620
 
See #<a class="link" href="ECal.html#e-cal-set-auth-func" title="e_cal_set_auth_func ()"><code class="function">e_cal_set_auth_func()</code></a> for details.</p>
 
633
See #<a class="link" href="ECal.html#e-cal-set-auth-func" title="e_cal_set_auth_func ()"><code class="function">e_cal_set_auth_func()</code></a> for details.
 
634
</p>
621
635
<div class="variablelist"><table border="0">
622
636
<col align="left" valign="top">
623
637
<tbody>
637
651
</table></div>
638
652
</div>
639
653
<hr>
640
 
<div class="refsect2" lang="en">
 
654
<div class="refsect2" title="e_cal_refresh ()">
 
655
<a name="e-cal-refresh"></a><h3>e_cal_refresh ()</h3>
 
656
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_refresh                       (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
 
657
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
658
<p>
 
659
Invokes refresh on a calendar. See <em class="parameter"><code>e_cal_get_refresh_supported</code></em>.
 
660
</p>
 
661
<div class="variablelist"><table border="0">
 
662
<col align="left" valign="top">
 
663
<tbody>
 
664
<tr>
 
665
<td><p><span class="term"><em class="parameter"><code>ecal</code></em> :</span></p></td>
 
666
<td>A calendar client.
 
667
</td>
 
668
</tr>
 
669
<tr>
 
670
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
671
<td>Placeholder for error information.
 
672
</td>
 
673
</tr>
 
674
<tr>
 
675
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
676
<td> TRUE if calendar supports refresh and it was invoked, FALSE otherwise.
 
677
 
 
678
</td>
 
679
</tr>
 
680
</tbody>
 
681
</table></div>
 
682
<p class="since">Since 2.30</p>
 
683
</div>
 
684
<hr>
 
685
<div class="refsect2" title="e_cal_remove ()">
641
686
<a name="e-cal-remove"></a><h3>e_cal_remove ()</h3>
642
687
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_remove                        (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
643
688
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
644
689
<p>
645
 
Removes a calendar.</p>
 
690
Removes a calendar.
 
691
</p>
646
692
<div class="variablelist"><table border="0">
647
693
<col align="left" valign="top">
648
694
<tbody>
665
711
</table></div>
666
712
</div>
667
713
<hr>
668
 
<div class="refsect2" lang="en">
 
714
<div class="refsect2" title="e_cal_uri_list ()">
669
715
<a name="e-cal-uri-list"></a><h3>e_cal_uri_list ()</h3>
670
716
<pre class="programlisting"><span class="returnvalue">GList</span> *             e_cal_uri_list                      (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
671
717
                                                         <em class="parameter"><code><a class="link" href="libecal-e-cal-util.html#CalMode" title="enum CalMode"><span class="type">CalMode</span></a> mode</code></em>);</pre>
672
718
<p>
673
 
Retrieves a list of all calendar clients for the given mode.</p>
 
719
Retrieves a list of all calendar clients for the given mode.
 
720
</p>
674
721
<div class="variablelist"><table border="0">
675
722
<col align="left" valign="top">
676
723
<tbody>
693
740
</table></div>
694
741
</div>
695
742
<hr>
696
 
<div class="refsect2" lang="en">
 
743
<div class="refsect2" title="e_cal_get_source_type ()">
697
744
<a name="e-cal-get-source-type"></a><h3>e_cal_get_source_type ()</h3>
698
745
<pre class="programlisting"><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="returnvalue">ECalSourceType</span></a>      e_cal_get_source_type               (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
699
746
<p>
700
 
Gets the type of the calendar client.</p>
 
747
Gets the type of the calendar client.
 
748
</p>
701
749
<div class="variablelist"><table border="0">
702
750
<col align="left" valign="top">
703
751
<tbody>
716
764
</table></div>
717
765
</div>
718
766
<hr>
719
 
<div class="refsect2" lang="en">
 
767
<div class="refsect2" title="e_cal_get_load_state ()">
720
768
<a name="e-cal-get-load-state"></a><h3>e_cal_get_load_state ()</h3>
721
769
<pre class="programlisting"><a class="link" href="ECal.html#ECalLoadState" title="enum ECalLoadState"><span class="returnvalue">ECalLoadState</span></a>       e_cal_get_load_state                (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
722
770
<p>
723
 
Queries the state of loading of a calendar client.</p>
 
771
Queries the state of loading of a calendar client.
 
772
</p>
724
773
<div class="variablelist"><table border="0">
725
774
<col align="left" valign="top">
726
775
<tbody>
740
789
</table></div>
741
790
</div>
742
791
<hr>
743
 
<div class="refsect2" lang="en">
 
792
<div class="refsect2" title="e_cal_get_source ()">
744
793
<a name="e-cal-get-source"></a><h3>e_cal_get_source ()</h3>
745
 
<pre class="programlisting"><a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           e_cal_get_source                    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
 
794
<pre class="programlisting"><span class="returnvalue">ESource</span> *           e_cal_get_source                    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
746
795
<p>
747
 
Queries the source that is open in a calendar client.</p>
 
796
Queries the source that is open in a calendar client.
 
797
</p>
748
798
<div class="variablelist"><table border="0">
749
799
<col align="left" valign="top">
750
800
<tbody>
763
813
</table></div>
764
814
</div>
765
815
<hr>
766
 
<div class="refsect2" lang="en">
 
816
<div class="refsect2" title="e_cal_get_uri ()">
767
817
<a name="e-cal-get-uri"></a><h3>e_cal_get_uri ()</h3>
768
818
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_cal_get_uri                       (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
769
819
<p>
770
 
Queries the URI that is open in a calendar client.</p>
 
820
Queries the URI that is open in a calendar client.
 
821
</p>
771
822
<div class="variablelist"><table border="0">
772
823
<col align="left" valign="top">
773
824
<tbody>
786
837
</table></div>
787
838
</div>
788
839
<hr>
789
 
<div class="refsect2" lang="en">
 
840
<div class="refsect2" title="e_cal_is_read_only ()">
790
841
<a name="e-cal-is-read-only"></a><h3>e_cal_is_read_only ()</h3>
791
842
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_is_read_only                  (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
792
843
                                                         <em class="parameter"><code><span class="type">gboolean</span> *read_only</code></em>,
794
845
<p>
795
846
Queries whether the calendar client can perform modifications
796
847
on the calendar or not. Whether the backend is read only or not
797
 
is specified, on exit, in the <em class="parameter"><code>read_only</code></em> argument.</p>
 
848
is specified, on exit, in the <em class="parameter"><code>read_only</code></em> argument.
 
849
</p>
798
850
<div class="variablelist"><table border="0">
799
851
<col align="left" valign="top">
800
852
<tbody>
822
874
</table></div>
823
875
</div>
824
876
<hr>
825
 
<div class="refsect2" lang="en">
 
877
<div class="refsect2" title="e_cal_get_cal_address ()">
826
878
<a name="e-cal-get-cal-address"></a><h3>e_cal_get_cal_address ()</h3>
827
879
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_cal_address               (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
828
880
                                                         <em class="parameter"><code><span class="type">gchar</span> **cal_address</code></em>,
829
881
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
830
882
<p>
831
 
Queries the calendar address associated with a calendar client.</p>
 
883
Queries the calendar address associated with a calendar client.
 
884
</p>
832
885
<div class="variablelist"><table border="0">
833
886
<col align="left" valign="top">
834
887
<tbody>
857
910
</table></div>
858
911
</div>
859
912
<hr>
860
 
<div class="refsect2" lang="en">
 
913
<div class="refsect2" title="e_cal_get_alarm_email_address ()">
861
914
<a name="e-cal-get-alarm-email-address"></a><h3>e_cal_get_alarm_email_address ()</h3>
862
915
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_alarm_email_address       (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
863
916
                                                         <em class="parameter"><code><span class="type">gchar</span> **alarm_address</code></em>,
864
917
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
865
918
<p>
866
 
Queries the address to be used for alarms in a calendar client.</p>
 
919
Queries the address to be used for alarms in a calendar client.
 
920
</p>
867
921
<div class="variablelist"><table border="0">
868
922
<col align="left" valign="top">
869
923
<tbody>
892
946
</table></div>
893
947
</div>
894
948
<hr>
895
 
<div class="refsect2" lang="en">
 
949
<div class="refsect2" title="e_cal_get_ldap_attribute ()">
896
950
<a name="e-cal-get-ldap-attribute"></a><h3>e_cal_get_ldap_attribute ()</h3>
897
951
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_ldap_attribute            (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
898
952
                                                         <em class="parameter"><code><span class="type">gchar</span> **ldap_attribute</code></em>,
899
953
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
900
954
<p>
901
 
Queries the LDAP attribute for a calendar client.</p>
 
955
Queries the LDAP attribute for a calendar client.
 
956
</p>
902
957
<div class="variablelist"><table border="0">
903
958
<col align="left" valign="top">
904
959
<tbody>
927
982
</table></div>
928
983
</div>
929
984
<hr>
930
 
<div class="refsect2" lang="en">
 
985
<div class="refsect2" title="e_cal_get_one_alarm_only ()">
931
986
<a name="e-cal-get-one-alarm-only"></a><h3>e_cal_get_one_alarm_only ()</h3>
932
987
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_one_alarm_only            (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
933
988
<p>
934
 
Checks if a calendar supports only one alarm per component.</p>
 
989
Checks if a calendar supports only one alarm per component.
 
990
</p>
935
991
<div class="variablelist"><table border="0">
936
992
<col align="left" valign="top">
937
993
<tbody>
949
1005
</table></div>
950
1006
</div>
951
1007
<hr>
952
 
<div class="refsect2" lang="en">
 
1008
<div class="refsect2" title="e_cal_get_organizer_must_attend ()">
953
1009
<a name="e-cal-get-organizer-must-attend"></a><h3>e_cal_get_organizer_must_attend ()</h3>
954
1010
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_organizer_must_attend     (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
955
1011
<p>
956
 
Checks if a calendar forces organizers of meetings to be also attendees.</p>
 
1012
Checks if a calendar forces organizers of meetings to be also attendees.
 
1013
</p>
957
1014
<div class="variablelist"><table border="0">
958
1015
<col align="left" valign="top">
959
1016
<tbody>
972
1029
</table></div>
973
1030
</div>
974
1031
<hr>
975
 
<div class="refsect2" lang="en">
 
1032
<div class="refsect2" title="e_cal_get_save_schedules ()">
976
1033
<a name="e-cal-get-save-schedules"></a><h3>e_cal_get_save_schedules ()</h3>
977
1034
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_save_schedules            (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
978
1035
<p>
979
 
Checks whether the calendar saves schedules.</p>
 
1036
Checks whether the calendar saves schedules.
 
1037
</p>
980
1038
<div class="variablelist"><table border="0">
981
1039
<col align="left" valign="top">
982
1040
<tbody>
994
1052
</table></div>
995
1053
</div>
996
1054
<hr>
997
 
<div class="refsect2" lang="en">
 
1055
<div class="refsect2" title="e_cal_get_static_capability ()">
998
1056
<a name="e-cal-get-static-capability"></a><h3>e_cal_get_static_capability ()</h3>
999
1057
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_static_capability         (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1000
1058
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *cap</code></em>);</pre>
1001
1059
<p>
1002
 
Queries the calendar for static capabilities.</p>
 
1060
Queries the calendar for static capabilities.
 
1061
</p>
1003
1062
<div class="variablelist"><table border="0">
1004
1063
<col align="left" valign="top">
1005
1064
<tbody>
1022
1081
</table></div>
1023
1082
</div>
1024
1083
<hr>
1025
 
<div class="refsect2" lang="en">
 
1084
<div class="refsect2" title="e_cal_get_organizer_must_accept ()">
1026
1085
<a name="e-cal-get-organizer-must-accept"></a><h3>e_cal_get_organizer_must_accept ()</h3>
1027
1086
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_organizer_must_accept     (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
1028
1087
<p>
1029
1088
Checks whether a calendar requires organizer to accept their attendance to
1030
 
meetings.</p>
 
1089
meetings.
 
1090
</p>
1031
1091
<div class="variablelist"><table border="0">
1032
1092
<col align="left" valign="top">
1033
1093
<tbody>
1046
1106
</table></div>
1047
1107
</div>
1048
1108
<hr>
1049
 
<div class="refsect2" lang="en">
 
1109
<div class="refsect2" title="e_cal_get_refresh_supported ()">
 
1110
<a name="e-cal-get-refresh-supported"></a><h3>e_cal_get_refresh_supported ()</h3>
 
1111
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_refresh_supported         (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
 
1112
<p>
 
1113
Checks whether a calendar supports explicit refreshing (see <em class="parameter"><code>e_cal_refresh</code></em>).
 
1114
</p>
 
1115
<div class="variablelist"><table border="0">
 
1116
<col align="left" valign="top">
 
1117
<tbody>
 
1118
<tr>
 
1119
<td><p><span class="term"><em class="parameter"><code>ecal</code></em> :</span></p></td>
 
1120
<td>A calendar client.
 
1121
</td>
 
1122
</tr>
 
1123
<tr>
 
1124
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1125
<td> TRUE if the calendar supports refreshing, FALSE otherwise.
 
1126
 
 
1127
</td>
 
1128
</tr>
 
1129
</tbody>
 
1130
</table></div>
 
1131
<p class="since">Since 2.30</p>
 
1132
</div>
 
1133
<hr>
 
1134
<div class="refsect2" title="e_cal_set_mode ()">
1050
1135
<a name="e-cal-set-mode"></a><h3>e_cal_set_mode ()</h3>
1051
1136
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_set_mode                      (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1052
1137
                                                         <em class="parameter"><code><a class="link" href="libecal-e-cal-util.html#CalMode" title="enum CalMode"><span class="type">CalMode</span></a> mode</code></em>);</pre>
1053
1138
<p>
1054
 
Switches online/offline mode on the calendar.</p>
 
1139
Switches online/offline mode on the calendar.
 
1140
</p>
1055
1141
<div class="variablelist"><table border="0">
1056
1142
<col align="left" valign="top">
1057
1143
<tbody>
1074
1160
</table></div>
1075
1161
</div>
1076
1162
<hr>
1077
 
<div class="refsect2" lang="en">
 
1163
<div class="refsect2" title="e_cal_get_default_object ()">
1078
1164
<a name="e-cal-get-default-object"></a><h3>e_cal_get_default_object ()</h3>
1079
1165
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_default_object            (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1080
1166
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> **icalcomp</code></em>,
1081
1167
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1082
1168
<p>
1083
1169
Retrives an <span class="type">icalcomponent</span> from the backend that contains the default
1084
 
values for properties needed.</p>
 
1170
values for properties needed.
 
1171
</p>
1085
1172
<div class="variablelist"><table border="0">
1086
1173
<col align="left" valign="top">
1087
1174
<tbody>
1109
1196
</table></div>
1110
1197
</div>
1111
1198
<hr>
1112
 
<div class="refsect2" lang="en">
 
1199
<div class="refsect2" title="e_cal_get_object ()">
1113
1200
<a name="e-cal-get-object"></a><h3>e_cal_get_object ()</h3>
1114
1201
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_object                    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1115
1202
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
1118
1205
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1119
1206
<p>
1120
1207
Queries a calendar for a calendar component object based on its unique
1121
 
identifier.</p>
 
1208
identifier.
 
1209
</p>
1122
1210
<div class="variablelist"><table border="0">
1123
1211
<col align="left" valign="top">
1124
1212
<tbody>
1156
1244
</table></div>
1157
1245
</div>
1158
1246
<hr>
1159
 
<div class="refsect2" lang="en">
 
1247
<div class="refsect2" title="e_cal_get_objects_for_uid ()">
1160
1248
<a name="e-cal-get-objects-for-uid"></a><h3>e_cal_get_objects_for_uid ()</h3>
1161
1249
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_objects_for_uid           (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1162
1250
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
1165
1253
<p>
1166
1254
Queries a calendar for all calendar components with the given unique
1167
1255
ID. This will return any recurring event and all its detached recurrences.
1168
 
For non-recurring events, it will just return the object with that ID.</p>
 
1256
For non-recurring events, it will just return the object with that ID.
 
1257
</p>
1169
1258
<div class="variablelist"><table border="0">
1170
1259
<col align="left" valign="top">
1171
1260
<tbody>
1198
1287
</table></div>
1199
1288
</div>
1200
1289
<hr>
1201
 
<div class="refsect2" lang="en">
 
1290
<div class="refsect2" title="e_cal_get_changes ()">
1202
1291
<a name="e-cal-get-changes"></a><h3>e_cal_get_changes ()</h3>
1203
1292
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_changes                   (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1204
1293
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *change_id</code></em>,
1207
1296
<p>
1208
1297
Returns a list of changes made to the calendar since a specific time. That time
1209
1298
is identified by the <em class="parameter"><code>change_id</code></em> argument, which is used by the backend to
1210
 
compute the changes done.</p>
 
1299
compute the changes done.
 
1300
</p>
1211
1301
<div class="variablelist"><table border="0">
1212
1302
<col align="left" valign="top">
1213
1303
<tbody>
1240
1330
</table></div>
1241
1331
</div>
1242
1332
<hr>
1243
 
<div class="refsect2" lang="en">
 
1333
<div class="refsect2" title="e_cal_free_change_list ()">
1244
1334
<a name="e-cal-free-change-list"></a><h3>e_cal_free_change_list ()</h3>
1245
1335
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_free_change_list              (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre>
1246
1336
<p>
1247
 
Free a list of changes as returned by <a class="link" href="ECal.html#e-cal-get-changes" title="e_cal_get_changes ()"><span class="type">e_cal_get_changes</span></a>.</p>
 
1337
Free a list of changes as returned by <a class="link" href="ECal.html#e-cal-get-changes" title="e_cal_get_changes ()"><span class="type">e_cal_get_changes</span></a>.
 
1338
</p>
1248
1339
<div class="variablelist"><table border="0">
1249
1340
<col align="left" valign="top">
1250
1341
<tbody><tr>
1255
1346
</table></div>
1256
1347
</div>
1257
1348
<hr>
1258
 
<div class="refsect2" lang="en">
 
1349
<div class="refsect2" title="e_cal_get_object_list ()">
1259
1350
<a name="e-cal-get-object-list"></a><h3>e_cal_get_object_list ()</h3>
1260
1351
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_object_list               (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1261
1352
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>,
1265
1356
Gets a list of objects from the calendar that match the query specified
1266
1357
by the <em class="parameter"><code>query</code></em> argument. The objects will be returned in the <em class="parameter"><code>objects</code></em>
1267
1358
argument, which is a list of <span class="type">icalcomponent</span>. When done, this list
1268
 
should be freed by using the <a class="link" href="ECal.html#e-cal-free-object-list" title="e_cal_free_object_list ()"><span class="type">e_cal_free_object_list</span></a> function.</p>
 
1359
should be freed by using the <a class="link" href="ECal.html#e-cal-free-object-list" title="e_cal_free_object_list ()"><span class="type">e_cal_free_object_list</span></a> function.
 
1360
</p>
1269
1361
<div class="variablelist"><table border="0">
1270
1362
<col align="left" valign="top">
1271
1363
<tbody>
1298
1390
</table></div>
1299
1391
</div>
1300
1392
<hr>
1301
 
<div class="refsect2" lang="en">
 
1393
<div class="refsect2" title="e_cal_get_object_list_as_comp ()">
1302
1394
<a name="e-cal-get-object-list-as-comp"></a><h3>e_cal_get_object_list_as_comp ()</h3>
1303
1395
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_object_list_as_comp       (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1304
1396
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *query</code></em>,
1307
1399
<p>
1308
1400
Gets a list of objects from the calendar that match the query specified
1309
1401
by the <em class="parameter"><code>query</code></em> argument. The objects will be returned in the <em class="parameter"><code>objects</code></em>
1310
 
argument, which is a list of <a class="link" href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a>.</p>
 
1402
argument, which is a list of <a class="link" href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a>.
 
1403
</p>
1311
1404
<div class="variablelist"><table border="0">
1312
1405
<col align="left" valign="top">
1313
1406
<tbody>
1340
1433
</table></div>
1341
1434
</div>
1342
1435
<hr>
1343
 
<div class="refsect2" lang="en">
 
1436
<div class="refsect2" title="e_cal_free_object_list ()">
1344
1437
<a name="e-cal-free-object-list"></a><h3>e_cal_free_object_list ()</h3>
1345
1438
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_free_object_list              (<em class="parameter"><code><span class="type">GList</span> *objects</code></em>);</pre>
1346
1439
<p>
1347
 
Frees a list of objects as returned by <a class="link" href="ECal.html#e-cal-get-object-list" title="e_cal_get_object_list ()"><span class="type">e_cal_get_object_list</span></a>.</p>
 
1440
Frees a list of objects as returned by <a class="link" href="ECal.html#e-cal-get-object-list" title="e_cal_get_object_list ()"><span class="type">e_cal_get_object_list</span></a>.
 
1441
</p>
1348
1442
<div class="variablelist"><table border="0">
1349
1443
<col align="left" valign="top">
1350
1444
<tbody><tr>
1355
1449
</table></div>
1356
1450
</div>
1357
1451
<hr>
1358
 
<div class="refsect2" lang="en">
 
1452
<div class="refsect2" title="e_cal_get_free_busy ()">
1359
1453
<a name="e-cal-get-free-busy"></a><h3>e_cal_get_free_busy ()</h3>
1360
1454
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_free_busy                 (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1361
1455
                                                         <em class="parameter"><code><span class="type">GList</span> *users</code></em>,
1364
1458
                                                         <em class="parameter"><code><span class="type">GList</span> **freebusy</code></em>,
1365
1459
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1366
1460
<p>
1367
 
Gets free/busy information from the calendar server.</p>
 
1461
Gets free/busy information from the calendar server.
 
1462
</p>
1368
1463
<div class="variablelist"><table border="0">
1369
1464
<col align="left" valign="top">
1370
1465
<tbody>
1407
1502
</table></div>
1408
1503
</div>
1409
1504
<hr>
1410
 
<div class="refsect2" lang="en">
 
1505
<div class="refsect2" title="e_cal_generate_instances ()">
1411
1506
<a name="e-cal-generate-instances"></a><h3>e_cal_generate_instances ()</h3>
1412
1507
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_generate_instances            (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1413
1508
                                                         <em class="parameter"><code><span class="type">time_t</span> start</code></em>,
1421
1516
<p>
1422
1517
The callback function should do a <code class="function">g_object_ref()</code> of the calendar component
1423
1518
it gets passed if it intends to keep it around, since it will be unref'ed
1424
 
as soon as the callback returns.</p>
 
1519
as soon as the callback returns.
 
1520
</p>
1425
1521
<div class="variablelist"><table border="0">
1426
1522
<col align="left" valign="top">
1427
1523
<tbody>
1454
1550
</table></div>
1455
1551
</div>
1456
1552
<hr>
1457
 
<div class="refsect2" lang="en">
 
1553
<div class="refsect2" title="e_cal_generate_instances_for_object ()">
1458
1554
<a name="e-cal-generate-instances-for-object"></a><h3>e_cal_generate_instances_for_object ()</h3>
1459
1555
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_generate_instances_for_object (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1460
1556
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
1470
1566
<p>
1471
1567
The callback function should do a <code class="function">g_object_ref()</code> of the calendar component
1472
1568
it gets passed if it intends to keep it around, since it will be unref'ed
1473
 
as soon as the callback returns.</p>
 
1569
as soon as the callback returns.
 
1570
</p>
1474
1571
<div class="variablelist"><table border="0">
1475
1572
<col align="left" valign="top">
1476
1573
<tbody>
1508
1605
</table></div>
1509
1606
</div>
1510
1607
<hr>
1511
 
<div class="refsect2" lang="en">
 
1608
<div class="refsect2" title="e_cal_get_alarms_in_range ()">
1512
1609
<a name="e-cal-get-alarms-in-range"></a><h3>e_cal_get_alarms_in_range ()</h3>
1513
1610
<pre class="programlisting"><span class="returnvalue">GSList</span> *            e_cal_get_alarms_in_range           (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1514
1611
                                                         <em class="parameter"><code><span class="type">time_t</span> start</code></em>,
1515
1612
                                                         <em class="parameter"><code><span class="type">time_t</span> end</code></em>);</pre>
1516
1613
<p>
1517
1614
Queries a calendar for the alarms that trigger in the specified range of
1518
 
time.</p>
 
1615
time.
 
1616
</p>
1519
1617
<div class="variablelist"><table border="0">
1520
1618
<col align="left" valign="top">
1521
1619
<tbody>
1546
1644
</table></div>
1547
1645
</div>
1548
1646
<hr>
1549
 
<div class="refsect2" lang="en">
 
1647
<div class="refsect2" title="e_cal_free_alarms ()">
1550
1648
<a name="e-cal-free-alarms"></a><h3>e_cal_free_alarms ()</h3>
1551
1649
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_free_alarms                   (<em class="parameter"><code><span class="type">GSList</span> *comp_alarms</code></em>);</pre>
1552
1650
<p>
1553
1651
Frees a list of <a class="link" href="ECalComponent.html#ECalComponentAlarms" title="ECalComponentAlarms"><span class="type">ECalComponentAlarms</span></a> structures as returned by
1554
 
<a class="link" href="ECal.html#e-cal-get-alarms-in-range" title="e_cal_get_alarms_in_range ()"><code class="function">e_cal_get_alarms_in_range()</code></a>.</p>
 
1652
<a class="link" href="ECal.html#e-cal-get-alarms-in-range" title="e_cal_get_alarms_in_range ()"><code class="function">e_cal_get_alarms_in_range()</code></a>.
 
1653
</p>
1555
1654
<div class="variablelist"><table border="0">
1556
1655
<col align="left" valign="top">
1557
1656
<tbody><tr>
1562
1661
</table></div>
1563
1662
</div>
1564
1663
<hr>
1565
 
<div class="refsect2" lang="en">
 
1664
<div class="refsect2" title="e_cal_get_alarms_for_object ()">
1566
1665
<a name="e-cal-get-alarms-for-object"></a><h3>e_cal_get_alarms_for_object ()</h3>
1567
1666
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_alarms_for_object         (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1568
1667
                                                         <em class="parameter"><code>const <a class="link" href="ECalComponent.html#ECalComponentId" title="ECalComponentId"><span class="type">ECalComponentId</span></a> *id</code></em>,
1571
1670
                                                         <em class="parameter"><code><a class="link" href="ECalComponent.html#ECalComponentAlarms" title="ECalComponentAlarms"><span class="type">ECalComponentAlarms</span></a> **alarms</code></em>);</pre>
1572
1671
<p>
1573
1672
Queries a calendar for the alarms of a particular object that trigger in the
1574
 
specified range of time.</p>
 
1673
specified range of time.
 
1674
</p>
1575
1675
<div class="variablelist"><table border="0">
1576
1676
<col align="left" valign="top">
1577
1677
<tbody>
1611
1711
</table></div>
1612
1712
</div>
1613
1713
<hr>
1614
 
<div class="refsect2" lang="en">
 
1714
<div class="refsect2" title="e_cal_create_object ()">
1615
1715
<a name="e-cal-create-object"></a><h3>e_cal_create_object ()</h3>
1616
1716
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_create_object                 (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1617
1717
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
1620
1720
<p>
1621
1721
Requests the calendar backend to create the object specified by the <em class="parameter"><code>icalcomp</code></em>
1622
1722
argument. Some backends would assign a specific UID to the newly created object,
1623
 
in those cases that UID would be returned in the <em class="parameter"><code>uid</code></em> argument.</p>
 
1723
in those cases that UID would be returned in the <em class="parameter"><code>uid</code></em> argument.
 
1724
</p>
1624
1725
<div class="variablelist"><table border="0">
1625
1726
<col align="left" valign="top">
1626
1727
<tbody>
1653
1754
</table></div>
1654
1755
</div>
1655
1756
<hr>
1656
 
<div class="refsect2" lang="en">
 
1757
<div class="refsect2" title="e_cal_modify_object ()">
1657
1758
<a name="e-cal-modify-object"></a><h3>e_cal_modify_object ()</h3>
1658
1759
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_modify_object                 (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1659
1760
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
1667
1768
For recurrent appointments, the <em class="parameter"><code>mod</code></em> argument specifies what to modify,
1668
1769
if all instances (CALOBJ_MOD_ALL), a single instance (CALOBJ_MOD_THIS),
1669
1770
or a specific set of instances (CALOBJ_MOD_THISNADPRIOR and
1670
 
CALOBJ_MOD_THISANDFUTURE).</p>
 
1771
CALOBJ_MOD_THISANDFUTURE).
 
1772
</p>
1671
1773
<div class="variablelist"><table border="0">
1672
1774
<col align="left" valign="top">
1673
1775
<tbody>
1700
1802
</table></div>
1701
1803
</div>
1702
1804
<hr>
1703
 
<div class="refsect2" lang="en">
 
1805
<div class="refsect2" title="e_cal_remove_object ()">
1704
1806
<a name="e-cal-remove-object"></a><h3>e_cal_remove_object ()</h3>
1705
1807
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_remove_object                 (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1706
1808
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
1708
1810
<p>
1709
1811
Asks a calendar to remove a component.  If the server is able to remove the
1710
1812
component, all clients will be notified and they will emit the "obj_removed"
1711
 
signal.</p>
 
1813
signal.
 
1814
</p>
1712
1815
<div class="variablelist"><table border="0">
1713
1816
<col align="left" valign="top">
1714
1817
<tbody>
1736
1839
</table></div>
1737
1840
</div>
1738
1841
<hr>
1739
 
<div class="refsect2" lang="en">
 
1842
<div class="refsect2" title="e_cal_remove_object_with_mod ()">
1740
1843
<a name="e-cal-remove-object-with-mod"></a><h3>e_cal_remove_object_with_mod ()</h3>
1741
1844
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_remove_object_with_mod        (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1742
1845
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
1752
1855
<p>
1753
1856
If not all instances are removed, the client will get a "obj_modified"
1754
1857
signal, while it will get a "obj_removed" signal when all instances
1755
 
are removed.</p>
 
1858
are removed.
 
1859
</p>
1756
1860
<div class="variablelist"><table border="0">
1757
1861
<col align="left" valign="top">
1758
1862
<tbody>
1790
1894
</table></div>
1791
1895
</div>
1792
1896
<hr>
1793
 
<div class="refsect2" lang="en">
 
1897
<div class="refsect2" title="e_cal_discard_alarm ()">
1794
1898
<a name="e-cal-discard-alarm"></a><h3>e_cal_discard_alarm ()</h3>
1795
1899
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_discard_alarm                 (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1796
1900
                                                         <em class="parameter"><code><a class="link" href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a> *comp</code></em>,
1800
1904
Tells the calendar backend to get rid of the alarm identified by the
1801
1905
<em class="parameter"><code>auid</code></em> argument in <em class="parameter"><code>comp</code></em>. Some backends might remove the alarm or
1802
1906
update internal information about the alarm be discarded, or, like
1803
 
the file backend does, ignore the operation.</p>
 
1907
the file backend does, ignore the operation.
 
1908
</p>
1804
1909
<div class="variablelist"><table border="0">
1805
1910
<col align="left" valign="top">
1806
1911
<tbody>
1833
1938
</table></div>
1834
1939
</div>
1835
1940
<hr>
1836
 
<div class="refsect2" lang="en">
 
1941
<div class="refsect2" title="e_cal_receive_objects ()">
1837
1942
<a name="e-cal-receive-objects"></a><h3>e_cal_receive_objects ()</h3>
1838
1943
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_receive_objects               (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1839
1944
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
1841
1946
<p>
1842
1947
Makes the backend receive the set of iCalendar objects specified in the
1843
1948
<em class="parameter"><code>icalcomp</code></em> argument. This is used for iTIP confirmation/cancellation
1844
 
messages for scheduled meetings.</p>
 
1949
messages for scheduled meetings.
 
1950
</p>
1845
1951
<div class="variablelist"><table border="0">
1846
1952
<col align="left" valign="top">
1847
1953
<tbody>
1869
1975
</table></div>
1870
1976
</div>
1871
1977
<hr>
1872
 
<div class="refsect2" lang="en">
 
1978
<div class="refsect2" title="e_cal_send_objects ()">
1873
1979
<a name="e-cal-send-objects"></a><h3>e_cal_send_objects ()</h3>
1874
1980
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_send_objects                  (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1875
1981
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
1878
1984
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1879
1985
<p>
1880
1986
Requests a calendar backend to send meeting information to the specified list
1881
 
of users.</p>
 
1987
of users.
 
1988
</p>
1882
1989
<div class="variablelist"><table border="0">
1883
1990
<col align="left" valign="top">
1884
1991
<tbody>
1917
2024
</table></div>
1918
2025
</div>
1919
2026
<hr>
1920
 
<div class="refsect2" lang="en">
 
2027
<div class="refsect2" title="e_cal_get_timezone ()">
1921
2028
<a name="e-cal-get-timezone"></a><h3>e_cal_get_timezone ()</h3>
1922
2029
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_timezone                  (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1923
2030
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
1924
2031
                                                         <em class="parameter"><code><span class="type">icaltimezone</span> **zone</code></em>,
1925
2032
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1926
2033
<p>
1927
 
Retrieves a timezone object from the calendar backend.</p>
 
2034
Retrieves a timezone object from the calendar backend.
 
2035
</p>
1928
2036
<div class="variablelist"><table border="0">
1929
2037
<col align="left" valign="top">
1930
2038
<tbody>
1957
2065
</table></div>
1958
2066
</div>
1959
2067
<hr>
1960
 
<div class="refsect2" lang="en">
 
2068
<div class="refsect2" title="e_cal_add_timezone ()">
1961
2069
<a name="e-cal-add-timezone"></a><h3>e_cal_add_timezone ()</h3>
1962
2070
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_add_timezone                  (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1963
2071
                                                         <em class="parameter"><code><span class="type">icaltimezone</span> *izone</code></em>,
1964
2072
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1965
2073
<p>
1966
 
Add a VTIMEZONE object to the given calendar.</p>
 
2074
Add a VTIMEZONE object to the given calendar.
 
2075
</p>
1967
2076
<div class="variablelist"><table border="0">
1968
2077
<col align="left" valign="top">
1969
2078
<tbody>
1991
2100
</table></div>
1992
2101
</div>
1993
2102
<hr>
1994
 
<div class="refsect2" lang="en">
 
2103
<div class="refsect2" title="e_cal_set_default_timezone ()">
1995
2104
<a name="e-cal-set-default-timezone"></a><h3>e_cal_set_default_timezone ()</h3>
1996
2105
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_set_default_timezone          (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
1997
2106
                                                         <em class="parameter"><code><span class="type">icaltimezone</span> *zone</code></em>,
1998
2107
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1999
2108
<p>
2000
2109
Sets the default timezone on the calendar. This should be called before opening
2001
 
the calendar.</p>
 
2110
the calendar.
 
2111
</p>
2002
2112
<div class="variablelist"><table border="0">
2003
2113
<col align="left" valign="top">
2004
2114
<tbody>
2026
2136
</table></div>
2027
2137
</div>
2028
2138
<hr>
2029
 
<div class="refsect2" lang="en">
 
2139
<div class="refsect2" title="e_cal_get_query ()">
2030
2140
<a name="e-cal-get-query"></a><h3>e_cal_get_query ()</h3>
2031
2141
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_query                     (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
2032
2142
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *sexp</code></em>,
2033
2143
                                                         <em class="parameter"><code><a class="link" href="ECalView.html" title="ECalView"><span class="type">ECalView</span></a> **query</code></em>,
2034
2144
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
2035
2145
<p>
2036
 
Creates a live query object from a loaded calendar.</p>
 
2146
Creates a live query object from a loaded calendar.
 
2147
</p>
2037
2148
<div class="variablelist"><table border="0">
2038
2149
<col align="left" valign="top">
2039
2150
<tbody>
2067
2178
</table></div>
2068
2179
</div>
2069
2180
<hr>
2070
 
<div class="refsect2" lang="en">
 
2181
<div class="refsect2" title="e_cal_resolve_tzid_cb ()">
2071
2182
<a name="e-cal-resolve-tzid-cb"></a><h3>e_cal_resolve_tzid_cb ()</h3>
2072
2183
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *      e_cal_resolve_tzid_cb               (<em class="parameter"><code>const <span class="type">gchar</span> *tzid</code></em>,
2073
2184
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
2074
2185
<p>
2075
 
Resolves TZIDs for the recurrence generator.</p>
 
2186
Resolves TZIDs for the recurrence generator.
 
2187
</p>
2076
2188
<div class="variablelist"><table border="0">
2077
2189
<col align="left" valign="top">
2078
2190
<tbody>
2096
2208
</table></div>
2097
2209
</div>
2098
2210
<hr>
2099
 
<div class="refsect2" lang="en">
 
2211
<div class="refsect2" title="e_cal_get_component_as_string ()">
2100
2212
<a name="e-cal-get-component-as-string"></a><h3>e_cal_get_component_as_string ()</h3>
2101
2213
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_cal_get_component_as_string       (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
2102
2214
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
2103
2215
<p>
2104
2216
Gets a calendar component as an iCalendar string, with a toplevel
2105
 
VCALENDAR component and all VTIMEZONEs needed for the component.</p>
 
2217
VCALENDAR component and all VTIMEZONEs needed for the component.
 
2218
</p>
2106
2219
<div class="variablelist"><table border="0">
2107
2220
<col align="left" valign="top">
2108
2221
<tbody>
2126
2239
</table></div>
2127
2240
</div>
2128
2241
<hr>
2129
 
<div class="refsect2" lang="en">
 
2242
<div class="refsect2" title="e_cal_get_error_message ()">
2130
2243
<a name="e-cal-get-error-message"></a><h3>e_cal_get_error_message ()</h3>
2131
2244
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_cal_get_error_message             (<em class="parameter"><code><a class="link" href="libecal-e-cal-types.html#ECalendarStatus" title="enum ECalendarStatus"><span class="type">ECalendarStatus</span></a> status</code></em>);</pre>
2132
2245
<p>
2133
 
Gets an error message for the given status code.</p>
 
2246
Gets an error message for the given status code.
 
2247
</p>
2134
2248
<div class="variablelist"><table border="0">
2135
2249
<col align="left" valign="top">
2136
2250
<tbody>
2148
2262
</table></div>
2149
2263
</div>
2150
2264
<hr>
2151
 
<div class="refsect2" lang="en">
 
2265
<div class="refsect2" title="e_cal_open_default ()">
2152
2266
<a name="e-cal-open-default"></a><h3>e_cal_open_default ()</h3>
2153
2267
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_open_default                  (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> **ecal</code></em>,
2154
2268
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>,
2156
2270
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
2157
2271
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
2158
2272
<p>
2159
 
Opens the default calendar.</p>
 
2273
Opens the default calendar.
 
2274
</p>
2160
2275
<div class="variablelist"><table border="0">
2161
2276
<col align="left" valign="top">
2162
2277
<tbody>
2194
2309
</table></div>
2195
2310
</div>
2196
2311
<hr>
2197
 
<div class="refsect2" lang="en">
 
2312
<div class="refsect2" title="e_cal_set_default ()">
2198
2313
<a name="e-cal-set-default"></a><h3>e_cal_set_default ()</h3>
2199
2314
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_set_default                   (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
2200
2315
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
2201
2316
<p>
2202
 
Sets a calendar as the default one.</p>
 
2317
Sets a calendar as the default one.
 
2318
</p>
2203
2319
<div class="variablelist"><table border="0">
2204
2320
<col align="left" valign="top">
2205
2321
<tbody>
2222
2338
</table></div>
2223
2339
</div>
2224
2340
<hr>
2225
 
<div class="refsect2" lang="en">
 
2341
<div class="refsect2" title="e_cal_set_default_source ()">
2226
2342
<a name="e-cal-set-default-source"></a><h3>e_cal_set_default_source ()</h3>
2227
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_set_default_source            (<em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>,
 
2343
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_set_default_source            (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
2228
2344
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>,
2229
2345
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
2230
2346
<p>
2231
 
Sets the default source for the specified <em class="parameter"><code>type</code></em>.</p>
 
2347
Sets the default source for the specified <em class="parameter"><code>type</code></em>.
 
2348
</p>
2232
2349
<div class="variablelist"><table border="0">
2233
2350
<col align="left" valign="top">
2234
2351
<tbody>
2235
2352
<tr>
2236
2353
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
2237
 
<td>An <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>.
 
2354
<td>An <span class="type">ESource</span>.
2238
2355
</td>
2239
2356
</tr>
2240
2357
<tr>
2256
2373
</table></div>
2257
2374
</div>
2258
2375
<hr>
2259
 
<div class="refsect2" lang="en">
 
2376
<div class="refsect2" title="e_cal_get_sources ()">
2260
2377
<a name="e-cal-get-sources"></a><h3>e_cal_get_sources ()</h3>
2261
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_sources                   (<em class="parameter"><code><a href="../libedataserver/ESourceList.html"><span class="type">ESourceList</span></a> **sources</code></em>,
 
2378
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_sources                   (<em class="parameter"><code><span class="type">ESourceList</span> **sources</code></em>,
2262
2379
                                                         <em class="parameter"><code><a class="link" href="ECal.html#ECalSourceType" title="enum ECalSourceType"><span class="type">ECalSourceType</span></a> type</code></em>,
2263
2380
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
2264
2381
<p>
2265
 
Gets the list of sources defined in the configuration for the given <em class="parameter"><code>type</code></em>.</p>
 
2382
Gets the list of sources defined in the configuration for the given <em class="parameter"><code>type</code></em>.
 
2383
</p>
2266
2384
<div class="variablelist"><table border="0">
2267
2385
<col align="left" valign="top">
2268
2386
<tbody>
2290
2408
</table></div>
2291
2409
</div>
2292
2410
<hr>
2293
 
<div class="refsect2" lang="en">
 
2411
<div class="refsect2" title="e_cal_get_local_attachment_store ()">
2294
2412
<a name="e-cal-get-local-attachment-store"></a><h3>e_cal_get_local_attachment_store ()</h3>
2295
2413
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_cal_get_local_attachment_store    (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
2296
2414
<p>
2298
2416
serialized in the local filesystem. This enable clients
2299
2417
to operate with the reference to attachments rather than the data itself
2300
2418
unless it specifically uses the attachments for open/sending
2301
 
operations.</p>
 
2419
operations.
 
2420
</p>
2302
2421
<div class="variablelist"><table border="0">
2303
2422
<col align="left" valign="top">
2304
2423
<tbody>
2317
2436
</table></div>
2318
2437
</div>
2319
2438
<hr>
2320
 
<div class="refsect2" lang="en">
 
2439
<div class="refsect2" title="e_cal_get_recurrences_no_master ()">
2321
2440
<a name="e-cal-get-recurrences-no-master"></a><h3>e_cal_get_recurrences_no_master ()</h3>
2322
2441
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_recurrences_no_master     (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>);</pre>
2323
2442
<p>
2324
 
Checks if the calendar has a master object for recurrences.</p>
 
2443
Checks if the calendar has a master object for recurrences.
 
2444
</p>
2325
2445
<div class="variablelist"><table border="0">
2326
2446
<col align="left" valign="top">
2327
2447
<tbody>
2340
2460
</table></div>
2341
2461
</div>
2342
2462
<hr>
2343
 
<div class="refsect2" lang="en">
 
2463
<div class="refsect2" title="e_cal_get_attachments_for_comp ()">
2344
2464
<a name="e-cal-get-attachments-for-comp"></a><h3>e_cal_get_attachments_for_comp ()</h3>
2345
2465
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_get_attachments_for_comp      (<em class="parameter"><code><a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a> *ecal</code></em>,
2346
2466
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
2349
2469
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
2350
2470
<p>
2351
2471
Queries a calendar for a calendar component object based on its unique
2352
 
identifier and gets the attachments for the component.</p>
 
2472
identifier and gets the attachments for the component.
 
2473
</p>
2353
2474
<div class="variablelist"><table border="0">
2354
2475
<col align="left" valign="top">
2355
2476
<tbody>
2387
2508
</table></div>
2388
2509
</div>
2389
2510
</div>
2390
 
<div class="refsect1" lang="en">
 
2511
<div class="refsect1" title="Signal Details">
2391
2512
<a name="ECal.signal-details"></a><h2>Signal Details</h2>
2392
 
<div class="refsect2" lang="en">
 
2513
<div class="refsect2" title='The "backend-died" signal'>
2393
2514
<a name="ECal-backend-died"></a><h3>The <code class="literal">"backend-died"</code> signal</h3>
2394
2515
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a>    *ecal,
2395
2516
                                                        <span class="type">gpointer</span> user_data)      : Run First</pre>
2411
2532
</table></div>
2412
2533
</div>
2413
2534
<hr>
2414
 
<div class="refsect2" lang="en">
 
2535
<div class="refsect2" title='The "backend-error" signal'>
2415
2536
<a name="ECal-backend-error"></a><h3>The <code class="literal">"backend-error"</code> signal</h3>
2416
2537
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a>    *ecal,
2417
2538
                                                        <span class="type">gchar</span>   *arg1,
2439
2560
</table></div>
2440
2561
</div>
2441
2562
<hr>
2442
 
<div class="refsect2" lang="en">
 
2563
<div class="refsect2" title='The "cal-opened" signal'>
2443
2564
<a name="ECal-cal-opened"></a><h3>The <code class="literal">"cal-opened"</code> signal</h3>
2444
2565
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a>    *ecal,
2445
2566
                                                        <span class="type">gint</span>     arg1,
2467
2588
</table></div>
2468
2589
</div>
2469
2590
<hr>
2470
 
<div class="refsect2" lang="en">
 
2591
<div class="refsect2" title='The "cal-set-mode" signal'>
2471
2592
<a name="ECal-cal-set-mode"></a><h3>The <code class="literal">"cal-set-mode"</code> signal</h3>
2472
2593
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ECal.html" title="ECal"><span class="type">ECal</span></a>                 *ecal,
2473
2594
                                                        <span class="type">ECalSetModeStatusEnum</span> arg1,
2501
2622
</table></div>
2502
2623
</div>
2503
2624
</div>
2504
 
<div class="refsect1" lang="en">
 
2625
<div class="refsect1" title="See Also">
2505
2626
<a name="ECal.see-also"></a><h2>See Also</h2>
2506
2627
<p>
2507
2628
<span class="type">e-cal-listener</span>, <span class="type">e-cal-view</span>