← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-08-10 15:05:30 UTC
  • mfrom: (1.1.71 upstream)
  • Revision ID: james.westby@ubuntu.com-20090810150530-91g7v606ee8ir474
Tags: 2.27.90-0ubuntu1
* New upstream version:
  Bug Fixes:
  Calendar:
  - #579965 - calendar file backend, update 'LAST-MODIFIED'
    when removing a recurring event instance 
  - #589984 - eds crash trying to create an event. 
  Mail:
  - #511283 - Some Images Do not Display in Evolution Mail Reader 
  Miscellaneous:
  - #590697 – Build regression detecting com_err.h 
  - #589388 – Build fixes / enhancements for EDS 

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libecal/xml/e-cal-util.xml
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBECAL Library</refmiscinfo>
9
9
</refmeta>
10
 
 
11
10
<refnamediv>
12
11
<refname>e-cal-util</refname>
13
12
<refpurpose>Various utility functions.</refpurpose>
16
15
<refsynopsisdiv id="libecal-e-cal-util.synopsis" role="synopsis">
17
16
<title role="synopsis.title">Synopsis</title>
18
17
 
19
 
<synopsis>
20
 
                    <link linkend="CalObjInstance">CalObjInstance</link>;
 
18
<synopsis>                    <link linkend="CalObjInstance">CalObjInstance</link>;
21
19
<link linkend="void">void</link>                <link linkend="cal-obj-instance-list-free">cal_obj_instance_list_free</link>          (<link linkend="GList">GList</link> *list);
22
20
enum                <link linkend="CalObjModType">CalObjModType</link>;
23
21
enum                <link linkend="CalMode">CalMode</link>;
58
56
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-util-component-has-attendee">e_cal_util_component_has_attendee</link>   (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);
59
57
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-util-event-dates-match">e_cal_util_event_dates_match</link>        (<link linkend="icalcomponent">icalcomponent</link> *icalcomp1,
60
58
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp2);
61
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT--CAPS">CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT</link>
62
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS--CAPS">CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS</link>
63
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS--CAPS">CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS</link>
64
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS--CAPS">CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS</link>
65
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS--CAPS">CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS</link>
66
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT--CAPS">CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT</link>
67
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-THISANDFUTURE--CAPS">CAL_STATIC_CAPABILITY_NO_THISANDFUTURE</link>
68
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-THISANDPRIOR--CAPS">CAL_STATIC_CAPABILITY_NO_THISANDPRIOR</link>
69
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-TRANSPARENCY--CAPS">CAL_STATIC_CAPABILITY_NO_TRANSPARENCY</link>
70
 
#define             <link linkend="CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY--CAPS">CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY</link>
71
 
#define             <link linkend="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND--CAPS">CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND</link>
72
 
#define             <link linkend="CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS--CAPS">CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS</link>
73
 
#define             <link linkend="CAL-STATIC-CAPABILITY-REMOVE-ALARMS--CAPS">CAL_STATIC_CAPABILITY_REMOVE_ALARMS</link>
74
 
#define             <link linkend="CAL-STATIC-CAPABILITY-CREATE-MESSAGES--CAPS">CAL_STATIC_CAPABILITY_CREATE_MESSAGES</link>
75
 
#define             <link linkend="CAL-STATIC-CAPABILITY-SAVE-SCHEDULES--CAPS">CAL_STATIC_CAPABILITY_SAVE_SCHEDULES</link>
76
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-CONV-TO-ASSIGN-TASK--CAPS">CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK</link>
77
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-CONV-TO-RECUR--CAPS">CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR</link>
78
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-GEN-OPTIONS--CAPS">CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS</link>
79
 
#define             <link linkend="CAL-STATIC-CAPABILITY-REQ-SEND-OPTIONS--CAPS">CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS</link>
80
 
#define             <link linkend="CAL-STATIC-CAPABILITY-RECURRENCES-NO-MASTER--CAPS">CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER</link>
81
 
#define             <link linkend="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ACCEPT--CAPS">CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT</link>
82
 
#define             <link linkend="CAL-STATIC-CAPABILITY-DELEGATE-SUPPORTED--CAPS">CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED</link>
83
 
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-ORGANIZER--CAPS">CAL_STATIC_CAPABILITY_NO_ORGANIZER</link>
84
 
#define             <link linkend="CAL-STATIC-CAPABILITY-DELEGATE-TO-MANY--CAPS">CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY</link>
85
 
#define             <link linkend="CAL-STATIC-CAPABILITY-HAS-UNACCEPTED-MEETING--CAPS">CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING</link>
 
59
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT:CAPS">CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT</link>
 
60
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS:CAPS">CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS</link>
 
61
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS:CAPS">CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS</link>
 
62
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS:CAPS">CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS</link>
 
63
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS:CAPS">CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS</link>
 
64
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT:CAPS">CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT</link>
 
65
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-THISANDFUTURE:CAPS">CAL_STATIC_CAPABILITY_NO_THISANDFUTURE</link>
 
66
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-THISANDPRIOR:CAPS">CAL_STATIC_CAPABILITY_NO_THISANDPRIOR</link>
 
67
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-TRANSPARENCY:CAPS">CAL_STATIC_CAPABILITY_NO_TRANSPARENCY</link>
 
68
#define             <link linkend="CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY:CAPS">CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY</link>
 
69
#define             <link linkend="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND:CAPS">CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND</link>
 
70
#define             <link linkend="CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS:CAPS">CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS</link>
 
71
#define             <link linkend="CAL-STATIC-CAPABILITY-REMOVE-ALARMS:CAPS">CAL_STATIC_CAPABILITY_REMOVE_ALARMS</link>
 
72
#define             <link linkend="CAL-STATIC-CAPABILITY-CREATE-MESSAGES:CAPS">CAL_STATIC_CAPABILITY_CREATE_MESSAGES</link>
 
73
#define             <link linkend="CAL-STATIC-CAPABILITY-SAVE-SCHEDULES:CAPS">CAL_STATIC_CAPABILITY_SAVE_SCHEDULES</link>
 
74
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-CONV-TO-ASSIGN-TASK:CAPS">CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK</link>
 
75
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-CONV-TO-RECUR:CAPS">CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR</link>
 
76
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-GEN-OPTIONS:CAPS">CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS</link>
 
77
#define             <link linkend="CAL-STATIC-CAPABILITY-REQ-SEND-OPTIONS:CAPS">CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS</link>
 
78
#define             <link linkend="CAL-STATIC-CAPABILITY-RECURRENCES-NO-MASTER:CAPS">CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER</link>
 
79
#define             <link linkend="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ACCEPT:CAPS">CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT</link>
 
80
#define             <link linkend="CAL-STATIC-CAPABILITY-DELEGATE-SUPPORTED:CAPS">CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED</link>
 
81
#define             <link linkend="CAL-STATIC-CAPABILITY-NO-ORGANIZER:CAPS">CAL_STATIC_CAPABILITY_NO_ORGANIZER</link>
 
