← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libecal/tmpl/e-cal.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-07-27 11:45:30 UTC
  • mfrom: (1.1.90 upstream)
  • Revision ID: james.westby@ubuntu.com-20110727114530-v4ntbu728os68b0b
Tags: 3.1.4-0ubuntu1
* New upstream version.
* debian/patches/999git_EDS_3_1_3_1_to_f94a069.patch: drop, included in
  the upstream 3.1.4 tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libecal/tmpl/e-cal.sgml
1
 
<!-- ##### SECTION Title ##### -->
2
 
ECal
3
 
 
4
 
<!-- ##### SECTION Short_Description ##### -->
5
 
Permits access to a calendar or list of tasks.
6
 
 
7
 
<!-- ##### SECTION Long_Description ##### -->
8
 
<para>
9
 
Represents an entire calendar or task list, not individual items within them.2
10
 
</para>
11
 
 
12
 
<!-- ##### SECTION See_Also ##### -->
13
 
<para>
14
 
#e-cal-listener, #e-cal-view
15
 
</para>
16
 
 
17
 
<!-- ##### SECTION Stability_Level ##### -->
18
 
 
19
 
 
20
 
<!-- ##### SECTION Image ##### -->
21
 
 
22
 
 
23
 
<!-- ##### STRUCT ECal ##### -->
24
 
<para>
25
 
 
26
 
</para>
27
 
 
28
 
 
29
 
<!-- ##### SIGNAL ECal::backend-died ##### -->
30
 
<para>
31
 
 
32
 
</para>
33
 
 
34
 
@ecal: the object which received the signal.
35
 
 
36
 
<!-- ##### SIGNAL ECal::backend-error ##### -->
37
 
<para>
38
 
 
39
 
</para>
40
 
 
41
 
@ecal: the object which received the signal.
42
 
@arg1: 
43
 
 
44
 
<!-- ##### SIGNAL ECal::cal-opened ##### -->
45
 
<para>
46
 
 
47
 
</para>
48
 
 
49
 
@ecal: the object which received the signal.
50
 
@arg1: 
51
 
 
52
 
<!-- ##### SIGNAL ECal::cal-opened-ex ##### -->
53
 
<para>
54
 
 
55
 
</para>
56
 
 
57
 
@ecal: the object which received the signal.
58
 
@arg1: 
59
 
 
60
 
<!-- ##### SIGNAL ECal::cal-set-mode ##### -->
61
 
<para>
62
 
 
63
 
</para>
64
 
 
65
 
@ecal: the object which received the signal.
66
 
@arg1: 
67
 
@arg2: 
68
 
 
69
 
<!-- ##### ENUM ECalSourceType ##### -->
70
 
<para>
71
 
 
72
 
</para>
73
 
 
74
 
@E_CAL_SOURCE_TYPE_EVENT: 
75
 
@E_CAL_SOURCE_TYPE_TODO: 
76
 
@E_CAL_SOURCE_TYPE_JOURNAL: 
77
 
@E_CAL_SOURCE_TYPE_LAST: 
78
 
 
79
 
<!-- ##### ENUM ECalSetModeStatus ##### -->
80
 
<para>
81
 
 
82
 
</para>
83
 
 
84
 
@E_CAL_SET_MODE_SUCCESS: 
85
 
@E_CAL_SET_MODE_ERROR: 
86
 
@E_CAL_SET_MODE_NOT_SUPPORTED: 
87
 
 
88
 
<!-- ##### ENUM ECalLoadState ##### -->
89
 
<para>
90
 
 
91
 
</para>
92
 
 
93
 
@E_CAL_LOAD_NOT_LOADED: 
94
 
@E_CAL_LOAD_AUTHENTICATING: 
95
 
@E_CAL_LOAD_LOADING: 
96
 
@E_CAL_LOAD_LOADED: 
97
 
 
98
 
<!-- ##### ENUM EDataCalMode ##### -->
99
 
<para>
100
 
 
101
 
</para>
102
 
 
103
 
@Local: 
104
 
@Remote: 
105
 
@AnyMode: 
106
 
 
107
 
<!-- ##### USER_FUNCTION ECalAuthFunc ##### -->
108
 
<para>
109
 
 
110
 
</para>
111
 
 
112
 
@ecal: 
113
 
@prompt: 
114
 
