aboutsummaryrefslogtreecommitdiffstats
path: root/doc/devel/calendar/cal-util/tmpl/cal-component.sgml
blob: 2f800e583fff127e28906542ca9bb91b604effbc (plain) (blame)
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
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
<!-- ##### SECTION Title ##### -->
CalComponent

<!-- ##### SECTION Short_Description ##### -->
RFC 2445 iCalendar component object.

<!-- ##### SECTION Long_Description ##### -->
  <para>
    The #CalComponent object provides a wrapper over the &libical;
    functions for manipulating calendar components.  #CalComponent
    presents a GTK+-like interface to calendar components according to
    RFC 2445.
  </para>

  <para>
    While &libical; supports almost all of the features of the
    iCalendar RFCs, applications are normally not interested in all
    the mindless gunk that is there.  Still, applications should do
    their best not to drop extension fields from calendar components
    or any other extra information they do not support (including
    standard fields they are not interested in).  The #CalComponent
    object provides a wrapper over
    <structname>icalcomponent</structname> structures from &libical;
    so that no information in them will be lost even if the
    application is not designed to handle it.  Also, #CalComponent
    provides a higher-level API to many of the &libical; operations so
    as to make it less painful to deal with iCalendar components.
  </para>

  <para>
    A #CalComponent object starts out empty.  It must be initialized
    from an existing <structname>icalcomponent</structname> structure
    by using the cal_component_set_icalcomponent() function, or from a
    completely new data by specifying the desired component type to
    the cal_component_set_new_vtype() function.
  </para>

  <para>
    #CalComponent will create an internal map of the properties in the
    <structname>icalcomponent</structname> structure and then allow
    random access to them via the #CalComponent API functions;
    normally the &libical; API would have to be used by creating many
    iterators and other unpleasant constructs.  #CalComponent keeps
    handles to the properties it scanned from the
    <structname>icalcomponent</structname> and will let the parent
    application modify them at any time without having to do any
    iteration.
  </para>

  <para>
    Eventually a #CalComponent may be turned into the RFC 2445 string
    representation of an iCalendar component by using the
    cal_component_get_as_string() function.  Applications can then
    transfer this interoperable
    <footnote>
      <para>
    &ldquo;Interoperable.&rdquo;  Heavens, I love that word.
      </para>
    </footnote>
    string to other programs that deal with iCalendar.
  </para>

<!-- ##### SECTION See_Also ##### -->
  <para>

  </para>

<!-- ##### MACRO CAL_COMPONENT ##### -->
  <para>
    Casts a #GtkObject to a #CalComponent.
  </para>

@obj: A GTK+ object.


<!-- ##### ENUM CalComponentVType ##### -->
  <para>
    Calendar component types as defined by RFC 2445.  These values can
    be used to create a new calendar component by passing them to the
    cal_component_set_new_vtype() function.  They are also the return
    value of the cal_component_get_vtype() function.  The only time
    the @CAL_COMPONENT_NO_TYPE value is used is when querying the
    vtype of an uninitialized #CalComponent.
  </para>

@CAL_COMPONENT_NO_TYPE: Returned from cal_component_get_vtype() to
  indicate an uninitialized #CalComponent object.

@CAL_COMPONENT_EVENT: Indicates a VEVENT component.
@CAL_COMPONENT_TODO: Indicates a VTODO component.
@CAL_COMPONENT_JOURNAL: Indicates a VJOURNAL component.
@CAL_COMPONENT_FREEBUSY: Indicates a VFREEBUSY component.
@CAL_COMPONENT_TIMEZONE: Indicates a VTIMEZOME component.

<!-- ##### ENUM CalComponentField ##### -->
  <para>
    These values are used as identifiers for #ETable columns.  These
    are used by the calendar GUI code in Evolution.
  </para>

