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