@key: 
115
 
@user_data: 
116
 
@Returns: 
117
 
 
118
 
 
119
 
<!-- ##### FUNCTION e_cal_new ##### -->
120
 
<para>
121
 
 
122
 
</para>
123
 
 
124
 
@source: 
125
 
@type: 
126
 
@Returns: 
127
 
 
128
 
 
129
 
<!-- ##### FUNCTION e_cal_new_from_uri ##### -->
130
 
<para>
131
 
 
132
 
</para>
133
 
 
134
 
@uri: 
135
 
@type: 
136
 
@Returns: 
137
 
 
138
 
 
139
 
<!-- ##### FUNCTION e_cal_new_system_calendar ##### -->
140
 
<para>
141
 
 
142
 
</para>
143
 
 
144
 
@void: 
145
 
@Returns: 
146
 
 
147
 
 
148
 
<!-- ##### FUNCTION e_cal_new_system_tasks ##### -->
149
 
<para>
150
 
 
151
 
</para>
152
 
 
153
 
@void: 
154
 
@Returns: 
155
 
 
156
 
 
157
 
<!-- ##### FUNCTION e_cal_new_system_memos ##### -->
158
 
<para>
159
 
 
160
 
</para>
161
 
 
162
 
@void: 
163
 
@Returns: 
164
 
 
165
 
 
166
 
<!-- ##### FUNCTION e_cal_set_auth_func ##### -->
167
 
<para>
168
 
 
169
 
</para>
170
 
 
171
 
@ecal: 
172
 
@func: 
173
 
@data: 
174
 
 
175
 
 
176
 
<!-- ##### FUNCTION e_cal_open ##### -->
177
 
<para>
178
 
 
179
 
</para>
180
 
 
181
 
@ecal: 
182
 
@only_if_exists: 
183
 
@error: 
184
 
@Returns: 
185
 
 
186
 
 
187
 
<!-- ##### FUNCTION e_cal_open_async ##### -->
188
 
<para>
189
 
 
190
 
</para>
191
 
 
192
 
@ecal: 
193
 
@only_if_exists: 
194
 
 
195
 
 
196
 
<!-- ##### FUNCTION e_cal_refresh ##### -->
197
 
<para>
198
 
 
199
 
</para>
200
 
 
201
 
@ecal: 
202
 
@error: 
203
 
@Returns: 
204
 
 
205
 
 
206
 
<!-- ##### FUNCTION e_cal_remove ##### -->
207
 
<para>
208
 
 
209
 
</para>
210
 
 
211
 
@ecal: 
212
 
@error: 
213
 
@Returns: 
214
 
 
215
 
 
216
 
<!-- ##### FUNCTION e_cal_uri_list ##### -->
217
 
<para>
218
 
 
219
 
</para>
220
 
 
221
 
@ecal: 
222
 
@mode: 
223
 
@Returns: 
224
 
 
225
 
 
226
 
<!-- ##### FUNCTION e_cal_get_source_type ##### -->
227
 
<para>
228
 
 
229
 
</para>
230
 
 
231
 
@ecal: 
232
 
@Returns: 
233
 
 
234
 
 
235
 
<!-- ##### FUNCTION e_cal_get_load_state ##### -->
236
 
<para>
237
 
 
238
 
</para>
239
 
 
240
 
@ecal: 
241
 
@Returns: 
242
 
 
243
 
 
244
 
<!-- ##### FUNCTION e_cal_get_source ##### -->
245
 
<para>
246
 
 
247
 
</para>
248
 
 
249
 
@ecal: 
250
 
@Returns: 
251
 
 
252
 
 
253
 
<!-- ##### FUNCTION e_cal_get_uri ##### -->
254
 
<para>
255
 
 
256
 
</para>
257
 
 
258
 
@ecal: 
259
 
@Returns: 
260
 
 
261
 
 
262
 
<!-- ##### FUNCTION e_cal_is_read_only ##### -->
263
 
<para>
264
 
 
265
 
</para>
266
 
 
267
 
@ecal: 
268
 
@read_only: 
269
 
@error: 
270
 
@Returns: 
271
 
 
272
 
 
273
 
<!-- ##### FUNCTION e_cal_get_cal_address ##### -->
274
 
<para>
275
 
 
276
 
</para>
277
 
 
278
 
@ecal: 
279
 
