1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ECal</title><meta name="generator" content="DocBook XSL Stylesheets V1.64.1"><link rel="home" href="index.html" title="Evolution API Reference: libecal, the Calendar Library"><link rel="up" href="ch01.html" title="Evolution API Reference: libecal, the Calendar Library"><link rel="previous" href="libecal-ECalViewListener.html" title="ECalViewListener"><link rel="next" href="libecal-e-cal-recur.html" title="e-cal-recur"><link rel="chapter" href="ch01.html" title="Evolution API Reference: libecal, the Calendar Library"><link rel="refentry" href="ECalComponent.html" title="ECalComponent"><link rel="refentry" href="libecal-ECalListener.html" title="ECalListener"><link rel="refentry" href="libecal-ECalViewListener.html" title="ECalViewListener"><link rel="refentry" href="ECal.html" title="ECal"><link rel="refentry" href="libecal-e-cal-recur.html" title="e-cal-recur"><link rel="refentry" href="libecal-e-cal-time-util.html" title="e-cal-time-util"><link rel="refentry" href="libecal-e-cal-types.html" title="e-cal-types"><link rel="refentry" href="libecal-e-cal-util.html" title="e-cal-util"><link rel="refentry" href="libecal-ECalView.html" title="ECalView"><link rel="section" href="ECal.html#id2567135" title="Object Hierarchy"><link rel="section" href="ECal.html#id2567150" title="Signal Prototypes"><link rel="section" href="ECal.html#id2567303" title="Description"><link rel="section" href="ECal.html#id2567314" title="Details"><link rel="section" href="ECal.html#id2584251" title="Signals"><link rel="section" href="ECal.html#id2584626" title="See Also"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libecal-ECalViewListener.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Evolution API Reference: libecal, the Calendar Library</th><td><a accesskey="n" href="libecal-e-cal-recur.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="ECal"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">ECal</span></h2><p>ECal — Permits access to a calendar or list of tasks.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
struct <a href="ECal.html#ECal-struct">ECal</a>;
#define <a href="ECal.html#E-CAL-SET-MODE-STATUS-ENUM-TYPE-CAPS">E_CAL_SET_MODE_STATUS_ENUM_TYPE</a>
#define <a href="ECal.html#CAL-MODE-ENUM-TYPE-CAPS">CAL_MODE_ENUM_TYPE</a>
enum <a href="ECal.html#ECalSetModeStatus">ECalSetModeStatus</a>;
enum <a href="ECal.html#ECalLoadState">ECalLoadState</a>;
char* (<a href="ECal.html#ECalAuthFunc">*ECalAuthFunc</a>) (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *prompt,
const char *key,
gpointer user_data);
GType <a href="ECal.html#e-cal-open-status-enum-get-type">e_cal_open_status_enum_get_type</a> (void);
GType <a href="ECal.html#e-cal-set-mode-status-enum-get-type">e_cal_set_mode_status_enum_get_type</a>
(void);
GType <a href="ECal.html#cal-mode-enum-get-type">cal_mode_enum_get_type</a> (void);
<a href="ECal.html" title="ECal">ECal</a>* <a href="ECal.html#e-cal-new">e_cal_new</a> (ESource *source,
ECalSourceType type);
void <a href="ECal.html#e-cal-set-auth-func">e_cal_set_auth_func</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
<a href="ECal.html#ECalAuthFunc">ECalAuthFunc</a> func,
gpointer data);
gboolean <a href="ECal.html#e-cal-open">e_cal_open</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gboolean only_if_exists,
GError **error);
void <a href="ECal.html#e-cal-open-async">e_cal_open_async</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gboolean only_if_exists);
GList* <a href="ECal.html#e-cal-uri-list">e_cal_uri_list</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
<a href="libecal-e-cal-util.html#CalMode">CalMode</a> mode);
<a href="ECal.html#ECalLoadState">ECalLoadState</a> <a href="ECal.html#e-cal-get-load-state">e_cal_get_load_state</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal);
const char* <a href="ECal.html#e-cal-get-uri">e_cal_get_uri</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal);
gboolean <a href="ECal.html#e-cal-is-read-only">e_cal_is_read_only</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gboolean *read_only,
GError **error);
gboolean <a href="ECal.html#e-cal-get-cal-address">e_cal_get_cal_address</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
char **cal_address,
GError **error);
gboolean <a href="ECal.html#e-cal-get-alarm-email-address">e_cal_get_alarm_email_address</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
char **alarm_address,
GError **error);
gboolean <a href="ECal.html#e-cal-get-ldap-attribute">e_cal_get_ldap_attribute</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
char **ldap_attribute,
GError **error);
gboolean <a href="ECal.html#e-cal-get-one-alarm-only">e_cal_get_one_alarm_only</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal);
gboolean <a href="ECal.html#e-cal-get-organizer-must-attend">e_cal_get_organizer_must_attend</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal);
gboolean <a href="ECal.html#e-cal-get-save-schedules">e_cal_get_save_schedules</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal);
gboolean <a href="ECal.html#e-cal-get-static-capability">e_cal_get_static_capability</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *cap);
gboolean <a href="ECal.html#e-cal-set-mode">e_cal_set_mode</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
<a href="libecal-e-cal-util.html#CalMode">CalMode</a> mode);
gboolean <a href="ECal.html#e-cal-get-default-object">e_cal_get_default_object</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent **icalcomp,
GError **error);
gboolean <a href="ECal.html#e-cal-get-object">e_cal_get_object</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *uid,
const char *rid,
icalcomponent **icalcomp,
GError **error);
gboolean <a href="ECal.html#e-cal-get-changes">e_cal_get_changes</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *change_id,
GList **changes,
GError **error);
void <a href="ECal.html#e-cal-free-change-list">e_cal_free_change_list</a> (GList *list);
gboolean <a href="ECal.html#e-cal-get-object-list">e_cal_get_object_list</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *query,
GList **objects,
GError **error);
gboolean <a href="ECal.html#e-cal-get-object-list-as-comp">e_cal_get_object_list_as_comp</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *query,
GList **objects,
GError **error);
void <a href="ECal.html#e-cal-free-object-list">e_cal_free_object_list</a> (GList *objects);
gboolean <a href="ECal.html#e-cal-get-free-busy">e_cal_get_free_busy</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
GList *users,
time_t start,
time_t end,
GList **freebusy,
GError **error);
void <a href="ECal.html#e-cal-generate-instances">e_cal_generate_instances</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
time_t start,
time_t end,
<a href="libecal-e-cal-recur.html#ECalRecurInstanceFn">ECalRecurInstanceFn</a> cb,
gpointer cb_data);
GSList* <a href="ECal.html#e-cal-get-alarms-in-range">e_cal_get_alarms_in_range</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
time_t start,
time_t end);
void <a href="ECal.html#e-cal-free-alarms">e_cal_free_alarms</a> (GSList *comp_alarms);
gboolean <a href="ECal.html#e-cal-get-alarms-for-object">e_cal_get_alarms_for_object</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *uid,
time_t start,
time_t end,
<a href="ECalComponent.html#ECalComponentAlarms">ECalComponentAlarms</a> **alarms);
gboolean <a href="ECal.html#e-cal-create-object">e_cal_create_object</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp,
char **uid,
GError **error);
gboolean <a href="ECal.html#e-cal-modify-object">e_cal_modify_object</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp,
<a href="libecal-e-cal-util.html#CalObjModType">CalObjModType</a> mod,
GError **error);
gboolean <a href="ECal.html#e-cal-remove-object">e_cal_remove_object</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *uid,
GError **error);
gboolean <a href="ECal.html#e-cal-remove-object-with-mod">e_cal_remove_object_with_mod</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *uid,
const char *rid,
<a href="libecal-e-cal-util.html#CalObjModType">CalObjModType</a> mod,
GError **error);
gboolean <a href="ECal.html#e-cal-discard-alarm">e_cal_discard_alarm</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *auid,
GError **error);
gboolean <a href="ECal.html#e-cal-receive-objects">e_cal_receive_objects</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp,
GError **error);
gboolean <a href="ECal.html#e-cal-send-objects">e_cal_send_objects</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp,
GList **users,
icalcomponent **modified_icalcomp,
GError **error);
gboolean <a href="ECal.html#e-cal-get-timezone">e_cal_get_timezone</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *tzid,
icaltimezone **zone,
GError **error);
gboolean <a href="ECal.html#e-cal-add-timezone">e_cal_add_timezone</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icaltimezone *izone,
GError **error);
gboolean <a href="ECal.html#e-cal-set-default-timezone">e_cal_set_default_timezone</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icaltimezone *zone,
GError **error);
gboolean <a href="ECal.html#e-cal-get-query">e_cal_get_query</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *sexp,
ECalView **query,
GError **error);
icaltimezone* <a href="ECal.html#e-cal-resolve-tzid-cb">e_cal_resolve_tzid_cb</a> (const char *tzid,
gpointer data);
char* <a href="ECal.html#e-cal-get-component-as-string">e_cal_get_component_as_string</a> (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp);
const char* <a href="ECal.html#e-cal-get-error-message">e_cal_get_error_message</a> (<a href="libecal-e-cal-types.html#ECalendarStatus">ECalendarStatus</a> status);
</pre></div><div class="refsect1" lang="en"><a name="id2567135"></a><h2>Object Hierarchy</h2><pre class="synopsis">
GObject
+----ECal
</pre></div><div class="refsect1" lang="en"><a name="id2567150"></a><h2>Signal Prototypes</h2><pre class="synopsis">
"<a href="ECal.html#ECal-backend-died">backend-died</a>"
void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gpointer user_data);
"<a href="ECal.html#ECal-backend-error">backend-error</a>"
void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gchar *arg1,
gpointer user_data);
"<a href="ECal.html#ECal-cal-opened">cal-opened</a>"
void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gint arg1,
gpointer user_data);
"<a href="ECal.html#ECal-cal-set-mode">cal-set-mode</a>"
void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
ECalSetModeStatusEnum arg1,
CalModeEnum arg2,
gpointer user_data);
"<a href="ECal.html#ECal-categories-changed">categories-changed</a>"
void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gpointer arg1,
gpointer user_data);
</pre></div><div class="refsect1" lang="en"><a name="id2567303"></a><h2>Description</h2><p>
Represents an entire calendar or task list, not individual items within them.2
</p></div><div class="refsect1" lang="en"><a name="id2567314"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2567319"></a><h3><a name="ECal-struct"></a>struct ECal</h3><a class="indexterm" name="id2567328"></a><pre class="programlisting">struct ECal;</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2567337"></a><h3><a name="E-CAL-SET-MODE-STATUS-ENUM-TYPE-CAPS"></a>E_CAL_SET_MODE_STATUS_ENUM_TYPE</h3><a class="indexterm" name="id2567346"></a><pre class="programlisting">#define E_CAL_SET_MODE_STATUS_ENUM_TYPE (e_cal_set_mode_status_enum_get_type ())
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2567358"></a><h3><a name="CAL-MODE-ENUM-TYPE-CAPS"></a>CAL_MODE_ENUM_TYPE</h3><a class="indexterm" name="id2567367"></a><pre class="programlisting">#define CAL_MODE_ENUM_TYPE (cal_mode_enum_get_type ())
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2567378"></a><h3><a name="ECalSetModeStatus"></a>enum ECalSetModeStatus</h3><a class="indexterm" name="id2567386"></a><pre class="programlisting">typedef enum {
E_CAL_SET_MODE_SUCCESS,
E_CAL_SET_MODE_ERROR,
E_CAL_SET_MODE_NOT_SUPPORTED
} ECalSetModeStatus;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2567398"></a><h3><a name="ECalLoadState"></a>enum ECalLoadState</h3><a class="indexterm" name="id2567406"></a><pre class="programlisting">typedef enum {
E_CAL_LOAD_NOT_LOADED,
E_CAL_LOAD_AUTHENTICATING,
E_CAL_LOAD_LOADING,
E_CAL_LOAD_LOADED
} ECalLoadState;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2567418"></a><h3><a name="ECalAuthFunc"></a>ECalAuthFunc ()</h3><a class="indexterm" name="id2567426"></a><pre class="programlisting">char* (*ECalAuthFunc) (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *prompt,
const char *key,
gpointer user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>prompt</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>key</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2567520"></a><h3><a name="e-cal-open-status-enum-get-type"></a>e_cal_open_status_enum_get_type ()</h3><a class="indexterm" name="id2567532"></a><pre class="programlisting">GType e_cal_open_status_enum_get_type (void);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2567561"></a><h3><a name="e-cal-set-mode-status-enum-get-type"></a>e_cal_set_mode_status_enum_get_type ()</h3><a class="indexterm" name="id2567572"></a><pre class="programlisting">GType e_cal_set_mode_status_enum_get_type
(void);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2567602"></a><h3><a name="cal-mode-enum-get-type"></a>cal_mode_enum_get_type ()</h3><a class="indexterm" name="id2567610"></a><pre class="programlisting">GType cal_mode_enum_get_type (void);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2567638"></a><h3><a name="e-cal-new"></a>e_cal_new ()</h3><a class="indexterm" name="id2567647"></a><pre class="programlisting"><a href="ECal.html" title="ECal">ECal</a>* e_cal_new (ESource *source,
ECalSourceType type);</pre><p>
Creates a new calendar ecal. It should be initialized by calling
<a href="ECal.html#e-cal-open"><tt class="function">e_cal_open()</tt></a>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>source</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A newly-created calendar ecal, or NULL if the ecal could
not be constructed because it could not contact the calendar server.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2567721"></a><h3><a name="e-cal-set-auth-func"></a>e_cal_set_auth_func ()</h3><a class="indexterm" name="id2567729"></a><pre class="programlisting">void e_cal_set_auth_func (<a href="ECal.html" title="ECal">ECal</a> *ecal,
<a href="ECal.html#ECalAuthFunc">ECalAuthFunc</a> func,
gpointer data);</pre><p>
Sets the given authentication function on the calendar ecal. This
function will be called any time the calendar server needs a
password for an operation associated with the calendar and should
be supplied before any calendar is opened.
</p><p>
When a calendar is opened asynchronously, the open function is
processed in a concurrent thread. This means that the
authentication function will also be called from this thread. As
such, the authentication callback cannot directly call any
functions that must be called from the main thread. For example
any Gtk+ related functions, which must be proxied synchronously to
the main thread by the callback.
</p><p>
The authentication function has the following signature
(ECalAuthFunc):
char * auth_func (ECal *ecal,
const gchar *prompt,
const gchar *key,
gpointer user_data)</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>func</tt></i>:</span></td><td> The authentication function
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i>:</span></td><td> User data to be used when calling the authentication function
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2567823"></a><h3><a name="e-cal-open"></a>e_cal_open ()</h3><a class="indexterm" name="id2567832"></a><pre class="programlisting">gboolean e_cal_open (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gboolean only_if_exists,
GError **error);</pre><p>
Makes a calendar ecal initiate a request to open a calendar. The calendar
ecal will emit the "cal_opened" signal when the response from the server is
received.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>only_if_exists</tt></i>:</span></td><td> FALSE if the calendar should be opened even if there
was no storage for it, i.e. to create a new calendar or load an existing
one if it already exists. TRUE if it should only try to load calendars
that already exist.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success, FALSE on failure to issue the open request.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2567921"></a><h3><a name="e-cal-open-async"></a>e_cal_open_async ()</h3><a class="indexterm" name="id2567929"></a><pre class="programlisting">void e_cal_open_async (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gboolean only_if_exists);</pre><p>
Open the calendar asynchronously. The calendar will emit the
"cal_opened" signal when the operation has completed.
</p><p>
Because this operation runs in another thread, any authentication
callback set on the calendar will be called from this other thread.
See <a href="ECal.html#e-cal-set-auth-func"><tt class="function">e_cal_set_auth_func()</tt></a> for details.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>only_if_exists</tt></i>:</span></td><td> If TRUE, then only open the calendar if it already
exists. If FALSE, then create a new calendar if it doesn't already
exist.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568000"></a><h3><a name="e-cal-uri-list"></a>e_cal_uri_list ()</h3><a class="indexterm" name="id2568008"></a><pre class="programlisting">GList* e_cal_uri_list (<a href="ECal.html" title="ECal">ECal</a> *ecal,
<a href="libecal-e-cal-util.html#CalMode">CalMode</a> mode);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mode</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568070"></a><h3><a name="e-cal-get-load-state"></a>e_cal_get_load_state ()</h3><a class="indexterm" name="id2568078"></a><pre class="programlisting"><a href="ECal.html#ECalLoadState">ECalLoadState</a> e_cal_get_load_state (<a href="ECal.html" title="ECal">ECal</a> *ecal);</pre><p>
Queries the state of loading of a calendar ecal.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A <a href="ECal.html#ECalLoadState"><span class="type">ECalLoadState</span></a> value indicating whether the ecal has
not been loaded with <tt class="function">e_cal_open_calendar()</tt> yet, whether it is being
loaded, or whether it is already loaded.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568141"></a><h3><a name="e-cal-get-uri"></a>e_cal_get_uri ()</h3><a class="indexterm" name="id2568149"></a><pre class="programlisting">const char* e_cal_get_uri (<a href="ECal.html" title="ECal">ECal</a> *ecal);</pre><p>
Queries the URI that is open in a calendar ecal.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The URI of the calendar that is already loaded or is being
loaded, or NULL if the ecal has not started a load request yet.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568201"></a><h3><a name="e-cal-is-read-only"></a>e_cal_is_read_only ()</h3><a class="indexterm" name="id2568209"></a><pre class="programlisting">gboolean e_cal_is_read_only (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gboolean *read_only,
GError **error);</pre><p>
Queries whether the calendar ecal can perform modifications
on the calendar or not. Whether the backend is read only or not
is specified, on exit, in the <i class="parameter"><tt>read_only</tt></i> argument.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>read_only</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the call was successful, FALSE if there was an error.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568298"></a><h3><a name="e-cal-get-cal-address"></a>e_cal_get_cal_address ()</h3><a class="indexterm" name="id2568306"></a><pre class="programlisting">gboolean e_cal_get_cal_address (<a href="ECal.html" title="ECal">ECal</a> *ecal,
char **cal_address,
GError **error);</pre><p>
Queries the calendar address associated with a calendar ecal.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>cal_address</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The calendar address associated with the calendar that
is loaded or being loaded, or <tt class="literal">NULL</tt> if the ecal has not started a
load request yet or the calendar has no associated email address.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568395"></a><h3><a name="e-cal-get-alarm-email-address"></a>e_cal_get_alarm_email_address ()</h3><a class="indexterm" name="id2568406"></a><pre class="programlisting">gboolean e_cal_get_alarm_email_address (<a href="ECal.html" title="ECal">ECal</a> *ecal,
char **alarm_address,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>alarm_address</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568485"></a><h3><a name="e-cal-get-ldap-attribute"></a>e_cal_get_ldap_attribute ()</h3><a class="indexterm" name="id2568493"></a><pre class="programlisting">gboolean e_cal_get_ldap_attribute (<a href="ECal.html" title="ECal">ECal</a> *ecal,
char **ldap_attribute,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>ldap_attribute</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568571"></a><h3><a name="e-cal-get-one-alarm-only"></a>e_cal_get_one_alarm_only ()</h3><a class="indexterm" name="id2568580"></a><pre class="programlisting">gboolean e_cal_get_one_alarm_only (<a href="ECal.html" title="ECal">ECal</a> *ecal);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568624"></a><h3><a name="e-cal-get-organizer-must-attend"></a>e_cal_get_organizer_must_attend ()</h3><a class="indexterm" name="id2568635"></a><pre class="programlisting">gboolean e_cal_get_organizer_must_attend (<a href="ECal.html" title="ECal">ECal</a> *ecal);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568680"></a><h3><a name="e-cal-get-save-schedules"></a>e_cal_get_save_schedules ()</h3><a class="indexterm" name="id2568688"></a><pre class="programlisting">gboolean e_cal_get_save_schedules (<a href="ECal.html" title="ECal">ECal</a> *ecal);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568732"></a><h3><a name="e-cal-get-static-capability"></a>e_cal_get_static_capability ()</h3><a class="indexterm" name="id2568741"></a><pre class="programlisting">gboolean e_cal_get_static_capability (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *cap);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>cap</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568808"></a><h3><a name="e-cal-set-mode"></a>e_cal_set_mode ()</h3><a class="indexterm" name="id2568818"></a><pre class="programlisting">gboolean e_cal_set_mode (<a href="ECal.html" title="ECal">ECal</a> *ecal,
<a href="libecal-e-cal-util.html#CalMode">CalMode</a> mode);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mode</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568892"></a><h3><a name="e-cal-get-default-object"></a>e_cal_get_default_object ()</h3><a class="indexterm" name="id2568902"></a><pre class="programlisting">gboolean e_cal_get_default_object (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent **icalcomp,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2568996"></a><h3><a name="e-cal-get-object"></a>e_cal_get_object ()</h3><a class="indexterm" name="id2569006"></a><pre class="programlisting">gboolean e_cal_get_object (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *uid,
const char *rid,
icalcomponent **icalcomp,
GError **error);</pre><p>
Queries a calendar for a calendar component object based on its unique
identifier.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>uid</tt></i>:</span></td><td> Unique identifier for a calendar component.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>rid</tt></i>:</span></td><td> Recurrence identifier.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td> Return value for the calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td> Placeholder for error information.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> Result code based on the status of the operation.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569147"></a><h3><a name="e-cal-get-changes"></a>e_cal_get_changes ()</h3><a class="indexterm" name="id2569157"></a><pre class="programlisting">gboolean e_cal_get_changes (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *change_id,
GList **changes,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>change_id</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>changes</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569272"></a><h3><a name="e-cal-free-change-list"></a>e_cal_free_change_list ()</h3><a class="indexterm" name="id2569282"></a><pre class="programlisting">void e_cal_free_change_list (GList *list);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>list</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569324"></a><h3><a name="e-cal-get-object-list"></a>e_cal_get_object_list ()</h3><a class="indexterm" name="id2569334"></a><pre class="programlisting">gboolean e_cal_get_object_list (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *query,
GList **objects,
GError **error);</pre><p>
</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>query</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>objects</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569452"></a><h3><a name="e-cal-get-object-list-as-comp"></a>e_cal_get_object_list_as_comp ()</h3><a class="indexterm" name="id2569465"></a><pre class="programlisting">gboolean e_cal_get_object_list_as_comp (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *query,
GList **objects,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>query</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>objects</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569580"></a><h3><a name="e-cal-free-object-list"></a>e_cal_free_object_list ()</h3><a class="indexterm" name="id2569590"></a><pre class="programlisting">void e_cal_free_object_list (GList *objects);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>objects</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569632"></a><h3><a name="e-cal-get-free-busy"></a>e_cal_get_free_busy ()</h3><a class="indexterm" name="id2569642"></a><pre class="programlisting">gboolean e_cal_get_free_busy (<a href="ECal.html" title="ECal">ECal</a> *ecal,
GList *users,
time_t start,
time_t end,
GList **freebusy,
GError **error);</pre><p>
Gets free/busy information from the calendar server.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>users</tt></i>:</span></td><td> List of users to retrieve free/busy information for.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>start</tt></i>:</span></td><td> Start time for query.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>end</tt></i>:</span></td><td> End time for query.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>freebusy</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a GList of VFREEBUSY ECalComponents
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569803"></a><h3><a name="e-cal-generate-instances"></a>e_cal_generate_instances ()</h3><a class="indexterm" name="id2569813"></a><pre class="programlisting">void e_cal_generate_instances (<a href="ECal.html" title="ECal">ECal</a> *ecal,
time_t start,
time_t end,
<a href="libecal-e-cal-recur.html#ECalRecurInstanceFn">ECalRecurInstanceFn</a> cb,
gpointer cb_data);</pre><p>
Does a combination of <a href="ECal.html#e-cal-get-object-list"><tt class="function">e_cal_get_object_list()</tt></a> and
<tt class="function">cal_recur_generate_instances()</tt>.
</p><p>
The callback function should do a <tt class="function">g_object_ref()</tt> of the calendar component
it gets passed if it intends to keep it around.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>start</tt></i>:</span></td><td> Start time for query.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>end</tt></i>:</span></td><td> End time for query.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>cb</tt></i>:</span></td><td> Callback for each generated instance.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>cb_data</tt></i>:</span></td><td> Closure data for the callback.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569968"></a><h3><a name="e-cal-get-alarms-in-range"></a>e_cal_get_alarms_in_range ()</h3><a class="indexterm" name="id2569979"></a><pre class="programlisting">GSList* e_cal_get_alarms_in_range (<a href="ECal.html" title="ECal">ECal</a> *ecal,
time_t start,
time_t end);</pre><p>
Queries a calendar for the alarms that trigger in the specified range of
time.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>start</tt></i>:</span></td><td> Start time for query.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>end</tt></i>:</span></td><td> End time for query.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A list of <a href="ECalComponent.html#ECalComponentAlarms"><span class="type">ECalComponentAlarms</span></a> structures. This should be freed
using the <a href="ECal.html#e-cal-free-alarms"><tt class="function">e_cal_free_alarms()</tt></a> function, or by freeing each element
separately with <a href="ECalComponent.html#e-cal-component-alarms-free"><tt class="function">e_cal_component_alarms_free()</tt></a> and then freeing the list with
<tt class="function">g_slist_free()</tt>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2570109"></a><h3><a name="e-cal-free-alarms"></a>e_cal_free_alarms ()</h3><a class="indexterm" name="id2570119"></a><pre class="programlisting">void e_cal_free_alarms (GSList *comp_alarms);</pre><p>
Frees a list of <a href="ECalComponent.html#ECalComponentAlarms"><span class="type">ECalComponentAlarms</span></a> structures as returned by
<a href="ECal.html#e-cal-get-alarms-in-range"><tt class="function">e_cal_get_alarms_in_range()</tt></a>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>comp_alarms</tt></i>:</span></td><td> A list of <a href="ECalComponent.html#ECalComponentAlarms"><span class="type">ECalComponentAlarms</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2570186"></a><h3><a name="e-cal-get-alarms-for-object"></a>e_cal_get_alarms_for_object ()</h3><a class="indexterm" name="id2570197"></a><pre class="programlisting">gboolean e_cal_get_alarms_for_object (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *uid,
time_t start,
time_t end,
<a href="ECalComponent.html#ECalComponentAlarms">ECalComponentAlarms</a> **alarms);</pre><p>
Queries a calendar for the alarms of a particular object that trigger in the
specified range of time.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>uid</tt></i>:</span></td><td> Unique identifier for a calendar component.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>start</tt></i>:</span></td><td> Start time for query.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>end</tt></i>:</span></td><td> End time for query.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>alarms</tt></i>:</span></td><td> Return value for the component's alarm instances. Will return NULL
if no instances occur within the specified time range. This should be freed
using the <a href="ECalComponent.html#e-cal-component-alarms-free"><tt class="function">e_cal_component_alarms_free()</tt></a> function.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success, FALSE if the object was not found.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2570348"></a><h3><a name="e-cal-create-object"></a>e_cal_create_object ()</h3><a class="indexterm" name="id2570358"></a><pre class="programlisting">gboolean e_cal_create_object (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp,
char **uid,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>uid</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582844"></a><h3><a name="e-cal-modify-object"></a>e_cal_modify_object ()</h3><a class="indexterm" name="id2582853"></a><pre class="programlisting">gboolean e_cal_modify_object (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp,
<a href="libecal-e-cal-util.html#CalObjModType">CalObjModType</a> mod,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mod</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582966"></a><h3><a name="e-cal-remove-object"></a>e_cal_remove_object ()</h3><a class="indexterm" name="id2582976"></a><pre class="programlisting">gboolean e_cal_remove_object (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *uid,
GError **error);</pre><p>
Asks a calendar to remove a component. If the server is able to remove the
component, all ecals will be notified and they will emit the "obj_removed"
signal.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>uid</tt></i>:</span></td><td> Unique identifier of the calendar component to remove.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td> Error placeholder.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if successful, <tt class="literal">FALSE</tt> otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583084"></a><h3><a name="e-cal-remove-object-with-mod"></a>e_cal_remove_object_with_mod ()</h3><a class="indexterm" name="id2583097"></a><pre class="programlisting">gboolean e_cal_remove_object_with_mod (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *uid,
const char *rid,
<a href="libecal-e-cal-util.html#CalObjModType">CalObjModType</a> mod,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>uid</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>rid</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mod</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583232"></a><h3><a name="e-cal-discard-alarm"></a>e_cal_discard_alarm ()</h3><a class="indexterm" name="id2583242"></a><pre class="programlisting">gboolean e_cal_discard_alarm (<a href="ECal.html" title="ECal">ECal</a> *ecal,
<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *auid,
GError **error);</pre><p>
Tells the calendar backend to get rid of the alarm identified by the
<i class="parameter"><tt>auid</tt></i> argument in <i class="parameter"><tt>comp</tt></i>. Some backends might remove the alarm or
update internal information about the alarm be discarded, or, like
the file backend does, ignore the operation.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>comp</tt></i>:</span></td><td> The component to discard the alarm from.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>auid</tt></i>:</span></td><td> Unique identifier of the alarm to be discarded.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a <span class="type">ECalResult</span> value indicating the result of the
operation.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583381"></a><h3><a name="e-cal-receive-objects"></a>e_cal_receive_objects ()</h3><a class="indexterm" name="id2583391"></a><pre class="programlisting">gboolean e_cal_receive_objects (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp,
GError **error);</pre><p>
Makes the backend receive the set of iCalendar objects specified in the
<i class="parameter"><tt>icalcomp</tt></i> argument. This is used for iTIP confirmation/cancellation
messages for scheduled meetings.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td> An icalcomponent.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td> Error placeholder.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if successful, <tt class="literal">FALSE</tt> otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583502"></a><h3><a name="e-cal-send-objects"></a>e_cal_send_objects ()</h3><a class="indexterm" name="id2583512"></a><pre class="programlisting">gboolean e_cal_send_objects (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp,
GList **users,
icalcomponent **modified_icalcomp,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>users</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>modified_icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583645"></a><h3><a name="e-cal-get-timezone"></a>e_cal_get_timezone ()</h3><a class="indexterm" name="id2583655"></a><pre class="programlisting">gboolean e_cal_get_timezone (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *tzid,
icaltimezone **zone,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>tzid</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>zone</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583770"></a><h3><a name="e-cal-add-timezone"></a>e_cal_add_timezone ()</h3><a class="indexterm" name="id2583780"></a><pre class="programlisting">gboolean e_cal_add_timezone (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icaltimezone *izone,
GError **error);</pre><p>
Add a VTIMEZONE object to the given calendar.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>izone</tt></i>:</span></td><td> The timezone to add.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td> Placeholder for error information.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if successful, FALSE otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583845"></a><h3><a name="e-cal-set-default-timezone"></a>e_cal_set_default_timezone ()</h3><a class="indexterm" name="id2583854"></a><pre class="programlisting">gboolean e_cal_set_default_timezone (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icaltimezone *zone,
GError **error);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>zone</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583932"></a><h3><a name="e-cal-get-query"></a>e_cal_get_query ()</h3><a class="indexterm" name="id2583940"></a><pre class="programlisting">gboolean e_cal_get_query (<a href="ECal.html" title="ECal">ECal</a> *ecal,
const char *sexp,
ECalView **query,
GError **error);</pre><p>
Creates a live query object from a loaded calendar.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>sexp</tt></i>:</span></td><td> S-expression representing the query.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>query</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A query object that will emit notification signals as calendar
components are added and removed from the query in the server.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2584042"></a><h3><a name="e-cal-resolve-tzid-cb"></a>e_cal_resolve_tzid_cb ()</h3><a class="indexterm" name="id2584051"></a><pre class="programlisting">icaltimezone* e_cal_resolve_tzid_cb (const char *tzid,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>tzid</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2584112"></a><h3><a name="e-cal-get-component-as-string"></a>e_cal_get_component_as_string ()</h3><a class="indexterm" name="id2584123"></a><pre class="programlisting">char* e_cal_get_component_as_string (<a href="ECal.html" title="ECal">ECal</a> *ecal,
icalcomponent *icalcomp);</pre><p>
Gets a calendar component as an iCalendar string, with a toplevel
VCALENDAR component and all VTIMEZONEs needed for the component.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td> A calendar ecal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the component as a complete iCalendar string, or NULL on
failure. The string should be freed after use.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2584193"></a><h3><a name="e-cal-get-error-message"></a>e_cal_get_error_message ()</h3><a class="indexterm" name="id2584201"></a><pre class="programlisting">const char* e_cal_get_error_message (<a href="libecal-e-cal-types.html#ECalendarStatus">ECalendarStatus</a> status);</pre><p>
Get an error message for the given status code.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>status</tt></i>:</span></td><td> A status code.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the error message.
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2584251"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2584257"></a><h3><a name="ECal-backend-died"></a>The "backend-died" signal</h3><pre class="programlisting">void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gpointer user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2584313"></a><h3><a name="ECal-backend-error"></a>The "backend-error" signal</h3><pre class="programlisting">void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gchar *arg1,
gpointer user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2584386"></a><h3><a name="ECal-cal-opened"></a>The "cal-opened" signal</h3><pre class="programlisting">void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gint arg1,
gpointer user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2584460"></a><h3><a name="ECal-cal-set-mode"></a>The "cal-set-mode" signal</h3><pre class="programlisting">void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
ECalSetModeStatusEnum arg1,
CalModeEnum arg2,
gpointer user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg2</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2584550"></a><h3><a name="ECal-categories-changed"></a>The "categories-changed" signal</h3><pre class="programlisting">void user_function (<a href="ECal.html" title="ECal">ECal</a> *ecal,
gpointer arg1,
gpointer user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ecal</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2584626"></a><h2>See Also</h2><p>
<span class="type">e-cal-listener</span>, <span class="type">e-cal-view</span>
</p></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libecal-ECalViewListener.html"><b><<ECalViewListener</b></a></td><td align="right"><a accesskey="n" href="libecal-e-cal-recur.html"><b>e-cal-recur>></b></a></td></tr></table></body></html>
|
