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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>e-cal-util</title><meta name="generator" content="DocBook XSL Stylesheets V1.64.1"><link rel="home" href="index.html" title="Evolution API Reference: libecal, the Calendar Library"><link rel="up" href="ch01.html" title="Evolution API Reference: libecal, the Calendar Library"><link rel="previous" href="libecal-e-cal-types.html" title="e-cal-types"><link rel="next" href="libecal-ECalView.html" title="ECalView"><link rel="chapter" href="ch01.html" title="Evolution API Reference: libecal, the Calendar Library"><link rel="refentry" href="ECalComponent.html" title="ECalComponent"><link rel="refentry" href="libecal-ECalListener.html" title="ECalListener"><link rel="refentry" href="libecal-ECalViewListener.html" title="ECalViewListener"><link rel="refentry" href="ECal.html" title="ECal"><link rel="refentry" href="libecal-e-cal-recur.html" title="e-cal-recur"><link rel="refentry" href="libecal-e-cal-time-util.html" title="e-cal-time-util"><link rel="refentry" href="libecal-e-cal-types.html" title="e-cal-types"><link rel="refentry" href="libecal-e-cal-util.html" title="e-cal-util"><link rel="refentry" href="libecal-ECalView.html" title="ECalView"><link rel="section" href="libecal-e-cal-util.html#id2563069" title="Description"><link rel="section" href="libecal-e-cal-util.html#id2563079" title="Details"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libecal-e-cal-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Evolution API Reference: libecal, the Calendar Library</th><td><a accesskey="n" href="libecal-ECalView.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libecal-e-cal-util"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">e-cal-util</span></h2><p>e-cal-util — </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
struct <a href="libecal-e-cal-util.html#CalObjInstance">CalObjInstance</a>;
void <a href="libecal-e-cal-util.html#cal-obj-instance-list-free">cal_obj_instance_list_free</a> (GList *list);
enum <a href="libecal-e-cal-util.html#CalObjModType">CalObjModType</a>;
enum <a href="libecal-e-cal-util.html#CalMode">CalMode</a>;
void <a href="libecal-e-cal-util.html#cal-obj-uid-list-free">cal_obj_uid_list_free</a> (GList *list);
icalcomponent* <a href="libecal-e-cal-util.html#e-cal-util-new-top-level">e_cal_util_new_top_level</a> (void);
icalcomponent* <a href="libecal-e-cal-util.html#e-cal-util-parse-ics-file">e_cal_util_parse_ics_file</a> (const char *filename);
<a href="ECalComponent.html#ECalComponentAlarms">ECalComponentAlarms</a>* <a href="libecal-e-cal-util.html#e-cal-util-generate-alarms-for-comp">e_cal_util_generate_alarms_for_comp</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
time_t start,
time_t end,
<a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a> *omit,
<a href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn">ECalRecurResolveTimezoneFn</a> resolve_tzid,
gpointer user_data,
icaltimezone *default_timezone);
int <a href="libecal-e-cal-util.html#e-cal-util-generate-alarms-for-list">e_cal_util_generate_alarms_for_list</a>
(GList *comps,
time_t start,
time_t end,
<a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a> *omit,
GSList **comp_alarms,
<a href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn">ECalRecurResolveTimezoneFn</a> resolve_tzid,
gpointer user_data,
icaltimezone *default_timezone);
icaltimezone* <a href="libecal-e-cal-util.html#e-cal-util-resolve-tzid">e_cal_util_resolve_tzid</a> (const char *tzid,
gpointer data);
char* <a href="libecal-e-cal-util.html#e-cal-util-priority-to-string">e_cal_util_priority_to_string</a> (int priority);
int <a href="libecal-e-cal-util.html#e-cal-util-priority-from-string">e_cal_util_priority_from_string</a> (const char *string);
char* <a href="libecal-e-cal-util.html#e-cal-util-expand-uri">e_cal_util_expand_uri</a> (char *uri,
gboolean tasks);
void <a href="libecal-e-cal-util.html#e-cal-util-add-timezones-from-component">e_cal_util_add_timezones_from_component</a>
(icalcomponent *vcal_comp,
icalcomponent *icalcomp);
gboolean <a href="libecal-e-cal-util.html#e-cal-util-component-is-instance">e_cal_util_component_is_instance</a>
(icalcomponent *icalcomp);
gboolean <a href="libecal-e-cal-util.html#e-cal-util-component-has-alarms">e_cal_util_component_has_alarms</a> (icalcomponent *icalcomp);
gboolean <a href="libecal-e-cal-util.html#e-cal-util-component-has-organizer">e_cal_util_component_has_organizer</a>
(icalcomponent *icalcomp);
gboolean <a href="libecal-e-cal-util.html#e-cal-util-component-has-recurrences">e_cal_util_component_has_recurrences</a>
(icalcomponent *icalcomp);
gboolean <a href="libecal-e-cal-util.html#e-cal-util-component-has-rdates">e_cal_util_component_has_rdates</a> (icalcomponent *icalcomp);
gboolean <a href="libecal-e-cal-util.html#e-cal-util-component-has-rrules">e_cal_util_component_has_rrules</a> (icalcomponent *icalcomp);
gboolean <a href="libecal-e-cal-util.html#e-cal-util-event-dates-match">e_cal_util_event_dates_match</a> (icalcomponent *icalcomp1,
icalcomponent *icalcomp2);
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT-CAPS">CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS-CAPS">CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS-CAPS">CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS-CAPS">CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS-CAPS">CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT-CAPS">CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-THISANDFUTURE-CAPS">CAL_STATIC_CAPABILITY_NO_THISANDFUTURE</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-THISANDPRIOR-CAPS">CAL_STATIC_CAPABILITY_NO_THISANDPRIOR</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-TRANSPARENCY-CAPS">CAL_STATIC_CAPABILITY_NO_TRANSPARENCY</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY-CAPS">CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND-CAPS">CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS-CAPS">CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-REMOVE-ALARMS-CAPS">CAL_STATIC_CAPABILITY_REMOVE_ALARMS</a>
#define <a href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-SAVE-SCHEDULES-CAPS">CAL_STATIC_CAPABILITY_SAVE_SCHEDULES</a>
icalcomponent* <a href="libecal-e-cal-util.html#e-cal-util-construct-instance">e_cal_util_construct_instance</a>
(icalcomponent *icalcomp,
struct icaltimetype rid);
void <a href="libecal-e-cal-util.html#e-cal-util-remove-instances">e_cal_util_remove_instances</a> (icalcomponent *icalcomp,
struct icaltimetype rid,
<a href="libecal-e-cal-util.html#CalObjModType">CalObjModType</a> mod);
</pre></div><div class="refsect1" lang="en"><a name="id2563069"></a><h2>Description</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2563079"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2563084"></a><h3><a name="CalObjInstance"></a>struct CalObjInstance</h3><a class="indexterm" name="id2563093"></a><pre class="programlisting">struct CalObjInstance {
char *uid; /* UID of the object */
time_t start; /* Start time of instance */
time_t end; /* End time of instance */
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2563105"></a><h3><a name="cal-obj-instance-list-free"></a>cal_obj_instance_list_free ()</h3><a class="indexterm" name="id2563113"></a><pre class="programlisting">void cal_obj_instance_list_free (GList *list);</pre><p>
Frees a list of <a href="libecal-e-cal-util.html#CalObjInstance"><span class="type">CalObjInstance</span></a> structures.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>list</tt></i>:</span></td><td> List of <a href="libecal-e-cal-util.html#CalObjInstance"><span class="type">CalObjInstance</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2563164"></a><h3><a name="CalObjModType"></a>enum CalObjModType</h3><a class="indexterm" name="id2563172"></a><pre class="programlisting">typedef enum {
CALOBJ_MOD_THIS = 1 << 0,
CALOBJ_MOD_THISANDPRIOR = 1 << 1,
CALOBJ_MOD_THISANDFUTURE = 1 << 2,
CALOBJ_MOD_ALL = 0x07
} CalObjModType;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2563185"></a><h3><a name="CalMode"></a>enum CalMode</h3><a class="indexterm" name="id2563193"></a><pre class="programlisting">typedef enum {
CAL_MODE_INVALID = -1,
CAL_MODE_LOCAL = 1 << 0,
CAL_MODE_REMOTE = 1 << 1,
CAL_MODE_ANY = 0x07
} CalMode;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2563205"></a><h3><a name="cal-obj-uid-list-free"></a>cal_obj_uid_list_free ()</h3><a class="indexterm" name="id2563213"></a><pre class="programlisting">void cal_obj_uid_list_free (GList *list);</pre><p>
Frees a list of unique identifiers for calendar objects.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>list</tt></i>:</span></td><td> List of strings with unique identifiers.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2563253"></a><h3><a name="e-cal-util-new-top-level"></a>e_cal_util_new_top_level ()</h3><a class="indexterm" name="id2563261"></a><pre class="programlisting">icalcomponent* e_cal_util_new_top_level (void);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2563290"></a><h3><a name="e-cal-util-parse-ics-file"></a>e_cal_util_parse_ics_file ()</h3><a class="indexterm" name="id2563299"></a><pre class="programlisting">icalcomponent* e_cal_util_parse_ics_file (const char *filename);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2585927"></a><h3><a name="e-cal-util-generate-alarms-for-comp"></a>e_cal_util_generate_alarms_for_comp ()</h3><a class="indexterm" name="id2585938"></a><pre class="programlisting"><a href="ECalComponent.html#ECalComponentAlarms">ECalComponentAlarms</a>* e_cal_util_generate_alarms_for_comp
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
time_t start,
time_t end,
<a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a> *omit,
<a href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn">ECalRecurResolveTimezoneFn</a> resolve_tzid,
gpointer user_data,
icaltimezone *default_timezone);</pre><p>
Generates alarm instances for a calendar component. Returns the instances
structure, or NULL if no alarm instances occurred in the specified time
range.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>comp</tt></i>:</span></td><td> the ECalComponent to generate alarms from
</td></tr><tr><td><span class="term"><i class="parameter"><tt>start</tt></i>:</span></td><td> start time
</td></tr><tr><td><span class="term"><i class="parameter"><tt>end</tt></i>:</span></td><td> end time
</td></tr><tr><td><span class="term"><i class="parameter"><tt>omit</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>resolve_tzid</tt></i>:</span></td><td> callback for resolving timezones
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td> data to be passed to the resolve_tzid callback
</td></tr><tr><td><span class="term"><i class="parameter"><tt>default_timezone</tt></i>:</span></td><td> the timezone used to resolve DATE and floating DATE-TIME
values.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2529279"></a><h3><a name="e-cal-util-generate-alarms-for-list"></a>e_cal_util_generate_alarms_for_list ()</h3><a class="indexterm" name="id2551239"></a><pre class="programlisting">int e_cal_util_generate_alarms_for_list
(GList *comps,
time_t start,
time_t end,
<a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a> *omit,
GSList **comp_alarms,
<a href="libecal-e-cal-recur.html#ECalRecurResolveTimezoneFn">ECalRecurResolveTimezoneFn</a> resolve_tzid,
gpointer user_data,
icaltimezone *default_timezone);</pre><p>
Iterates through all the components in the comps list and generates alarm
instances for them; putting them in the comp_alarms list.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>comps</tt></i>:</span></td><td> list of ECalComponent's
</td></tr><tr><td><span class="term"><i class="parameter"><tt>start</tt></i>:</span></td><td> start time
</td></tr><tr><td><span class="term"><i class="parameter"><tt>end</tt></i>:</span></td><td> end time
</td></tr><tr><td><span class="term"><i class="parameter"><tt>omit</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>comp_alarms</tt></i>:</span></td><td> list to be returned
</td></tr><tr><td><span class="term"><i class="parameter"><tt>resolve_tzid</tt></i>:</span></td><td> callback for resolving timezones
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td> data to be passed to the resolve_tzid callback
</td></tr><tr><td><span class="term"><i class="parameter"><tt>default_timezone</tt></i>:</span></td><td> the timezone used to resolve DATE and floating DATE-TIME
values.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the number of elements it added to that list.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586226"></a><h3><a name="e-cal-util-resolve-tzid"></a>e_cal_util_resolve_tzid ()</h3><a class="indexterm" name="id2586234"></a><pre class="programlisting">icaltimezone* e_cal_util_resolve_tzid (const char *tzid,
gpointer data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>tzid</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586290"></a><h3><a name="e-cal-util-priority-to-string"></a>e_cal_util_priority_to_string ()</h3><a class="indexterm" name="id2586298"></a><pre class="programlisting">char* e_cal_util_priority_to_string (int priority);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>priority</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586341"></a><h3><a name="e-cal-util-priority-from-string"></a>e_cal_util_priority_from_string ()</h3><a class="indexterm" name="id2586350"></a><pre class="programlisting">int e_cal_util_priority_from_string (const char *string);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>string</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586394"></a><h3><a name="e-cal-util-expand-uri"></a>e_cal_util_expand_uri ()</h3><a class="indexterm" name="id2586402"></a><pre class="programlisting">char* e_cal_util_expand_uri (char *uri,
gboolean tasks);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>uri</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>tasks</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586463"></a><h3><a name="e-cal-util-add-timezones-from-component"></a>e_cal_util_add_timezones_from_component ()</h3><a class="indexterm" name="id2586471"></a><pre class="programlisting">void e_cal_util_add_timezones_from_component
(icalcomponent *vcal_comp,
icalcomponent *icalcomp);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>vcal_comp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586523"></a><h3><a name="e-cal-util-component-is-instance"></a>e_cal_util_component_is_instance ()</h3><a class="indexterm" name="id2586532"></a><pre class="programlisting">gboolean e_cal_util_component_is_instance
(icalcomponent *icalcomp);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586577"></a><h3><a name="e-cal-util-component-has-alarms"></a>e_cal_util_component_has_alarms ()</h3><a class="indexterm" name="id2586585"></a><pre class="programlisting">gboolean e_cal_util_component_has_alarms (icalcomponent *icalcomp);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586628"></a><h3><a name="e-cal-util-component-has-organizer"></a>e_cal_util_component_has_organizer ()</h3><a class="indexterm" name="id2586637"></a><pre class="programlisting">gboolean e_cal_util_component_has_organizer
(icalcomponent *icalcomp);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586682"></a><h3><a name="e-cal-util-component-has-recurrences"></a>e_cal_util_component_has_recurrences ()</h3><a class="indexterm" name="id2586690"></a><pre class="programlisting">gboolean e_cal_util_component_has_recurrences
(icalcomponent *icalcomp);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586735"></a><h3><a name="e-cal-util-component-has-rdates"></a>e_cal_util_component_has_rdates ()</h3><a class="indexterm" name="id2586743"></a><pre class="programlisting">gboolean e_cal_util_component_has_rdates (icalcomponent *icalcomp);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586787"></a><h3><a name="e-cal-util-component-has-rrules"></a>e_cal_util_component_has_rrules ()</h3><a class="indexterm" name="id2586795"></a><pre class="programlisting">gboolean e_cal_util_component_has_rrules (icalcomponent *icalcomp);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586838"></a><h3><a name="e-cal-util-event-dates-match"></a>e_cal_util_event_dates_match ()</h3><a class="indexterm" name="id2586847"></a><pre class="programlisting">gboolean e_cal_util_event_dates_match (icalcomponent *icalcomp1,
icalcomponent *icalcomp2);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp1</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp2</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586907"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT-CAPS"></a>CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT</h3><a class="indexterm" name="id2586916"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT "no-alarm-repeat"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2586927"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS-CAPS"></a>CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS</h3><a class="indexterm" name="id2586935"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS "no-audio-alarms"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2586946"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS-CAPS"></a>CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS</h3><a class="indexterm" name="id2586958"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS "no-display-alarms"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2586969"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS-CAPS"></a>CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS</h3><a class="indexterm" name="id2586977"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS "no-email-alarms"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2586988"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS-CAPS"></a>CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS</h3><a class="indexterm" name="id2587000"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS "no-procedure-alarms"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587011"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT-CAPS"></a>CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT</h3><a class="indexterm" name="id2587022"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT "no-task-assignment"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587033"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-THISANDFUTURE-CAPS"></a>CAL_STATIC_CAPABILITY_NO_THISANDFUTURE</h3><a class="indexterm" name="id2587042"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_THISANDFUTURE "no-thisandfuture"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587053"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-THISANDPRIOR-CAPS"></a>CAL_STATIC_CAPABILITY_NO_THISANDPRIOR</h3><a class="indexterm" name="id2587065"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_THISANDPRIOR "no-thisandprior"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587077"></a><h3><a name="CAL-STATIC-CAPABILITY-NO-TRANSPARENCY-CAPS"></a>CAL_STATIC_CAPABILITY_NO_TRANSPARENCY</h3><a class="indexterm" name="id2587088"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_TRANSPARENCY "no-transparency"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587100"></a><h3><a name="CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY-CAPS"></a>CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY</h3><a class="indexterm" name="id2587112"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY "one-alarm-only"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587124"></a><h3><a name="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND-CAPS"></a>CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND</h3><a class="indexterm" name="id2587137"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND "organizer-must-attend"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587148"></a><h3><a name="CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS-CAPS"></a>CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS</h3><a class="indexterm" name="id2587160"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS "organizer-not-email-address"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587172"></a><h3><a name="CAL-STATIC-CAPABILITY-REMOVE-ALARMS-CAPS"></a>CAL_STATIC_CAPABILITY_REMOVE_ALARMS</h3><a class="indexterm" name="id2587184"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_REMOVE_ALARMS "remove-alarms"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587196"></a><h3><a name="CAL-STATIC-CAPABILITY-SAVE-SCHEDULES-CAPS"></a>CAL_STATIC_CAPABILITY_SAVE_SCHEDULES</h3><a class="indexterm" name="id2587207"></a><pre class="programlisting">#define CAL_STATIC_CAPABILITY_SAVE_SCHEDULES "save-schedules"
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2587219"></a><h3><a name="e-cal-util-construct-instance"></a>e_cal_util_construct_instance ()</h3><a class="indexterm" name="id2587230"></a><pre class="programlisting">icalcomponent* e_cal_util_construct_instance
(icalcomponent *icalcomp,
struct icaltimetype rid);</pre><p>
This checks that <i class="parameter"><tt>rid</tt></i> indicates a valid recurrence of <i class="parameter"><tt>icalcomp</tt></i>, and
if so, generates a copy of <i class="parameter"><tt>comp</tt></i> containing a RECURRENCE-ID of <i class="parameter"><tt>rid</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td> a recurring <span class="type">icalcomponent</span>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>rid</tt></i>:</span></td><td> the RECURRENCE-ID to construct a component for
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the instance, or <tt class="literal">NULL</tt>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2587321"></a><h3><a name="e-cal-util-remove-instances"></a>e_cal_util_remove_instances ()</h3><a class="indexterm" name="id2587330"></a><pre class="programlisting">void e_cal_util_remove_instances (icalcomponent *icalcomp,
struct icaltimetype rid,
<a href="libecal-e-cal-util.html#CalObjModType">CalObjModType</a> mod);</pre><p>
Removes one or more instances from <i class="parameter"><tt>comp</tt></i> according to <i class="parameter"><tt>rid</tt></i> and <i class="parameter"><tt>mod</tt></i>.
</p><p>
FIXME: should probably have a return value indicating whether or not
<i class="parameter"><tt>icalcomp</tt></i> still has any instances</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td> a (recurring) <span class="type">icalcomponent</span>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>rid</tt></i>:</span></td><td> the base RECURRENCE-ID to remove
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mod</tt></i>:</span></td><td> how to interpret <i class="parameter"><tt>rid</tt></i>
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libecal-e-cal-types.html"><b><<e-cal-types</b></a></td><td align="right"><a accesskey="n" href="libecal-ECalView.html"><b>ECalView>></b></a></td></tr></table></body></html>
|