@cal_address: 
280
 
@error: 
281
 
@Returns: 
282
 
 
283
 
 
284
 
<!-- ##### FUNCTION e_cal_get_alarm_email_address ##### -->
285
 
<para>
286
 
 
287
 
</para>
288
 
 
289
 
@ecal: 
290
 
@alarm_address: 
291
 
@error: 
292
 
@Returns: 
293
 
 
294
 
 
295
 
<!-- ##### FUNCTION e_cal_get_ldap_attribute ##### -->
296
 
<para>
297
 
 
298
 
</para>
299
 
 
300
 
@ecal: 
301
 
@ldap_attribute: 
302
 
@error: 
303
 
@Returns: 
304
 
 
305
 
 
306
 
<!-- ##### FUNCTION e_cal_get_one_alarm_only ##### -->
307
 
<para>
308
 
 
309
 
</para>
310
 
 
311
 
@ecal: 
312
 
@Returns: 
313
 
 
314
 
 
315
 
<!-- ##### FUNCTION e_cal_get_organizer_must_attend ##### -->
316
 
<para>
317
 
 
318
 
</para>
319
 
 
320
 
@ecal: 
321
 
@Returns: 
322
 
 
323
 
 
324
 
<!-- ##### FUNCTION e_cal_get_save_schedules ##### -->
325
 
<para>
326
 
 
327
 
</para>
328
 
 
329
 
@ecal: 
330
 
@Returns: 
331
 
 
332
 
 
333
 
<!-- ##### FUNCTION e_cal_get_static_capability ##### -->
334
 
<para>
335
 
 
336
 
</para>
337
 
 
338
 
@ecal: 
339
 
@cap: 
340
 
@Returns: 
341
 
 
342
 
 
343
 
<!-- ##### FUNCTION e_cal_get_organizer_must_accept ##### -->
344
 
<para>
345
 
 
346
 
</para>
347
 
 
348
 
@ecal: 
349
 
@Returns: 
350
 
 
351
 
 
352
 
<!-- ##### FUNCTION e_cal_get_refresh_supported ##### -->
353
 
<para>
354
 
 
355
 
</para>
356
 
 
357
 
@ecal: 
358
 
@Returns: 
359
 
 
360
 
 
361
 
<!-- ##### FUNCTION e_cal_set_mode ##### -->
362
 
<para>
363
 
 
364
 
</para>
365
 
 
366
 
@ecal: 
367
 
@mode: 
368
 
@Returns: 
369
 
 
370
 
 
371
 
<!-- ##### FUNCTION e_cal_get_default_object ##### -->
372
 
<para>
373
 
 
374
 
</para>
375
 
 
376
 
@ecal: 
377
 
@icalcomp: 
378
 
@error: 
379
 
@Returns: 
380
 
 
381
 
 
382
 
<!-- ##### FUNCTION e_cal_get_object ##### -->
383
 
<para>
384
 
 
385
 
</para>
386
 
 
387
 
@ecal: 
388
 
@uid: 
389
 
@rid: 
390
 
@icalcomp: 
391
 
@error: 
392
 
@Returns: 
393
 
 
394
 
 
395
 
<!-- ##### FUNCTION e_cal_get_objects_for_uid ##### -->
396
 
<para>
397
 
 
398
 
</para>
399
 
 
400
 
@ecal: 
401
 
@uid: 
402
 
@objects: 
403
 
@error: 
404
 
@Returns: 
405
 
 
406
 
 
407
 
<!-- ##### FUNCTION e_cal_get_changes ##### -->
408
 
<para>
409
 
 
410
 
</para>
411
 
 
412
 
@ecal: 
413
 
@change_id: 
414
 
@changes: 
415
 
@error: 
416
 
@Returns: 
417
 
 
418
 
 
419
 
<!-- ##### FUNCTION e_cal_free_change_list ##### -->
420
 
<para>
421
 
 
422
 
</para>
423
 
 
424
 
@list: 
425
 
 
426
 
 
427
 
<!-- ##### FUNCTION e_cal_get_object_list ##### -->
428
 
<para>
429
 
 
430
 
</para>
431
 
 
432
 
@ecal: 
433
 
@query: 
434
 
@objects: 
435
 
@error: 
436
 
@Returns: 
437
 
 
438
 
 
439
 