@CAL_COMPONENT_FIELD_CATEGORIES: Component's list of categories.
@CAL_COMPONENT_FIELD_CLASSIFICATION: Component's classification.
@CAL_COMPONENT_FIELD_COMPLETED: Component's completion date.
@CAL_COMPONENT_FIELD_DTEND: Component's ending date.
@CAL_COMPONENT_FIELD_DTSTART: Component's starting date.
@CAL_COMPONENT_FIELD_DUE: Component's due date.
@CAL_COMPONENT_FIELD_GEO: Component's geographical position.
@CAL_COMPONENT_FIELD_PERCENT: Component's percent completed value.
@CAL_COMPONENT_FIELD_PRIORITY: Component's priority.
@CAL_COMPONENT_FIELD_SUMMARY: Component's summary.
@CAL_COMPONENT_FIELD_TRANSPARENCY: Component's transparency value.
@CAL_COMPONENT_FIELD_URL: Component's URL.
@CAL_COMPONENT_FIELD_HAS_ALARMS: Whether the component has any alarms.
@CAL_COMPONENT_FIELD_ICON: Which icon to use for the component.
@CAL_COMPONENT_FIELD_COMPLETE: Whether the component has been completed.
@CAL_COMPONENT_FIELD_RECURRING: Whether the component has any recurrences.
@CAL_COMPONENT_FIELD_OVERDUE: Whether the component is overdue.
@CAL_COMPONENT_FIELD_COLOR: Which color to use for the component.
@CAL_COMPONENT_FIELD_NUM_FIELDS: Total number of enumerated fields.

<!-- ##### ENUM CalComponentClassification ##### -->
  <para>
    Values for the access classification property of a calendar
    component.
  </para>

@CAL_COMPONENT_CLASS_NONE: Indicates that no access classification has
    been set for the corresponding component.

@CAL_COMPONENT_CLASS_PUBLIC: Public access.
@CAL_COMPONENT_CLASS_PRIVATE: Private access.
@CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential access.

@CAL_COMPONENT_CLASS_UNKNOWN: Unknown access classification value,
  used when &libical; returns something #CalComponent does not know
  about.

<!-- ##### TYPEDEF CalComponentDateTime ##### -->
  <para>
    This structure defines a date and time value.
  </para>


<!-- ##### ENUM CalComponentPeriodType ##### -->
  <para>
    Defines how a period of time is specified.
  </para>

@CAL_COMPONENT_PERIOD_DATETIME: Indicates that the period is specified
  by starting and ending date/time values.

@CAL_COMPONENT_PERIOD_DURATION: Indicates that the period is specified
  as a starding date/time and a duration value.

<!-- ##### TYPEDEF CalComponentPeriod ##### -->
  <para>
    This structure defines a period of time.
  </para>


<!-- ##### TYPEDEF CalComponentText ##### -->
  <para>
    This structure defines the value of a text property that may have
    an alternate representation parameter.
  </para>


<!-- ##### ENUM CalComponentTransparency ##### -->
<para>

</para>

@CAL_COMPONENT_TRANSP_NONE: 
@CAL_COMPONENT_TRANSP_TRANSPARENT: 
@CAL_COMPONENT_TRANSP_OPAQUE: 
@CAL_COMPONENT_TRANSP_UNKNOWN: 

<!-- ##### STRUCT CalComponentAlarm ##### -->
<para>

</para>


<!-- ##### STRUCT CalComponentPrivate ##### -->
<para>

</para>


<!-- ##### FUNCTION cal_component_gen_uid ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION cal_component_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION cal_component_clone ##### -->
<para>

</para>

@comp: 
@Returns: 


<!-- ##### FUNCTION cal_component_set_new_vtype ##### -->
<para>

</para>

@comp: 
@type: 


<!-- ##### FUNCTION cal_component_set_icalcomponent ##### -->
<para>

</para>

@comp: 
@icalcomp: 
@Returns: 


<!-- ##### FUNCTION cal_component_get_icalcomponent ##### -->
<para>

</para>

@comp: 
@Returns: 


<!-- ##### FUNCTION cal_component_get_vtype ##### -->
<para>

</para>

@comp: 
@Returns: 


<!-- ##### FUNCTION cal_component_get_as_string ##### -->
<para>

</para>

@comp: 
@Returns: 


<!-- ##### FUNCTION cal_component_commit_sequence ##### -->
<para>

</para>

@comp: 


<!-- ##### FUNCTION cal_component_get_uid ##### -->
<para>

</para>

@comp: 
@uid: 


<!-- ##### FUNCTION cal_component_set_uid ##### -->
<para>

</para>

@comp: 
@uid: 


<!-- ##### FUNCTION cal_component_get_categories_list ##### -->
<para>

</para>

@comp: 
@categ_list: 


<!-- ##### FUNCTION cal_component_set_categories_list ##### -->
<para>

</para>

@comp: 
@categ_list: 


<!-- ##### FUNCTION cal_component_get_classification ##### -->
<para>

</para>

@comp: 
@classif: 


<!-- ##### FUNCTION cal_component_set_classification ##### -->
<para>

</para>

@comp: 
@classif: 