82
#define             <link linkend="CAL-STATIC-CAPABILITY-DELEGATE-TO-MANY:CAPS">CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY</link>
 
83
#define             <link linkend="CAL-STATIC-CAPABILITY-HAS-UNACCEPTED-MEETING:CAPS">CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING</link>
86
84
<link linkend="icalcomponent">icalcomponent</link> *     <link linkend="e-cal-util-construct-instance">e_cal_util_construct_instance</link>       (<link linkend="icalcomponent">icalcomponent</link> *icalcomp,
87
85
                                                         <link linkend="struct-icaltimetype">struct icaltimetype</link> rid);
88
86
<link linkend="void">void</link>                <link linkend="e-cal-util-remove-instances">e_cal_util_remove_instances</link>         (<link linkend="icalcomponent">icalcomponent</link> *icalcomp,
94
92
</synopsis>
95
93
</refsynopsisdiv>
96
94
 
97
 
 
98
 
 
99
 
 
100
 
 
101
 
 
102
 
 
103
 
 
104
 
 
105
95
<refsect1 id="libecal-e-cal-util.description" role="desc">
106
96
<title role="desc.title">Description</title>
107
97
<para>
108
98
</para>
109
99
</refsect1>
110
 
 
111
100
<refsect1 id="libecal-e-cal-util.details" role="details">
112
101
<title role="details.title">Details</title>
113
102
<refsect2 id="CalObjInstance" role="struct">
114
103
<title>CalObjInstance</title>
115
 
<indexterm zone="CalObjInstance"><primary sortas="CalObjInstance">CalObjInstance</primary></indexterm><programlisting>typedef struct {
 
104
<indexterm zone="CalObjInstance"><primary>CalObjInstance</primary></indexterm>
 
105
<programlisting>typedef struct {
116
106
        gchar *uid;                     /* UID of the object */
117
107
        time_t start;                   /* Start time of instance */
118
108
        time_t end;                     /* End time of instance */
122
112
</para></refsect2>
123
113
<refsect2 id="cal-obj-instance-list-free" role="function">
124
114
<title>cal_obj_instance_list_free ()</title>
125
 
<indexterm zone="cal-obj-instance-list-free"><primary sortas="cal_obj_instance_list_free">cal_obj_instance_list_free</primary></indexterm><programlisting><link linkend="void">void</link>                cal_obj_instance_list_free          (<link linkend="GList">GList</link> *list);</programlisting>
 
115
<indexterm zone="cal-obj-instance-list-free"><primary>cal_obj_instance_list_free</primary></indexterm>
 
116
<programlisting><link linkend="void">void</link>                cal_obj_instance_list_free          (<link linkend="GList">GList</link> *list);</programlisting>
126
117
<para>
127
118
Frees a list of <link linkend="CalObjInstance"><type>CalObjInstance</type></link> structures.</para>
128
 
<para>
129
 
</para><variablelist role="params">
 
119
<variablelist role="params">
130
120
<varlistentry><term><parameter>list</parameter>&#160;:</term>
131
121
<listitem><simpara> List of <link linkend="CalObjInstance"><type>CalObjInstance</type></link> structures.
132
122
</simpara></listitem></varlistentry>
133
123
</variablelist></refsect2>
134
124
<refsect2 id="CalObjModType" role="enum">
135
125
<title>enum CalObjModType</title>
136
 
<indexterm zone="CalObjModType"><primary sortas="CalObjModType">CalObjModType</primary></indexterm><programlisting>typedef enum {
 
126
<indexterm zone="CalObjModType"><primary>CalObjModType</primary></indexterm>
 
127
<programlisting>typedef enum {
137
128
        CALOBJ_MOD_THIS          = 1 &lt;&lt; 0,
138
129
        CALOBJ_MOD_THISANDPRIOR  = 1 &lt;&lt; 1,
139
130
        CALOBJ_MOD_THISANDFUTURE = 1 &lt;&lt; 2,
144
135
</para></refsect2>
145
136
<refsect2 id="CalMode" role="enum">
146
137
<title>enum CalMode</title>
147
 
<indexterm zone="CalMode"><primary sortas="CalMode">CalMode</primary></indexterm><programlisting>typedef enum {
 
138
<indexterm zone="CalMode"><primary>CalMode</primary></indexterm>
 
139
<programlisting>typedef enum {
148
140
        CAL_MODE_INVALID = -1,
149
141
        CAL_MODE_LOCAL   = 1 &lt;&lt; 0,
150
142
        CAL_MODE_REMOTE  = 1 &lt;&lt; 1,
155
147
</para></refsect2>
156
148
<refsect2 id="cal-mode-to-corba" role="macro">
157
149
<title>cal_mode_to_corba()</title>
158
 
<indexterm zone="cal-mode-to-corba"><primary sortas="cal_mode_to_corba">cal_mode_to_corba</primary></indexterm><programlisting>#define             cal_mode_to_corba(mode)</programlisting>
 
150
<indexterm zone="cal-mode-to-corba"><primary>cal_mode_to_corba</primary></indexterm>
 
151
<programlisting>#define             cal_mode_to_corba(mode)</programlisting>
159
152
<para>
160
153
</para><variablelist role="params">
161
154
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
164
157
</variablelist></refsect2>
165
158
<refsect2 id="cal-obj-uid-list-free" role="function">
166
159
<title>cal_obj_uid_list_free ()</title>
167
 
<indexterm zone="cal-obj-uid-list-free"><primary sortas="cal_obj_uid_list_free">cal_obj_uid_list_free</primary></indexterm><programlisting><link linkend="void">void</link>                cal_obj_uid_list_free               (<link linkend="GList">GList</link> *list);</programlisting>
 
160
<indexterm zone="cal-obj-uid-list-free"><primary>cal_obj_uid_list_free</primary></indexterm>
 
161
<programlisting><link linkend="void">void</link>                cal_obj_uid_list_free               (<link linkend="GList">GList</link> *list);</programlisting>
168
162
<para>
169
163
Frees a list of unique identifiers for calendar objects.</para>
170
 
<para>
171
 
</para><variablelist role="params">
 
164
<variablelist role="params">
172
165
<varlistentry><term><parameter>list</parameter>&#160;:</term>
173
166
<listitem><simpara> List of strings with unique identifiers.
174
167
</simpara></listitem></varlistentry>
175
168
</variablelist></refsect2>
176
169
<refsect2 id="e-cal-util-new-top-level" role="function">
177
170
<title>e_cal_util_new_top_level ()</title>
178
 
<indexterm zone="e-cal-util-new-top-level"><primary sortas="e_cal_util_new_top_level">e_cal_util_new_top_level</primary></indexterm><programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_new_top_level            (void);</programlisting>
 
171
<indexterm zone="e-cal-util-new-top-level"><primary>e_cal_util_new_top_level</primary></indexterm>
 
172
<programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_new_top_level            (void);</programlisting>
179
173
<para>
180
174
Creates a new VCALENDAR component.</para>
181
 
<para>
182
 
</para><variablelist role="params">
 
175
<variablelist role="params">
183
176
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created top level component.
184
177
</simpara></listitem></varlistentry>
185
178
</variablelist></refsect2>
186
179
<refsect2 id="e-cal-util-new-component" role="function">
187
180
<title>e_cal_util_new_component ()</title>
188
 
<indexterm zone="e-cal-util-new-component"><primary sortas="e_cal_util_new_component">e_cal_util_new_component</primary></indexterm><programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_new_component            (<link linkend="icalcomponent-kind">icalcomponent_kind</link> kind);</programlisting>
 
181
<indexterm zone="e-cal-util-new-component"><primary>e_cal_util_new_component</primary></indexterm>
 
182
<programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_new_component            (<link linkend="icalcomponent-kind">icalcomponent_kind</link> kind);</programlisting>
189
183
<para>
190
184
Creates a new <link linkend="icalcomponent"><type>icalcomponent</type></link> of the specified kind.</para>
191
 
<para>
192
 
</para><variablelist role="params">
 
185
<variablelist role="params">
193
186
<varlistentry><term><parameter>kind</parameter>&#160;:</term>
194
187
<listitem><simpara> Kind of the component to create.
195
188
</simpara></listitem></varlistentry>
198
191
</variablelist></refsect2>
199
192
<refsect2 id="e-cal-util-parse-ics-string" role="function">
200
193
<title>e_cal_util_parse_ics_string ()</title>
201
 
<indexterm zone="e-cal-util-parse-ics-string"><primary sortas="e_cal_util_parse_ics_string">e_cal_util_parse_ics_string</primary></indexterm><programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_parse_ics_string         (const <link linkend="gchar">gchar</link> *string);</programlisting>
 
194
<indexterm zone="e-cal-util-parse-ics-string"><primary>e_cal_util_parse_ics_string</primary></indexterm>
 
195
<programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_parse_ics_string         (const <link linkend="gchar">gchar</link> *string);</programlisting>
202
196
<para>
203
197
Parses an iCalendar string and returns a new <link linkend="icalcomponent"><type>icalcomponent</type></link> representing
204
198
that string. Note that this function deals with multiple VCALENDAR's in the
205
199
string, something that Mozilla used to do and which libical does not
206
200
support.</para>
207
 
<para>
208
 
</para><variablelist role="params">
 
201
<variablelist role="params">
209
202
<varlistentry><term><parameter>string</parameter>&#160;:</term>
210
203
<listitem><simpara> iCalendar string to be parsed.
211
204
</simpara></listitem></varlistentry>
215
208
</variablelist></refsect2>
216
209
<refsect2 id="e-cal-util-parse-ics-file" role="function">
217
210
<title>e_cal_util_parse_ics_file ()</title>
218
 
<indexterm zone="e-cal-util-parse-ics-file"><primary sortas="e_cal_util_parse_ics_file">e_cal_util_parse_ics_file</primary></indexterm><programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_parse_ics_file           (const <link linkend="gchar">gchar</link> *filename);</programlisting>
 
211
<indexterm zone="e-cal-util-parse-ics-file"><primary>e_cal_util_parse_ics_file</primary></indexterm>
 
212
<programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_parse_ics_file           (const <link linkend="gchar">gchar</link> *filename);</programlisting>
219
213
<para>
220
214
Parses the given file, and, if it contains a valid iCalendar object,
221
215
parse it and return a new <link linkend="icalcomponent"><type>icalcomponent</type></link>.</para>
222
 
<para>
223
 
</para><variablelist role="params">
 
216
<variablelist role="params">
224
217
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
225
218
<listitem><simpara> Name of the file to be parsed.
226
219
</simpara></listitem></varlistentry>
230
223
</variablelist></refsect2>
231
224
<refsect2 id="e-cal-util-generate-alarms-for-comp" role="function">
232
225
<title>e_cal_util_generate_alarms_for_comp ()</title>
233
 
<indexterm zone="e-cal-util-generate-alarms-for-comp"><primary sortas="e_cal_util_generate_alarms_for_comp">e_cal_util_generate_alarms_for_comp</primary></indexterm><programlisting><link linkend="ECalComponentAlarms">ECalComponentAlarms</link> * e_cal_util_generate_alarms_for_comp
 
226
<indexterm zone="e-cal-util-generate-alarms-for-comp"><primary>e_cal_util_generate_alarms_for_comp</primary></indexterm>
 
227
<programlisting><link linkend="ECalComponentAlarms">ECalComponentAlarms</link> * e_cal_util_generate_alarms_for_comp
234
228
                                                        (<link linkend="ECalComponent">ECalComponent</link> *comp,
235
229
                                                         <link linkend="time-t">time_t</link> start,
236
230
                                                         <link linkend="time-t">time_t</link> end,
242
236
Generates alarm instances for a calendar component.  Returns the instances
243
237
structure, or NULL if no alarm instances occurred in the specified time
244
238
range.</para>
245
 
<para>
246
 
</para><variablelist role="params">
 
239
<variablelist role="params">
247
240
<varlistentry><term><parameter>comp</parameter>&#160;:</term>
248
241
<listitem><simpara> The <link linkend="ECalComponent"><type>ECalComponent</type></link> to generate alarms from.
249
242
</simpara></listitem></varlistentry>
273
266
</variablelist></refsect2>
274
267
<refsect2 id="e-cal-util-generate-alarms-for-list" role="function">
275
268
<title>e_cal_util_generate_alarms_for_list ()</title>
276
 
<indexterm zone="e-cal-util-generate-alarms-for-list"><primary sortas="e_cal_util_generate_alarms_for_list">e_cal_util_generate_alarms_for_list</primary></indexterm><programlisting><link linkend="gint">gint</link>                e_cal_util_generate_alarms_for_list (<link linkend="GList">GList</link> *comps,
 
269
<indexterm zone="e-cal-util-generate-alarms-for-list"><primary>e_cal_util_generate_alarms_for_list</primary></indexterm>
 
270
<programlisting><link linkend="gint">gint</link>                e_cal_util_generate_alarms_for_list (<link linkend="GList">GList</link> *comps,
277
271
                                                         <link linkend="time-t">time_t</link> start,
278
272
                                                         <link linkend="time-t">time_t</link> end,
279
273
                                                         <link linkend="ECalComponentAlarmAction">ECalComponentAlarmAction</link> *omit,
284
278
<para>
285
279
Iterates through all the components in the <parameter>comps</parameter> list and generates alarm
286
280
instances for them; putting them in the <parameter>comp_alarms</parameter> list.</para>
287
 
<para>
288
 
</para><variablelist role="params">
 
281
<variablelist role="params">
289
282
<varlistentry><term><parameter>comps</parameter>&#160;:</term>
290
283
<listitem><simpara> List of <link linkend="ECalComponent"><type>ECalComponent</type></link>'s.
291
284
</simpara></listitem></varlistentry>
316
309
</variablelist></refsect2>
317
310
<refsect2 id="e-cal-util-priority-to-string" role="function">
318
311
<title>e_cal_util_priority_to_string ()</title>
319
 
<indexterm zone="e-cal-util-priority-to-string"><primary sortas="e_cal_util_priority_to_string">e_cal_util_priority_to_string</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       e_cal_util_priority_to_string       (<link linkend="gint">gint</link> priority);</programlisting>
 
312
<indexterm zone="e-cal-util-priority-to-string"><primary>e_cal_util_priority_to_string</primary></indexterm>
 
313
<programlisting>const <link linkend="gchar">gchar</link> *       e_cal_util_priority_to_string       (<link linkend="gint">gint</link> priority);</programlisting>
320
314
<para>
321
315
Converts an iCalendar PRIORITY value to a translated string. Any unknown
322
316
priority value (i.e. not 0-9) will be returned as "" (undefined).</para>
323
 
<para>
324
 
</para><variablelist role="params">
 
317
<variablelist role="params">
325
318
<varlistentry><term><parameter>priority</parameter>&#160;:</term>
326
319
<listitem><simpara> Priority value.
327
320
</simpara></listitem></varlistentry>
331
324
</variablelist></refsect2>
332
325
<refsect2 id="e-cal-util-priority-from-string" role="function">
333
326
<title>e_cal_util_priority_from_string ()</title>
334
 
<indexterm zone="e-cal-util-priority-from-string"><primary sortas="e_cal_util_priority_from_string">e_cal_util_priority_from_string</primary></indexterm><programlisting><link linkend="gint">gint</link>                e_cal_util_priority_from_string     (const <link linkend="gchar">gchar</link> *string);</programlisting>
 
327
<indexterm zone="e-cal-util-priority-from-string"><primary>e_cal_util_priority_from_string</primary></indexterm>
 
328
<programlisting><link linkend="gint">gint</link>                e_cal_util_priority_from_string     (const <link linkend="gchar">gchar</link> *string);</programlisting>
335
329
<para>
336
330
Converts a translated priority string to an iCalendar priority value.</para>
337
 
<para>
338
 
</para><variablelist role="params">
 
331
<variablelist role="params">
339
332
<varlistentry><term><parameter>string</parameter>&#160;:</term>
340
333
<listitem><simpara> A string representing the PRIORITY value.
341
334
</simpara></listitem></varlistentry>
344
337
</variablelist></refsect2>
345
338
<refsect2 id="e-cal-util-add-timezones-from-component" role="function">
346
339
<title>e_cal_util_add_timezones_from_component ()</title>
347
 
<indexterm zone="e-cal-util-add-timezones-from-component"><primary sortas="e_cal_util_add_timezones_from_component">e_cal_util_add_timezones_from_component</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_util_add_timezones_from_component
 
340
<indexterm zone="e-cal-util-add-timezones-from-component"><primary>e_cal_util_add_timezones_from_component</primary></indexterm>
 
341
<programlisting><link linkend="void">void</link>                e_cal_util_add_timezones_from_component
348
342
                                                        (<link linkend="icalcomponent">icalcomponent</link> *vcal_comp,
349
343
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
350
344
<para>
351
345
Adds VTIMEZONE components to a VCALENDAR for all tzid's
352
346
in the given <parameter>icalcomp</parameter>.</para>
353
 
<para>
354
 
</para><variablelist role="params">
 
347
<variablelist role="params">
355
348
<varlistentry><term><parameter>vcal_comp</parameter>&#160;:</term>
356
349
<listitem><simpara> A VCALENDAR component.
357
350
</simpara></listitem></varlistentry>
361
354
</variablelist></refsect2>
362
355
<refsect2 id="e-cal-util-component-is-instance" role="function">
363
356
<title>e_cal_util_component_is_instance ()</title>
364
 
<indexterm zone="e-cal-util-component-is-instance"><primary sortas="e_cal_util_component_is_instance">e_cal_util_component_is_instance</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_is_instance    (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
 
357
<indexterm zone="e-cal-util-component-is-instance"><primary>e_cal_util_component_is_instance</primary></indexterm>
 
358
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_is_instance    (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
365
359
<para>
366
360
Checks whether an <link linkend="icalcomponent"><type>icalcomponent</type></link> is an instance of a recurring appointment or not.</para>
367
 
<para>
368
 
</para><variablelist role="params">
 
361
<variablelist role="params">
369
362
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
370
363
<listitem><simpara> An <link linkend="icalcomponent"><type>icalcomponent</type></link>.
371
364
</simpara></listitem></varlistentry>
374
367
</variablelist></refsect2>
375
368
<refsect2 id="e-cal-util-component-has-alarms" role="function">
376
369
<title>e_cal_util_component_has_alarms ()</title>
377
 
<indexterm zone="e-cal-util-component-has-alarms"><primary sortas="e_cal_util_component_has_alarms">e_cal_util_component_has_alarms</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_alarms     (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
 
370
<indexterm zone="e-cal-util-component-has-alarms"><primary>e_cal_util_component_has_alarms</primary></indexterm>
 
371
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_alarms     (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
378
372
<para>
379
373
Checks whether an <link linkend="icalcomponent"><type>icalcomponent</type></link> has any alarm.</para>
380
 
<para>
381
 
</para><variablelist role="params">
 
374
<variablelist role="params">
382
375
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
383
376
<listitem><simpara> An <link linkend="icalcomponent"><type>icalcomponent</type></link>.
384
377
</simpara></listitem></varlistentry>
387
380
</variablelist></refsect2>
388
381
<refsect2 id="e-cal-util-component-has-organizer" role="function">
389
382
<title>e_cal_util_component_has_organizer ()</title>
390
 
<indexterm zone="e-cal-util-component-has-organizer"><primary sortas="e_cal_util_component_has_organizer">e_cal_util_component_has_organizer</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_organizer  (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
 
383
<indexterm zone="e-cal-util-component-has-organizer"><primary>e_cal_util_component_has_organizer</primary></indexterm>
 
384
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_organizer  (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
391
385
<para>
392
386
Checks whether an <link linkend="icalcomponent"><type>icalcomponent</type></link> has an organizer or not.</para>
393
 
<para>
394
 
</para><variablelist role="params">
 
387
<variablelist role="params">
395
388
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
396
389
<listitem><simpara> An <link linkend="icalcomponent"><type>icalcomponent</type></link>.
397
390
</simpara></listitem></varlistentry>
400
393
</variablelist></refsect2>
401
394
<refsect2 id="e-cal-util-component-has-recurrences" role="function">
402
395
<title>e_cal_util_component_has_recurrences ()</title>
403
 
<indexterm zone="e-cal-util-component-has-recurrences"><primary sortas="e_cal_util_component_has_recurrences">e_cal_util_component_has_recurrences</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_recurrences
 
396
<indexterm zone="e-cal-util-component-has-recurrences"><primary>e_cal_util_component_has_recurrences</primary></indexterm>
 
397
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_recurrences
404
398
                                                        (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
405
399
<para>
406
400
Checks if an <link linkend="icalcomponent"><type>icalcomponent</type></link> has recurrence dates or rules.</para>
407
 
<para>
408
 
</para><variablelist role="params">
 
401
<variablelist role="params">
409
402
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
410
403
<listitem><simpara> An <link linkend="icalcomponent"><type>icalcomponent</type></link>.
411
404
</simpara></listitem></varlistentry>
414
407
</variablelist></refsect2>
415
408
<refsect2 id="e-cal-util-component-has-rdates" role="function">
416
409
<title>e_cal_util_component_has_rdates ()</title>
417
 
<indexterm zone="e-cal-util-component-has-rdates"><primary sortas="e_cal_util_component_has_rdates">e_cal_util_component_has_rdates</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_rdates     (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
 
410
<indexterm zone="e-cal-util-component-has-rdates"><primary>e_cal_util_component_has_rdates</primary></indexterm>
 
411
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_rdates     (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
418
412
<para>
419
413
Checks if an <link linkend="icalcomponent"><type>icalcomponent</type></link> has recurrence dates.</para>
420
 
<para>
421
 
</para><variablelist role="params">
 
414
<variablelist role="params">
422
415
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
423
416
<listitem><simpara> An <link linkend="icalcomponent"><type>icalcomponent</type></link>.
424
417
</simpara></listitem></varlistentry>
427
420
</variablelist></refsect2>
428
421
<refsect2 id="e-cal-util-component-has-rrules" role="function">
429
422
<title>e_cal_util_component_has_rrules ()</title>
430
 
<indexterm zone="e-cal-util-component-has-rrules"><primary sortas="e_cal_util_component_has_rrules">e_cal_util_component_has_rrules</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_rrules     (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
 
423
<indexterm zone="e-cal-util-component-has-rrules"><primary>e_cal_util_component_has_rrules</primary></indexterm>
 
424
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_rrules     (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
431
425
<para>
432
426
Checks if an <link linkend="icalcomponent"><type>icalcomponent</type></link> has recurrence rules.</para>
433
 
<para>
434
 
</para><variablelist role="params">
 
427
<variablelist role="params">
435
428
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
436
429
<listitem><simpara> An <link linkend="icalcomponent"><type>icalcomponent</type></link>.
437
430
</simpara></listitem></varlistentry>
440
433
</variablelist></refsect2>
441
434
<refsect2 id="e-cal-util-component-has-attendee" role="function">
442
435
<title>e_cal_util_component_has_attendee ()</title>
443
 
<indexterm zone="e-cal-util-component-has-attendee"><primary sortas="e_cal_util_component_has_attendee">e_cal_util_component_has_attendee</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_attendee   (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
 
436
<indexterm zone="e-cal-util-component-has-attendee"><primary>e_cal_util_component_has_attendee</primary></indexterm>
 
437
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_component_has_attendee   (<link linkend="icalcomponent">icalcomponent</link> *icalcomp);</programlisting>
444
438
<para>
445
439
Checks if an <link linkend="icalcomponent"><type>icalcomponent</type></link> has any attendees.</para>
446
 
<para>
447
 
</para><variablelist role="params">
 
440
<variablelist role="params">
448
441
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
449
442
<listitem><simpara> An <link linkend="icalcomponent"><type>icalcomponent</type></link>.
450
443
</simpara></listitem></varlistentry>
453
446
</variablelist></refsect2>
454
447
<refsect2 id="e-cal-util-event-dates-match" role="function">
455
448
<title>e_cal_util_event_dates_match ()</title>
456
 
<indexterm zone="e-cal-util-event-dates-match"><primary sortas="e_cal_util_event_dates_match">e_cal_util_event_dates_match</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_event_dates_match        (<link linkend="icalcomponent">icalcomponent</link> *icalcomp1,
 
449
<indexterm zone="e-cal-util-event-dates-match"><primary>e_cal_util_event_dates_match</primary></indexterm>
 
450
<programlisting><link linkend="gboolean">gboolean</link>            e_cal_util_event_dates_match        (<link linkend="icalcomponent">icalcomponent</link> *icalcomp1,
457
451
                                                         <link linkend="icalcomponent">icalcomponent</link> *icalcomp2);</programlisting>
458
452
<para>
459
453
Compare the dates of two <link linkend="icalcomponent"><type>icalcomponent</type></link>'s to check if they match.</para>
460
 
<para>
461
 
</para><variablelist role="params">
 
454
<variablelist role="params">
462
455
<varlistentry><term><parameter>icalcomp1</parameter>&#160;:</term>
463
456
<listitem><simpara> An <link linkend="icalcomponent"><type>icalcomponent</type></link>.
464
457
</simpara></listitem></varlistentry>
468
461
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the dates of both components match, FALSE otherwise.
469
462
</simpara></listitem></varlistentry>
470
463
</variablelist></refsect2>
471
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT--CAPS" role="macro">
 
464
<refsect2 id="CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT:CAPS" role="macro">
472
465
<title>CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT</title>
473
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT">CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT             "no-alarm-repeat"
 
466
<indexterm zone="CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT</primary></indexterm>
 
467
<programlisting>#define CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT             "no-alarm-repeat"
474
468
</programlisting>
475
469
<para>
476
470
</para></refsect2>
477
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS--CAPS" role="macro">
 
471
<refsect2 id="CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS:CAPS" role="macro">
478
472
<title>CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS</title>
479
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS">CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS             "no-audio-alarms"
 
473
<indexterm zone="CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS</primary></indexterm>
 
474
<programlisting>#define CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS             "no-audio-alarms"
480
475
</programlisting>
481
476
<para>
482
477
</para></refsect2>
483
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS--CAPS" role="macro">
 
478
<refsect2 id="CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS:CAPS" role="macro">
484
479
<title>CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS</title>
485
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS">CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS           "no-display-alarms"
 
480
<indexterm zone="CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS</primary></indexterm>
 
481
<programlisting>#define CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS           "no-display-alarms"
486
482
</programlisting>
487
483
<para>
488
484
</para></refsect2>
489
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS--CAPS" role="macro">
 
485
<refsect2 id="CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS:CAPS" role="macro">
490
486
<title>CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS</title>
491
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS">CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS             "no-email-alarms"
 
487
<indexterm zone="CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS</primary></indexterm>
 
488
<programlisting>#define CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS             "no-email-alarms"
492
489
</programlisting>
493
490
<para>
494
491
</para></refsect2>
495
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS--CAPS" role="macro">
 
492
<refsect2 id="CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS:CAPS" role="macro">
496
493
<title>CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS</title>
497
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS">CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS         "no-procedure-alarms"
 
494
<indexterm zone="CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS</primary></indexterm>
 
495
<programlisting>#define CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS         "no-procedure-alarms"
498
496
</programlisting>
499
497
<para>
500
498
</para></refsect2>
501
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT--CAPS" role="macro">
 
499
<refsect2 id="CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT:CAPS" role="macro">
502
500
<title>CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT</title>
503
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT">CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT          "no-task-assignment"
 
501
<indexterm zone="CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT</primary></indexterm>
 
502
<programlisting>#define CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT          "no-task-assignment"
504
503
</programlisting>
505
504
<para>
506
505
</para></refsect2>
507
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-THISANDFUTURE--CAPS" role="macro">
 
506
<refsect2 id="CAL-STATIC-CAPABILITY-NO-THISANDFUTURE:CAPS" role="macro">
508
507
<title>CAL_STATIC_CAPABILITY_NO_THISANDFUTURE</title>
509
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-THISANDFUTURE--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_THISANDFUTURE">CAL_STATIC_CAPABILITY_NO_THISANDFUTURE</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_THISANDFUTURE            "no-thisandfuture"
 
508
<indexterm zone="CAL-STATIC-CAPABILITY-NO-THISANDFUTURE:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_THISANDFUTURE</primary></indexterm>
 
509
<programlisting>#define CAL_STATIC_CAPABILITY_NO_THISANDFUTURE            "no-thisandfuture"
510
510
</programlisting>
511
511
<para>
512
512
</para></refsect2>
513
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-THISANDPRIOR--CAPS" role="macro">
 
513
<refsect2 id="CAL-STATIC-CAPABILITY-NO-THISANDPRIOR:CAPS" role="macro">
514
514
<title>CAL_STATIC_CAPABILITY_NO_THISANDPRIOR</title>
515
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-THISANDPRIOR--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_THISANDPRIOR">CAL_STATIC_CAPABILITY_NO_THISANDPRIOR</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_THISANDPRIOR             "no-thisandprior"
 
515
<indexterm zone="CAL-STATIC-CAPABILITY-NO-THISANDPRIOR:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_THISANDPRIOR</primary></indexterm>
 
516
<programlisting>#define CAL_STATIC_CAPABILITY_NO_THISANDPRIOR             "no-thisandprior"
516
517
</programlisting>
517
518
<para>
518
519
</para></refsect2>
519
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-TRANSPARENCY--CAPS" role="macro">
 
520
<refsect2 id="CAL-STATIC-CAPABILITY-NO-TRANSPARENCY:CAPS" role="macro">
520
521
<title>CAL_STATIC_CAPABILITY_NO_TRANSPARENCY</title>
521
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-TRANSPARENCY--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_TRANSPARENCY">CAL_STATIC_CAPABILITY_NO_TRANSPARENCY</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_TRANSPARENCY             "no-transparency"
 
522
<indexterm zone="CAL-STATIC-CAPABILITY-NO-TRANSPARENCY:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_TRANSPARENCY</primary></indexterm>
 
523
<programlisting>#define CAL_STATIC_CAPABILITY_NO_TRANSPARENCY             "no-transparency"
522
524
</programlisting>
523
525
<para>
524
526
</para></refsect2>
525
 
<refsect2 id="CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY--CAPS" role="macro">
 
527
<refsect2 id="CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY:CAPS" role="macro">
526
528
<title>CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY</title>
527
 
<indexterm zone="CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY">CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY              "one-alarm-only"
 
529
<indexterm zone="CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY:CAPS"><primary>CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY</primary></indexterm>
 
530
<programlisting>#define CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY              "one-alarm-only"
528
531
</programlisting>
529
532
<para>
530
533
</para></refsect2>
531
 
<refsect2 id="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND--CAPS" role="macro">
 
534
<refsect2 id="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND:CAPS" role="macro">
532
535
<title>CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND</title>
533
 
<indexterm zone="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND">CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND       "organizer-must-attend"
 
536
<indexterm zone="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND:CAPS"><primary>CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND</primary></indexterm>
 
537
<programlisting>#define CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND       "organizer-must-attend"
534
538
</programlisting>
535
539
<para>
536
540
</para></refsect2>
537
 
<refsect2 id="CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS--CAPS" role="macro">
 
541
<refsect2 id="CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS:CAPS" role="macro">
538
542
<title>CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS</title>
539
 
<indexterm zone="CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS">CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS "organizer-not-email-address"
 
543
<indexterm zone="CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS:CAPS"><primary>CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS</primary></indexterm>
 
544
<programlisting>#define CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS "organizer-not-email-address"
540
545
</programlisting>
541
546
<para>
542
547
</para></refsect2>
543
 
<refsect2 id="CAL-STATIC-CAPABILITY-REMOVE-ALARMS--CAPS" role="macro">
 
548
<refsect2 id="CAL-STATIC-CAPABILITY-REMOVE-ALARMS:CAPS" role="macro">
544
549
<title>CAL_STATIC_CAPABILITY_REMOVE_ALARMS</title>
545
 
<indexterm zone="CAL-STATIC-CAPABILITY-REMOVE-ALARMS--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_REMOVE_ALARMS">CAL_STATIC_CAPABILITY_REMOVE_ALARMS</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_REMOVE_ALARMS               "remove-alarms"
 
550
<indexterm zone="CAL-STATIC-CAPABILITY-REMOVE-ALARMS:CAPS"><primary>CAL_STATIC_CAPABILITY_REMOVE_ALARMS</primary></indexterm>
 
551
<programlisting>#define CAL_STATIC_CAPABILITY_REMOVE_ALARMS               "remove-alarms"
546
552
</programlisting>
547
553
<para>
548
554
</para></refsect2>
549
 
<refsect2 id="CAL-STATIC-CAPABILITY-CREATE-MESSAGES--CAPS" role="macro">
 
555
<refsect2 id="CAL-STATIC-CAPABILITY-CREATE-MESSAGES:CAPS" role="macro">
550
556
<title>CAL_STATIC_CAPABILITY_CREATE_MESSAGES</title>
551
 
<indexterm zone="CAL-STATIC-CAPABILITY-CREATE-MESSAGES--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_CREATE_MESSAGES">CAL_STATIC_CAPABILITY_CREATE_MESSAGES</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_CREATE_MESSAGES             "create-messages"
 
557
<indexterm zone="CAL-STATIC-CAPABILITY-CREATE-MESSAGES:CAPS"><primary>CAL_STATIC_CAPABILITY_CREATE_MESSAGES</primary></indexterm>
 
558
<programlisting>#define CAL_STATIC_CAPABILITY_CREATE_MESSAGES             "create-messages"
552
559
</programlisting>
553
560
<para>
554
561
</para></refsect2>
555
 
<refsect2 id="CAL-STATIC-CAPABILITY-SAVE-SCHEDULES--CAPS" role="macro">
 
562
<refsect2 id="CAL-STATIC-CAPABILITY-SAVE-SCHEDULES:CAPS" role="macro">
556
563
<title>CAL_STATIC_CAPABILITY_SAVE_SCHEDULES</title>
557
 
<indexterm zone="CAL-STATIC-CAPABILITY-SAVE-SCHEDULES--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_SAVE_SCHEDULES">CAL_STATIC_CAPABILITY_SAVE_SCHEDULES</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_SAVE_SCHEDULES              "save-schedules"
 
564
<indexterm zone="CAL-STATIC-CAPABILITY-SAVE-SCHEDULES:CAPS"><primary>CAL_STATIC_CAPABILITY_SAVE_SCHEDULES</primary></indexterm>
 
565
<programlisting>#define CAL_STATIC_CAPABILITY_SAVE_SCHEDULES              "save-schedules"
558
566
</programlisting>
559
567
<para>
560
568
</para></refsect2>
561
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-CONV-TO-ASSIGN-TASK--CAPS" role="macro">
 
569
<refsect2 id="CAL-STATIC-CAPABILITY-NO-CONV-TO-ASSIGN-TASK:CAPS" role="macro">
562
570
<title>CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK</title>
563
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-CONV-TO-ASSIGN-TASK--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK">CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK        "no-conv-to-assign-task"
 
571
<indexterm zone="CAL-STATIC-CAPABILITY-NO-CONV-TO-ASSIGN-TASK:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK</primary></indexterm>
 
572
<programlisting>#define CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK      "no-conv-to-assign-task"
564
573
</programlisting>
565
574
<para>
566
575
</para></refsect2>
567
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-CONV-TO-RECUR--CAPS" role="macro">
 
576
<refsect2 id="CAL-STATIC-CAPABILITY-NO-CONV-TO-RECUR:CAPS" role="macro">
568
577
<title>CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR</title>
569
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-CONV-TO-RECUR--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR">CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR                "no-conv-to-recur"
 
578
<indexterm zone="CAL-STATIC-CAPABILITY-NO-CONV-TO-RECUR:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR</primary></indexterm>
 
579
<programlisting>#define CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR            "no-conv-to-recur"
570
580
</programlisting>
571
581
<para>
572
582
</para></refsect2>
573
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-GEN-OPTIONS--CAPS" role="macro">
 
583
<refsect2 id="CAL-STATIC-CAPABILITY-NO-GEN-OPTIONS:CAPS" role="macro">
574
584
<title>CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS</title>
575
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-GEN-OPTIONS--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS">CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS                "no-general-options"
 
585
<indexterm zone="CAL-STATIC-CAPABILITY-NO-GEN-OPTIONS:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS</primary></indexterm>
 
586
<programlisting>#define CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS              "no-general-options"
576
587
</programlisting>
577
588
<para>
578
589
</para></refsect2>
579
 
<refsect2 id="CAL-STATIC-CAPABILITY-REQ-SEND-OPTIONS--CAPS" role="macro">
 
590
<refsect2 id="CAL-STATIC-CAPABILITY-REQ-SEND-OPTIONS:CAPS" role="macro">
580
591
<title>CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS</title>
581
 
<indexterm zone="CAL-STATIC-CAPABILITY-REQ-SEND-OPTIONS--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS">CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS                "require-send-options"
 
592
<indexterm zone="CAL-STATIC-CAPABILITY-REQ-SEND-OPTIONS:CAPS"><primary>CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS</primary></indexterm>
 
593
<programlisting>#define CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS            "require-send-options"
582
594
</programlisting>
583
595
<para>
584
596
</para></refsect2>
585
 
<refsect2 id="CAL-STATIC-CAPABILITY-RECURRENCES-NO-MASTER--CAPS" role="macro">
 
597
<refsect2 id="CAL-STATIC-CAPABILITY-RECURRENCES-NO-MASTER:CAPS" role="macro">
586
598
<title>CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER</title>
587
 
<indexterm zone="CAL-STATIC-CAPABILITY-RECURRENCES-NO-MASTER--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER">CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER       "recurrences-no-master-object"
 
599
<indexterm zone="CAL-STATIC-CAPABILITY-RECURRENCES-NO-MASTER:CAPS"><primary>CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER</primary></indexterm>
 
600
<programlisting>#define CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER       "recurrences-no-master-object"
588
601
</programlisting>
589
602
<para>
590
603
</para></refsect2>
591
 
<refsect2 id="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ACCEPT--CAPS" role="macro">
 
604
<refsect2 id="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ACCEPT:CAPS" role="macro">
592
605
<title>CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT</title>
593
 
<indexterm zone="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ACCEPT--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT">CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT      "organizer-must-accept"
 
606
<indexterm zone="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ACCEPT:CAPS"><primary>CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT</primary></indexterm>
 
607
<programlisting>#define CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT      "organizer-must-accept"
594
608
</programlisting>
595
609
<para>
596
610
</para></refsect2>
597
 
<refsect2 id="CAL-STATIC-CAPABILITY-DELEGATE-SUPPORTED--CAPS" role="macro">
 
611
<refsect2 id="CAL-STATIC-CAPABILITY-DELEGATE-SUPPORTED:CAPS" role="macro">
598
612
<title>CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED</title>
599
 
<indexterm zone="CAL-STATIC-CAPABILITY-DELEGATE-SUPPORTED--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED">CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED       "delegate-support"
 
613
<indexterm zone="CAL-STATIC-CAPABILITY-DELEGATE-SUPPORTED:CAPS"><primary>CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED</primary></indexterm>
 
614
<programlisting>#define CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED         "delegate-support"
600
615
</programlisting>
601
616
<para>
602
617
</para></refsect2>
603
 
<refsect2 id="CAL-STATIC-CAPABILITY-NO-ORGANIZER--CAPS" role="macro">
 
618
<refsect2 id="CAL-STATIC-CAPABILITY-NO-ORGANIZER:CAPS" role="macro">
604
619
<title>CAL_STATIC_CAPABILITY_NO_ORGANIZER</title>
605
 
<indexterm zone="CAL-STATIC-CAPABILITY-NO-ORGANIZER--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_NO_ORGANIZER">CAL_STATIC_CAPABILITY_NO_ORGANIZER</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_NO_ORGANIZER               "no-organizer"
 
620
<indexterm zone="CAL-STATIC-CAPABILITY-NO-ORGANIZER:CAPS"><primary>CAL_STATIC_CAPABILITY_NO_ORGANIZER</primary></indexterm>
 
621
<programlisting>#define CAL_STATIC_CAPABILITY_NO_ORGANIZER               "no-organizer"
606
622
</programlisting>
607
623
<para>
608
624
</para></refsect2>
609
 
<refsect2 id="CAL-STATIC-CAPABILITY-DELEGATE-TO-MANY--CAPS" role="macro">
 
625
<refsect2 id="CAL-STATIC-CAPABILITY-DELEGATE-TO-MANY:CAPS" role="macro">
610
626
<title>CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY</title>
611
 
<indexterm zone="CAL-STATIC-CAPABILITY-DELEGATE-TO-MANY--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY">CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY               "delegate-to-many"
 
627
<indexterm zone="CAL-STATIC-CAPABILITY-DELEGATE-TO-MANY:CAPS"><primary>CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY</primary></indexterm>
 
628
<programlisting>#define CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY           "delegate-to-many"
612
629
</programlisting>
613
630
<para>
614
631
</para></refsect2>
615
 
<refsect2 id="CAL-STATIC-CAPABILITY-HAS-UNACCEPTED-MEETING--CAPS" role="macro">
 
632
<refsect2 id="CAL-STATIC-CAPABILITY-HAS-UNACCEPTED-MEETING:CAPS" role="macro">
616
633
<title>CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING</title>
617
 
<indexterm zone="CAL-STATIC-CAPABILITY-HAS-UNACCEPTED-MEETING--CAPS"><primary sortas="CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING">CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING</primary></indexterm><programlisting>#define CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING     "has-unaccepted-meeting"
 
634
<indexterm zone="CAL-STATIC-CAPABILITY-HAS-UNACCEPTED-MEETING:CAPS"><primary>CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING</primary></indexterm>
 
635
<programlisting>#define CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING     "has-unaccepted-meeting"
618
636
</programlisting>
619
637
<para>
620
638
</para></refsect2>
621
639
<refsect2 id="e-cal-util-construct-instance" role="function">
622
640
<title>e_cal_util_construct_instance ()</title>
623
 
<indexterm zone="e-cal-util-construct-instance"><primary sortas="e_cal_util_construct_instance">e_cal_util_construct_instance</primary></indexterm><programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_construct_instance       (<link linkend="icalcomponent">icalcomponent</link> *icalcomp,
 
641
<indexterm zone="e-cal-util-construct-instance"><primary>e_cal_util_construct_instance</primary></indexterm>
 
642
<programlisting><link linkend="icalcomponent">icalcomponent</link> *     e_cal_util_construct_instance       (<link linkend="icalcomponent">icalcomponent</link> *icalcomp,
624
643
                                                         <link linkend="struct-icaltimetype">struct icaltimetype</link> rid);</programlisting>
625
644
<para>
626
645
This checks that <parameter>rid</parameter> indicates a valid recurrence of <parameter>icalcomp</parameter>, and
627
646
if so, generates a copy of <parameter>comp</parameter> containing a RECURRENCE-ID of <parameter>rid</parameter>.</para>
628
 
<para>
629
 
</para><variablelist role="params">
 
647
<variablelist role="params">
630
648
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
631
649
<listitem><simpara> A recurring <link linkend="icalcomponent"><type>icalcomponent</type></link>
632
650
</simpara></listitem></varlistentry>
633
651
<varlistentry><term><parameter>rid</parameter>&#160;:</term>
634
652
<listitem><simpara> The RECURRENCE-ID to construct a component for
635
653
</simpara></listitem></varlistentry>
636
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the instance, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
 
654
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the instance, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
637
655
</simpara></listitem></varlistentry>
638
656
</variablelist></refsect2>
639
657
<refsect2 id="e-cal-util-remove-instances" role="function">
640
658
<title>e_cal_util_remove_instances ()</title>
641
 
<indexterm zone="e-cal-util-remove-instances"><primary sortas="e_cal_util_remove_instances">e_cal_util_remove_instances</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_util_remove_instances         (<link linkend="icalcomponent">icalcomponent</link> *icalcomp,
 
659
<indexterm zone="e-cal-util-remove-instances"><primary>e_cal_util_remove_instances</primary></indexterm>
 
660
<programlisting><link linkend="void">void</link>                e_cal_util_remove_instances         (<link linkend="icalcomponent">icalcomponent</link> *icalcomp,
642
661
                                                         <link linkend="struct-icaltimetype">struct icaltimetype</link> rid,
643
662
                                                         <link linkend="CalObjModType">CalObjModType</link> mod);</programlisting>
644
663
<para>
647
666
<para>
648
667
FIXME: should probably have a return value indicating whether or not
649
668
<parameter>icalcomp</parameter> still has any instances</para>
650
 
<para>
651
 
</para><variablelist role="params">
 
669
<variablelist role="params">
652
670
<varlistentry><term><parameter>icalcomp</parameter>&#160;:</term>
653
671
<listitem><simpara> A (recurring) <link linkend="icalcomponent"><type>icalcomponent</type></link>
654
672
</simpara></listitem></varlistentry>
661
679
</variablelist></refsect2>
662
680
<refsect2 id="e-cal-util-get-system-timezone-location" role="function">
663
681
<title>e_cal_util_get_system_timezone_location ()</title>
664
 
<indexterm zone="e-cal-util-get-system-timezone-location"><primary sortas="e_cal_util_get_system_timezone_location">e_cal_util_get_system_timezone_location</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             e_cal_util_get_system_timezone_location
 
682
<indexterm zone="e-cal-util-get-system-timezone-location"><primary>e_cal_util_get_system_timezone_location</primary></indexterm>
 
683
<programlisting><link linkend="gchar">gchar</link> *             e_cal_util_get_system_timezone_location
665
684
                                                        (void);</programlisting>
666
 
<para>
667
 
</para>
668
 
<para>
669
 
</para><variablelist role="params">
 
685
<variablelist role="params">
670
686
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>system timezone location string, NULL on an error.
671
687
Returned pointer should be freed with <link linkend="g-free"><function>g_free()</function></link>.
672
688
</simpara></listitem></varlistentry>
673
689
</variablelist></refsect2>
674
690
<refsect2 id="e-cal-util-get-system-timezone" role="function">
675
691
<title>e_cal_util_get_system_timezone ()</title>
676
 
<indexterm zone="e-cal-util-get-system-timezone"><primary sortas="e_cal_util_get_system_timezone">e_cal_util_get_system_timezone</primary></indexterm><programlisting><link linkend="icaltimezone">icaltimezone</link> *      e_cal_util_get_system_timezone      (void);</programlisting>
677
 
<para>
678
 
</para>
679
 
<para>
680
 
</para><variablelist role="params">
 
692
<indexterm zone="e-cal-util-get-system-timezone"><primary>e_cal_util_get_system_timezone</primary></indexterm>
 
693
<programlisting><link linkend="icaltimezone">icaltimezone</link> *      e_cal_util_get_system_timezone      (void);</programlisting>
 
694
<variablelist role="params">
681
695
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>icaltimezone object of the system timezone. NULL on an error.
682
696
Returned pointer is part of the built-in timezones, thus do not free it.
683
697
</simpara></listitem></varlistentry>
685
699
 
686
700
</refsect1>
687
701
 
688
 
 
689
 
 
690
 
 
691
702
</refentry>