<!-- ##### FUNCTION e_cal_get_object_list_as_comp ##### -->
440
 
<para>
441
 
 
442
 
</para>
443
 
 
444
 
@ecal: 
445
 
@query: 
446
 
@objects: 
447
 
@error: 
448
 
@Returns: 
449
 
 
450
 
 
451
 
<!-- ##### FUNCTION e_cal_free_object_list ##### -->
452
 
<para>
453
 
 
454
 
</para>
455
 
 
456
 
@objects: 
457
 
 
458
 
 
459
 
<!-- ##### FUNCTION e_cal_get_free_busy ##### -->
460
 
<para>
461
 
 
462
 
</para>
463
 
 
464
 
@ecal: 
465
 
@users: 
466
 
@start: 
467
 
@end: 
468
 
@freebusy: 
469
 
@error: 
470
 
@Returns: 
471
 
 
472
 
 
473
 
<!-- ##### FUNCTION e_cal_generate_instances ##### -->
474
 
<para>
475
 
 
476
 
</para>
477
 
 
478
 
@ecal: 
479
 
@start: 
480
 
@end: 
481
 
@cb: 
482
 
@cb_data: 
483
 
 
484
 
 
485
 
<!-- ##### FUNCTION e_cal_generate_instances_for_object ##### -->
486
 
<para>
487
 
 
488
 
</para>
489
 
 
490
 
@ecal: 
491
 
@icalcomp: 
492
 
@start: 
493
 
@end: 
494
 
@cb: 
495
 
@cb_data: 
496
 
 
497
 
 
498
 
<!-- ##### FUNCTION e_cal_get_alarms_in_range ##### -->
499
 
<para>
500
 
 
501
 
</para>
502
 
 
503
 
@ecal: 
504
 
@start: 
505
 
@end: 
506
 
@Returns: 
507
 
 
508
 
 
509
 
<!-- ##### FUNCTION e_cal_free_alarms ##### -->
510
 
<para>
511
 
 
512
 
</para>
513
 
 
514
 
@comp_alarms: 
515
 
 
516
 
 
517
 
<!-- ##### FUNCTION e_cal_get_alarms_for_object ##### -->
518
 
<para>
519
 
 
520
 
</para>
521
 
 
522
 
@ecal: 
523
 
@id: 
524
 
@start: 
525
 
@end: 
526
 
@alarms: 
527
 
@Returns: 
528
 
 
529
 
 
530
 
<!-- ##### FUNCTION e_cal_create_object ##### -->
531
 
<para>
532
 
 
533
 
</para>
534
 
 
535
 
@ecal: 
536
 
@icalcomp: 
537
 
@uid: 
538
 
@error: 
539
 
@Returns: 
540
 
 
541
 
 
542
 
<!-- ##### FUNCTION e_cal_modify_object ##### -->
543
 
<para>
544
 
 
545
 
</para>
546
 
 
547
 
@ecal: 
548
 
@icalcomp: 
549
 
@mod: 
550
 
@error: 
551
 
@Returns: 
552
 
 
553
 
 
554
 
<!-- ##### FUNCTION e_cal_remove_object ##### -->
555
 
<para>
556
 
 
557
 
</para>
558
 
 
559
 
@ecal: 
560
 
@uid: 
561
 
@error: 
562
 
@Returns: 
563
 
 
564
 
 
565
 
<!-- ##### FUNCTION e_cal_remove_object_with_mod ##### -->
566
 
<para>
567
 
 
568
 
</para>
569
 
 
570
 
@ecal: 
571
 
@uid: 
572
 
@rid: 
573
 
@mod: 
574
 
@error: 
575
 
@Returns: 
576
 
 
577
 
 
578
 
<!-- ##### FUNCTION e_cal_discard_alarm ##### -->
579
 
<para>
580
 
 
581
 
</para>
582
 
 
583
 
@ecal: 
584
 
@comp: 
585
 
@auid: 
586
 
@error: 
587
 
@Returns: 
588
 
 
589
 
 
590
 
<!-- ##### FUNCTION e_cal_receive_objects ##### -->
591
 
<para>
592
 
 
593
 
</para>
594
 
 
595
 
@ecal: 
596
 
@icalcomp: 
597
 
@error: 
598
 
@Returns: 
599
 
 
600
 
 
601
 
