← Back to branch summary

~ubuntu-branches/ubuntu/breezy/evolution-data-server/breezy

« back to all changes in this revision

Viewing changes to docs/reference/calendar/libecal/xml/e-cal-component.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-10-10 11:30:56 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20051010113056-rb4vj4kbs8yxft85
Tags: 1.4.1-0ubuntu3
* debian/patches/camel-imap-store.c.patch:
  - Ubuntu 17465: apply patch from
  http://bugzilla.gnome.org/attachment.cgi?id=53234&action=view
  (additional NULL pointer check)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libecal/xml/e-cal-component.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="ECalComponent">
5
5
<refmeta>
6
 
<refentrytitle>ECalComponent</refentrytitle>
 
6
<refentrytitle id="top_of_page">ECalComponent</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBECAL Library</refmiscinfo>
9
9
</refmeta>
10
10
 
11
11
<refnamediv>
12
 
<refname>ECalComponent</refname><refpurpose>Typically an appointment or task, part of the ECal object.</refpurpose>
 
12
<refname>ECalComponent</refname>
 
13
<refpurpose></refpurpose>
 
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
13
15
</refnamediv>
14
16
 
15
 
<refsynopsisdiv><title>Synopsis</title>
 
17
<refsynopsisdiv id="synopsis">
 
18
<title id="synopsis.title">Synopsis</title>
16
19
 
17
20
<synopsis>
18
21
 
292
295
</synopsis>
293
296
</refsynopsisdiv>
294
297
 
295
 
<refsect1>
296
 
<title>Object Hierarchy</title>
 
298
<refsect1 id="object_hierarchy">
 
299
<title id="object_hierarchy.title">Object Hierarchy</title>
297
300
<synopsis>
298
301
 
299
302
  <link linkend="GObject">GObject</link>
309
312
 
310
313
 
311
314
 
312
 
<refsect1>
313
 
<title>Description</title>
 
315
<refsect1 id="desc">
 
316
<title id="desc.title">Description</title>
314
317
<para>
315
318
 
316
319
</para>
317
320
</refsect1>
318
321
 
319
 
<refsect1>
320
 
<title>Details</title>
 
322
<refsect1 id="details">
 
323
<title id="details.title">Details</title>
321
324
<refsect2>
322
325
<title><anchor id="ECalComponent-struct"/>ECalComponent</title>
323
326
<indexterm><primary>ECalComponent</primary></indexterm><programlisting>typedef struct _ECalComponent ECalComponent;</programlisting>
379
382
} ECalComponentClassification;
380
383
</programlisting>
381
384
<para>
382
 
These values determine the privacy classification of the event.
 
385
 
383
386
</para></refsect2>
384
387
<refsect2>
385
388
<title><anchor id="ECalComponentDateTime"/>ECalComponentDateTime</title>
516
519
<title><anchor id="e-cal-component-new"/>e_cal_component_new ()</title>
517
520
<indexterm><primary>e_cal_component_new</primary></indexterm><programlisting><link linkend="ECalComponent">ECalComponent</link>* e_cal_component_new          (void);</programlisting>
518
521
<para>
519
 
Creates a new empty calendar component object.  You should set it from an
520
 
<link linkend="icalcomponent"><type>icalcomponent</type></link> structure by using <link linkend="e-cal-component-set-icalcomponent"><function>e_cal_component_set_icalcomponent()</function></link> or with a
 
522
Creates a new empty calendar component object.  Once created, you should set it from an
 
523
existing <link linkend="icalcomponent"><type>icalcomponent</type></link> structure by using <link linkend="e-cal-component-set-icalcomponent"><function>e_cal_component_set_icalcomponent()</function></link> or with a
521
524
new empty component type by using <link linkend="e-cal-component-set-new-vtype"><function>e_cal_component_set_new_vtype()</function></link>.</para>
522
525
<para>
523
526
 