<!-- ##### FUNCTION cal_component_get_comment_list ##### -->
<para>

</para>

@comp: 
@text_list: 


<!-- ##### FUNCTION cal_component_set_comment_list ##### -->
<para>

</para>

@comp: 
@text_list: 


<!-- ##### FUNCTION cal_component_get_completed ##### -->
<para>

</para>

@comp: 
@t: 


<!-- ##### FUNCTION cal_component_set_completed ##### -->
<para>

</para>

@comp: 
@t: 


<!-- ##### FUNCTION cal_component_get_created ##### -->
<para>

</para>

@comp: 
@t: 


<!-- ##### FUNCTION cal_component_set_created ##### -->
<para>

</para>

@comp: 
@t: 


<!-- ##### FUNCTION cal_component_get_description_list ##### -->
<para>

</para>

@comp: 
@text_list: 


<!-- ##### FUNCTION cal_component_set_description_list ##### -->
<para>

</para>

@comp: 
@text_list: 


<!-- ##### FUNCTION cal_component_get_dtend ##### -->
<para>

</para>

@comp: 
@dt: 


<!-- ##### FUNCTION cal_component_set_dtend ##### -->
<para>

</para>

@comp: 
@dt: 


<!-- ##### FUNCTION cal_component_get_dtstamp ##### -->
<para>

</para>

@comp: 
@t: 


<!-- ##### FUNCTION cal_component_set_dtstamp ##### -->
<para>

</para>

@comp: 
@t: 


<!-- ##### FUNCTION cal_component_get_dtstart ##### -->
<para>

</para>

@comp: 
@dt: 


<!-- ##### FUNCTION cal_component_set_dtstart ##### -->
<para>

</para>

@comp: 
@dt: 


<!-- ##### FUNCTION cal_component_get_due ##### -->
<para>

</para>

@comp: 
@dt: 


<!-- ##### FUNCTION cal_component_set_due ##### -->
<para>

</para>

@comp: 
@dt: 


<!-- ##### FUNCTION cal_component_get_exdate_list ##### -->
<para>

</para>

@comp: 
@exdate_list: 


<!-- ##### FUNCTION cal_component_set_exdate_list ##### -->
<para>

</para>

@comp: 
@exdate_list: 


<!-- ##### FUNCTION cal_component_get_exrule_list ##### -->
<para>

</para>

@comp: 
@recur_list: 


<!-- ##### FUNCTION cal_component_set_exrule_list ##### -->
<para>

</para>

@comp: 
@recur_list: 


<!-- ##### FUNCTION cal_component_get_geo ##### -->
<para>

</para>

@comp: 
@geo: 


<!-- ##### FUNCTION cal_component_set_geo ##### -->
<para>

</para>

@comp: 
@geo: 


<!-- ##### FUNCTION cal_component_get_last_modified ##### -->
<para>

</para>

@comp: 
@t: 


<!-- ##### FUNCTION cal_component_set_last_modified ##### -->
<para>

</para>

@comp: 
@t: 


<!-- ##### FUNCTION cal_component_get_percent ##### -->
<para>

</para>

@comp: 
@percent: 


<!-- ##### FUNCTION cal_component_set_percent ##### -->
<para>

</para>

@comp: 
@percent: 


<!-- ##### FUNCTION cal_component_get_priority ##### -->
<para>

</para>

@comp: 
@priority: 


<!-- ##### FUNCTION cal_component_set_priority ##### -->
<para>

</para>

@comp: 
@priority: 


<!-- ##### FUNCTION cal_component_get_rdate_list ##### -->
<para>

</para>

@comp: 
@period_list: 


<!-- ##### FUNCTION cal_component_set_rdate_list ##### -->
<para>

</para>

@comp: 
@period_list: 


<!-- ##### FUNCTION cal_component_has_rdates ##### -->
<para>

</para>

@comp: 
@Returns: 


<!-- ##### FUNCTION cal_component_get_rrule_list ##### -->
<para>

</para>

@comp: 
@recur_list: 


<!-- ##### FUNCTION cal_component_set_rrule_list ##### -->
<para>

</para>

@comp: 
@recur_list: 


<!-- ##### FUNCTION cal_component_has_rrules ##### -->
<para>

</para>

@comp: 
@Returns: 


<!-- ##### FUNCTION cal_component_get_sequence ##### -->
<para>

</para>

@comp: 
@sequence: 


<!-- ##### FUNCTION cal_component_set_sequence ##### -->
<para>

</para>

@comp: 
@sequence: 


