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 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ECalComponent</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="ch01.html" title="Evolution API Reference: libecal, the Calendar Library"><link rel="next" href="libecal-ECalListener.html" title="ECalListener"><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="ECalComponent.html#id2572294" title="Object Hierarchy"><link rel="section" href="ECalComponent.html#id2572309" title="Description"><link rel="section" href="ECalComponent.html#id2572319" 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="ch01.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-ECalListener.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="ECalComponent"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">ECalComponent</span></h2><p>ECalComponent — Typically an appointment or task, part of the ECal object.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
struct <a href="ECalComponent.html#ECalComponent-struct">ECalComponent</a>;
enum <a href="ECalComponent.html#ECalComponentVType">ECalComponentVType</a>;
enum <a href="ECalComponent.html#ECalComponentField">ECalComponentField</a>;
enum <a href="ECalComponent.html#ECalComponentClassification">ECalComponentClassification</a>;
struct <a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a>;
enum <a href="ECalComponent.html#ECalComponentPeriodType">ECalComponentPeriodType</a>;
struct <a href="ECalComponent.html#ECalComponentPeriod">ECalComponentPeriod</a>;
enum <a href="ECalComponent.html#ECalComponentRangeType">ECalComponentRangeType</a>;
struct <a href="ECalComponent.html#ECalComponentRange">ECalComponentRange</a>;
struct <a href="ECalComponent.html#ECalComponentText">ECalComponentText</a>;
enum <a href="ECalComponent.html#ECalComponentTransparency">ECalComponentTransparency</a>;
struct <a href="ECalComponent.html#ECalComponentAttendee">ECalComponentAttendee</a>;
struct <a href="ECalComponent.html#ECalComponentOrganizer">ECalComponentOrganizer</a>;
char* <a href="ECalComponent.html#e-cal-component-gen-uid">e_cal_component_gen_uid</a> (void);
<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a>* <a href="ECalComponent.html#e-cal-component-new">e_cal_component_new</a> (void);
<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a>* <a href="ECalComponent.html#e-cal-component-clone">e_cal_component_clone</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-set-new-vtype">e_cal_component_set_new_vtype</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentVType">ECalComponentVType</a> type);
gboolean <a href="ECalComponent.html#e-cal-component-set-icalcomponent">e_cal_component_set_icalcomponent</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
icalcomponent *icalcomp);
icalcomponent* <a href="ECalComponent.html#e-cal-component-get-icalcomponent">e_cal_component_get_icalcomponent</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-rescan">e_cal_component_rescan</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-strip-errors">e_cal_component_strip_errors</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
<a href="ECalComponent.html#ECalComponentVType">ECalComponentVType</a> <a href="ECalComponent.html#e-cal-component-get-vtype">e_cal_component_get_vtype</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
char* <a href="ECalComponent.html#e-cal-component-get-as-string">e_cal_component_get_as_string</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-commit-sequence">e_cal_component_commit_sequence</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-abort-sequence">e_cal_component_abort_sequence</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-get-uid">e_cal_component_get_uid</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char **uid);
void <a href="ECalComponent.html#e-cal-component-set-uid">e_cal_component_set_uid</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *uid);
void <a href="ECalComponent.html#e-cal-component-get-categories">e_cal_component_get_categories</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char **categories);
void <a href="ECalComponent.html#e-cal-component-set-categories">e_cal_component_set_categories</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *categories);
void <a href="ECalComponent.html#e-cal-component-get-categories-list">e_cal_component_get_categories_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **categ_list);
void <a href="ECalComponent.html#e-cal-component-set-categories-list">e_cal_component_set_categories_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *categ_list);
void <a href="ECalComponent.html#e-cal-component-get-classification">e_cal_component_get_classification</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentClassification">ECalComponentClassification</a> *classif);
void <a href="ECalComponent.html#e-cal-component-set-classification">e_cal_component_set_classification</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentClassification">ECalComponentClassification</a> classif);
void <a href="ECalComponent.html#e-cal-component-get-comment-list">e_cal_component_get_comment_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **text_list);
void <a href="ECalComponent.html#e-cal-component-set-comment-list">e_cal_component_set_comment_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *text_list);
void <a href="ECalComponent.html#e-cal-component-get-completed">e_cal_component_get_completed</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype **t);
void <a href="ECalComponent.html#e-cal-component-set-completed">e_cal_component_set_completed</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);
void <a href="ECalComponent.html#e-cal-component-get-contact-list">e_cal_component_get_contact_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **text_list);
void <a href="ECalComponent.html#e-cal-component-set-contact-list">e_cal_component_set_contact_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *text_list);
void <a href="ECalComponent.html#e-cal-component-get-created">e_cal_component_get_created</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype **t);
void <a href="ECalComponent.html#e-cal-component-set-created">e_cal_component_set_created</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);
void <a href="ECalComponent.html#e-cal-component-get-description-list">e_cal_component_get_description_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **text_list);
void <a href="ECalComponent.html#e-cal-component-set-description-list">e_cal_component_set_description_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *text_list);
void <a href="ECalComponent.html#e-cal-component-get-dtend">e_cal_component_get_dtend</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);
void <a href="ECalComponent.html#e-cal-component-set-dtend">e_cal_component_set_dtend</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);
void <a href="ECalComponent.html#e-cal-component-get-dtstamp">e_cal_component_get_dtstamp</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);
void <a href="ECalComponent.html#e-cal-component-set-dtstamp">e_cal_component_set_dtstamp</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);
void <a href="ECalComponent.html#e-cal-component-get-dtstart">e_cal_component_get_dtstart</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);
void <a href="ECalComponent.html#e-cal-component-set-dtstart">e_cal_component_set_dtstart</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);
void <a href="ECalComponent.html#e-cal-component-get-due">e_cal_component_get_due</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);
void <a href="ECalComponent.html#e-cal-component-set-due">e_cal_component_set_due</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);
void <a href="ECalComponent.html#e-cal-component-get-exdate-list">e_cal_component_get_exdate_list</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **exdate_list);
void <a href="ECalComponent.html#e-cal-component-set-exdate-list">e_cal_component_set_exdate_list</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *exdate_list);
gboolean <a href="ECalComponent.html#e-cal-component-has-exdates">e_cal_component_has_exdates</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-get-exrule-list">e_cal_component_get_exrule_list</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **recur_list);
void <a href="ECalComponent.html#e-cal-component-get-exrule-property-list">e_cal_component_get_exrule_property_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **recur_list);
void <a href="ECalComponent.html#e-cal-component-set-exrule-list">e_cal_component_set_exrule_list</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *recur_list);
gboolean <a href="ECalComponent.html#e-cal-component-has-exrules">e_cal_component_has_exrules</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
gboolean <a href="ECalComponent.html#e-cal-component-has-exceptions">e_cal_component_has_exceptions</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-get-geo">e_cal_component_get_geo</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icalgeotype **geo);
void <a href="ECalComponent.html#e-cal-component-set-geo">e_cal_component_set_geo</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icalgeotype *geo);
void <a href="ECalComponent.html#e-cal-component-get-last-modified">e_cal_component_get_last_modified</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype **t);
void <a href="ECalComponent.html#e-cal-component-set-last-modified">e_cal_component_set_last_modified</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);
void <a href="ECalComponent.html#e-cal-component-get-organizer">e_cal_component_get_organizer</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentOrganizer">ECalComponentOrganizer</a> *organizer);
void <a href="ECalComponent.html#e-cal-component-set-organizer">e_cal_component_set_organizer</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentOrganizer">ECalComponentOrganizer</a> *organizer);
gboolean <a href="ECalComponent.html#e-cal-component-has-organizer">e_cal_component_has_organizer</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-get-percent">e_cal_component_get_percent</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int **percent);
void <a href="ECalComponent.html#e-cal-component-set-percent">e_cal_component_set_percent</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int *percent);
void <a href="ECalComponent.html#e-cal-component-get-priority">e_cal_component_get_priority</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int **priority);
void <a href="ECalComponent.html#e-cal-component-set-priority">e_cal_component_set_priority</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int *priority);
void <a href="ECalComponent.html#e-cal-component-get-recurid">e_cal_component_get_recurid</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentRange">ECalComponentRange</a> *recur_id);
void <a href="ECalComponent.html#e-cal-component-set-recurid">e_cal_component_set_recurid</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentRange">ECalComponentRange</a> *recur_id);
void <a href="ECalComponent.html#e-cal-component-get-rdate-list">e_cal_component_get_rdate_list</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **period_list);
void <a href="ECalComponent.html#e-cal-component-set-rdate-list">e_cal_component_set_rdate_list</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *period_list);
gboolean <a href="ECalComponent.html#e-cal-component-has-rdates">e_cal_component_has_rdates</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-get-rrule-list">e_cal_component_get_rrule_list</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **recur_list);
void <a href="ECalComponent.html#e-cal-component-get-rrule-property-list">e_cal_component_get_rrule_property_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **recur_list);
void <a href="ECalComponent.html#e-cal-component-set-rrule-list">e_cal_component_set_rrule_list</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *recur_list);
gboolean <a href="ECalComponent.html#e-cal-component-has-rrules">e_cal_component_has_rrules</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
gboolean <a href="ECalComponent.html#e-cal-component-has-recurrences">e_cal_component_has_recurrences</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
gboolean <a href="ECalComponent.html#e-cal-component-has-simple-recurrence">e_cal_component_has_simple_recurrence</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
gboolean <a href="ECalComponent.html#e-cal-component-is-instance">e_cal_component_is_instance</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-get-sequence">e_cal_component_get_sequence</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int **sequence);
void <a href="ECalComponent.html#e-cal-component-set-sequence">e_cal_component_set_sequence</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int *sequence);
void <a href="ECalComponent.html#e-cal-component-get-status">e_cal_component_get_status</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
icalproperty_status *status);
void <a href="ECalComponent.html#e-cal-component-set-status">e_cal_component_set_status</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
icalproperty_status status);
void <a href="ECalComponent.html#e-cal-component-get-summary">e_cal_component_get_summary</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentText">ECalComponentText</a> *summary);
void <a href="ECalComponent.html#e-cal-component-set-summary">e_cal_component_set_summary</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentText">ECalComponentText</a> *summary);
void <a href="ECalComponent.html#e-cal-component-get-transparency">e_cal_component_get_transparency</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentTransparency">ECalComponentTransparency</a> *transp);
void <a href="ECalComponent.html#e-cal-component-set-transparency">e_cal_component_set_transparency</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentTransparency">ECalComponentTransparency</a> transp);
void <a href="ECalComponent.html#e-cal-component-get-url">e_cal_component_get_url</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char **url);
void <a href="ECalComponent.html#e-cal-component-set-url">e_cal_component_set_url</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *url);
void <a href="ECalComponent.html#e-cal-component-get-attendee-list">e_cal_component_get_attendee_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **attendee_list);
void <a href="ECalComponent.html#e-cal-component-set-attendee-list">e_cal_component_set_attendee_list</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *attendee_list);
gboolean <a href="ECalComponent.html#e-cal-component-has-attendees">e_cal_component_has_attendees</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-get-location">e_cal_component_get_location</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char **location);
void <a href="ECalComponent.html#e-cal-component-set-location">e_cal_component_set_location</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *location);
gboolean <a href="ECalComponent.html#e-cal-component-event-dates-match">e_cal_component_event_dates_match</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp1,
<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp2);
void <a href="ECalComponent.html#e-cal-component-free-categories-list">e_cal_component_free_categories_list</a>
(GSList *categ_list);
void <a href="ECalComponent.html#e-cal-component-free-datetime">e_cal_component_free_datetime</a> (<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);
void <a href="ECalComponent.html#e-cal-component-free-range">e_cal_component_free_range</a> (<a href="ECalComponent.html#ECalComponentRange">ECalComponentRange</a> *range);
void <a href="ECalComponent.html#e-cal-component-free-exdate-list">e_cal_component_free_exdate_list</a>
(GSList *exdate_list);
void <a href="ECalComponent.html#e-cal-component-free-geo">e_cal_component_free_geo</a> (struct icalgeotype *geo);
void <a href="ECalComponent.html#e-cal-component-free-icaltimetype">e_cal_component_free_icaltimetype</a>
(struct icaltimetype *t);
void <a href="ECalComponent.html#e-cal-component-free-percent">e_cal_component_free_percent</a> (int *percent);
void <a href="ECalComponent.html#e-cal-component-free-priority">e_cal_component_free_priority</a> (int *priority);
void <a href="ECalComponent.html#e-cal-component-free-period-list">e_cal_component_free_period_list</a>
(GSList *period_list);
void <a href="ECalComponent.html#e-cal-component-free-recur-list">e_cal_component_free_recur_list</a> (GSList *recur_list);
void <a href="ECalComponent.html#e-cal-component-free-sequence">e_cal_component_free_sequence</a> (int *sequence);
void <a href="ECalComponent.html#e-cal-component-free-text-list">e_cal_component_free_text_list</a> (GSList *text_list);
void <a href="ECalComponent.html#e-cal-component-free-attendee-list">e_cal_component_free_attendee_list</a>
(GSList *attendee_list);
struct <a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a>;
struct <a href="ECalComponent.html#ECalComponentAlarmInstance">ECalComponentAlarmInstance</a>;
struct <a href="ECalComponent.html#ECalComponentAlarms">ECalComponentAlarms</a>;
enum <a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a>;
enum <a href="ECalComponent.html#ECalComponentAlarmTriggerType">ECalComponentAlarmTriggerType</a>;
struct <a href="ECalComponent.html#ECalComponentAlarmTrigger">ECalComponentAlarmTrigger</a>;
struct <a href="ECalComponent.html#ECalComponentAlarmRepeat">ECalComponentAlarmRepeat</a>;
gboolean <a href="ECalComponent.html#e-cal-component-has-alarms">e_cal_component_has_alarms</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
void <a href="ECalComponent.html#e-cal-component-add-alarm">e_cal_component_add_alarm</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);
void <a href="ECalComponent.html#e-cal-component-remove-alarm">e_cal_component_remove_alarm</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *auid);
void <a href="ECalComponent.html#e-cal-component-remove-all-alarms">e_cal_component_remove_all_alarms</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
GList* <a href="ECalComponent.html#e-cal-component-get-alarm-uids">e_cal_component_get_alarm_uids</a> (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);
<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a>* <a href="ECalComponent.html#e-cal-component-get-alarm">e_cal_component_get_alarm</a>
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *auid);
void <a href="ECalComponent.html#e-cal-component-alarms-free">e_cal_component_alarms_free</a> (<a href="ECalComponent.html#ECalComponentAlarms">ECalComponentAlarms</a> *alarms);
<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a>* <a href="ECalComponent.html#e-cal-component-alarm-new">e_cal_component_alarm_new</a>
(void);
<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a>* <a href="ECalComponent.html#e-cal-component-alarm-clone">e_cal_component_alarm_clone</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);
void <a href="ECalComponent.html#e-cal-component-alarm-free">e_cal_component_alarm_free</a> (<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);
const char* <a href="ECalComponent.html#e-cal-component-alarm-get-uid">e_cal_component_alarm_get_uid</a> (<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);
void <a href="ECalComponent.html#e-cal-component-alarm-get-action">e_cal_component_alarm_get_action</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a> *action);
void <a href="ECalComponent.html#e-cal-component-alarm-set-action">e_cal_component_alarm_set_action</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a> action);
void <a href="ECalComponent.html#e-cal-component-alarm-get-attach">e_cal_component_alarm_get_attach</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
icalattach **attach);
void <a href="ECalComponent.html#e-cal-component-alarm-set-attach">e_cal_component_alarm_set_attach</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
icalattach *attach);
void <a href="ECalComponent.html#e-cal-component-alarm-get-description">e_cal_component_alarm_get_description</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentText">ECalComponentText</a> *description);
void <a href="ECalComponent.html#e-cal-component-alarm-set-description">e_cal_component_alarm_set_description</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentText">ECalComponentText</a> *description);
void <a href="ECalComponent.html#e-cal-component-alarm-get-repeat">e_cal_component_alarm_get_repeat</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmRepeat">ECalComponentAlarmRepeat</a> *repeat);
void <a href="ECalComponent.html#e-cal-component-alarm-set-repeat">e_cal_component_alarm_set_repeat</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmRepeat">ECalComponentAlarmRepeat</a> repeat);
void <a href="ECalComponent.html#e-cal-component-alarm-get-trigger">e_cal_component_alarm_get_trigger</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmTrigger">ECalComponentAlarmTrigger</a> *trigger);
void <a href="ECalComponent.html#e-cal-component-alarm-set-trigger">e_cal_component_alarm_set_trigger</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmTrigger">ECalComponentAlarmTrigger</a> trigger);
void <a href="ECalComponent.html#e-cal-component-alarm-get-attendee-list">e_cal_component_alarm_get_attendee_list</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
GSList **attendee_list);
void <a href="ECalComponent.html#e-cal-component-alarm-set-attendee-list">e_cal_component_alarm_set_attendee_list</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
GSList *attendee_list);
gboolean <a href="ECalComponent.html#e-cal-component-alarm-has-attendees">e_cal_component_alarm_has_attendees</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);
icalcomponent* <a href="ECalComponent.html#e-cal-component-alarm-get-icalcomponent">e_cal_component_alarm_get_icalcomponent</a>
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);
</pre></div><div class="refsect1" lang="en"><a name="id2572294"></a><h2>Object Hierarchy</h2><pre class="synopsis">
GObject
+----ECalComponent
</pre></div><div class="refsect1" lang="en"><a name="id2572309"></a><h2>Description</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2572319"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2572324"></a><h3><a name="ECalComponent-struct"></a>struct ECalComponent</h3><a class="indexterm" name="id2572333"></a><pre class="programlisting">struct ECalComponent;</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572342"></a><h3><a name="ECalComponentVType"></a>enum ECalComponentVType</h3><a class="indexterm" name="id2572351"></a><pre class="programlisting">typedef enum {
E_CAL_COMPONENT_NO_TYPE,
E_CAL_COMPONENT_EVENT,
E_CAL_COMPONENT_TODO,
E_CAL_COMPONENT_JOURNAL,
E_CAL_COMPONENT_FREEBUSY,
E_CAL_COMPONENT_TIMEZONE
} ECalComponentVType;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572364"></a><h3><a name="ECalComponentField"></a>enum ECalComponentField</h3><a class="indexterm" name="id2572372"></a><pre class="programlisting">typedef enum {
E_CAL_COMPONENT_FIELD_CATEGORIES, /* concatenation of the categories list */
E_CAL_COMPONENT_FIELD_CLASSIFICATION,
E_CAL_COMPONENT_FIELD_COMPLETED,
E_CAL_COMPONENT_FIELD_DTEND,
E_CAL_COMPONENT_FIELD_DTSTART,
E_CAL_COMPONENT_FIELD_DUE,
E_CAL_COMPONENT_FIELD_GEO,
E_CAL_COMPONENT_FIELD_PERCENT,
E_CAL_COMPONENT_FIELD_PRIORITY,
E_CAL_COMPONENT_FIELD_SUMMARY,
E_CAL_COMPONENT_FIELD_TRANSPARENCY,
E_CAL_COMPONENT_FIELD_URL,
E_CAL_COMPONENT_FIELD_HAS_ALARMS, /* not a real field */
E_CAL_COMPONENT_FIELD_ICON, /* not a real field */
E_CAL_COMPONENT_FIELD_COMPLETE, /* not a real field */
E_CAL_COMPONENT_FIELD_RECURRING, /* not a real field */
E_CAL_COMPONENT_FIELD_OVERDUE, /* not a real field */
E_CAL_COMPONENT_FIELD_COLOR, /* not a real field */
E_CAL_COMPONENT_FIELD_STATUS,
E_CAL_COMPONENT_FIELD_COMPONENT, /* not a real field */
E_CAL_COMPONENT_FIELD_LOCATION,
E_CAL_COMPONENT_FIELD_NUM_FIELDS
} ECalComponentField;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2537834"></a><h3><a name="ECalComponentClassification"></a>enum ECalComponentClassification</h3><a class="indexterm" name="id2544552"></a><pre class="programlisting">typedef enum {
E_CAL_COMPONENT_CLASS_NONE,
E_CAL_COMPONENT_CLASS_PUBLIC,
E_CAL_COMPONENT_CLASS_PRIVATE,
E_CAL_COMPONENT_CLASS_CONFIDENTIAL,
E_CAL_COMPONENT_CLASS_UNKNOWN
} ECalComponentClassification;
</pre><p>
These values determine the privacy classification of the event.
</p></div><hr><div class="refsect2" lang="en"><a name="id2572397"></a><h3><a name="ECalComponentDateTime"></a>struct ECalComponentDateTime</h3><a class="indexterm" name="id2572404"></a><pre class="programlisting">struct ECalComponentDateTime {
/* Actual date/time value */
struct icaltimetype *value;
/* Timezone ID */
const char *tzid;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572416"></a><h3><a name="ECalComponentPeriodType"></a>enum ECalComponentPeriodType</h3><a class="indexterm" name="id2572424"></a><pre class="programlisting">typedef enum {
E_CAL_COMPONENT_PERIOD_DATETIME,
E_CAL_COMPONENT_PERIOD_DURATION
} ECalComponentPeriodType;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572436"></a><h3><a name="ECalComponentPeriod"></a>struct ECalComponentPeriod</h3><a class="indexterm" name="id2572443"></a><pre class="programlisting">struct ECalComponentPeriod {
ECalComponentPeriodType type;
struct icaltimetype start;
union {
struct icaltimetype end;
struct icaldurationtype duration;
} u;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572456"></a><h3><a name="ECalComponentRangeType"></a>enum ECalComponentRangeType</h3><a class="indexterm" name="id2572463"></a><pre class="programlisting">typedef enum {
E_CAL_COMPONENT_RANGE_SINGLE,
E_CAL_COMPONENT_RANGE_THISPRIOR,
E_CAL_COMPONENT_RANGE_THISFUTURE
} ECalComponentRangeType;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572475"></a><h3><a name="ECalComponentRange"></a>struct ECalComponentRange</h3><a class="indexterm" name="id2572483"></a><pre class="programlisting">struct ECalComponentRange {
ECalComponentRangeType type;
ECalComponentDateTime datetime;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572494"></a><h3><a name="ECalComponentText"></a>struct ECalComponentText</h3><a class="indexterm" name="id2572502"></a><pre class="programlisting">struct ECalComponentText {
/* Description string */
const char *value;
/* Alternate representation URI */
const char *altrep;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572514"></a><h3><a name="ECalComponentTransparency"></a>enum ECalComponentTransparency</h3><a class="indexterm" name="id2572521"></a><pre class="programlisting">typedef enum {
E_CAL_COMPONENT_TRANSP_NONE,
E_CAL_COMPONENT_TRANSP_TRANSPARENT,
E_CAL_COMPONENT_TRANSP_OPAQUE,
E_CAL_COMPONENT_TRANSP_UNKNOWN
} ECalComponentTransparency;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572534"></a><h3><a name="ECalComponentAttendee"></a>struct ECalComponentAttendee</h3><a class="indexterm" name="id2572541"></a><pre class="programlisting">struct ECalComponentAttendee {
const char *value;
const char *member;
icalparameter_cutype cutype;
icalparameter_role role;
icalparameter_partstat status;
gboolean rsvp;
const char *delto;
const char *delfrom;
const char *sentby;
const char *cn;
const char *language;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572556"></a><h3><a name="ECalComponentOrganizer"></a>struct ECalComponentOrganizer</h3><a class="indexterm" name="id2572563"></a><pre class="programlisting">struct ECalComponentOrganizer {
const char *value;
const char *sentby;
const char *cn;
const char *language;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2572575"></a><h3><a name="e-cal-component-gen-uid"></a>e_cal_component_gen_uid ()</h3><a class="indexterm" name="id2572582"></a><pre class="programlisting">char* e_cal_component_gen_uid (void);</pre><p>
Generates a unique identifier suitable for calendar components.</p><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> A unique identifier string. Every time this function is called
a different string is returned.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2572617"></a><h3><a name="e-cal-component-new"></a>e_cal_component_new ()</h3><a class="indexterm" name="id2572625"></a><pre class="programlisting"><a href="ECalComponent.html" title="ECalComponent">ECalComponent</a>* e_cal_component_new (void);</pre><p>
Creates a new empty calendar component object. You should set it from an
<span class="type">icalcomponent</span> structure by using <a href="ECalComponent.html#e-cal-component-set-icalcomponent"><tt class="function">e_cal_component_set_icalcomponent()</tt></a> or with a
new empty component type by using <a href="ECalComponent.html#e-cal-component-set-new-vtype"><tt class="function">e_cal_component_set_new_vtype()</tt></a>.</p><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> A newly-created calendar component object.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2572678"></a><h3><a name="e-cal-component-clone"></a>e_cal_component_clone ()</h3><a class="indexterm" name="id2572686"></a><pre class="programlisting"><a href="ECalComponent.html" title="ECalComponent">ECalComponent</a>* e_cal_component_clone (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Creates a new calendar component object by copying the information from
another one.</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> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A newly-created calendar component with the same values as the
original one.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2572736"></a><h3><a name="e-cal-component-set-new-vtype"></a>e_cal_component_set_new_vtype ()</h3><a class="indexterm" name="id2572744"></a><pre class="programlisting">void e_cal_component_set_new_vtype (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentVType">ECalComponentVType</a> type);</pre><p>
Clears any existing component data from a calendar component object and
creates a new <span class="type">icalcomponent</span> of the specified type for it. The only property
that will be set in the new component will be its unique identifier.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>:</span></td><td> Type of calendar component to create.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2572808"></a><h3><a name="e-cal-component-set-icalcomponent"></a>e_cal_component_set_icalcomponent ()</h3><a class="indexterm" name="id2572817"></a><pre class="programlisting">gboolean e_cal_component_set_icalcomponent
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
icalcomponent *icalcomp);</pre><p>
Sets the contents of a calendar component object from an <span class="type">icalcomponent</span>
structure. If the <i class="parameter"><tt>comp</tt></i> already had an <span class="type">icalcomponent</span> set into it, it will
will be freed automatically if the <span class="type">icalcomponent</span> does not have a parent
component itself.
</p><p>
Supported component types are VEVENT, VTODO, VJOURNAL, VFREEBUSY, and VTIMEZONE.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>icalcomp</tt></i>:</span></td><td> An <span class="type">icalcomponent</span>.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success, FALSE if <i class="parameter"><tt>icalcomp</tt></i> is an unsupported component
type.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2572920"></a><h3><a name="e-cal-component-get-icalcomponent"></a>e_cal_component_get_icalcomponent ()</h3><a class="indexterm" name="id2572928"></a><pre class="programlisting">icalcomponent* e_cal_component_get_icalcomponent
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Queries the <span class="type">icalcomponent</span> structure that a calendar component object is
wrapping.</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> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> An <span class="type">icalcomponent</span> structure, or NULL if the <i class="parameter"><tt>comp</tt></i> has no
<span class="type">icalcomponent</span> set to it.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2572999"></a><h3><a name="e-cal-component-rescan"></a>e_cal_component_rescan ()</h3><a class="indexterm" name="id2573008"></a><pre class="programlisting">void e_cal_component_rescan (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><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>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573041"></a><h3><a name="e-cal-component-strip-errors"></a>e_cal_component_strip_errors ()</h3><a class="indexterm" name="id2573050"></a><pre class="programlisting">void e_cal_component_strip_errors (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><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>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573084"></a><h3><a name="e-cal-component-get-vtype"></a>e_cal_component_get_vtype ()</h3><a class="indexterm" name="id2573092"></a><pre class="programlisting"><a href="ECalComponent.html#ECalComponentVType">ECalComponentVType</a> e_cal_component_get_vtype
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Queries the type of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The type of the component, as defined by RFC 2445.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573142"></a><h3><a name="e-cal-component-get-as-string"></a>e_cal_component_get_as_string ()</h3><a class="indexterm" name="id2573150"></a><pre class="programlisting">char* e_cal_component_get_as_string (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Gets the iCalendar string representation of a calendar component. You should
call <a href="ECalComponent.html#e-cal-component-commit-sequence"><tt class="function">e_cal_component_commit_sequence()</tt></a> before this function to ensure that the
component's sequence number is consistent with the state of the object.</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> A calendar component.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> String representation of the calendar component according to
RFC 2445.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573208"></a><h3><a name="e-cal-component-commit-sequence"></a>e_cal_component_commit_sequence ()</h3><a class="indexterm" name="id2573216"></a><pre class="programlisting">void e_cal_component_commit_sequence (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Increments the sequence number property in a calendar component object if it
needs it. This needs to be done when any of a number of properties listed in
RFC 2445 change values, such as the start and end dates of a component.
</p><p>
This function must be called before calling <a href="ECalComponent.html#e-cal-component-get-as-string"><tt class="function">e_cal_component_get_as_string()</tt></a> to
ensure that the component is fully consistent.</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>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573269"></a><h3><a name="e-cal-component-abort-sequence"></a>e_cal_component_abort_sequence ()</h3><a class="indexterm" name="id2573280"></a><pre class="programlisting">void e_cal_component_abort_sequence (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><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>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573316"></a><h3><a name="e-cal-component-get-uid"></a>e_cal_component_get_uid ()</h3><a class="indexterm" name="id2573324"></a><pre class="programlisting">void e_cal_component_get_uid (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char **uid);</pre><p>
Queries the unique identifier of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>uid</tt></i>:</span></td><td> Return value for the UID string.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573381"></a><h3><a name="e-cal-component-set-uid"></a>e_cal_component_set_uid ()</h3><a class="indexterm" name="id2573390"></a><pre class="programlisting">void e_cal_component_set_uid (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *uid);</pre><p>
Sets the unique identifier string of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>uid</tt></i>:</span></td><td> Unique identifier.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573446"></a><h3><a name="e-cal-component-get-categories"></a>e_cal_component_get_categories ()</h3><a class="indexterm" name="id2573457"></a><pre class="programlisting">void e_cal_component_get_categories (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char **categories);</pre><p>
</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>categories</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573513"></a><h3><a name="e-cal-component-set-categories"></a>e_cal_component_set_categories ()</h3><a class="indexterm" name="id2573524"></a><pre class="programlisting">void e_cal_component_set_categories (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *categories);</pre><p>
</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>categories</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573580"></a><h3><a name="e-cal-component-get-categories-list"></a>e_cal_component_get_categories_list ()</h3><a class="indexterm" name="id2573592"></a><pre class="programlisting">void e_cal_component_get_categories_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **categ_list);</pre><p>
Queries the list of categories of a calendar component object. Each element
in the returned categ_list is a string with the corresponding category.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>categ_list</tt></i>:</span></td><td> Return value for the list of strings, where each string is a
category. This should be freed using <a href="ECalComponent.html#e-cal-component-free-categories-list"><tt class="function">e_cal_component_free_categories_list()</tt></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573661"></a><h3><a name="e-cal-component-set-categories-list"></a>e_cal_component_set_categories_list ()</h3><a class="indexterm" name="id2573672"></a><pre class="programlisting">void e_cal_component_set_categories_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *categ_list);</pre><p>
Sets the list of categories of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>categ_list</tt></i>:</span></td><td> List of strings, one for each category.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573731"></a><h3><a name="e-cal-component-get-classification"></a>e_cal_component_get_classification ()</h3><a class="indexterm" name="id2573742"></a><pre class="programlisting">void e_cal_component_get_classification
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentClassification">ECalComponentClassification</a> *classif);</pre><p>
Queries the classification of a calendar component object. If the
classification property is not set on this component, this function returns
<span class="type">E_CAL_COMPONENT_CLASS_NONE</span>.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>classif</tt></i>:</span></td><td> Return value for the classification.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573809"></a><h3><a name="e-cal-component-set-classification"></a>e_cal_component_set_classification ()</h3><a class="indexterm" name="id2573821"></a><pre class="programlisting">void e_cal_component_set_classification
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentClassification">ECalComponentClassification</a> classif);</pre><p>
Sets the classification property of a calendar component object. To unset
the property, specify E_CAL_COMPONENT_CLASS_NONE for <i class="parameter"><tt>classif</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>comp</tt></i>:</span></td><td> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>classif</tt></i>:</span></td><td> Classification to use.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573882"></a><h3><a name="e-cal-component-get-comment-list"></a>e_cal_component_get_comment_list ()</h3><a class="indexterm" name="id2573893"></a><pre class="programlisting">void e_cal_component_get_comment_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **text_list);</pre><p>
Queries the comment of a calendar component object. The comment property can
appear several times inside a calendar component, and so a list of
<a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> is returned.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>text_list</tt></i>:</span></td><td> Return value for the comment properties and their parameters, as
a list of <a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures. This should be freed using the
<a href="ECalComponent.html#e-cal-component-free-text-list"><tt class="function">e_cal_component_free_text_list()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573975"></a><h3><a name="e-cal-component-set-comment-list"></a>e_cal_component_set_comment_list ()</h3><a class="indexterm" name="id2573986"></a><pre class="programlisting">void e_cal_component_set_comment_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *text_list);</pre><p>
Sets the comment of a calendar component object. The comment property can
appear several times inside a calendar component, and so a list of
<a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures is used.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>text_list</tt></i>:</span></td><td> List of <a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574068"></a><h3><a name="e-cal-component-get-completed"></a>e_cal_component_get_completed ()</h3><a class="indexterm" name="id2574081"></a><pre class="programlisting">void e_cal_component_get_completed (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype **t);</pre><p>
Queries the date at which a calendar compoment object was completed.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> Return value for the completion date. This should be freed using the
<a href="ECalComponent.html#e-cal-component-free-icaltimetype"><tt class="function">e_cal_component_free_icaltimetype()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574161"></a><h3><a name="e-cal-component-set-completed"></a>e_cal_component_set_completed ()</h3><a class="indexterm" name="id2574174"></a><pre class="programlisting">void e_cal_component_set_completed (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);</pre><p>
Sets the date at which a calendar component object was completed.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> Value for the completion date.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574245"></a><h3><a name="e-cal-component-get-contact-list"></a>e_cal_component_get_contact_list ()</h3><a class="indexterm" name="id2574258"></a><pre class="programlisting">void e_cal_component_get_contact_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **text_list);</pre><p>
Queries the contact of a calendar component object. The contact property can
appear several times inside a calendar component, and so a list of
<a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> is returned.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>text_list</tt></i>:</span></td><td> Return value for the contact properties and their parameters, as
a list of <a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures. This should be freed using the
<a href="ECalComponent.html#e-cal-component-free-text-list"><tt class="function">e_cal_component_free_text_list()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574358"></a><h3><a name="e-cal-component-set-contact-list"></a>e_cal_component_set_contact_list ()</h3><a class="indexterm" name="id2574371"></a><pre class="programlisting">void e_cal_component_set_contact_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *text_list);</pre><p>
Sets the contact of a calendar component object. The contact property can
appear several times inside a calendar component, and so a list of
<a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures is used.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>text_list</tt></i>:</span></td><td> List of <a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574460"></a><h3><a name="e-cal-component-get-created"></a>e_cal_component_get_created ()</h3><a class="indexterm" name="id2574473"></a><pre class="programlisting">void e_cal_component_get_created (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype **t);</pre><p>
Queries the date in which a calendar component object was created in the
calendar store.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> Return value for the creation date. This should be freed using the
<a href="ECalComponent.html#e-cal-component-free-icaltimetype"><tt class="function">e_cal_component_free_icaltimetype()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574553"></a><h3><a name="e-cal-component-set-created"></a>e_cal_component_set_created ()</h3><a class="indexterm" name="id2574566"></a><pre class="programlisting">void e_cal_component_set_created (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);</pre><p>
Sets the date in which a calendar component object is created in the calendar
store. This should only be used inside a calendar store application, i.e.
not by calendar user agents.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> Value for the creation date.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574638"></a><h3><a name="e-cal-component-get-description-list"></a>e_cal_component_get_description_list ()</h3><a class="indexterm" name="id2574652"></a><pre class="programlisting">void e_cal_component_get_description_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **text_list);</pre><p>
Queries the description of a calendar component object. Journal components
may have more than one description, and as such this function returns a list
of <a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures. All other types of components can have at
most one description.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>text_list</tt></i>:</span></td><td> Return value for the description properties and their parameters,
as a list of <a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures. This should be freed using the
<a href="ECalComponent.html#e-cal-component-free-text-list"><tt class="function">e_cal_component_free_text_list()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574753"></a><h3><a name="e-cal-component-set-description-list"></a>e_cal_component_set_description_list ()</h3><a class="indexterm" name="id2574767"></a><pre class="programlisting">void e_cal_component_set_description_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *text_list);</pre><p>
Sets the description of a calendar component object. Journal components may
have more than one description, and as such this function takes in a list of
<span class="type">ECalComponentDescription</span> structures. All other types of components can have
at most one description.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>text_list</tt></i>:</span></td><td> List of <span class="type">ECalComponentSummary</span> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574858"></a><h3><a name="e-cal-component-get-dtend"></a>e_cal_component_get_dtend ()</h3><a class="indexterm" name="id2574871"></a><pre class="programlisting">void e_cal_component_get_dtend (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);</pre><p>
Queries the date/time end of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dt</tt></i>:</span></td><td> Return value for the date/time end. This should be freed with the
<a href="ECalComponent.html#e-cal-component-free-datetime"><tt class="function">e_cal_component_free_datetime()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2574951"></a><h3><a name="e-cal-component-set-dtend"></a>e_cal_component_set_dtend ()</h3><a class="indexterm" name="id2574964"></a><pre class="programlisting">void e_cal_component_set_dtend (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);</pre><p>
Sets the date/time end property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dt</tt></i>:</span></td><td> End date/time.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575034"></a><h3><a name="e-cal-component-get-dtstamp"></a>e_cal_component_get_dtstamp ()</h3><a class="indexterm" name="id2575047"></a><pre class="programlisting">void e_cal_component_get_dtstamp (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);</pre><p>
Queries the date/timestamp property of a calendar component object, which is
the last time at which the object was modified by a calendar user agent.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> A value for the date/timestamp.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575119"></a><h3><a name="e-cal-component-set-dtstamp"></a>e_cal_component_set_dtstamp ()</h3><a class="indexterm" name="id2575132"></a><pre class="programlisting">void e_cal_component_set_dtstamp (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);</pre><p>
Sets the date/timestamp of a calendar component object. This should be
called whenever a calendar user agent makes a change to a component's
properties.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> Date/timestamp value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575204"></a><h3><a name="e-cal-component-get-dtstart"></a>e_cal_component_get_dtstart ()</h3><a class="indexterm" name="id2575217"></a><pre class="programlisting">void e_cal_component_get_dtstart (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);</pre><p>
Queries the date/time start of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dt</tt></i>:</span></td><td> Return value for the date/time start. This should be freed with the
<a href="ECalComponent.html#e-cal-component-free-datetime"><tt class="function">e_cal_component_free_datetime()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575297"></a><h3><a name="e-cal-component-set-dtstart"></a>e_cal_component_set_dtstart ()</h3><a class="indexterm" name="id2575310"></a><pre class="programlisting">void e_cal_component_set_dtstart (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);</pre><p>
Sets the date/time start property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dt</tt></i>:</span></td><td> Start date/time.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575380"></a><h3><a name="e-cal-component-get-due"></a>e_cal_component_get_due ()</h3><a class="indexterm" name="id2575393"></a><pre class="programlisting">void e_cal_component_get_due (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);</pre><p>
Queries the due date/time of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dt</tt></i>:</span></td><td> Return value for the due date/time. This should be freed with the
<a href="ECalComponent.html#e-cal-component-free-datetime"><tt class="function">e_cal_component_free_datetime()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575473"></a><h3><a name="e-cal-component-set-due"></a>e_cal_component_set_due ()</h3><a class="indexterm" name="id2575486"></a><pre class="programlisting">void e_cal_component_set_due (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);</pre><p>
Sets the due date/time property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dt</tt></i>:</span></td><td> End date/time.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575556"></a><h3><a name="e-cal-component-get-exdate-list"></a>e_cal_component_get_exdate_list ()</h3><a class="indexterm" name="id2575570"></a><pre class="programlisting">void e_cal_component_get_exdate_list (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **exdate_list);</pre><p>
Queries the list of exception date properties in a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>exdate_list</tt></i>:</span></td><td> Return value for the list of exception dates, as a list of
<a href="ECalComponent.html#ECalComponentDateTime"><span class="type">ECalComponentDateTime</span></a> structures. This should be freed using the
<a href="ECalComponent.html#e-cal-component-free-exdate-list"><tt class="function">e_cal_component_free_exdate_list()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575659"></a><h3><a name="e-cal-component-set-exdate-list"></a>e_cal_component_set_exdate_list ()</h3><a class="indexterm" name="id2575672"></a><pre class="programlisting">void e_cal_component_set_exdate_list (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *exdate_list);</pre><p>
Sets the list of exception dates in a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>exdate_list</tt></i>:</span></td><td> List of <a href="ECalComponent.html#ECalComponentDateTime"><span class="type">ECalComponentDateTime</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575751"></a><h3><a name="e-cal-component-has-exdates"></a>e_cal_component_has_exdates ()</h3><a class="indexterm" name="id2575764"></a><pre class="programlisting">gboolean e_cal_component_has_exdates (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Queries whether a calendar component object has any exception dates defined
for it.</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> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the component has exception dates, FALSE otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575826"></a><h3><a name="e-cal-component-get-exrule-list"></a>e_cal_component_get_exrule_list ()</h3><a class="indexterm" name="id2575840"></a><pre class="programlisting">void e_cal_component_get_exrule_list (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **recur_list);</pre><p>
Queries the list of exception rule properties of a calendar component
object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>recur_list</tt></i>:</span></td><td> List of exception rules as struct <span class="type">icalrecurrencetype</span>
structures. This should be freed using the <a href="ECalComponent.html#e-cal-component-free-recur-list"><tt class="function">e_cal_component_free_recur_list()</tt></a>
function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575928"></a><h3><a name="e-cal-component-get-exrule-property-list"></a>e_cal_component_get_exrule_property_list ()</h3><a class="indexterm" name="id2575942"></a><pre class="programlisting">void e_cal_component_get_exrule_property_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **recur_list);</pre><p>
Queries the list of exception rule properties of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>recur_list</tt></i>:</span></td><td> Returns a list of exception rule properties.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576014"></a><h3><a name="e-cal-component-set-exrule-list"></a>e_cal_component_set_exrule_list ()</h3><a class="indexterm" name="id2576028"></a><pre class="programlisting">void e_cal_component_set_exrule_list (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *recur_list);</pre><p>
Sets the list of exception rules in a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>recur_list</tt></i>:</span></td><td> List of struct <span class="type">icalrecurrencetype</span> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576106"></a><h3><a name="e-cal-component-has-exrules"></a>e_cal_component_has_exrules ()</h3><a class="indexterm" name="id2576120"></a><pre class="programlisting">gboolean e_cal_component_has_exrules (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Queries whether a calendar component object has any exception rules defined
for it.</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> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the component has exception rules, FALSE otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576182"></a><h3><a name="e-cal-component-has-exceptions"></a>e_cal_component_has_exceptions ()</h3><a class="indexterm" name="id2576195"></a><pre class="programlisting">gboolean e_cal_component_has_exceptions (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Queries whether a calendar component object has any exception dates
or exception rules.</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> A calendar component object
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the component has exceptions, FALSE otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576258"></a><h3><a name="e-cal-component-get-geo"></a>e_cal_component_get_geo ()</h3><a class="indexterm" name="id2576271"></a><pre class="programlisting">void e_cal_component_get_geo (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icalgeotype **geo);</pre><p>
Sets the geographic position property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>geo</tt></i>:</span></td><td> Return value for the geographic position property. This should be
freed using the <a href="ECalComponent.html#e-cal-component-free-geo"><tt class="function">e_cal_component_free_geo()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576351"></a><h3><a name="e-cal-component-set-geo"></a>e_cal_component_set_geo ()</h3><a class="indexterm" name="id2576363"></a><pre class="programlisting">void e_cal_component_set_geo (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icalgeotype *geo);</pre><p>
Sets the geographic position property on a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>geo</tt></i>:</span></td><td> Value for the geographic position property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576434"></a><h3><a name="e-cal-component-get-last-modified"></a>e_cal_component_get_last_modified ()</h3><a class="indexterm" name="id2576449"></a><pre class="programlisting">void e_cal_component_get_last_modified
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype **t);</pre><p>
Queries the time at which a calendar component object was last modified in
the calendar store.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> Return value for the last modified time value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576520"></a><h3><a name="e-cal-component-set-last-modified"></a>e_cal_component_set_last_modified ()</h3><a class="indexterm" name="id2576534"></a><pre class="programlisting">void e_cal_component_set_last_modified
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
struct icaltimetype *t);</pre><p>
Sets the time at which a calendar component object was last stored in the
calendar store. This should not be called by plain calendar user agents.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> Value for the last time modified.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576607"></a><h3><a name="e-cal-component-get-organizer"></a>e_cal_component_get_organizer ()</h3><a class="indexterm" name="id2576620"></a><pre class="programlisting">void e_cal_component_get_organizer (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentOrganizer">ECalComponentOrganizer</a> *organizer);</pre><p>
Queries the organizer property of a calendar component object</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> A calendar component object
</td></tr><tr><td><span class="term"><i class="parameter"><tt>organizer</tt></i>:</span></td><td> A value for the organizer
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576691"></a><h3><a name="e-cal-component-set-organizer"></a>e_cal_component_set_organizer ()</h3><a class="indexterm" name="id2576705"></a><pre class="programlisting">void e_cal_component_set_organizer (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentOrganizer">ECalComponentOrganizer</a> *organizer);</pre><p>
Sets the organizer of a calendar component object</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>organizer</tt></i>:</span></td><td> Value for the organizer property
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576776"></a><h3><a name="e-cal-component-has-organizer"></a>e_cal_component_has_organizer ()</h3><a class="indexterm" name="id2576790"></a><pre class="programlisting">gboolean e_cal_component_has_organizer (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
</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>
</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="id2576850"></a><h3><a name="e-cal-component-get-percent"></a>e_cal_component_get_percent ()</h3><a class="indexterm" name="id2576864"></a><pre class="programlisting">void e_cal_component_get_percent (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int **percent);</pre><p>
Queries the percent-complete property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>percent</tt></i>:</span></td><td> Return value for the percent-complete property. This should be
freed using the <a href="ECalComponent.html#e-cal-component-free-percent"><tt class="function">e_cal_component_free_percent()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576943"></a><h3><a name="e-cal-component-set-percent"></a>e_cal_component_set_percent ()</h3><a class="indexterm" name="id2576956"></a><pre class="programlisting">void e_cal_component_set_percent (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int *percent);</pre><p>
Sets the percent-complete property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>percent</tt></i>:</span></td><td> Value for the percent-complete property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577026"></a><h3><a name="e-cal-component-get-priority"></a>e_cal_component_get_priority ()</h3><a class="indexterm" name="id2577040"></a><pre class="programlisting">void e_cal_component_get_priority (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int **priority);</pre><p>
Queries the priority property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>priority</tt></i>:</span></td><td> Return value for the priority property. This should be freed using
the <a href="ECalComponent.html#e-cal-component-free-priority"><tt class="function">e_cal_component_free_priority()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577120"></a><h3><a name="e-cal-component-set-priority"></a>e_cal_component_set_priority ()</h3><a class="indexterm" name="id2577133"></a><pre class="programlisting">void e_cal_component_set_priority (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int *priority);</pre><p>
Sets the priority property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>priority</tt></i>:</span></td><td> Value for the priority property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577203"></a><h3><a name="e-cal-component-get-recurid"></a>e_cal_component_get_recurid ()</h3><a class="indexterm" name="id2577217"></a><pre class="programlisting">void e_cal_component_get_recurid (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentRange">ECalComponentRange</a> *recur_id);</pre><p>
Queries the recurrence id property of a calendar component object</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>recur_id</tt></i>:</span></td><td> Return value for the recurrence id property
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577287"></a><h3><a name="e-cal-component-set-recurid"></a>e_cal_component_set_recurid ()</h3><a class="indexterm" name="id2577300"></a><pre class="programlisting">void e_cal_component_set_recurid (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentRange">ECalComponentRange</a> *recur_id);</pre><p>
Sets the recurrence id property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>recur_id</tt></i>:</span></td><td> Value for the recurrence id property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577371"></a><h3><a name="e-cal-component-get-rdate-list"></a>e_cal_component_get_rdate_list ()</h3><a class="indexterm" name="id2577384"></a><pre class="programlisting">void e_cal_component_get_rdate_list (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **period_list);</pre><p>
Queries the list of recurrence date properties in a calendar component
object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>period_list</tt></i>:</span></td><td> Return value for the list of recurrence dates, as a list of
<a href="ECalComponent.html#ECalComponentPeriod"><span class="type">ECalComponentPeriod</span></a> structures. This should be freed using the
<a href="ECalComponent.html#e-cal-component-free-period-list"><tt class="function">e_cal_component_free_period_list()</tt></a> function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577473"></a><h3><a name="e-cal-component-set-rdate-list"></a>e_cal_component_set_rdate_list ()</h3><a class="indexterm" name="id2577486"></a><pre class="programlisting">void e_cal_component_set_rdate_list (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *period_list);</pre><p>
Sets the list of recurrence dates in a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>period_list</tt></i>:</span></td><td> List of <a href="ECalComponent.html#ECalComponentPeriod"><span class="type">ECalComponentPeriod</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577564"></a><h3><a name="e-cal-component-has-rdates"></a>e_cal_component_has_rdates ()</h3><a class="indexterm" name="id2577578"></a><pre class="programlisting">gboolean e_cal_component_has_rdates (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Queries whether a calendar component object has any recurrence dates defined
for it.</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> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the component has recurrence dates, FALSE otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577640"></a><h3><a name="e-cal-component-get-rrule-list"></a>e_cal_component_get_rrule_list ()</h3><a class="indexterm" name="id2577654"></a><pre class="programlisting">void e_cal_component_get_rrule_list (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **recur_list);</pre><p>
Queries the list of recurrence rule properties of a calendar component
object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>recur_list</tt></i>:</span></td><td> List of recurrence rules as struct <span class="type">icalrecurrencetype</span>
structures. This should be freed using the <a href="ECalComponent.html#e-cal-component-free-recur-list"><tt class="function">e_cal_component_free_recur_list()</tt></a>
function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577742"></a><h3><a name="e-cal-component-get-rrule-property-list"></a>e_cal_component_get_rrule_property_list ()</h3><a class="indexterm" name="id2577756"></a><pre class="programlisting">void e_cal_component_get_rrule_property_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **recur_list);</pre><p>
Queries a list of recurrence rule properties of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>recur_list</tt></i>:</span></td><td> Returns a list of recurrence rule properties.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577828"></a><h3><a name="e-cal-component-set-rrule-list"></a>e_cal_component_set_rrule_list ()</h3><a class="indexterm" name="id2577841"></a><pre class="programlisting">void e_cal_component_set_rrule_list (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *recur_list);</pre><p>
Sets the list of recurrence rules in a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>recur_list</tt></i>:</span></td><td> List of struct <span class="type">icalrecurrencetype</span> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577920"></a><h3><a name="e-cal-component-has-rrules"></a>e_cal_component_has_rrules ()</h3><a class="indexterm" name="id2577933"></a><pre class="programlisting">gboolean e_cal_component_has_rrules (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Queries whether a calendar component object has any recurrence rules defined
for it.</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> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the component has recurrence rules, FALSE otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2577995"></a><h3><a name="e-cal-component-has-recurrences"></a>e_cal_component_has_recurrences ()</h3><a class="indexterm" name="id2578008"></a><pre class="programlisting">gboolean e_cal_component_has_recurrences (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Queries whether a calendar component object has any recurrence dates or
recurrence rules.</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> A calendar component object
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the component has recurrences, FALSE otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578071"></a><h3><a name="e-cal-component-has-simple-recurrence"></a>e_cal_component_has_simple_recurrence ()</h3><a class="indexterm" name="id2578085"></a><pre class="programlisting">gboolean e_cal_component_has_simple_recurrence
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><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>
</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="id2578142"></a><h3><a name="e-cal-component-is-instance"></a>e_cal_component_is_instance ()</h3><a class="indexterm" name="id2578155"></a><pre class="programlisting">gboolean e_cal_component_is_instance (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><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>
</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="id2578210"></a><h3><a name="e-cal-component-get-sequence"></a>e_cal_component_get_sequence ()</h3><a class="indexterm" name="id2578224"></a><pre class="programlisting">void e_cal_component_get_sequence (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int **sequence);</pre><p>
Queries the sequence number of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>sequence</tt></i>:</span></td><td> Return value for the sequence number. This should be freed using
<a href="ECalComponent.html#e-cal-component-free-sequence"><tt class="function">e_cal_component_free_sequence()</tt></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578304"></a><h3><a name="e-cal-component-set-sequence"></a>e_cal_component_set_sequence ()</h3><a class="indexterm" name="id2578317"></a><pre class="programlisting">void e_cal_component_set_sequence (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
int *sequence);</pre><p>
Sets the sequence number of a calendar component object. Normally this
function should not be called, since the sequence number is incremented
automatically at the proper times.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>sequence</tt></i>:</span></td><td> Sequence number value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578389"></a><h3><a name="e-cal-component-get-status"></a>e_cal_component_get_status ()</h3><a class="indexterm" name="id2578403"></a><pre class="programlisting">void e_cal_component_get_status (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
icalproperty_status *status);</pre><p>
Queries the status property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>status</tt></i>:</span></td><td> Return value for the status value. It is set to <span class="type">ICAL_STATUS_NONE</span>
if the component has no status property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578482"></a><h3><a name="e-cal-component-set-status"></a>e_cal_component_set_status ()</h3><a class="indexterm" name="id2578496"></a><pre class="programlisting">void e_cal_component_set_status (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
icalproperty_status status);</pre><p>
Sets the status property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>status</tt></i>:</span></td><td> Status value. You should use <span class="type">ICAL_STATUS_NONE</span> if you want to unset
this property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578574"></a><h3><a name="e-cal-component-get-summary"></a>e_cal_component_get_summary ()</h3><a class="indexterm" name="id2578588"></a><pre class="programlisting">void e_cal_component_get_summary (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentText">ECalComponentText</a> *summary);</pre><p>
Queries the summary of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>summary</tt></i>:</span></td><td> Return value for the summary property and its parameters.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578658"></a><h3><a name="e-cal-component-set-summary"></a>e_cal_component_set_summary ()</h3><a class="indexterm" name="id2578672"></a><pre class="programlisting">void e_cal_component_set_summary (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentText">ECalComponentText</a> *summary);</pre><p>
Sets the summary of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>summary</tt></i>:</span></td><td> Summary property and its parameters.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578742"></a><h3><a name="e-cal-component-get-transparency"></a>e_cal_component_get_transparency ()</h3><a class="indexterm" name="id2578755"></a><pre class="programlisting">void e_cal_component_get_transparency
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentTransparency">ECalComponentTransparency</a> *transp);</pre><p>
Queries the time transparency of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>transp</tt></i>:</span></td><td> Return value for the time transparency.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578827"></a><h3><a name="e-cal-component-set-transparency"></a>e_cal_component_set_transparency ()</h3><a class="indexterm" name="id2578840"></a><pre class="programlisting">void e_cal_component_set_transparency
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentTransparency">ECalComponentTransparency</a> transp);</pre><p>
Sets the time transparency of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>transp</tt></i>:</span></td><td> Time transparency value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578911"></a><h3><a name="e-cal-component-get-url"></a>e_cal_component_get_url ()</h3><a class="indexterm" name="id2578924"></a><pre class="programlisting">void e_cal_component_get_url (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char **url);</pre><p>
Queries the uniform resource locator property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>url</tt></i>:</span></td><td> Return value for the URL.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2578994"></a><h3><a name="e-cal-component-set-url"></a>e_cal_component_set_url ()</h3><a class="indexterm" name="id2579007"></a><pre class="programlisting">void e_cal_component_set_url (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *url);</pre><p>
Sets the uniform resource locator property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>url</tt></i>:</span></td><td> URL value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579077"></a><h3><a name="e-cal-component-get-attendee-list"></a>e_cal_component_get_attendee_list ()</h3><a class="indexterm" name="id2579091"></a><pre class="programlisting">void e_cal_component_get_attendee_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList **attendee_list);</pre><p>
Queries the attendee properties of the calendar component object</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>attendee_list</tt></i>:</span></td><td> Return value for the attendee property.
This should be freed using the <a href="ECalComponent.html#e-cal-component-free-attendee-list"><tt class="function">e_cal_component_free_attendee_list()</tt></a>
function.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579171"></a><h3><a name="e-cal-component-set-attendee-list"></a>e_cal_component_set_attendee_list ()</h3><a class="indexterm" name="id2579185"></a><pre class="programlisting">void e_cal_component_set_attendee_list
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
GSList *attendee_list);</pre><p>
Sets the attendees of a calendar component object</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>attendee_list</tt></i>:</span></td><td> Values for attendee properties
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579256"></a><h3><a name="e-cal-component-has-attendees"></a>e_cal_component_has_attendees ()</h3><a class="indexterm" name="id2579269"></a><pre class="programlisting">gboolean e_cal_component_has_attendees (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><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>
</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="id2579325"></a><h3><a name="e-cal-component-get-location"></a>e_cal_component_get_location ()</h3><a class="indexterm" name="id2579338"></a><pre class="programlisting">void e_cal_component_get_location (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char **location);</pre><p>
Queries the location property of a calendar component object.</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> A calendar component object
</td></tr><tr><td><span class="term"><i class="parameter"><tt>location</tt></i>:</span></td><td> Return value for the location.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579409"></a><h3><a name="e-cal-component-set-location"></a>e_cal_component_set_location ()</h3><a class="indexterm" name="id2579422"></a><pre class="programlisting">void e_cal_component_set_location (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *location);</pre><p>
Sets the location property of a calendar component object.</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> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>location</tt></i>:</span></td><td> Location value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579492"></a><h3><a name="e-cal-component-event-dates-match"></a>e_cal_component_event_dates_match ()</h3><a class="indexterm" name="id2579507"></a><pre class="programlisting">gboolean e_cal_component_event_dates_match
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp1,
<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp2);</pre><p>
Checks if the DTSTART and DTEND properties of the 2 components match.
Note that the events may have different recurrence properties which are not
taken into account here.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>comp1</tt></i>:</span></td><td> A calendar component object.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>comp2</tt></i>:</span></td><td> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the DTSTART and DTEND properties of the 2 components match.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579592"></a><h3><a name="e-cal-component-free-categories-list"></a>e_cal_component_free_categories_list ()</h3><a class="indexterm" name="id2579606"></a><pre class="programlisting">void e_cal_component_free_categories_list
(GSList *categ_list);</pre><p>
Frees a list of category strings.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>categ_list</tt></i>:</span></td><td> List of category strings.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579655"></a><h3><a name="e-cal-component-free-datetime"></a>e_cal_component_free_datetime ()</h3><a class="indexterm" name="id2579669"></a><pre class="programlisting">void e_cal_component_free_datetime (<a href="ECalComponent.html#ECalComponentDateTime">ECalComponentDateTime</a> *dt);</pre><p>
Frees a date/time structure.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>dt</tt></i>:</span></td><td> A date/time structure.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579717"></a><h3><a name="e-cal-component-free-range"></a>e_cal_component_free_range ()</h3><a class="indexterm" name="id2579731"></a><pre class="programlisting">void e_cal_component_free_range (<a href="ECalComponent.html#ECalComponentRange">ECalComponentRange</a> *range);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>range</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579774"></a><h3><a name="e-cal-component-free-exdate-list"></a>e_cal_component_free_exdate_list ()</h3><a class="indexterm" name="id2579787"></a><pre class="programlisting">void e_cal_component_free_exdate_list
(GSList *exdate_list);</pre><p>
Frees a list of <a href="ECalComponent.html#ECalComponentDateTime"><span class="type">ECalComponentDateTime</span></a> structures as returned by the
<a href="ECalComponent.html#e-cal-component-get-exdate-list"><tt class="function">e_cal_component_get_exdate_list()</tt></a> function.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>exdate_list</tt></i>:</span></td><td> List of <a href="ECalComponent.html#ECalComponentDateTime"><span class="type">ECalComponentDateTime</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579862"></a><h3><a name="e-cal-component-free-geo"></a>e_cal_component_free_geo ()</h3><a class="indexterm" name="id2579874"></a><pre class="programlisting">void e_cal_component_free_geo (struct icalgeotype *geo);</pre><p>
Frees a struct <span class="type">icalgeotype</span> structure as returned by the calendar component
functions.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>geo</tt></i>:</span></td><td> An <span class="type">icalgeotype</span> structure.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579939"></a><h3><a name="e-cal-component-free-icaltimetype"></a>e_cal_component_free_icaltimetype ()</h3><a class="indexterm" name="id2579953"></a><pre class="programlisting">void e_cal_component_free_icaltimetype
(struct icaltimetype *t);</pre><p>
Frees a struct <span class="type">icaltimetype</span> value as returned by the calendar component
functions.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>t</tt></i>:</span></td><td> An <span class="type">icaltimetype</span> structure.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580018"></a><h3><a name="e-cal-component-free-percent"></a>e_cal_component_free_percent ()</h3><a class="indexterm" name="id2580032"></a><pre class="programlisting">void e_cal_component_free_percent (int *percent);</pre><p>
Frees a percent value as returned by the <a href="ECalComponent.html#e-cal-component-get-percent"><tt class="function">e_cal_component_get_percent()</tt></a>
function.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>percent</tt></i>:</span></td><td> Percent value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580088"></a><h3><a name="e-cal-component-free-priority"></a>e_cal_component_free_priority ()</h3><a class="indexterm" name="id2580102"></a><pre class="programlisting">void e_cal_component_free_priority (int *priority);</pre><p>
Frees a priority value as returned by the <a href="ECalComponent.html#e-cal-component-get-priority"><tt class="function">e_cal_component_get_priority()</tt></a>
function.</p><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> Priority value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580159"></a><h3><a name="e-cal-component-free-period-list"></a>e_cal_component_free_period_list ()</h3><a class="indexterm" name="id2580172"></a><pre class="programlisting">void e_cal_component_free_period_list
(GSList *period_list);</pre><p>
Frees a list of <a href="ECalComponent.html#ECalComponentPeriod"><span class="type">ECalComponentPeriod</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>period_list</tt></i>:</span></td><td> List of <a href="ECalComponent.html#ECalComponentPeriod"><span class="type">ECalComponentPeriod</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580237"></a><h3><a name="e-cal-component-free-recur-list"></a>e_cal_component_free_recur_list ()</h3><a class="indexterm" name="id2580250"></a><pre class="programlisting">void e_cal_component_free_recur_list (GSList *recur_list);</pre><p>
Frees a list of struct <span class="type">icalrecurrencetype</span> 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>recur_list</tt></i>:</span></td><td> List of struct <span class="type">icalrecurrencetype</span> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580315"></a><h3><a name="e-cal-component-free-sequence"></a>e_cal_component_free_sequence ()</h3><a class="indexterm" name="id2580328"></a><pre class="programlisting">void e_cal_component_free_sequence (int *sequence);</pre><p>
Frees a sequence number value.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>sequence</tt></i>:</span></td><td> Sequence number value.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580376"></a><h3><a name="e-cal-component-free-text-list"></a>e_cal_component_free_text_list ()</h3><a class="indexterm" name="id2580390"></a><pre class="programlisting">void e_cal_component_free_text_list (GSList *text_list);</pre><p>
Frees a list of <a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures. This function should only be
used to free lists of text values as returned by the other getter functions
of <a href="ECalComponent.html" title="ECalComponent"><span class="type">ECalComponent</span></a>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>text_list</tt></i>:</span></td><td> List of <a href="ECalComponent.html#ECalComponentText"><span class="type">ECalComponentText</span></a> structures.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580464"></a><h3><a name="e-cal-component-free-attendee-list"></a>e_cal_component_free_attendee_list ()</h3><a class="indexterm" name="id2580479"></a><pre class="programlisting">void e_cal_component_free_attendee_list
(GSList *attendee_list);</pre><p>
</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>attendee_list</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580527"></a><h3><a name="ECalComponentAlarm"></a>struct ECalComponentAlarm</h3><a class="indexterm" name="id2580540"></a><pre class="programlisting">struct ECalComponentAlarm;</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2580552"></a><h3><a name="ECalComponentAlarmInstance"></a>struct ECalComponentAlarmInstance</h3><a class="indexterm" name="id2580566"></a><pre class="programlisting">struct ECalComponentAlarmInstance {
/* UID of the alarm that triggered */
const char *auid;
/* Trigger time, i.e. "5 minutes before the appointment" */
time_t trigger;
/* Actual event occurrence to which this trigger corresponds */
time_t occur_start;
time_t occur_end;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2580582"></a><h3><a name="ECalComponentAlarms"></a>struct ECalComponentAlarms</h3><a class="indexterm" name="id2580595"></a><pre class="programlisting">struct ECalComponentAlarms {
/* The actual component */
ECalComponent *comp;
/* List of ECalComponentAlarmInstance structures */
GSList *alarms;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2580609"></a><h3><a name="ECalComponentAlarmAction"></a>enum ECalComponentAlarmAction</h3><a class="indexterm" name="id2580622"></a><pre class="programlisting">typedef enum {
E_CAL_COMPONENT_ALARM_NONE,
E_CAL_COMPONENT_ALARM_AUDIO,
E_CAL_COMPONENT_ALARM_DISPLAY,
E_CAL_COMPONENT_ALARM_EMAIL,
E_CAL_COMPONENT_ALARM_PROCEDURE,
E_CAL_COMPONENT_ALARM_UNKNOWN
} ECalComponentAlarmAction;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2580638"></a><h3><a name="ECalComponentAlarmTriggerType"></a>enum ECalComponentAlarmTriggerType</h3><a class="indexterm" name="id2580651"></a><pre class="programlisting">typedef enum {
E_CAL_COMPONENT_ALARM_TRIGGER_NONE,
E_CAL_COMPONENT_ALARM_TRIGGER_RELATIVE_START,
E_CAL_COMPONENT_ALARM_TRIGGER_RELATIVE_END,
E_CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE
} ECalComponentAlarmTriggerType;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2580667"></a><h3><a name="ECalComponentAlarmTrigger"></a>struct ECalComponentAlarmTrigger</h3><a class="indexterm" name="id2580680"></a><pre class="programlisting">struct ECalComponentAlarmTrigger {
ECalComponentAlarmTriggerType type;
union {
struct icaldurationtype rel_duration;
struct icaltimetype abs_time;
} u;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2580695"></a><h3><a name="ECalComponentAlarmRepeat"></a>struct ECalComponentAlarmRepeat</h3><a class="indexterm" name="id2580708"></a><pre class="programlisting">struct ECalComponentAlarmRepeat {
/* Number of extra repetitions, zero for none */
int repetitions;
/* Interval between repetitions */
struct icaldurationtype duration;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2580723"></a><h3><a name="e-cal-component-has-alarms"></a>e_cal_component_has_alarms ()</h3><a class="indexterm" name="id2580736"></a><pre class="programlisting">gboolean e_cal_component_has_alarms (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Checks whether the component has any alarms.</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> A calendar component object.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the component has any alarms.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580797"></a><h3><a name="e-cal-component-add-alarm"></a>e_cal_component_add_alarm ()</h3><a class="indexterm" name="id2580811"></a><pre class="programlisting">void e_cal_component_add_alarm (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);</pre><p>
Adds an alarm subcomponent to a calendar component. You should have created
the <i class="parameter"><tt>alarm</tt></i> by using <a href="ECalComponent.html#e-cal-component-alarm-new"><tt class="function">e_cal_component_alarm_new()</tt></a>; it is invalid to use a
<a href="ECalComponent.html#ECalComponentAlarm"><span class="type">ECalComponentAlarm</span></a> structure that came from <a href="ECalComponent.html#e-cal-component-get-alarm"><tt class="function">e_cal_component_get_alarm()</tt></a>. After
adding the alarm, the <i class="parameter"><tt>alarm</tt></i> structure is no longer valid because the
internal structures may change and you should get rid of it by using
<a href="ECalComponent.html#e-cal-component-alarm-free"><tt class="function">e_cal_component_alarm_free()</tt></a>.</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> A calendar component.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2580924"></a><h3><a name="e-cal-component-remove-alarm"></a>e_cal_component_remove_alarm ()</h3><a class="indexterm" name="id2580938"></a><pre class="programlisting">void e_cal_component_remove_alarm (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *auid);</pre><p>
Removes an alarm subcomponent from a calendar component. If the alarm that
corresponds to the specified <i class="parameter"><tt>auid</tt></i> had been fetched with
<a href="ECalComponent.html#e-cal-component-get-alarm"><tt class="function">e_cal_component_get_alarm()</tt></a>, then those alarm structures will be invalid; you
should get rid of them with <a href="ECalComponent.html#e-cal-component-alarm-free"><tt class="function">e_cal_component_alarm_free()</tt></a> before using this
function.</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> A calendar component.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>auid</tt></i>:</span></td><td> UID of the alarm to remove.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581032"></a><h3><a name="e-cal-component-remove-all-alarms"></a>e_cal_component_remove_all_alarms ()</h3><a class="indexterm" name="id2581046"></a><pre class="programlisting">void e_cal_component_remove_all_alarms
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Remove all alarms from the calendar component</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> A calendar component
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581095"></a><h3><a name="e-cal-component-get-alarm-uids"></a>e_cal_component_get_alarm_uids ()</h3><a class="indexterm" name="id2581108"></a><pre class="programlisting">GList* e_cal_component_get_alarm_uids (<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp);</pre><p>
Builds a list of the unique identifiers of the alarm subcomponents inside a
calendar component.</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> A calendar component.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> List of unique identifiers for alarms. This should be freed
using <a href="libecal-e-cal-util.html#cal-obj-uid-list-free"><tt class="function">cal_obj_uid_list_free()</tt></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581179"></a><h3><a name="e-cal-component-get-alarm"></a>e_cal_component_get_alarm ()</h3><a class="indexterm" name="id2581193"></a><pre class="programlisting"><a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a>* e_cal_component_get_alarm
(<a href="ECalComponent.html" title="ECalComponent">ECalComponent</a> *comp,
const char *auid);</pre><p>
Queries a particular alarm subcomponent of a calendar component.</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> A calendar component.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>auid</tt></i>:</span></td><td> Unique identifier for the sought alarm subcomponent.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The alarm subcomponent that corresponds to the specified <i class="parameter"><tt>auid</tt></i>,
or <span class="type">NULL</span> if no alarm exists with that UID. This should be freed using
<a href="ECalComponent.html#e-cal-component-alarm-free"><tt class="function">e_cal_component_alarm_free()</tt></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581298"></a><h3><a name="e-cal-component-alarms-free"></a>e_cal_component_alarms_free ()</h3><a class="indexterm" name="id2581312"></a><pre class="programlisting">void e_cal_component_alarms_free (<a href="ECalComponent.html#ECalComponentAlarms">ECalComponentAlarms</a> *alarms);</pre><p>
Frees a <a href="ECalComponent.html#ECalComponentAlarms"><span class="type">ECalComponentAlarms</span></a> structure.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarms</tt></i>:</span></td><td> Component alarms structure.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581367"></a><h3><a name="e-cal-component-alarm-new"></a>e_cal_component_alarm_new ()</h3><a class="indexterm" name="id2581381"></a><pre class="programlisting"><a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a>* e_cal_component_alarm_new
(void);</pre><p>
</p><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> a new alarm component
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581421"></a><h3><a name="e-cal-component-alarm-clone"></a>e_cal_component_alarm_clone ()</h3><a class="indexterm" name="id2581434"></a><pre class="programlisting"><a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a>* e_cal_component_alarm_clone
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);</pre><p>
Creates a new alarm subcomponent by copying the information from another one.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm subcomponent.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A newly-created alarm subcomponent with the same values as the
original one. Should be freed with <a href="ECalComponent.html#e-cal-component-alarm-free"><tt class="function">e_cal_component_alarm_free()</tt></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581506"></a><h3><a name="e-cal-component-alarm-free"></a>e_cal_component_alarm_free ()</h3><a class="indexterm" name="id2581520"></a><pre class="programlisting">void e_cal_component_alarm_free (<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);</pre><p>
Frees an alarm structure.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> A calendar alarm.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581567"></a><h3><a name="e-cal-component-alarm-get-uid"></a>e_cal_component_alarm_get_uid ()</h3><a class="indexterm" name="id2581581"></a><pre class="programlisting">const char* e_cal_component_alarm_get_uid (<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);</pre><p>
Queries the unique identifier of an alarm subcomponent.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm subcomponent.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> UID of the alarm.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581644"></a><h3><a name="e-cal-component-alarm-get-action"></a>e_cal_component_alarm_get_action ()</h3><a class="indexterm" name="id2581657"></a><pre class="programlisting">void e_cal_component_alarm_get_action
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a> *action);</pre><p>
Queries the action type of an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>action</tt></i>:</span></td><td> Return value for the alarm's action type.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581728"></a><h3><a name="e-cal-component-alarm-set-action"></a>e_cal_component_alarm_set_action ()</h3><a class="indexterm" name="id2581742"></a><pre class="programlisting">void e_cal_component_alarm_set_action
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmAction">ECalComponentAlarmAction</a> action);</pre><p>
Sets the action type for an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>action</tt></i>:</span></td><td> Action type.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581812"></a><h3><a name="e-cal-component-alarm-get-attach"></a>e_cal_component_alarm_get_attach ()</h3><a class="indexterm" name="id2581825"></a><pre class="programlisting">void e_cal_component_alarm_get_attach
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
icalattach **attach);</pre><p>
Queries the attachment property of an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>attach</tt></i>:</span></td><td> Return value for the attachment; should be freed using <tt class="function">icalattach_unref()</tt>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581904"></a><h3><a name="e-cal-component-alarm-set-attach"></a>e_cal_component_alarm_set_attach ()</h3><a class="indexterm" name="id2581918"></a><pre class="programlisting">void e_cal_component_alarm_set_attach
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
icalattach *attach);</pre><p>
Sets the attachment property of an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>attach</tt></i>:</span></td><td> Attachment property or NULL to remove an existing property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581988"></a><h3><a name="e-cal-component-alarm-get-description"></a>e_cal_component_alarm_get_description ()</h3><a class="indexterm" name="id2582003"></a><pre class="programlisting">void e_cal_component_alarm_get_description
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentText">ECalComponentText</a> *description);</pre><p>
Queries the description property of an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>description</tt></i>:</span></td><td> Return value for the description property and its parameters.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582074"></a><h3><a name="e-cal-component-alarm-set-description"></a>e_cal_component_alarm_set_description ()</h3><a class="indexterm" name="id2582089"></a><pre class="programlisting">void e_cal_component_alarm_set_description
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentText">ECalComponentText</a> *description);</pre><p>
Sets the description property of an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>description</tt></i>:</span></td><td> Description property and its parameters, or NULL for no description.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582160"></a><h3><a name="e-cal-component-alarm-get-repeat"></a>e_cal_component_alarm_get_repeat ()</h3><a class="indexterm" name="id2582174"></a><pre class="programlisting">void e_cal_component_alarm_get_repeat
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmRepeat">ECalComponentAlarmRepeat</a> *repeat);</pre><p>
Queries the repeat/duration properties of an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>repeat</tt></i>:</span></td><td> Return value for the repeat/duration properties.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582245"></a><h3><a name="e-cal-component-alarm-set-repeat"></a>e_cal_component_alarm_set_repeat ()</h3><a class="indexterm" name="id2582259"></a><pre class="programlisting">void e_cal_component_alarm_set_repeat
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmRepeat">ECalComponentAlarmRepeat</a> repeat);</pre><p>
Sets the repeat/duration values for an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>repeat</tt></i>:</span></td><td> Repeat/duration values. To remove any repetitions from the alarm,
set the <i class="parameter"><tt>repeat.repetitions</tt></i> to 0.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582335"></a><h3><a name="e-cal-component-alarm-get-trigger"></a>e_cal_component_alarm_get_trigger ()</h3><a class="indexterm" name="id2582350"></a><pre class="programlisting">void e_cal_component_alarm_get_trigger
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmTrigger">ECalComponentAlarmTrigger</a> *trigger);</pre><p>
Queries the trigger time for an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>trigger</tt></i>:</span></td><td> Return value for the trigger time.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582420"></a><h3><a name="e-cal-component-alarm-set-trigger"></a>e_cal_component_alarm_set_trigger ()</h3><a class="indexterm" name="id2582435"></a><pre class="programlisting">void e_cal_component_alarm_set_trigger
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
<a href="ECalComponent.html#ECalComponentAlarmTrigger">ECalComponentAlarmTrigger</a> trigger);</pre><p>
Sets the trigger time of an alarm.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>trigger</tt></i>:</span></td><td> Trigger time structure.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582505"></a><h3><a name="e-cal-component-alarm-get-attendee-list"></a>e_cal_component_alarm_get_attendee_list ()</h3><a class="indexterm" name="id2582519"></a><pre class="programlisting">void e_cal_component_alarm_get_attendee_list
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
GSList **attendee_list);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>attendee_list</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582585"></a><h3><a name="e-cal-component-alarm-set-attendee-list"></a>e_cal_component_alarm_set_attendee_list ()</h3><a class="indexterm" name="id2582599"></a><pre class="programlisting">void e_cal_component_alarm_set_attendee_list
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm,
GSList *attendee_list);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>attendee_list</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582665"></a><h3><a name="e-cal-component-alarm-has-attendees"></a>e_cal_component_alarm_has_attendees ()</h3><a class="indexterm" name="id2582679"></a><pre class="programlisting">gboolean e_cal_component_alarm_has_attendees
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</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="id2582735"></a><h3><a name="e-cal-component-alarm-get-icalcomponent"></a>e_cal_component_alarm_get_icalcomponent ()</h3><a class="indexterm" name="id2582748"></a><pre class="programlisting">icalcomponent* e_cal_component_alarm_get_icalcomponent
(<a href="ECalComponent.html#ECalComponentAlarm">ECalComponentAlarm</a> *alarm);</pre><p>
Get the icalcomponent associated with the given <a href="ECalComponent.html#ECalComponentAlarm"><span class="type">ECalComponentAlarm</span></a>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>alarm</tt></i>:</span></td><td> An alarm.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the icalcomponent.
</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="ch01.html"><b><<Evolution API Reference: libecal, the Calendar Library</b></a></td><td align="right"><a accesskey="n" href="libecal-ECalListener.html"><b>ECalListener>></b></a></td></tr></table></body></html>
|