606
609
<title><anchor id="e-cal-component-rescan"/>e_cal_component_rescan ()</title>
607
610
<indexterm><primary>e_cal_component_rescan</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_rescan          (<link linkend="ECalComponent">ECalComponent</link> *comp);</programlisting>
608
611
<para>
 
612
Rescans the <link linkend="icalcomponent"><type>icalcomponent</type></link> being wrapped by the given calendar component. This
 
613
would replace any value that was changed in the wrapped <link linkend="icalcomponent"><type>icalcomponent</type></link>.</para>
 
614
<para>
609
615
 
610
616
</para><variablelist role="params">
611
617
<varlistentry><term><parameter>comp</parameter>&nbsp;:</term>
612
 
<listitem><simpara>
613
 
 
614
 
 
 
618
<listitem><simpara> A calendar component object.
615
619
</simpara></listitem></varlistentry>
616
620
</variablelist></refsect2>
617
621
<refsect2>
618
622
<title><anchor id="e-cal-component-strip-errors"/>e_cal_component_strip_errors ()</title>
619
623
<indexterm><primary>e_cal_component_strip_errors</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_strip_errors    (<link linkend="ECalComponent">ECalComponent</link> *comp);</programlisting>
620
624
<para>
 
625
Strips all error messages from the calendar component. Those error messages are
 
626
added to the iCalendar string representation whenever an invalid is used for
 
627
one of its fields.</para>
 
628
<para>
621
629
 
622
630
</para><variablelist role="params">
623
631
<varlistentry><term><parameter>comp</parameter>&nbsp;:</term>
624
 
<listitem><simpara>
625
 
 
626
 
 
 
632
<listitem><simpara> A calendar component object.
627
633
</simpara></listitem></varlistentry>
628
634
</variablelist></refsect2>
629
635
<refsect2>
673
679
 
674
680
</para><variablelist role="params">
675
681
<varlistentry><term><parameter>comp</parameter>&nbsp;:</term>
676
 
<listitem><simpara>
 
682
<listitem><simpara> A calendar component object.
677
683
</simpara></listitem></varlistentry>
678
684
</variablelist></refsect2>
679
685
<refsect2>
680
686
<title><anchor id="e-cal-component-abort-sequence"/>e_cal_component_abort_sequence ()</title>
681
687
<indexterm><primary>e_cal_component_abort_sequence</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_abort_sequence  (<link linkend="ECalComponent">ECalComponent</link> *comp);</programlisting>
682
688
<para>
 
689
Aborts the sequence change needed in the given calendar component, which
 
690
means it will not require a sequence commit (via <link linkend="e-cal-component-commit-sequence"><type>e_cal_component_commit_sequence</type></link>)
 
691
even if the changes done require a sequence increment.</para>
 
692
<para>
683
693
 
684
694
</para><variablelist role="params">
685
695
<varlistentry><term><parameter>comp</parameter>&nbsp;:</term>
686
 
<listitem><simpara>
687
 
 
688
 
 
 
696
<listitem><simpara> A calendar component object.
689
697
</simpara></listitem></varlistentry>
690
698
</variablelist></refsect2>
691
699
<refsect2>
725
733
<indexterm><primary>e_cal_component_get_categories</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_get_categories  (<link linkend="ECalComponent">ECalComponent</link> *comp,
726
734
                                             const <link linkend="char">char</link> **categories);</programlisting>
727
735
<para>
728
 
</para>
 
736
Queries the categories of the given calendar component. The categories
 
737
are returned in the <parameter>categories</parameter> argument, which, on success, will contain
 
738
a comma-separated list of all categories set in the component.</para>
729
739
<para>
730
740
 
731
741
</para><variablelist role="params">
733
743
<listitem><simpara> A calendar component object.
734
744
</simpara></listitem></varlistentry>
735
745
<varlistentry><term><parameter>categories</parameter>&nbsp;:</term>
736
 