<!-- ##### FUNCTION cal_component_get_summary ##### -->
<para>

</para>

@comp: 
@summary: 


<!-- ##### FUNCTION cal_component_set_summary ##### -->
<para>

</para>

@comp: 
@summary: 


<!-- ##### FUNCTION cal_component_get_transparency ##### -->
<para>

</para>

@comp: 
@transp: 


<!-- ##### FUNCTION cal_component_set_transparency ##### -->
<para>

</para>

@comp: 
@transp: 


<!-- ##### FUNCTION cal_component_get_url ##### -->
<para>

</para>

@comp: 
@url: 


<!-- ##### FUNCTION cal_component_set_url ##### -->
<para>

</para>

@comp: 
@url: 


<!-- ##### FUNCTION cal_component_get_pilot_id ##### -->
<para>

</para>

@comp: 
@pilot_id: 


<!-- ##### FUNCTION cal_component_set_pilot_id ##### -->
<para>

</para>

@comp: 
@pilot_id: 


<!-- ##### FUNCTION cal_component_get_pilot_status ##### -->
<para>

</para>

@comp: 
@pilot_status: 


<!-- ##### FUNCTION cal_component_set_pilot_status ##### -->
<para>

</para>

@comp: 
@pilot_status: 


<!-- ##### FUNCTION cal_component_free_categories_list ##### -->
<para>

</para>

@categ_list: 


<!-- ##### FUNCTION cal_component_free_datetime ##### -->
<para>

</para>

@dt: 


<!-- ##### FUNCTION cal_component_free_exdate_list ##### -->
<para>

</para>

@exdate_list: 


<!-- ##### FUNCTION cal_component_free_geo ##### -->
<para>

</para>

@geo: 


<!-- ##### FUNCTION cal_component_free_icaltimetype ##### -->
<para>

</para>

@t: 


<!-- ##### FUNCTION cal_component_free_percent ##### -->
<para>

</para>

@percent: 


<!-- ##### FUNCTION cal_component_free_priority ##### -->
<para>

</para>

@priority: 


<!-- ##### FUNCTION cal_component_free_period_list ##### -->
<para>

</para>

@period_list: 


<!-- ##### FUNCTION cal_component_free_recur_list ##### -->
<para>

</para>

@recur_list: 


<!-- ##### FUNCTION cal_component_free_sequence ##### -->
<para>

</para>

@sequence: 


<!-- ##### FUNCTION cal_component_free_text_list ##### -->
<para>

</para>

@text_list: 


<!-- ##### ENUM CalComponentAlarmAction ##### -->
<para>

</para>

@CAL_COMPONENT_ALARM_NONE: 
@CAL_COMPONENT_ALARM_AUDIO: 
@CAL_COMPONENT_ALARM_DISPLAY: 
@CAL_COMPONENT_ALARM_EMAIL: 
@CAL_COMPONENT_ALARM_PROCEDURE: 
@CAL_COMPONENT_ALARM_UNKNOWN: 

<!-- ##### ENUM CalComponentAlarmTriggerType ##### -->
<para>

</para>

@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: 
@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: 

<!-- ##### ENUM CalComponentAlarmTriggerRelated ##### -->
<para>

</para>

@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: 
@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: 

<!-- ##### TYPEDEF CalComponentAlarmTrigger ##### -->
<para>

</para>


<!-- ##### FUNCTION cal_component_get_first_alarm ##### -->
<para>

</para>

@comp: 
@Returns: 


<!-- ##### FUNCTION cal_component_get_next_alarm ##### -->
<para>

</para>

@comp: 
@Returns: 


<!-- ##### FUNCTION cal_component_alarm_free ##### -->
<para>

</para>

@alarm: 


<!-- ##### FUNCTION cal_component_alarm_get_action ##### -->
<para>

</para>

@alarm: 
@action: 


<!-- ##### FUNCTION cal_component_alarm_set_action ##### -->
<para>

</para>

@alarm: 
@action: 


<!-- ##### FUNCTION cal_component_alarm_get_trigger ##### -->
<para>

</para>

@alarm: 
@trigger: 


<!-- ##### FUNCTION cal_component_alarm_set_trigger ##### -->
<para>

</para>

@alarm: 
@trigger: 


<!-- ##### FUNCTION cal_component_alarm_free_trigger ##### -->
<para>

</para>

@trigger: 


<!--
Local variables:
mode: sgml
sgml-parent-document: ("../../../evolution-devel-guide.sgml" "book" "refsect2" "")
End:
-->