<!-- ##### FUNCTION e_cal_send_objects ##### -->
602
 
<para>
603
 
 
604
 
</para>
605
 
 
606
 
@ecal: 
607
 
@icalcomp: 
608
 
@users: 
609
 
@modified_icalcomp: 
610
 
@error: 
611
 
@Returns: 
612
 
 
613
 
 
614
 
<!-- ##### FUNCTION e_cal_get_timezone ##### -->
615
 
<para>
616
 
 
617
 
</para>
618
 
 
619
 
@ecal: 
620
 
@tzid: 
621
 
@zone: 
622
 
@error: 
623
 
@Returns: 
624
 
 
625
 
 
626
 
<!-- ##### FUNCTION e_cal_add_timezone ##### -->
627
 
<para>
628
 
 
629
 
</para>
630
 
 
631
 
@ecal: 
632
 
@izone: 
633
 
@error: 
634
 
@Returns: 
635
 
 
636
 
 
637
 
<!-- ##### FUNCTION e_cal_set_default_timezone ##### -->
638
 
<para>
639
 
 
640
 
</para>
641
 
 
642
 
@ecal: 
643
 
@zone: 
644
 
@error: 
645
 
@Returns: 
646
 
 
647
 
 
648
 
<!-- ##### FUNCTION e_cal_get_query ##### -->
649
 
<para>
650
 
 
651
 
</para>
652
 
 
653
 
@ecal: 
654
 
@sexp: 
655
 
@query: 
656
 
@error: 
657
 
@Returns: 
658
 
 
659
 
 
660
 
<!-- ##### FUNCTION e_cal_resolve_tzid_cb ##### -->
661
 
<para>
662
 
 
663
 
</para>
664
 
 
665
 
@tzid: 
666
 
@data: 
667
 
@Returns: 
668
 
 
669
 
 
670
 
<!-- ##### FUNCTION e_cal_get_component_as_string ##### -->
671
 
<para>
672
 
 
673
 
</para>
674
 
 
675
 
@ecal: 
676
 
@icalcomp: 
677
 
@Returns: 
678
 
 
679
 
 
680
 
<!-- ##### FUNCTION e_cal_get_error_message ##### -->
681
 
<para>
682
 
 
683
 
</para>
684
 
 
685
 
@status: 
686
 
@Returns: 
687
 
 
688
 
 
689
 
<!-- ##### FUNCTION e_cal_open_default ##### -->
690
 
<para>
691
 
 
692
 
</para>
693
 
 
694
 
@ecal: 
695
 
@type: 
696
 
@func: 
697
 
@data: 
698
 
@error: 
699
 
@Returns: 
700
 
 
701
 
 
702
 
<!-- ##### FUNCTION e_cal_set_default ##### -->
703
 
<para>
704
 
 
705
 
</para>
706
 
 
707
 
@ecal: 
708
 
@error: 
709
 
@Returns: 
710
 
 
711
 
 
712
 
<!-- ##### FUNCTION e_cal_set_default_source ##### -->
713
 
<para>
714
 
 
715
 
</para>
716
 
 
717
 
@source: 
718
 
@type: 
719
 
@error: 
720
 
@Returns: 
721
 
 
722
 
 
723
 
<!-- ##### FUNCTION e_cal_get_sources ##### -->
724
 
<para>
725
 
 
726
 
</para>
727
 
 
728
 
@sources: 
729
 
@type: 
730
 
@error: 
731
 
@Returns: 
732
 
 
733
 
 
734
 
<!-- ##### FUNCTION e_cal_get_local_attachment_store ##### -->
735
 
<para>
736
 
 
737
 
</para>
738
 
 
739
 
@ecal: 
740
 
@Returns: 
741
 
 
742
 
 
743
 
<!-- ##### FUNCTION e_cal_get_recurrences_no_master ##### -->
744
 
<para>
745
 
 
746
 
</para>
747
 
 
748
 
@ecal: 
749
 
@Returns: 
750
 
 
751
 
 
752
 
<!-- ##### FUNCTION e_cal_get_attachments_for_comp ##### -->
753
 
<para>
754
 
 
755
 
</para>
756
 
 
757
 
@ecal: 
758
 
@uid: 
759
 
@rid: 
760
 
@list: 
761
 
@error: 
762
 
@Returns: 
763
 
 
764