<listitem><simpara>
 
746
<listitem><simpara> Return holder for the categories.
737
747
</simpara></listitem></varlistentry>
738
748
</variablelist></refsect2>
739
749
<refsect2>
741
751
<indexterm><primary>e_cal_component_set_categories</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_set_categories  (<link linkend="ECalComponent">ECalComponent</link> *comp,
742
752
                                             const <link linkend="char">char</link> *categories);</programlisting>
743
753
<para>
744
 
</para>
 
754
Sets the list of categories for a calendar component.</para>
745
755
<para>
746
756
 
747
757
</para><variablelist role="params">
749
759
<listitem><simpara> A calendar component object.
750
760
</simpara></listitem></varlistentry>
751
761
<varlistentry><term><parameter>categories</parameter>&nbsp;:</term>
752
 
<listitem><simpara>
 
762
<listitem><simpara> Comma-separated list of categories.
753
763
</simpara></listitem></varlistentry>
754
764
</variablelist></refsect2>
755
765
<refsect2>
768
778
</simpara></listitem></varlistentry>
769
779
<varlistentry><term><parameter>categ_list</parameter>&nbsp;:</term>
770
780
<listitem><simpara> Return value for the list of strings, where each string is a
771
 
category.  This should be freed using <link linkend="e-cal-component-free-categories-list"><function>e_cal_component_free_categories_list()</function></link>.
 
781
category. This should be freed using <link linkend="e-cal-component-free-categories-list"><function>e_cal_component_free_categories_list()</function></link>.
772
782
</simpara></listitem></varlistentry>
773
783
</variablelist></refsect2>
774
784
<refsect2>
831
841
                                            (<link linkend="ECalComponent">ECalComponent</link> *comp,
832
842
                                             <link linkend="GSList">GSList</link> **text_list);</programlisting>
833
843
<para>
834
 
Queries the comment of a calendar component object.  The comment property can
 
844
Queries the comments of a calendar component object.  The comment property can
835
845
appear several times inside a calendar component, and so a list of
836
846
<link linkend="ECalComponentText"><type>ECalComponentText</type></link> is returned.</para>
837
847
<para>
852
862
                                            (<link linkend="ECalComponent">ECalComponent</link> *comp,
853
863
                                             <link linkend="GSList">GSList</link> *text_list);</programlisting>
854
864
<para>
855
 
Sets the comment of a calendar component object.  The comment property can
 
865
Sets the comments of a calendar component object.  The comment property can
856
866
appear several times inside a calendar component, and so a list of
857
867
<link linkend="ECalComponentText"><type>ECalComponentText</type></link> structures is used.</para>
858
868
<para>
1286
1296
<indexterm><primary>e_cal_component_get_geo</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_get_geo         (<link linkend="ECalComponent">ECalComponent</link> *comp,
1287
1297
                                             struct <link linkend="icalgeotype">icalgeotype</link> **geo);</programlisting>
1288
1298
<para>
1289
 
Sets the geographic position property of a calendar component object.</para>
 
1299
Gets the geographic position property of a calendar component object.</para>
1290
1300
<para>
1291
1301
 
1292
1302
</para><variablelist role="params">
1386
1396
<title><anchor id="e-cal-component-has-organizer"/>e_cal_component_has_organizer ()</title>
1387
1397
<indexterm><primary>e_cal_component_has_organizer</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_component_has_organizer   (<link linkend="ECalComponent">ECalComponent</link> *comp);</programlisting>
1388
1398
<para>
1389
 
</para>
 
1399
Check whether a calendar component object has an organizer or not.</para>
1390
1400
<para>
1391
1401
 
1392
1402
</para><variablelist role="params">
1393
1403
<varlistentry><term><parameter>comp</parameter>&nbsp;:</term>
1394
 
<listitem><simpara> 
 
1404
<listitem><simpara> A calendar component object.
1395
1405
</simpara></listitem></varlistentry>
1396
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 
 
