← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/calendar/libecal/html/libecal-e-cal-util.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>e-cal-util</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Calendar Client (libecal)">
9
9
<link rel="prev" href="libecal-e-cal-types.html" title="e-cal-types">
26
26
                  <a href="#libecal-e-cal-util.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="e-cal-util">
30
30
<a name="libecal-e-cal-util"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="libecal-e-cal-util.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">                    <a class="link" href="libecal-e-cal-util.html#CalObjInstance" title="CalObjInstance">CalObjInstance</a>;
41
41
<span class="returnvalue">void</span>                <a class="link" href="libecal-e-cal-util.html#cal-obj-instance-list-free" title="cal_obj_instance_list_free ()">cal_obj_instance_list_free</a>          (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);
103
103
#define             <a class="link" href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-NO-ORGANIZER:CAPS" title="CAL_STATIC_CAPABILITY_NO_ORGANIZER">CAL_STATIC_CAPABILITY_NO_ORGANIZER</a>
104
104
#define             <a class="link" href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-DELEGATE-TO-MANY:CAPS" title="CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY">CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY</a>
105
105
#define             <a class="link" href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-HAS-UNACCEPTED-MEETING:CAPS" title="CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING">CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING</a>
 
106
#define             <a class="link" href="libecal-e-cal-util.html#CAL-STATIC-CAPABILITY-REFRESH-SUPPORTED:CAPS" title="CAL_STATIC_CAPABILITY_REFRESH_SUPPORTED">CAL_STATIC_CAPABILITY_REFRESH_SUPPORTED</a>
106
107
<span class="returnvalue">icalcomponent</span> *     <a class="link" href="libecal-e-cal-util.html#e-cal-util-construct-instance" title="e_cal_util_construct_instance ()">e_cal_util_construct_instance</a>       (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
107
108
                                                         <em class="parameter"><code><span class="type">struct icaltimetype</span> rid</code></em>);