1406
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if there is an organizer, FALSE otherwise.
1397
1407
</simpara></listitem></varlistentry>
1398
1408
</variablelist></refsect2>
1399
1409
<refsect2>
1467
1477
<indexterm><primary>e_cal_component_get_recurid</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_get_recurid     (<link linkend="ECalComponent">ECalComponent</link> *comp,
1468
1478
                                             <link linkend="ECalComponentRange">ECalComponentRange</link> *recur_id);</programlisting>
1469
1479
<para>
1470
 
Queries the recurrence id property of a calendar component object</para>
 
1480
Queries the recurrence id property of a calendar component object.</para>
1471
1481
<para>
1472
1482
 
1473
1483
</para><variablelist role="params">
1631
1641
<indexterm><primary>e_cal_component_has_simple_recurrence</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_component_has_simple_recurrence
1632
1642
                                            (<link linkend="ECalComponent">ECalComponent</link> *comp);</programlisting>
1633
1643
<para>
 
1644
Checks whether the given calendar component object has simple recurrence
 
1645
rules or more complicated ones.
 
1646
</para>
 
1647
<para>
 
1648
 + Return value: TRUE if it has a simple recurrence rule, FALSE otherwise.</para>
 
1649
<para>
1634
1650
 
1635
1651
</para><variablelist role="params">
1636
1652
<varlistentry><term><parameter>comp</parameter>&nbsp;:</term>
1637
 
<listitem><simpara>
 
1653
<listitem><simpara> A calendar component object.
1638
1654
</simpara></listitem></varlistentry>
1639
1655
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
1640
1656
 
1645
1661
<title><anchor id="e-cal-component-is-instance"/>e_cal_component_is_instance ()</title>
1646
1662
<indexterm><primary>e_cal_component_is_instance</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_component_is_instance     (<link linkend="ECalComponent">ECalComponent</link> *comp);</programlisting>
1647
1663
<para>
 
1664
Checks whether a calendar component object is an instance of a recurring
 
1665
event.</para>
 
1666
<para>
1648
1667
 
1649
1668
</para><variablelist role="params">
1650
1669
<varlistentry><term><parameter>comp</parameter>&nbsp;:</term>
1651
 
<listitem><simpara>
 
1670
<listitem><simpara> A calendar component object.
1652
1671
</simpara></listitem></varlistentry>
1653
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
1654
 
 
1655
 
 
 
1672
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if it is an instance, FALSE if not.
1656
1673
</simpara></listitem></varlistentry>
1657
1674
</variablelist></refsect2>
1658
1675
<refsect2>
1862
1879
<title><anchor id="e-cal-component-has-attendees"/>e_cal_component_has_attendees ()</title>
1863
1880
<indexterm><primary>e_cal_component_has_attendees</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_component_has_attendees   (<link linkend="ECalComponent">ECalComponent</link> *comp);</programlisting>
1864
1881
<para>
 
1882
Queries a calendar component object for the existence of attendees.</para>
 
1883
<para>
1865
1884
 
1866
1885
</para><variablelist role="params">
1867
1886
<varlistentry><term><parameter>comp</parameter>&nbsp;:</term>
1868
 
<listitem><simpara>
 
1887
<listitem><simpara> A calendar component object.
1869
1888
</simpara></listitem></varlistentry>
1870
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
1871
 
 
1872
 
 
 
1889
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if there are attendees, FALSE if not.
1873
1890
</simpara></listitem></varlistentry>
1874
1891
</variablelist></refsect2>
1875
1892
<refsect2>
1954
1971
<title><anchor id="e-cal-component-free-range"/>e_cal_component_free_range ()</title>
1955
1972
<indexterm><primary>e_cal_component_free_range</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_free_range      (<link linkend="ECalComponentRange">ECalComponentRange</link> *range);</programlisting>
1956
1973
<para>
 
1974
Frees an <link linkend="ECalComponentRange"><type>ECalComponentRange</type></link> structure.</para>
 
1975
<para>
1957
1976
 
1958
1977
</para><variablelist role="params">
1959
1978
<varlistentry><term><parameter>range</parameter>&nbsp;:</term>
1960
 
<listitem><simpara>
1961
 
 
1962
 
 
 
1979
<listitem><simpara> A <link linkend="ECalComponentRange"><type>ECalComponentRange</type></link>.
1963
1980
</simpara></listitem></varlistentry>
1964
1981
</variablelist></refsect2>
1965
1982
<refsect2>
2085
2102
<indexterm><primary>e_cal_component_free_attendee_list</primary></indexterm><programlisting><link linkend="void">void</link>        e_cal_component_free_attendee_list
2086
2103
                                            (<link linkend="GSList">GSList</link> *attendee_list);</programlisting>
2087
2104
<para>
2088
 
</para>
 
2105
Frees a list of <link linkend="ECalComponentAttendee"><type>ECalComponentAttendee</type></link> structures.</para>
2089
2106
<para>
2090
2107
 
2091
2108
</para><variablelist role="params">
2092
2109
<varlistentry><term><parameter>attendee_list</parameter>&nbsp;:</term>
2093
 
<listitem><simpara> 
 
2110
<listitem><simpara>  List of attendees.
2094
2111
</simpara></listitem></varlistentry>
2095
2112
</variablelist></refsect2>
2096
2113
<refsect2>
2304
2321
<indexterm><primary>e_cal_component_alarm_new</primary></indexterm><programlisting><link linkend="ECalComponentAlarm">ECalComponentAlarm</link>* e_cal_component_alarm_new
2305
2322
                                            (void);</programlisting>
2306
2323
<para>
2307
 
</para>
 
2324
Create a new alarm object.</para>
2308
2325
<para>
2309
2326
 
2310
2327
</para><variablelist role="params">
2547
2564
                                            (<link linkend="ECalComponentAlarm">ECalComponentAlarm</link> *alarm,
2548
2565
                                             <link linkend="GSList">GSList</link> *attendee_list);</programlisting>
2549
2566
<para>
 
2567
Sets the list of attendees for an alarm.</para>
 
2568
<para>
2550
2569
 
2551
2570
</para><variablelist role="params">
2552
2571
<varlistentry><term><parameter>alarm</parameter>&nbsp;:</term>
2553
 
<listitem><simpara>
 
2572
<listitem><simpara> An alarm.
2554
2573
</simpara></listitem></varlistentry>
2555
2574
<varlistentry><term><parameter>attendee_list</parameter>&nbsp;:</term>
2556
 
<listitem><simpara>
2557
 
 
2558
 
 
 
2575
<listitem><simpara> List of attendees.
2559
2576
</simpara></listitem></varlistentry>
2560
2577
</variablelist></refsect2>
2561
2578
<refsect2>
2563
2580
<indexterm><primary>e_cal_component_alarm_has_attendees</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_cal_component_alarm_has_attendees
2564
2581
                                            (<link linkend="ECalComponentAlarm">ECalComponentAlarm</link> *alarm);</programlisting>
2565
2582
<para>
 
2583
Queries an alarm to see if it has attendees associated with it.</para>
 
2584
<para>
2566
2585
 
2567
2586
</para><variablelist role="params">
2568
2587
<varlistentry><term><parameter>alarm</parameter>&nbsp;:</term>
2569
 
<listitem><simpara>
 
2588
<listitem><simpara> An alarm.
2570
2589
</simpara></listitem></varlistentry>
2571
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
2572
 
 
2573
 
 
 
2590
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if there are attendees in the alarm, FALSE if not.
2574
2591
</simpara></listitem></varlistentry>
2575
2592
</variablelist></refsect2>
2576
2593
<refsect2>