108
109
<span class="returnvalue">void</span>                <a class="link" href="libecal-e-cal-util.html#e-cal-util-remove-instances" title="e_cal_util_remove_instances ()">e_cal_util_remove_instances</a>         (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
113
114
<span class="returnvalue">icaltimezone</span> *      <a class="link" href="libecal-e-cal-util.html#e-cal-util-get-system-timezone" title="e_cal_util_get_system_timezone ()">e_cal_util_get_system_timezone</a>      (<em class="parameter"><code><span class="type">void</span></code></em>);
114
115
</pre>
115
116
</div>
116
 
<div class="refsect1" lang="en">
 
117
<div class="refsect1" title="Description">
117
118
<a name="libecal-e-cal-util.description"></a><h2>Description</h2>
118
119
<p>
119
120
</p>
120
121
</div>
121
 
<div class="refsect1" lang="en">
 
122
<div class="refsect1" title="Details">
122
123
<a name="libecal-e-cal-util.details"></a><h2>Details</h2>
123
 
<div class="refsect2" lang="en">
 
124
<div class="refsect2" title="CalObjInstance">
124
125
<a name="CalObjInstance"></a><h3>CalObjInstance</h3>
125
126
<pre class="programlisting">typedef struct {
126
127
        gchar *uid;                     /* UID of the object */
132
133
</p>
133
134
</div>
134
135
<hr>
135
 
<div class="refsect2" lang="en">
 
136
<div class="refsect2" title="cal_obj_instance_list_free ()">
136
137
<a name="cal-obj-instance-list-free"></a><h3>cal_obj_instance_list_free ()</h3>
137
138
<pre class="programlisting"><span class="returnvalue">void</span>                cal_obj_instance_list_free          (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre>
138
139
<p>
139
 
Frees a list of <a class="link" href="libecal-e-cal-util.html#CalObjInstance" title="CalObjInstance"><span class="type">CalObjInstance</span></a> structures.</p>
 
140
Frees a list of <a class="link" href="libecal-e-cal-util.html#CalObjInstance" title="CalObjInstance"><span class="type">CalObjInstance</span></a> structures.
 
141
</p>
140
142
<div class="variablelist"><table border="0">
141
143
<col align="left" valign="top">
142
144
<tbody><tr>
147
149
</table></div>
148
150
</div>
149
151
<hr>
150
 
<div class="refsect2" lang="en">
 
152
<div class="refsect2" title="enum CalObjModType">
151
153
<a name="CalObjModType"></a><h3>enum CalObjModType</h3>
152
154
<pre class="programlisting">typedef enum {
153
155
        CALOBJ_MOD_THIS          = 1 &lt;&lt; 0,
160
162
</p>
161
163
</div>
162
164
<hr>
163
 
<div class="refsect2" lang="en">
 
165
<div class="refsect2" title="enum CalMode">
164
166
<a name="CalMode"></a><h3>enum CalMode</h3>
165
167
<pre class="programlisting">typedef enum {
166
168
        CAL_MODE_INVALID = -1,
173
175
</p>
174
176
</div>
175
177
<hr>
176
 
<div class="refsect2" lang="en">
 
178
<div class="refsect2" title="cal_mode_to_corba()">
177
179
<a name="cal-mode-to-corba"></a><h3>cal_mode_to_corba()</h3>
178
180
<pre class="programlisting">#define             cal_mode_to_corba(mode)</pre>
179
181
<p>
188
190
</table></div>
189
191
</div>
190
192
<hr>
191
 
<div class="refsect2" lang="en">
 
193
<div class="refsect2" title="cal_obj_uid_list_free ()">
192
194
<a name="cal-obj-uid-list-free"></a><h3>cal_obj_uid_list_free ()</h3>
193
195
<pre class="programlisting"><span class="returnvalue">void</span>                cal_obj_uid_list_free               (<em class="parameter"><code><span class="type">GList</span> *list</code></em>);</pre>
194
196
<p>
195
 
Frees a list of unique identifiers for calendar objects.</p>
 
197
Frees a list of unique identifiers for calendar objects.
 
198
</p>
196
199
<div class="variablelist"><table border="0">
197
200
<col align="left" valign="top">
198
201
<tbody><tr>
203
206
</table></div>
204
207
</div>
205
208
<hr>
206
 
<div class="refsect2" lang="en">
 
209
<div class="refsect2" title="e_cal_util_new_top_level ()">
207
210
<a name="e-cal-util-new-top-level"></a><h3>e_cal_util_new_top_level ()</h3>
208
211
<pre class="programlisting"><span class="returnvalue">icalcomponent</span> *     e_cal_util_new_top_level            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
209
212
<p>
210
 
Creates a new VCALENDAR component.</p>
 
213
Creates a new VCALENDAR component.
 
214
</p>
211
215
<div class="variablelist"><table border="0">
212
216
<col align="left" valign="top">
213
217
<tbody><tr>
218
222
</table></div>
219
223
</div>
220
224
<hr>
221
 
<div class="refsect2" lang="en">
 
225
<div class="refsect2" title="e_cal_util_new_component ()">
222
226
<a name="e-cal-util-new-component"></a><h3>e_cal_util_new_component ()</h3>
223
227
<pre class="programlisting"><span class="returnvalue">icalcomponent</span> *     e_cal_util_new_component            (<em class="parameter"><code><span class="type">icalcomponent_kind</span> kind</code></em>);</pre>
224
228
<p>
225
 
Creates a new <span class="type">icalcomponent</span> of the specified kind.</p>
 
229
Creates a new <span class="type">icalcomponent</span> of the specified kind.
 
230
</p>
226
231
<div class="variablelist"><table border="0">
227
232
<col align="left" valign="top">
228
233
<tbody>
240
245
</table></div>
241
246
</div>
242
247
<hr>
243
 
<div class="refsect2" lang="en">
 
248
<div class="refsect2" title="e_cal_util_parse_ics_string ()">
244
249
<a name="e-cal-util-parse-ics-string"></a><h3>e_cal_util_parse_ics_string ()</h3>
245
250
<pre class="programlisting"><span class="returnvalue">icalcomponent</span> *     e_cal_util_parse_ics_string         (<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>);</pre>
246
251
<p>
247
252
Parses an iCalendar string and returns a new <span class="type">icalcomponent</span> representing
248
253
that string. Note that this function deals with multiple VCALENDAR's in the
249
254
string, something that Mozilla used to do and which libical does not
250
 
support.</p>
 
255
support.
 
256
</p>
251
257
<div class="variablelist"><table border="0">
252
258
<col align="left" valign="top">
253
259
<tbody>
266
272
</table></div>
267
273
</div>
268
274
<hr>
269
 
<div class="refsect2" lang="en">
 
275
<div class="refsect2" title="e_cal_util_parse_ics_file ()">
270
276
<a name="e-cal-util-parse-ics-file"></a><h3>e_cal_util_parse_ics_file ()</h3>
271
277
<pre class="programlisting"><span class="returnvalue">icalcomponent</span> *     e_cal_util_parse_ics_file           (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
272
278
<p>
273
279
Parses the given file, and, if it contains a valid iCalendar object,
274
 
parse it and return a new <span class="type">icalcomponent</span>.</p>
 
280
parse it and return a new <span class="type">icalcomponent</span>.
 
281
</p>
275
282
<div class="variablelist"><table border="0">
276
283
<col align="left" valign="top">
277
284
<tbody>
290
297
</table></div>
291
298
</div>
292
299
<hr>
293
 
<div class="refsect2" lang="en">
 
300
<div class="refsect2" title="e_cal_util_generate_alarms_for_comp ()">
294
301
<a name="e-cal-util-generate-alarms-for-comp"></a><h3>e_cal_util_generate_alarms_for_comp ()</h3>
295
302
<pre class="programlisting"><a class="link" href="ECalComponent.html#ECalComponentAlarms" title="ECalComponentAlarms"><span class="returnvalue">ECalComponentAlarms</span></a> * e_cal_util_generate_alarms_for_comp
296
303
                                                        (<em class="parameter"><code><a class="link" href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a> *comp</code></em>,
303
310
<p>
304
311
Generates alarm instances for a calendar component.  Returns the instances
305
312
structure, or NULL if no alarm instances occurred in the specified time
306
 
range.</p>
 
313
range.
 
314
</p>
307
315
<div class="variablelist"><table border="0">
308
316
<col align="left" valign="top">
309
317
<tbody>
354
362
</table></div>
355
363
</div>
356
364
<hr>
357
 
<div class="refsect2" lang="en">
 
365
<div class="refsect2" title="e_cal_util_generate_alarms_for_list ()">
358
366
<a name="e-cal-util-generate-alarms-for-list"></a><h3>e_cal_util_generate_alarms_for_list ()</h3>
359
367
<pre class="programlisting"><span class="returnvalue">gint</span>                e_cal_util_generate_alarms_for_list (<em class="parameter"><code><span class="type">GList</span> *comps</code></em>,
360
368
                                                         <em class="parameter"><code><span class="type">time_t</span> start</code></em>,
366
374
                                                         <em class="parameter"><code><span class="type">icaltimezone</span> *default_timezone</code></em>);</pre>
367
375
<p>
368
376
Iterates through all the components in the <em class="parameter"><code>comps</code></em> list and generates alarm
369
 
instances for them; putting them in the <em class="parameter"><code>comp_alarms</code></em> list.</p>
 
377
instances for them; putting them in the <em class="parameter"><code>comp_alarms</code></em> list.
 
378
</p>
370
379
<div class="variablelist"><table border="0">
371
380
<col align="left" valign="top">
372
381
<tbody>
420
429
</table></div>
421
430
</div>
422
431
<hr>
423
 
<div class="refsect2" lang="en">
 
432
<div class="refsect2" title="e_cal_util_priority_to_string ()">
424
433
<a name="e-cal-util-priority-to-string"></a><h3>e_cal_util_priority_to_string ()</h3>
425
434
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_cal_util_priority_to_string       (<em class="parameter"><code><span class="type">gint</span> priority</code></em>);</pre>
426
435
<p>
427
436
Converts an iCalendar PRIORITY value to a translated string. Any unknown
428
 
priority value (i.e. not 0-9) will be returned as "" (undefined).</p>
 
437
priority value (i.e. not 0-9) will be returned as "" (undefined).
 
438
</p>
429
439
<div class="variablelist"><table border="0">
430
440
<col align="left" valign="top">
431
441
<tbody>
444
454
</table></div>
445
455
</div>
446
456
<hr>
447
 
<div class="refsect2" lang="en">
 
457
<div class="refsect2" title="e_cal_util_priority_from_string ()">
448
458
<a name="e-cal-util-priority-from-string"></a><h3>e_cal_util_priority_from_string ()</h3>
449
459
<pre class="programlisting"><span class="returnvalue">gint</span>                e_cal_util_priority_from_string     (<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>);</pre>
450
460
<p>
451
 
Converts a translated priority string to an iCalendar priority value.</p>
 
461
Converts a translated priority string to an iCalendar priority value.
 
462
</p>
452
463
<div class="variablelist"><table border="0">
453
464
<col align="left" valign="top">
454
465
<tbody>
466
477
</table></div>
467
478
</div>
468
479
<hr>
469
 
<div class="refsect2" lang="en">
 
480
<div class="refsect2" title="e_cal_util_add_timezones_from_component ()">
470
481
<a name="e-cal-util-add-timezones-from-component"></a><h3>e_cal_util_add_timezones_from_component ()</h3>
471
482
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_util_add_timezones_from_component
472
483
                                                        (<em class="parameter"><code><span class="type">icalcomponent</span> *vcal_comp</code></em>,
473
484
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
474
485
<p>
475
486
Adds VTIMEZONE components to a VCALENDAR for all tzid's
476
 
in the given <em class="parameter"><code>icalcomp</code></em>.</p>
 
487
in the given <em class="parameter"><code>icalcomp</code></em>.
 
488
</p>
477
489
<div class="variablelist"><table border="0">
478
490
<col align="left" valign="top">
479
491
<tbody>
491
503
</table></div>
492
504
</div>
493
505
<hr>
494
 
<div class="refsect2" lang="en">
 
506
<div class="refsect2" title="e_cal_util_component_is_instance ()">
495
507
<a name="e-cal-util-component-is-instance"></a><h3>e_cal_util_component_is_instance ()</h3>
496
508
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_util_component_is_instance    (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
497
509
<p>
498
 
Checks whether an <span class="type">icalcomponent</span> is an instance of a recurring appointment or not.</p>
 
510
Checks whether an <span class="type">icalcomponent</span> is an instance of a recurring appointment or not.
 
511
</p>
499
512
<div class="variablelist"><table border="0">
500
513
<col align="left" valign="top">
501
514
<tbody>
513
526
</table></div>
514
527
</div>
515
528
<hr>
516
 
<div class="refsect2" lang="en">
 
529
<div class="refsect2" title="e_cal_util_component_has_alarms ()">
517
530
<a name="e-cal-util-component-has-alarms"></a><h3>e_cal_util_component_has_alarms ()</h3>
518
531
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_util_component_has_alarms     (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
519
532
<p>
520
 
Checks whether an <span class="type">icalcomponent</span> has any alarm.</p>
 
533
Checks whether an <span class="type">icalcomponent</span> has any alarm.
 
534
</p>
521
535
<div class="variablelist"><table border="0">
522
536
<col align="left" valign="top">
523
537
<tbody>
535
549
</table></div>
536
550
</div>
537
551
<hr>
538
 
<div class="refsect2" lang="en">
 
552
<div class="refsect2" title="e_cal_util_component_has_organizer ()">
539
553
<a name="e-cal-util-component-has-organizer"></a><h3>e_cal_util_component_has_organizer ()</h3>
540
554
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_util_component_has_organizer  (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
541
555
<p>
542
 
Checks whether an <span class="type">icalcomponent</span> has an organizer or not.</p>
 
556
Checks whether an <span class="type">icalcomponent</span> has an organizer or not.
 
557
</p>
543
558
<div class="variablelist"><table border="0">
544
559
<col align="left" valign="top">
545
560
<tbody>
557
572
</table></div>
558
573
</div>
559
574
<hr>
560
 
<div class="refsect2" lang="en">
 
575
<div class="refsect2" title="e_cal_util_component_has_recurrences ()">
561
576
<a name="e-cal-util-component-has-recurrences"></a><h3>e_cal_util_component_has_recurrences ()</h3>
562
577
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_util_component_has_recurrences
563
578
                                                        (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
564
579
<p>
565
 
Checks if an <span class="type">icalcomponent</span> has recurrence dates or rules.</p>
 
580
Checks if an <span class="type">icalcomponent</span> has recurrence dates or rules.
 
581
</p>
566
582
<div class="variablelist"><table border="0">
567
583
<col align="left" valign="top">
568
584
<tbody>
580
596
</table></div>
581
597
</div>
582
598
<hr>
583
 
<div class="refsect2" lang="en">
 
599
<div class="refsect2" title="e_cal_util_component_has_rdates ()">
584
600
<a name="e-cal-util-component-has-rdates"></a><h3>e_cal_util_component_has_rdates ()</h3>
585
601
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_util_component_has_rdates     (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
586
602
<p>
587
 
Checks if an <span class="type">icalcomponent</span> has recurrence dates.</p>
 
603
Checks if an <span class="type">icalcomponent</span> has recurrence dates.
 
604
</p>
588
605
<div class="variablelist"><table border="0">
589
606
<col align="left" valign="top">
590
607
<tbody>
602
619
</table></div>
603
620
</div>
604
621
<hr>
605
 
<div class="refsect2" lang="en">
 
622
<div class="refsect2" title="e_cal_util_component_has_rrules ()">
606
623
<a name="e-cal-util-component-has-rrules"></a><h3>e_cal_util_component_has_rrules ()</h3>
607
624
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_util_component_has_rrules     (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
608
625
<p>
609
 
Checks if an <span class="type">icalcomponent</span> has recurrence rules.</p>
 
626
Checks if an <span class="type">icalcomponent</span> has recurrence rules.
 
627
</p>
610
628
<div class="variablelist"><table border="0">
611
629
<col align="left" valign="top">
612
630
<tbody>
624
642
</table></div>
625
643
</div>
626
644
<hr>
627
 
<div class="refsect2" lang="en">
 
645
<div class="refsect2" title="e_cal_util_component_has_attendee ()">
628
646
<a name="e-cal-util-component-has-attendee"></a><h3>e_cal_util_component_has_attendee ()</h3>
629
647
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_util_component_has_attendee   (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>);</pre>
630
648
<p>
631
 
Checks if an <span class="type">icalcomponent</span> has any attendees.</p>
 
649
Checks if an <span class="type">icalcomponent</span> has any attendees.
 
650
</p>
632
651
<div class="variablelist"><table border="0">
633
652
<col align="left" valign="top">
634
653
<tbody>
646
665
</table></div>
647
666
</div>
648
667
<hr>
649
 
<div class="refsect2" lang="en">
 
668
<div class="refsect2" title="e_cal_util_event_dates_match ()">
650
669
<a name="e-cal-util-event-dates-match"></a><h3>e_cal_util_event_dates_match ()</h3>
651
670
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_cal_util_event_dates_match        (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp1</code></em>,
652
671
                                                         <em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp2</code></em>);</pre>
653
672
<p>
654
 
Compare the dates of two <span class="type">icalcomponent</span>'s to check if they match.</p>
 
673
Compare the dates of two <span class="type">icalcomponent</span>'s to check if they match.
 
674
</p>
655
675
<div class="variablelist"><table border="0">
656
676
<col align="left" valign="top">
657
677
<tbody>
674
694
</table></div>
675
695
</div>
676
696
<hr>
677
 
<div class="refsect2" lang="en">
 
697
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT">
678
698
<a name="CAL-STATIC-CAPABILITY-NO-ALARM-REPEAT:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT</h3>
679
699
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_ALARM_REPEAT             "no-alarm-repeat"
680
700
</pre>
682
702
</p>
683
703
</div>
684
704
<hr>
685
 
<div class="refsect2" lang="en">
 
705
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS">
686
706
<a name="CAL-STATIC-CAPABILITY-NO-AUDIO-ALARMS:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS</h3>
687
707
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_AUDIO_ALARMS             "no-audio-alarms"
688
708
</pre>
690
710
</p>
691
711
</div>
692
712
<hr>
693
 
<div class="refsect2" lang="en">
 
713
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS">
694
714
<a name="CAL-STATIC-CAPABILITY-NO-DISPLAY-ALARMS:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS</h3>
695
715
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_DISPLAY_ALARMS           "no-display-alarms"
696
716
</pre>
698
718
</p>
699
719
</div>
700
720
<hr>
701
 
<div class="refsect2" lang="en">
 
721
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS">
702
722
<a name="CAL-STATIC-CAPABILITY-NO-EMAIL-ALARMS:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS</h3>
703
723
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_EMAIL_ALARMS             "no-email-alarms"
704
724
</pre>
706
726
</p>
707
727
</div>
708
728
<hr>
709
 
<div class="refsect2" lang="en">
 
729
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS">
710
730
<a name="CAL-STATIC-CAPABILITY-NO-PROCEDURE-ALARMS:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS</h3>
711
731
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_PROCEDURE_ALARMS         "no-procedure-alarms"
712
732
</pre>
714
734
</p>
715
735
</div>
716
736
<hr>
717
 
<div class="refsect2" lang="en">
 
737
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT">
718
738
<a name="CAL-STATIC-CAPABILITY-NO-TASK-ASSIGNMENT:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT</h3>
719
739
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_TASK_ASSIGNMENT          "no-task-assignment"
720
740
</pre>
722
742
</p>
723
743
</div>
724
744
<hr>
725
 
<div class="refsect2" lang="en">
 
745
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_THISANDFUTURE">
726
746
<a name="CAL-STATIC-CAPABILITY-NO-THISANDFUTURE:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_THISANDFUTURE</h3>
727
747
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_THISANDFUTURE            "no-thisandfuture"
728
748
</pre>
730
750
</p>
731
751
</div>
732
752
<hr>
733
 
<div class="refsect2" lang="en">
 
753
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_THISANDPRIOR">
734
754
<a name="CAL-STATIC-CAPABILITY-NO-THISANDPRIOR:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_THISANDPRIOR</h3>
735
755
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_THISANDPRIOR             "no-thisandprior"
736
756
</pre>
738
758
</p>
739
759
</div>
740
760
<hr>
741
 
<div class="refsect2" lang="en">
 
761
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_TRANSPARENCY">
742
762
<a name="CAL-STATIC-CAPABILITY-NO-TRANSPARENCY:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_TRANSPARENCY</h3>
743
763
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_TRANSPARENCY             "no-transparency"
744
764
</pre>
746
766
</p>
747
767
</div>
748
768
<hr>
749
 
<div class="refsect2" lang="en">
 
769
<div class="refsect2" title="CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY">
750
770
<a name="CAL-STATIC-CAPABILITY-ONE-ALARM-ONLY:CAPS"></a><h3>CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY</h3>
751
771
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY              "one-alarm-only"
752
772
</pre>
754
774
</p>
755
775
</div>
756
776
<hr>
757
 
<div class="refsect2" lang="en">
 
777
<div class="refsect2" title="CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND">
758
778
<a name="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ATTEND:CAPS"></a><h3>CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND</h3>
759
779
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND       "organizer-must-attend"
760
780
</pre>
762
782
</p>
763
783
</div>
764
784
<hr>
765
 
<div class="refsect2" lang="en">
 
785
<div class="refsect2" title="CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS">
766
786
<a name="CAL-STATIC-CAPABILITY-ORGANIZER-NOT-EMAIL-ADDRESS:CAPS"></a><h3>CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS</h3>
767
787
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS "organizer-not-email-address"
768
788
</pre>
770
790
</p>
771
791
</div>
772
792
<hr>
773
 
<div class="refsect2" lang="en">
 
793
<div class="refsect2" title="CAL_STATIC_CAPABILITY_REMOVE_ALARMS">
774
794
<a name="CAL-STATIC-CAPABILITY-REMOVE-ALARMS:CAPS"></a><h3>CAL_STATIC_CAPABILITY_REMOVE_ALARMS</h3>
775
795
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_REMOVE_ALARMS               "remove-alarms"
776
796
</pre>
778
798
</p>
779
799
</div>
780
800
<hr>
781
 
<div class="refsect2" lang="en">
 
801
<div class="refsect2" title="CAL_STATIC_CAPABILITY_CREATE_MESSAGES">
782
802
<a name="CAL-STATIC-CAPABILITY-CREATE-MESSAGES:CAPS"></a><h3>CAL_STATIC_CAPABILITY_CREATE_MESSAGES</h3>
783
803
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_CREATE_MESSAGES             "create-messages"
784
804
</pre>
785
 
<p>
786
 
</p>
 
805
<p class="since">Since 2.26</p>
787
806
</div>
788
807
<hr>
789
 
<div class="refsect2" lang="en">
 
808
<div class="refsect2" title="CAL_STATIC_CAPABILITY_SAVE_SCHEDULES">
790
809
<a name="CAL-STATIC-CAPABILITY-SAVE-SCHEDULES:CAPS"></a><h3>CAL_STATIC_CAPABILITY_SAVE_SCHEDULES</h3>
791
810
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_SAVE_SCHEDULES              "save-schedules"
792
811
</pre>
794
813
</p>
795
814
</div>
796
815
<hr>
797
 
<div class="refsect2" lang="en">
 
816
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK">
798
817
<a name="CAL-STATIC-CAPABILITY-NO-CONV-TO-ASSIGN-TASK:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK</h3>
799
818
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_CONV_TO_ASSIGN_TASK          "no-conv-to-assign-task"
800
819
</pre>
802
821
</p>
803
822
</div>
804
823
<hr>
805
 
<div class="refsect2" lang="en">
 
824
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR">
806
825
<a name="CAL-STATIC-CAPABILITY-NO-CONV-TO-RECUR:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR</h3>
807
826
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_CONV_TO_RECUR                "no-conv-to-recur"
808
827
</pre>
810
829
</p>
811
830
</div>
812
831
<hr>
813
 
<div class="refsect2" lang="en">
 
832
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS">
814
833
<a name="CAL-STATIC-CAPABILITY-NO-GEN-OPTIONS:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS</h3>
815
834
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_GEN_OPTIONS                  "no-general-options"
816
835
</pre>
818
837
</p>
819
838
</div>
820
839
<hr>
821
 
<div class="refsect2" lang="en">
 
840
<div class="refsect2" title="CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS">
822
841
<a name="CAL-STATIC-CAPABILITY-REQ-SEND-OPTIONS:CAPS"></a><h3>CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS</h3>
823
842
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_REQ_SEND_OPTIONS                "require-send-options"
824
843
</pre>
826
845
</p>
827
846
</div>
828
847
<hr>
829
 
<div class="refsect2" lang="en">
 
848
<div class="refsect2" title="CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER">
830
849
<a name="CAL-STATIC-CAPABILITY-RECURRENCES-NO-MASTER:CAPS"></a><h3>CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER</h3>
831
850
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_RECURRENCES_NO_MASTER       "recurrences-no-master-object"
832
851
</pre>
834
853
</p>
835
854
</div>
836
855
<hr>
837
 
<div class="refsect2" lang="en">
 
856
<div class="refsect2" title="CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT">
838
857
<a name="CAL-STATIC-CAPABILITY-ORGANIZER-MUST-ACCEPT:CAPS"></a><h3>CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT</h3>
839
858
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ACCEPT      "organizer-must-accept"
840
859
</pre>
842
861
</p>
843
862
</div>
844
863
<hr>
845
 
<div class="refsect2" lang="en">
 
864
<div class="refsect2" title="CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED">
846
865
<a name="CAL-STATIC-CAPABILITY-DELEGATE-SUPPORTED:CAPS"></a><h3>CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED</h3>
847
866
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_DELEGATE_SUPPORTED     "delegate-support"
848
867
</pre>
850
869
</p>
851
870
</div>
852
871
<hr>
853
 
<div class="refsect2" lang="en">
 
872
<div class="refsect2" title="CAL_STATIC_CAPABILITY_NO_ORGANIZER">
854
873
<a name="CAL-STATIC-CAPABILITY-NO-ORGANIZER:CAPS"></a><h3>CAL_STATIC_CAPABILITY_NO_ORGANIZER</h3>
855
874
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_NO_ORGANIZER           "no-organizer"
856
875
</pre>
858
877
</p>
859
878
</div>
860
879
<hr>
861
 
<div class="refsect2" lang="en">
 
880
<div class="refsect2" title="CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY">
862
881
<a name="CAL-STATIC-CAPABILITY-DELEGATE-TO-MANY:CAPS"></a><h3>CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY</h3>
863
882
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY               "delegate-to-many"
864
883
</pre>
866
885
</p>
867
886
</div>
868
887
<hr>
869
 
<div class="refsect2" lang="en">
 
888
<div class="refsect2" title="CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING">
870
889
<a name="CAL-STATIC-CAPABILITY-HAS-UNACCEPTED-MEETING:CAPS"></a><h3>CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING</h3>
871
890
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING     "has-unaccepted-meeting"
872
891
</pre>
874
893
</p>
875
894
</div>
876
895
<hr>
877
 
<div class="refsect2" lang="en">
 
896
<div class="refsect2" title="CAL_STATIC_CAPABILITY_REFRESH_SUPPORTED">
 
897
<a name="CAL-STATIC-CAPABILITY-REFRESH-SUPPORTED:CAPS"></a><h3>CAL_STATIC_CAPABILITY_REFRESH_SUPPORTED</h3>
 
898
<pre class="programlisting">#define CAL_STATIC_CAPABILITY_REFRESH_SUPPORTED             "refresh-supported"
 
899
</pre>
 
900
<p class="since">Since 2.30</p>
 
901
</div>
 
902
<hr>
 
903
<div class="refsect2" title="e_cal_util_construct_instance ()">
878
904
<a name="e-cal-util-construct-instance"></a><h3>e_cal_util_construct_instance ()</h3>
879
905
<pre class="programlisting"><span class="returnvalue">icalcomponent</span> *     e_cal_util_construct_instance       (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
880
906
                                                         <em class="parameter"><code><span class="type">struct icaltimetype</span> rid</code></em>);</pre>
881
907
<p>
882
908
This checks that <em class="parameter"><code>rid</code></em> indicates a valid recurrence of <em class="parameter"><code>icalcomp</code></em>, and
883
 
if so, generates a copy of <em class="parameter"><code>comp</code></em> containing a RECURRENCE-ID of <em class="parameter"><code>rid</code></em>.</p>
 
909
if so, generates a copy of <em class="parameter"><code>comp</code></em> containing a RECURRENCE-ID of <em class="parameter"><code>rid</code></em>.
 
910
</p>
884
911
<div class="variablelist"><table border="0">
885
912
<col align="left" valign="top">
886
913
<tbody>
903
930
</table></div>
904
931
</div>
905
932
<hr>
906
 
<div class="refsect2" lang="en">
 
933
<div class="refsect2" title="e_cal_util_remove_instances ()">
907
934
<a name="e-cal-util-remove-instances"></a><h3>e_cal_util_remove_instances ()</h3>
908
935
<pre class="programlisting"><span class="returnvalue">void</span>                e_cal_util_remove_instances         (<em class="parameter"><code><span class="type">icalcomponent</span> *icalcomp</code></em>,
909
936
                                                         <em class="parameter"><code><span class="type">struct icaltimetype</span> rid</code></em>,
913
940
</p>
914
941
<p>
915
942
FIXME: should probably have a return value indicating whether or not
916
 
<em class="parameter"><code>icalcomp</code></em> still has any instances</p>
 
943
<em class="parameter"><code>icalcomp</code></em> still has any instances
 
944
</p>
917
945
<div class="variablelist"><table border="0">
918
946
<col align="left" valign="top">
919
947
<tbody>
936
964
</table></div>
937
965
</div>
938
966
<hr>
939
 
<div class="refsect2" lang="en">
 
967
<div class="refsect2" title="e_cal_util_get_system_timezone_location ()">
940
968
<a name="e-cal-util-get-system-timezone-location"></a><h3>e_cal_util_get_system_timezone_location ()</h3>
941
969
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_cal_util_get_system_timezone_location
942
970
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
946
974
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
947
975
<td>system timezone location string, NULL on an error.
948
976
Returned pointer should be freed with <code class="function">g_free()</code>.
 
977
 
949
978
</td>
950
979
</tr></tbody>
951
980
</table></div>
 
981
<p class="since">Since 2.28</p>
952
982
</div>
953
983
<hr>
954
 
<div class="refsect2" lang="en">
 
984
<div class="refsect2" title="e_cal_util_get_system_timezone ()">
955
985
<a name="e-cal-util-get-system-timezone"></a><h3>e_cal_util_get_system_timezone ()</h3>
956
986
<pre class="programlisting"><span class="returnvalue">icaltimezone</span> *      e_cal_util_get_system_timezone      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
957
987
<div class="variablelist"><table border="0">
960
990
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
961
991
<td>icaltimezone object of the system timezone. NULL on an error.
962
992
Returned pointer is part of the built-in timezones, thus do not free it.
 
993
 
963
994
</td>
964
995
</tr></tbody>
965
996
</table></div>
 
997
<p class="since">Since 2.28</p>
966
998
</div>
967
999
</div>
968
1000
</div>