From 89a67caf2c463900bf0d8fa552b21e5ac4bf0f78 Mon Sep 17 00:00:00 2001 From: Allen Winter Date: Thu, 6 Oct 2022 14:47:43 -0400 Subject: update apidox --- apidocs/Install.txt | 158 --- apidocs/annotated.html | 229 ++-- apidocs/astime_8h.html | 147 +-- apidocs/astime_8h_source.html | 227 ++-- apidocs/classICPointerHolder.html | 55 +- apidocs/classLibICal_1_1ICalBDBSet.html | 75 +- apidocs/classLibICal_1_1ICalParameter.html | 161 +-- apidocs/classLibICal_1_1ICalProperty.html | 395 +++---- apidocs/classLibICal_1_1ICalSpanList.html | 81 +- apidocs/classLibICal_1_1ICalValue.html | 159 +-- apidocs/classLibICal_1_1VAgenda.html | 219 ++-- apidocs/classLibICal_1_1VAlarm.html | 223 ++-- apidocs/classLibICal_1_1VCalendar.html | 219 ++-- apidocs/classLibICal_1_1VComponent.html | 245 +++-- .../classLibICal_1_1VComponent__inherit__graph.md5 | 2 +- .../classLibICal_1_1VComponent__inherit__graph.png | Bin 48220 -> 48142 bytes apidocs/classLibICal_1_1VEvent.html | 219 ++-- apidocs/classLibICal_1_1VFreeBusy.html | 219 ++-- apidocs/classLibICal_1_1VJournal.html | 219 ++-- apidocs/classLibICal_1_1VQuery.html | 219 ++-- apidocs/classLibICal_1_1VTimezone.html | 219 ++-- apidocs/classLibICal_1_1VToDo.html | 219 ++-- apidocs/classLibICal_1_1XDaylight.html | 219 ++-- apidocs/classLibICal_1_1XStandard.html | 219 ++-- apidocs/classes.html | 79 +- apidocs/deprecated.html | 89 -- apidocs/dir_000002_000001.html | 75 ++ apidocs/dir_000002_000005.html | 75 -- apidocs/dir_000003_000001.html | 75 ++ apidocs/dir_000003_000002.html | 75 -- apidocs/dir_000003_000005.html | 75 -- apidocs/dir_000004_000002.html | 75 -- apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42.html | 43 +- .../dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.map | 2 +- .../dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.md5 | 2 +- .../dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.png | Bin 3972 -> 3642 bytes apidocs/dir_5330c68354327086ecc8df050e51eedc.html | 31 +- apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba.html | 44 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map | 9 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 | 2 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png | Bin 8415 -> 5449 bytes apidocs/dir_8e427daf5a9f830cf32cf5e679910194.html | 45 +- .../dir_8e427daf5a9f830cf32cf5e679910194_dep.map | 4 - .../dir_8e427daf5a9f830cf32cf5e679910194_dep.md5 | 1 - .../dir_8e427daf5a9f830cf32cf5e679910194_dep.png | Bin 1998 -> 0 bytes apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9.html | 114 +- .../dir_b7a0ea939f6e83384f3c571d31a84be9_dep.map | 6 - .../dir_b7a0ea939f6e83384f3c571d31a84be9_dep.md5 | 1 - .../dir_b7a0ea939f6e83384f3c571d31a84be9_dep.png | Bin 3081 -> 0 bytes apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20.html | 71 +- .../dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.map | 4 +- .../dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.md5 | 2 +- .../dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.png | Bin 6050 -> 3865 bytes apidocs/dir_e68e8157741866f444e17edd764ebbae.html | 27 +- apidocs/doxygen.css | 58 +- apidocs/files.html | 155 ++- apidocs/functions.html | 439 +++++--- apidocs/functions_func.html | 112 +- apidocs/functions_vars.html | 345 ++++-- apidocs/globals.html | 31 +- apidocs/globals_defs.html | 64 +- apidocs/globals_enum.html | 40 +- apidocs/globals_eval.html | 140 ++- apidocs/globals_f.html | 30 +- apidocs/globals_func.html | 31 +- apidocs/globals_func_f.html | 30 +- apidocs/globals_func_i.html | 941 +++++++++++----- apidocs/globals_func_j.html | 31 +- apidocs/globals_func_q.html | 77 -- apidocs/globals_func_s.html | 30 +- apidocs/globals_i.html | 1137 ++++++++++++++------ apidocs/globals_j.html | 31 +- apidocs/globals_q.html | 77 -- apidocs/globals_s.html | 30 +- apidocs/globals_type.html | 48 +- apidocs/globals_vars.html | 28 +- apidocs/graph_legend.html | 35 +- apidocs/hierarchy.html | 223 ++-- apidocs/icalarray_8h.html | 173 +-- apidocs/icalarray_8h_source.html | 135 +-- apidocs/icalattach_8h.html | 137 +-- apidocs/icalattach_8h_source.html | 125 ++- apidocs/icalattachimpl_8h_source.html | 125 ++- apidocs/icalbdbset_8h_source.html | 385 +++---- apidocs/icalbdbset__cxx_8h.html | 38 +- apidocs/icalbdbset__cxx_8h_source.html | 147 +-- apidocs/icalbdbsetimpl_8h_source.html | 119 +- apidocs/icalcalendar_8h.html | 67 +- apidocs/icalcalendar_8h_source.html | 122 ++- apidocs/icalclassify_8h_source.html | 87 +- apidocs/icalcluster_8h_source.html | 147 +-- apidocs/icalclusterimpl_8h_source.html | 95 +- apidocs/icalcomponent_8h.html | 563 +++++----- apidocs/icalcomponent_8h_source.html | 719 ++++++------- apidocs/icaldirset_8h.html | 119 +- apidocs/icaldirset_8h_source.html | 240 +++-- apidocs/icaldirsetimpl_8h_source.html | 132 +-- apidocs/icalduration_8h.html | 182 ++-- apidocs/icalduration_8h_source.html | 172 +-- apidocs/icalenums_8h.html | 102 +- apidocs/icalenums_8h_source.html | 366 +++---- apidocs/icalerror_8h.html | 321 +++--- apidocs/icalerror_8h_source.html | 466 ++++---- apidocs/icalfileset_8h_source.html | 258 ++--- apidocs/icalfilesetimpl_8h_source.html | 118 +- apidocs/icalgauge_8h.html | 55 +- apidocs/icalgauge_8h_source.html | 108 +- apidocs/icalgaugeimpl_8h_source.html | 155 +-- apidocs/icallangbind_8h_source.html | 141 +-- apidocs/icalmemory_8h.html | 300 ++---- apidocs/icalmemory_8h_source.html | 163 +-- apidocs/icalmessage_8h_source.html | 121 ++- apidocs/icalmime_8h_source.html | 79 +- apidocs/icalparameter_8h.html | 427 ++++---- apidocs/icalparameter_8h_source.html | 215 ++-- apidocs/icalparameter__cxx_8h.html | 38 +- apidocs/icalparameter__cxx_8h_source.html | 347 +++--- apidocs/icalparameterimpl_8h_source.html | 102 +- apidocs/icalparser_8h.html | 211 ++-- apidocs/icalparser_8h_source.html | 192 ++-- apidocs/icalperiod_8h.html | 127 +-- apidocs/icalperiod_8h_source.html | 144 +-- apidocs/icalproperty_8h.html | 255 ++--- apidocs/icalproperty_8h_source.html | 294 ++--- apidocs/icalproperty__cxx_8h.html | 42 +- apidocs/icalproperty__cxx_8h_source.html | 779 +++++++------- apidocs/icalproperty__p_8h_source.html | 83 +- apidocs/icalrecur_8h.html | 407 ++----- apidocs/icalrecur_8h_source.html | 495 ++++----- apidocs/icalrestriction_8h.html | 75 +- apidocs/icalrestriction_8h_source.html | 152 +-- apidocs/icalset_8h.html | 193 ++-- apidocs/icalset_8h_source.html | 324 +++--- apidocs/icalspanlist_8h.html | 95 +- apidocs/icalspanlist_8h_source.html | 137 +-- apidocs/icalspanlist__cxx_8h.html | 38 +- apidocs/icalspanlist__cxx_8h_source.html | 149 +-- apidocs/icalssyacc_8h_source.html | 228 ++-- apidocs/icaltime_8h.html | 256 +++-- apidocs/icaltime_8h_source.html | 395 +++---- apidocs/icaltimezone_8h.html | 243 ++--- apidocs/icaltimezone_8h_source.html | 393 +++---- apidocs/icaltimezoneimpl_8h_source.html | 111 +- apidocs/icaltypes_8h_source.html | 247 +++-- apidocs/icaltz-util_8h_source.html | 92 +- apidocs/icalvalue_8h.html | 131 +-- apidocs/icalvalue_8h_source.html | 196 ++-- apidocs/icalvalue__cxx_8h_source.html | 379 +++---- apidocs/icalvalueimpl_8h_source.html | 220 ++-- apidocs/icalvcal_8h_source.html | 113 +- apidocs/icalversion_8h_source.html | 91 +- apidocs/icptrholder__cxx_8h.html | 44 +- apidocs/icptrholder__cxx_8h_source.html | 215 ++-- apidocs/index.html | 89 +- apidocs/inherit_graph_10.map | 2 +- apidocs/inherit_graph_10.md5 | 2 +- apidocs/inherit_graph_10.png | Bin 1172 -> 1068 bytes apidocs/inherit_graph_11.map | 2 +- apidocs/inherit_graph_11.md5 | 2 +- apidocs/inherit_graph_11.png | Bin 1068 -> 1285 bytes apidocs/inherit_graph_12.map | 2 +- apidocs/inherit_graph_12.md5 | 2 +- apidocs/inherit_graph_12.png | Bin 1285 -> 1633 bytes apidocs/inherit_graph_13.map | 2 +- apidocs/inherit_graph_13.md5 | 2 +- apidocs/inherit_graph_13.png | Bin 1633 -> 1630 bytes apidocs/inherit_graph_14.map | 2 +- apidocs/inherit_graph_14.md5 | 2 +- apidocs/inherit_graph_14.png | Bin 1630 -> 1284 bytes apidocs/inherit_graph_15.map | 2 +- apidocs/inherit_graph_15.md5 | 2 +- apidocs/inherit_graph_15.png | Bin 1284 -> 1313 bytes apidocs/inherit_graph_16.map | 2 +- apidocs/inherit_graph_16.md5 | 2 +- apidocs/inherit_graph_16.png | Bin 1313 -> 1325 bytes apidocs/inherit_graph_17.map | 2 +- apidocs/inherit_graph_17.md5 | 2 +- apidocs/inherit_graph_17.png | Bin 1325 -> 1500 bytes apidocs/inherit_graph_18.map | 2 +- apidocs/inherit_graph_18.md5 | 2 +- apidocs/inherit_graph_18.png | Bin 1500 -> 1346 bytes apidocs/inherit_graph_19.map | 2 +- apidocs/inherit_graph_19.md5 | 2 +- apidocs/inherit_graph_19.png | Bin 1346 -> 1322 bytes apidocs/inherit_graph_2.map | 2 +- apidocs/inherit_graph_2.md5 | 2 +- apidocs/inherit_graph_2.png | Bin 1654 -> 1257 bytes apidocs/inherit_graph_20.map | 2 +- apidocs/inherit_graph_20.md5 | 2 +- apidocs/inherit_graph_20.png | Bin 1322 -> 1630 bytes apidocs/inherit_graph_21.map | 2 +- apidocs/inherit_graph_21.md5 | 2 +- apidocs/inherit_graph_21.png | Bin 1630 -> 1802 bytes apidocs/inherit_graph_22.map | 2 +- apidocs/inherit_graph_22.md5 | 2 +- apidocs/inherit_graph_22.png | Bin 1802 -> 1391 bytes apidocs/inherit_graph_23.map | 2 +- apidocs/inherit_graph_23.md5 | 2 +- apidocs/inherit_graph_23.png | Bin 1391 -> 1528 bytes apidocs/inherit_graph_24.map | 2 +- apidocs/inherit_graph_24.md5 | 2 +- apidocs/inherit_graph_24.png | Bin 1528 -> 1560 bytes apidocs/inherit_graph_25.map | 2 +- apidocs/inherit_graph_25.md5 | 2 +- apidocs/inherit_graph_25.png | Bin 1560 -> 1306 bytes apidocs/inherit_graph_26.map | 2 +- apidocs/inherit_graph_26.md5 | 2 +- apidocs/inherit_graph_26.png | Bin 1306 -> 1720 bytes apidocs/inherit_graph_27.map | 2 +- apidocs/inherit_graph_27.md5 | 2 +- apidocs/inherit_graph_27.png | Bin 1720 -> 1197 bytes apidocs/inherit_graph_28.map | 2 +- apidocs/inherit_graph_28.md5 | 2 +- apidocs/inherit_graph_28.png | Bin 1197 -> 1440 bytes apidocs/inherit_graph_29.map | 2 +- apidocs/inherit_graph_29.md5 | 2 +- apidocs/inherit_graph_29.png | Bin 1440 -> 1457 bytes apidocs/inherit_graph_3.map | 2 +- apidocs/inherit_graph_3.md5 | 2 +- apidocs/inherit_graph_3.png | Bin 1257 -> 1716 bytes apidocs/inherit_graph_30.map | 2 +- apidocs/inherit_graph_30.md5 | 2 +- apidocs/inherit_graph_30.png | Bin 1457 -> 1417 bytes apidocs/inherit_graph_31.map | 2 +- apidocs/inherit_graph_31.md5 | 2 +- apidocs/inherit_graph_31.png | Bin 1417 -> 1383 bytes apidocs/inherit_graph_32.map | 2 +- apidocs/inherit_graph_32.md5 | 2 +- apidocs/inherit_graph_32.png | Bin 1383 -> 1498 bytes apidocs/inherit_graph_33.map | 2 +- apidocs/inherit_graph_33.md5 | 2 +- apidocs/inherit_graph_33.png | Bin 1498 -> 1227 bytes apidocs/inherit_graph_34.map | 2 +- apidocs/inherit_graph_34.md5 | 2 +- apidocs/inherit_graph_34.png | Bin 1227 -> 1219 bytes apidocs/inherit_graph_35.map | 2 +- apidocs/inherit_graph_35.md5 | 2 +- apidocs/inherit_graph_35.png | Bin 1219 -> 1400 bytes apidocs/inherit_graph_36.map | 2 +- apidocs/inherit_graph_36.md5 | 2 +- apidocs/inherit_graph_36.png | Bin 1400 -> 1591 bytes apidocs/inherit_graph_37.map | 2 +- apidocs/inherit_graph_37.md5 | 2 +- apidocs/inherit_graph_37.png | Bin 1591 -> 1433 bytes apidocs/inherit_graph_38.map | 2 +- apidocs/inherit_graph_38.md5 | 2 +- apidocs/inherit_graph_38.png | Bin 1433 -> 1229 bytes apidocs/inherit_graph_39.map | 2 +- apidocs/inherit_graph_39.md5 | 2 +- apidocs/inherit_graph_39.png | Bin 1229 -> 1526 bytes apidocs/inherit_graph_4.map | 2 +- apidocs/inherit_graph_4.md5 | 2 +- apidocs/inherit_graph_4.png | Bin 1716 -> 1421 bytes apidocs/inherit_graph_40.map | 2 +- apidocs/inherit_graph_40.md5 | 2 +- apidocs/inherit_graph_40.png | Bin 1526 -> 1470 bytes apidocs/inherit_graph_41.map | 2 +- apidocs/inherit_graph_41.md5 | 2 +- apidocs/inherit_graph_41.png | Bin 1470 -> 1225 bytes apidocs/inherit_graph_42.map | 2 +- apidocs/inherit_graph_42.md5 | 2 +- apidocs/inherit_graph_42.png | Bin 1225 -> 1022 bytes apidocs/inherit_graph_43.map | 2 +- apidocs/inherit_graph_43.md5 | 2 +- apidocs/inherit_graph_43.png | Bin 1022 -> 1223 bytes apidocs/inherit_graph_44.map | 2 +- apidocs/inherit_graph_44.md5 | 2 +- apidocs/inherit_graph_44.png | Bin 1223 -> 1301 bytes apidocs/inherit_graph_45.map | 2 +- apidocs/inherit_graph_45.md5 | 2 +- apidocs/inherit_graph_45.png | Bin 1301 -> 1359 bytes apidocs/inherit_graph_46.map | 2 +- apidocs/inherit_graph_46.md5 | 2 +- apidocs/inherit_graph_46.png | Bin 1359 -> 1608 bytes apidocs/inherit_graph_47.map | 2 +- apidocs/inherit_graph_47.md5 | 2 +- apidocs/inherit_graph_47.png | Bin 1386 -> 1688 bytes apidocs/inherit_graph_48.map | 2 +- apidocs/inherit_graph_48.md5 | 2 +- apidocs/inherit_graph_48.png | Bin 1352 -> 1386 bytes apidocs/inherit_graph_49.map | 2 +- apidocs/inherit_graph_49.md5 | 2 +- apidocs/inherit_graph_49.png | Bin 1484 -> 1352 bytes apidocs/inherit_graph_5.map | 2 +- apidocs/inherit_graph_5.md5 | 2 +- apidocs/inherit_graph_5.png | Bin 1421 -> 1129 bytes apidocs/inherit_graph_50.map | 2 +- apidocs/inherit_graph_50.md5 | 2 +- apidocs/inherit_graph_50.png | Bin 1683 -> 1484 bytes apidocs/inherit_graph_51.map | 2 +- apidocs/inherit_graph_51.md5 | 2 +- apidocs/inherit_graph_51.png | Bin 859 -> 1683 bytes apidocs/inherit_graph_52.map | 2 +- apidocs/inherit_graph_52.md5 | 2 +- apidocs/inherit_graph_52.png | Bin 1681 -> 712 bytes apidocs/inherit_graph_53.map | 2 +- apidocs/inherit_graph_53.md5 | 2 +- apidocs/inherit_graph_53.png | Bin 1486 -> 859 bytes apidocs/inherit_graph_54.map | 2 +- apidocs/inherit_graph_54.md5 | 2 +- apidocs/inherit_graph_54.png | Bin 1922 -> 1681 bytes apidocs/inherit_graph_55.map | 2 +- apidocs/inherit_graph_55.md5 | 2 +- apidocs/inherit_graph_55.png | Bin 1630 -> 1486 bytes apidocs/inherit_graph_56.map | 2 +- apidocs/inherit_graph_56.md5 | 2 +- apidocs/inherit_graph_56.png | Bin 1526 -> 1922 bytes apidocs/inherit_graph_57.map | 13 +- apidocs/inherit_graph_57.md5 | 2 +- apidocs/inherit_graph_57.png | Bin 47093 -> 1630 bytes apidocs/inherit_graph_58.map | 2 +- apidocs/inherit_graph_58.md5 | 2 +- apidocs/inherit_graph_58.png | Bin 1764 -> 1526 bytes apidocs/inherit_graph_59.map | 13 +- apidocs/inherit_graph_59.md5 | 2 +- apidocs/inherit_graph_59.png | Bin 776 -> 47093 bytes apidocs/inherit_graph_6.map | 2 +- apidocs/inherit_graph_6.md5 | 2 +- apidocs/inherit_graph_6.png | Bin 1129 -> 1862 bytes apidocs/inherit_graph_60.map | 2 +- apidocs/inherit_graph_60.md5 | 2 +- apidocs/inherit_graph_60.png | Bin 1745 -> 1764 bytes apidocs/inherit_graph_61.map | 2 +- apidocs/inherit_graph_61.md5 | 2 +- apidocs/inherit_graph_61.png | Bin 1285 -> 776 bytes apidocs/inherit_graph_62.map | 2 +- apidocs/inherit_graph_62.md5 | 2 +- apidocs/inherit_graph_62.png | Bin 735 -> 1745 bytes apidocs/inherit_graph_63.map | 2 +- apidocs/inherit_graph_63.md5 | 2 +- apidocs/inherit_graph_63.png | Bin 1085 -> 1285 bytes apidocs/inherit_graph_64.map | 2 +- apidocs/inherit_graph_64.md5 | 2 +- apidocs/inherit_graph_64.png | Bin 960 -> 735 bytes apidocs/inherit_graph_65.map | 2 +- apidocs/inherit_graph_65.md5 | 2 +- apidocs/inherit_graph_65.png | Bin 840 -> 1085 bytes apidocs/inherit_graph_66.map | 2 +- apidocs/inherit_graph_66.md5 | 2 +- apidocs/inherit_graph_66.png | Bin 790 -> 960 bytes apidocs/inherit_graph_67.map | 2 +- apidocs/inherit_graph_67.md5 | 2 +- apidocs/inherit_graph_67.png | Bin 1106 -> 840 bytes apidocs/inherit_graph_68.map | 2 +- apidocs/inherit_graph_68.md5 | 2 +- apidocs/inherit_graph_68.png | Bin 1001 -> 790 bytes apidocs/inherit_graph_69.map | 2 +- apidocs/inherit_graph_69.md5 | 2 +- apidocs/inherit_graph_69.png | Bin 1017 -> 1106 bytes apidocs/inherit_graph_7.map | 2 +- apidocs/inherit_graph_7.md5 | 2 +- apidocs/inherit_graph_7.png | Bin 1862 -> 1495 bytes apidocs/inherit_graph_70.map | 2 +- apidocs/inherit_graph_70.md5 | 2 +- apidocs/inherit_graph_70.png | Bin 1451 -> 1001 bytes apidocs/inherit_graph_71.map | 2 +- apidocs/inherit_graph_71.md5 | 2 +- apidocs/inherit_graph_71.png | Bin 1206 -> 1017 bytes apidocs/inherit_graph_72.map | 2 +- apidocs/inherit_graph_72.md5 | 2 +- apidocs/inherit_graph_72.png | Bin 1369 -> 1451 bytes apidocs/inherit_graph_73.map | 2 +- apidocs/inherit_graph_73.md5 | 2 +- apidocs/inherit_graph_73.png | Bin 1003 -> 1206 bytes apidocs/inherit_graph_74.map | 2 +- apidocs/inherit_graph_74.md5 | 2 +- apidocs/inherit_graph_74.png | Bin 894 -> 1369 bytes apidocs/inherit_graph_75.map | 2 +- apidocs/inherit_graph_75.md5 | 2 +- apidocs/inherit_graph_75.png | Bin 962 -> 1003 bytes apidocs/inherit_graph_76.map | 2 +- apidocs/inherit_graph_76.md5 | 2 +- apidocs/inherit_graph_76.png | Bin 911 -> 894 bytes apidocs/inherit_graph_77.map | 2 +- apidocs/inherit_graph_77.md5 | 2 +- apidocs/inherit_graph_77.png | Bin 1013 -> 962 bytes apidocs/inherit_graph_78.map | 2 +- apidocs/inherit_graph_78.md5 | 2 +- apidocs/inherit_graph_78.png | Bin 1189 -> 644 bytes apidocs/inherit_graph_79.map | 2 +- apidocs/inherit_graph_79.md5 | 2 +- apidocs/inherit_graph_79.png | Bin 1164 -> 751 bytes apidocs/inherit_graph_8.map | 2 +- apidocs/inherit_graph_8.md5 | 2 +- apidocs/inherit_graph_8.png | Bin 1495 -> 1817 bytes apidocs/inherit_graph_80.map | 2 +- apidocs/inherit_graph_80.md5 | 2 +- apidocs/inherit_graph_80.png | Bin 1624 -> 911 bytes apidocs/inherit_graph_81.map | 2 +- apidocs/inherit_graph_81.md5 | 2 +- apidocs/inherit_graph_81.png | Bin 1032 -> 1189 bytes apidocs/inherit_graph_82.map | 2 +- apidocs/inherit_graph_82.md5 | 2 +- apidocs/inherit_graph_82.png | Bin 1499 -> 1164 bytes apidocs/inherit_graph_83.map | 2 +- apidocs/inherit_graph_83.md5 | 2 +- apidocs/inherit_graph_83.png | Bin 1327 -> 1624 bytes apidocs/inherit_graph_84.map | 2 +- apidocs/inherit_graph_84.md5 | 2 +- apidocs/inherit_graph_84.png | Bin 878 -> 1032 bytes apidocs/inherit_graph_85.map | 2 +- apidocs/inherit_graph_85.md5 | 2 +- apidocs/inherit_graph_85.png | Bin 1562 -> 1499 bytes apidocs/inherit_graph_86.map | 2 +- apidocs/inherit_graph_86.md5 | 2 +- apidocs/inherit_graph_86.png | Bin 899 -> 1327 bytes apidocs/inherit_graph_87.map | 2 +- apidocs/inherit_graph_87.md5 | 2 +- apidocs/inherit_graph_87.png | Bin 1182 -> 878 bytes apidocs/inherit_graph_88.map | 3 + apidocs/inherit_graph_88.md5 | 1 + apidocs/inherit_graph_88.png | Bin 0 -> 899 bytes apidocs/inherit_graph_89.map | 3 + apidocs/inherit_graph_89.md5 | 1 + apidocs/inherit_graph_89.png | Bin 0 -> 1182 bytes apidocs/inherit_graph_9.map | 2 +- apidocs/inherit_graph_9.md5 | 2 +- apidocs/inherit_graph_9.png | Bin 1817 -> 1172 bytes apidocs/inherits.html | 233 ++-- apidocs/jquery.js | 4 +- apidocs/libical__deprecated_8h_source.html | 98 -- apidocs/libical__ical__export_8h_source.html | 82 +- apidocs/libical__icalss__export_8h_source.html | 82 +- apidocs/libical__vcal__export_8h_source.html | 83 +- ..._projects_libical_libical_doc_UsingLibical.html | 921 ---------------- apidocs/menu.js | 86 +- apidocs/menudata.js | 3 - apidocs/pages.html | 80 -- apidocs/pvl_8h_source.html | 221 ++-- apidocs/qsort__gen_8h.html | 193 ---- apidocs/qsort__gen_8h_source.html | 100 -- apidocs/search/all_0.html | 6 +- apidocs/search/all_0.js | 7 +- apidocs/search/all_1.html | 6 +- apidocs/search/all_1.js | 6 +- apidocs/search/all_10.html | 6 +- apidocs/search/all_10.js | 6 +- apidocs/search/all_11.html | 6 +- apidocs/search/all_11.js | 21 +- apidocs/search/all_12.html | 6 +- apidocs/search/all_12.js | 25 +- apidocs/search/all_13.html | 6 +- apidocs/search/all_13.js | 7 +- apidocs/search/all_14.html | 6 +- apidocs/search/all_14.js | 18 +- apidocs/search/all_15.html | 6 +- apidocs/search/all_15.js | 17 +- apidocs/search/all_16.html | 6 +- apidocs/search/all_16.js | 5 +- apidocs/search/all_17.html | 6 +- apidocs/search/all_17.js | 9 +- apidocs/search/all_18.html | 6 +- apidocs/search/all_18.js | 10 +- apidocs/search/all_19.html | 6 +- apidocs/search/all_19.js | 3 +- apidocs/search/all_1a.html | 37 - apidocs/search/all_1a.js | 4 - apidocs/search/all_2.html | 6 +- apidocs/search/all_2.js | 12 +- apidocs/search/all_3.html | 6 +- apidocs/search/all_3.js | 19 +- apidocs/search/all_4.html | 6 +- apidocs/search/all_4.js | 25 +- apidocs/search/all_5.html | 6 +- apidocs/search/all_5.js | 8 +- apidocs/search/all_6.html | 6 +- apidocs/search/all_6.js | 14 +- apidocs/search/all_7.html | 6 +- apidocs/search/all_7.js | 20 +- apidocs/search/all_8.html | 6 +- apidocs/search/all_8.js | 2 +- apidocs/search/all_9.html | 6 +- apidocs/search/all_9.js | 717 ++++++------ apidocs/search/all_a.html | 6 +- apidocs/search/all_a.js | 6 +- apidocs/search/all_b.html | 6 +- apidocs/search/all_b.js | 9 +- apidocs/search/all_c.html | 6 +- apidocs/search/all_c.js | 12 +- apidocs/search/all_d.html | 6 +- apidocs/search/all_d.js | 2 +- apidocs/search/all_e.html | 6 +- apidocs/search/all_e.js | 10 +- apidocs/search/all_f.html | 6 +- apidocs/search/all_f.js | 16 +- apidocs/search/classes_0.html | 6 +- apidocs/search/classes_0.js | 11 +- apidocs/search/classes_1.html | 6 +- apidocs/search/classes_1.js | 2 +- apidocs/search/classes_10.html | 6 +- apidocs/search/classes_10.js | 2 +- apidocs/search/classes_11.html | 6 +- apidocs/search/classes_11.js | 4 +- apidocs/search/classes_12.html | 6 +- apidocs/search/classes_12.js | 9 +- apidocs/search/classes_13.html | 6 +- apidocs/search/classes_13.js | 2 +- apidocs/search/classes_2.html | 6 +- apidocs/search/classes_2.js | 2 +- apidocs/search/classes_3.html | 6 +- apidocs/search/classes_3.js | 2 +- apidocs/search/classes_4.html | 6 +- apidocs/search/classes_4.js | 4 +- apidocs/search/classes_5.html | 6 +- apidocs/search/classes_5.js | 2 +- apidocs/search/classes_6.html | 6 +- apidocs/search/classes_6.js | 90 +- apidocs/search/classes_7.html | 6 +- apidocs/search/classes_7.js | 3 +- apidocs/search/classes_8.html | 6 +- apidocs/search/classes_8.js | 6 +- apidocs/search/classes_9.html | 6 +- apidocs/search/classes_9.js | 4 +- apidocs/search/classes_a.html | 6 +- apidocs/search/classes_a.js | 6 +- apidocs/search/classes_b.html | 6 +- apidocs/search/classes_b.js | 4 +- apidocs/search/classes_c.html | 6 +- apidocs/search/classes_c.js | 14 +- apidocs/search/classes_d.html | 6 +- apidocs/search/classes_d.js | 4 +- apidocs/search/classes_e.html | 6 +- apidocs/search/classes_e.js | 3 +- apidocs/search/classes_f.html | 6 +- apidocs/search/classes_f.js | 26 +- apidocs/search/defines_0.html | 6 +- apidocs/search/defines_0.js | 20 +- apidocs/search/enums_0.html | 6 +- apidocs/search/enums_0.js | 8 +- apidocs/search/enumvalues_0.html | 6 +- apidocs/search/enumvalues_0.js | 58 +- apidocs/search/files_0.html | 6 +- apidocs/search/files_0.js | 2 +- apidocs/search/files_1.html | 6 +- apidocs/search/files_1.js | 52 +- apidocs/search/files_2.html | 6 +- apidocs/search/files_2.js | 2 +- apidocs/search/files_3.html | 37 - apidocs/search/files_3.js | 4 - apidocs/search/functions_0.html | 6 +- apidocs/search/functions_0.js | 4 +- apidocs/search/functions_1.html | 6 +- apidocs/search/functions_1.js | 2 +- apidocs/search/functions_2.html | 6 +- apidocs/search/functions_2.js | 7 +- apidocs/search/functions_3.html | 6 +- apidocs/search/functions_3.js | 2 +- apidocs/search/functions_4.html | 6 +- apidocs/search/functions_4.js | 2 +- apidocs/search/functions_5.html | 6 +- apidocs/search/functions_5.js | 18 +- apidocs/search/functions_6.html | 6 +- apidocs/search/functions_6.js | 467 ++++---- apidocs/search/functions_7.html | 6 +- apidocs/search/functions_7.js | 3 +- apidocs/search/functions_8.html | 6 +- apidocs/search/functions_8.js | 2 +- apidocs/search/functions_9.html | 6 +- apidocs/search/functions_9.js | 3 +- apidocs/search/functions_a.html | 6 +- apidocs/search/functions_a.js | 5 +- apidocs/search/functions_b.html | 6 +- apidocs/search/functions_b.js | 5 +- apidocs/search/functions_c.html | 37 - apidocs/search/functions_c.js | 4 - apidocs/search/pages_0.html | 6 +- apidocs/search/pages_0.js | 2 +- apidocs/search/pages_1.html | 37 - apidocs/search/pages_1.js | 4 - apidocs/search/pages_2.html | 37 - apidocs/search/pages_2.js | 4 - apidocs/search/search.css | 12 +- apidocs/search/search.js | 68 +- apidocs/search/searchdata.js | 8 +- apidocs/search/typedefs_0.html | 6 +- apidocs/search/typedefs_0.js | 12 +- apidocs/search/variables_0.html | 6 +- apidocs/search/variables_0.js | 8 +- apidocs/search/variables_1.html | 6 +- apidocs/search/variables_1.js | 10 +- apidocs/search/variables_10.html | 6 +- apidocs/search/variables_10.js | 2 +- apidocs/search/variables_11.html | 6 +- apidocs/search/variables_11.js | 4 +- apidocs/search/variables_12.html | 6 +- apidocs/search/variables_12.js | 6 +- apidocs/search/variables_13.html | 6 +- apidocs/search/variables_13.js | 2 +- apidocs/search/variables_2.html | 6 +- apidocs/search/variables_2.js | 20 +- apidocs/search/variables_3.html | 6 +- apidocs/search/variables_3.js | 4 +- apidocs/search/variables_4.html | 6 +- apidocs/search/variables_4.js | 10 +- apidocs/search/variables_5.html | 6 +- apidocs/search/variables_5.js | 2 +- apidocs/search/variables_6.html | 6 +- apidocs/search/variables_6.js | 2 +- apidocs/search/variables_7.html | 6 +- apidocs/search/variables_7.js | 14 +- apidocs/search/variables_8.html | 6 +- apidocs/search/variables_8.js | 3 +- apidocs/search/variables_9.html | 6 +- apidocs/search/variables_9.js | 4 +- apidocs/search/variables_a.html | 6 +- apidocs/search/variables_a.js | 6 +- apidocs/search/variables_b.html | 6 +- apidocs/search/variables_b.js | 2 +- apidocs/search/variables_c.html | 6 +- apidocs/search/variables_c.js | 4 +- apidocs/search/variables_d.html | 6 +- apidocs/search/variables_d.js | 10 +- apidocs/search/variables_e.html | 6 +- apidocs/search/variables_e.js | 14 +- apidocs/search/variables_f.html | 6 +- apidocs/search/variables_f.js | 8 +- apidocs/src/libicalvcal/README.txt | 959 ----------------- apidocs/sspm_8h_source.html | 295 ++--- apidocs/structLexBuf.html | 53 +- apidocs/structOFile.html | 41 +- apidocs/structPreDefProp.html | 37 +- apidocs/structStrItem.html | 35 +- apidocs/structVObject.html | 39 +- apidocs/structVObjectIterator.html | 33 +- apidocs/structYYSTACKDATA.html | 101 -- apidocs/struct__compat__tzids.html | 33 +- apidocs/struct__icalarray.html | 39 +- apidocs/struct__icalarray__sort__context.html | 89 -- apidocs/struct__icaltimezone.html | 63 +- apidocs/struct__icaltimezonechange.html | 59 +- apidocs/struct__icalvcal__defaults.html | 35 +- apidocs/structbuffer__ring.html | 33 +- apidocs/structconversion__table__struct.html | 39 +- apidocs/structencoding__map.html | 33 +- apidocs/structexpand__split__map__struct.html | 41 +- apidocs/structfreq__map.html | 37 +- apidocs/structicalattach__impl.html | 35 +- apidocs/structicalbdbset__id.html | 35 +- apidocs/structicalbdbset__impl.html | 59 +- apidocs/structicalbdbset__options.html | 59 +- apidocs/structicalcalendar__impl.html | 39 +- apidocs/structicalclassify__map.html | 35 +- apidocs/structicalclassify__parts.html | 49 +- apidocs/structicalcluster__impl.html | 37 +- apidocs/structicalcompiter.html | 33 +- apidocs/structicalcomponent__impl.html | 51 +- apidocs/structicalcomponent__kind__map.html | 33 +- apidocs/structicaldatetimeperiodtype.html | 33 +- apidocs/structicaldirset__impl.html | 61 +- apidocs/structicaldirset__options.html | 33 +- apidocs/structicaldurationtype.html | 45 +- apidocs/structicalerror__state.html | 33 +- apidocs/structicalerror__string__map.html | 35 +- apidocs/structicalfileset__id.html | 35 +- apidocs/structicalfileset__impl.html | 57 +- apidocs/structicalfileset__options.html | 51 +- apidocs/structicalgauge__impl.html | 43 +- apidocs/structicalgauge__where.html | 39 +- apidocs/structicalgeotype.html | 41 +- apidocs/structicalparameter__impl.html | 43 +- apidocs/structicalparser__impl.html | 54 +- apidocs/structicalperiodtype.html | 39 +- apidocs/structicalproperty__impl.html | 43 +- apidocs/structicalrecur__iterator__impl.html | 62 +- apidocs/structicalrecur__parser.html | 39 +- apidocs/structicalrecurrencetype.html | 73 +- apidocs/structicalreqstattype.html | 35 +- apidocs/structicalset__impl.html | 93 +- apidocs/structicalsetiter.html | 39 +- apidocs/structicalspanlist__impl.html | 41 +- apidocs/structicaltime__span.html | 45 +- apidocs/structicaltimetype.html | 57 +- apidocs/structicaltimezonephase.html | 108 ++ apidocs/structicaltimezonetype.html | 96 ++ apidocs/structicaltriggertype.html | 33 +- apidocs/structicalvalue__impl.html | 43 +- apidocs/structleap.html | 90 ++ apidocs/structmajor__content__type__map.html | 33 +- apidocs/structmime__impl.html | 49 +- apidocs/structminor__content__type__map.html | 33 +- apidocs/structobservance.html | 37 +- apidocs/structpvl__elem__t.html | 49 +- apidocs/structpvl__list__t.html | 55 +- apidocs/structrdate.html | 33 +- apidocs/structrecur__map.html | 42 +- apidocs/structskip__map.html | 37 +- apidocs/structslg__data.html | 33 +- apidocs/structsspm__action__map.html | 45 +- apidocs/structsspm__buffer.html | 37 +- apidocs/structsspm__header.html | 53 +- apidocs/structsspm__part.html | 37 +- apidocs/structtext__part.html | 35 +- apidocs/structttinfo.html | 102 ++ apidocs/structtzinfo.html | 111 ++ apidocs/structut__instant.html | 77 +- apidocs/structut__instant__int.html | 189 ---- apidocs/structwd__map.html | 37 +- apidocs/structyy__buffer__state.html | 57 +- apidocs/structyy__trans__info.html | 33 +- apidocs/structzone__context.html | 53 +- apidocs/tabs.css | 2 +- apidocs/unionValueItem.html | 41 +- apidocs/unionYYSTYPE.html | 35 +- apidocs/unionicalvalue__impl_1_1data.html | 51 +- apidocs/unionyyalloc.html | 33 +- apidocs/vcaltmp_8h_source.html | 201 ++-- apidocs/vcc_8h_source.html | 163 +-- apidocs/vcomponent__cxx_8h.html | 42 +- apidocs/vcomponent__cxx_8h_source.html | 665 ++++++------ apidocs/vobject_8h_source.html | 717 ++++++------ 710 files changed, 17960 insertions(+), 19823 deletions(-) delete mode 100644 apidocs/Install.txt delete mode 100644 apidocs/deprecated.html create mode 100644 apidocs/dir_000002_000001.html delete mode 100644 apidocs/dir_000002_000005.html create mode 100644 apidocs/dir_000003_000001.html delete mode 100644 apidocs/dir_000003_000002.html delete mode 100644 apidocs/dir_000003_000005.html delete mode 100644 apidocs/dir_000004_000002.html delete mode 100644 apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.map delete mode 100644 apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.md5 delete mode 100644 apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.png delete mode 100644 apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.map delete mode 100644 apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.md5 delete mode 100644 apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.png delete mode 100644 apidocs/globals_func_q.html delete mode 100644 apidocs/globals_q.html create mode 100644 apidocs/inherit_graph_88.map create mode 100644 apidocs/inherit_graph_88.md5 create mode 100644 apidocs/inherit_graph_88.png create mode 100644 apidocs/inherit_graph_89.map create mode 100644 apidocs/inherit_graph_89.md5 create mode 100644 apidocs/inherit_graph_89.png delete mode 100644 apidocs/libical__deprecated_8h_source.html delete mode 100644 apidocs/md__home_allen_projects_libical_libical_doc_UsingLibical.html delete mode 100644 apidocs/pages.html delete mode 100644 apidocs/qsort__gen_8h.html delete mode 100644 apidocs/qsort__gen_8h_source.html delete mode 100644 apidocs/search/all_1a.html delete mode 100644 apidocs/search/all_1a.js delete mode 100644 apidocs/search/files_3.html delete mode 100644 apidocs/search/files_3.js delete mode 100644 apidocs/search/functions_c.html delete mode 100644 apidocs/search/functions_c.js delete mode 100644 apidocs/search/pages_1.html delete mode 100644 apidocs/search/pages_1.js delete mode 100644 apidocs/search/pages_2.html delete mode 100644 apidocs/search/pages_2.js delete mode 100644 apidocs/src/libicalvcal/README.txt delete mode 100644 apidocs/structYYSTACKDATA.html delete mode 100644 apidocs/struct__icalarray__sort__context.html create mode 100644 apidocs/structicaltimezonephase.html create mode 100644 apidocs/structicaltimezonetype.html create mode 100644 apidocs/structleap.html create mode 100644 apidocs/structttinfo.html create mode 100644 apidocs/structtzinfo.html delete mode 100644 apidocs/structut__instant__int.html diff --git a/apidocs/Install.txt b/apidocs/Install.txt deleted file mode 100644 index 30b4de99..00000000 --- a/apidocs/Install.txt +++ /dev/null @@ -1,158 +0,0 @@ -Libical uses the CMake buildsystem. - -Please see the comments at the top of CMakeLists.txt for -the available configuration options you can pass to cmake. - -The installation directory defaults to /usr/local on UNIX -and c:/Program Files on Windows. You can change this by -passing -DCMAKE_INSTALL_PREFIX=/install/path to cmake. - -To build a debug version pass -DCMAKE_BUILD_TYPE=Debug to cmake. - -To build libical you will need: - - a C99-compliant C compiler (let us know if the build fails with your C compiler) - - a C11-compliant C compiler for libical-glib - - a C++11 compliant compiler for C++ bindings - - CMake version 3.11.0 or higher - - Perl - - libicu (not required but strongly recommended) - -Building on Unix with gcc or clang: -% mkdir build -% cd build -% cmake .. -% make -% make install - -Building on Windows with MicroSoft Visual Studio: -From a command prompt for the version of MSVC you want to use -% mkdir build -% cd build -% cmake -G "NMake Makefiles" .. -% nmake -% nmake install - -NOTE: Some MSVC 32bit compilers (like MSVC2005) use a 64bit version of time_t. -In these cases you must pass -DUSE_32BIT_TIME_T=true to cmake to make sure -the 32bit version of time_t is used instead. - -Building on Windows with mingw: -Make sure you have the path to the MinGW programs in %PATH% first, for example: -% set "PATH=c:\MinGW\mingw64\bin;%PATH%" -% mkdir build -% cd build -% cmake -G "MinGW Makefiles" .. -% mingw32-make -% mingw32-make install - -Building on Windows under Cygwin: -% mkdir build -% cd build -% cmake .. -% make -% make install - -Building on MSYS with mingw: -% mkdir build -% cd build -% cmake -G "MSYS Makefiles" .. -% nmake -% nmake install - -To run the test suite, from inside the build directory -run 'make test' (or 'nmake test' or 'mingw32-make test') - -To run the test suite in verbose mode, pass ARGS="-V" to the make command -For example: nmake test ARGS="-V" - -By default, the buildsystem creates shared(dynamic) and static versions -of the libraries, but that behavior can be modified at CMake time: - - To build the static libraries only, pass -DSTATIC_ONLY=True to CMake. - - To build the shared libraries only, pass -DSHARED_ONLY=True to CMake. - -== Building with Different Compilers == -For example, say you want to use Clang to build on Linux. -Then you can set the C and C++ compilers at CMake time, like so: -% CC=clang CXX=clang++ cmake .. - -== Building for OSX (Mac) == -Homebrew: - A couple of necessary dependencies do not have their headers - and development libraries linked into /usr/local/{include,lib} due - to possible contamination with the operating system versions of the - same name. This is known to be the case with libffi and libxml2 - Fix is to export PKG_CONFIG_PATH so CMake can find them, as in: - export PKG_CONFIG_PATH=/usr/local/opt/libffi/lib/pkgconfig:\ - /usr/local/opt/libxml2/lib/pkgconfig - - Also, if building the gtkdocs you'll need to say where the xml - catalog files can be found so the gtk entities are located, like so: - export XML_CATALOG_FILES=/usr/local/etc/xml/catalog - -== Optional Dependencies == -* libicu "International Components for Unicode" development libraries. - Highly recommended for RSCALE support. - libicu can be found at http://www.icu-project.org - - If CMake doesn't locate your libicu installation try setting the - ICU_ROOT or ICU_BASE environment variables to the top folder where - libicu is installed and run cmake again. - -* Berkeley DB storage. - Optional for the Berkeley Database storage support. - The development toolkit can be found at https://www.oracle.com/database/berkeley-db - - ** This code path has not been fully tested. - ** Don't be surprised if there are bugs. - ** Do NOT use for production code. - -* GObject Introspection. To generate GObject introspection "typelib" - files pass the -DGOBJECT_INTROSPECTION=True option to CMake. You'll - need to have the GObject Introspection development package v0.6.7 or higher - installed beforehand. - -You can also force CMake to ignore any of the optional dependencies -by passing the option -DCMAKE_DISABLE_FIND_PACKAGE_=True. -For instance: -# tell cmake to ignore ICU - % cmake -DCMAKE_DISABLE_FIND_PACKAGE_ICU=True - -== Language Bindings == -This C library can be built with bindings for these other languages: -* C++. If a C++ compiler is found the buildsystem will create and install the C++ bindings API. - Turn this off by passing -DWITH_CXX_BINDINGS=False option to CMake. - Don't mix ABI from C and C++ compilers. - -* There are Java, Perl, PHP and Python bindings but they are old and haven't - been tested in a very long time. Volunteers wanted. - -== Tweaking the Library Behavior == -Use these CMake options to adjust the library behavior as follows: - * ICAL_ERRORS_ARE_FATAL=[true|false] - Set to make icalerror_* calls abort instead of internally signaling an error. - Default=false - - * ICAL_ALLOW_EMPTY_PROPERTIES=[true|false] - Set to prevent empty properties from being replaced with X-LIC-ERROR properties. - Default=false - - * USE_BUILTIN_TZDATA=[true|false] - Set to build using our own (instead of the system's) timezone data. - Default=false (use the system timezone data on non-Windows systems) - ALWAYS true on Windows systems - -== Tweaking the Installation Directories == -By default, the installation layout is according to the GNU standard installation directories. -https://www.gnu.org/prep/standards/html_node/Directory-Variables.html - -You can override various installation folders by passing the following variables to CMake: - CMAKE_INSTALL_LIBDIR = The fullpath where you want the put the installed libraries - CMAKE_INSTALL_INCLUDEDIR = The fullpath where you want to put the installed include files - CMAKE_INSTALL_DATAROOTDIR = The fullpath where to want to put the shared files - -for example: cmake -DCMAKE_INSTALL_PREFIX=/opt -DCMAKE_INSTALL_LIBDIR=/opt/lib32 .. - -== Build the documentation == -Run 'make docs' to build the API documentation and reference. -Disable the docs make target by running CMake with -DICAL_BUILD_DOCS=False option. -Disable the libical-glib developer documentation by running CMake with -DENABLE_GTK_DOC=False. diff --git a/apidocs/annotated.html b/apidocs/annotated.html index db02806e..988477c9 100644 --- a/apidocs/annotated.html +++ b/apidocs/annotated.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Data Structures @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -62,117 +62,120 @@ $(function() {
-
Data Structures
+
+
Data Structures
Here are the data structures with brief descriptions:
[detail level 12]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼NLibICal
 CICalBDBSet
 CICalParameter
 CICalProperty
 CICalSpanList
 CICalValue
 CVAgenda
 CVAlarm
 CVCalendar
 CVComponentA class wrapping the libical icalcomponent functions
 CVEvent
 CVFreeBusy
 CVJournal
 CVQuery
 CVTimezone
 CVToDo
 CXDaylight
 CXStandard
 C_compat_tzids
 C_icalarray
 C_icalarray_sort_context
 C_icaltimezone
 C_icaltimezonechange
 C_icalvcal_defaults
 Cbuffer_ring
 Cconversion_table_struct
 Cencoding_map
 Cexpand_split_map_struct
 Cfreq_map
 Cicalattach_impl
 Cicalbdbset_id
 Cicalbdbset_impl
 Cicalbdbset_options
 Cicalcalendar_impl
 Cicalclassify_map
 Cicalclassify_parts
 Cicalcluster_impl
 Cicalcompiter
 Cicalcomponent_impl
 Cicalcomponent_kind_map
 Cicaldatetimeperiodtype
 Cicaldirset_impl
 Cicaldirset_options
 CicaldurationtypeA struct representing a duration
 Cicalerror_state
 Cicalerror_string_map
 Cicalfileset_id
 Cicalfileset_impl
 Cicalfileset_optionsOptions for opening an icalfileset
 Cicalgauge_impl
 Cicalgauge_where
 Cicalgeotype
 Cicalparameter_impl
 Cicalparser_impl
 CicalperiodtypeStruct to represent a period in time
 Cicalproperty_impl
 Cicalrecur_iterator_impl
 Cicalrecur_parser
 Cicalrecurrencetype
 Cicalreqstattype
 Cicalset_impl
 Cicalsetiter
 Cicalspanlist_impl
 Cicaltime_span
 Cicaltimetype
 Cicaltriggertype
 ▼Cicalvalue_impl
 Cdata
 CICPointerHolder
 CLexBuf
 Cmajor_content_type_map
 Cmime_impl
 Cminor_content_type_map
 Cobservance
 COFile
 CPreDefProp
 Cpvl_elem_t
 Cpvl_list_t
 Crdate
 Crecur_map
 Cskip_map
 Cslg_data
 Csspm_action_map
 Csspm_buffer
 Csspm_header
 Csspm_part
 CStrItem
 Ctext_part
 Cut_instant
 Cut_instant_int
 CValueItem
 CVObject
 CVObjectIterator
 Cwd_map
 Cyy_buffer_state
 Cyy_trans_info
 Cyyalloc
 CYYSTACKDATA
 CYYSTYPE
 Czone_context
 ►NLibICal
 C_compat_tzids
 C_icalarray
 C_icaltimezone
 C_icaltimezonechange
 C_icalvcal_defaults
 Cbuffer_ring
 Cconversion_table_struct
 Cencoding_map
 Cexpand_split_map_struct
 Cfreq_map
 Cicalattach_impl
 Cicalbdbset_id
 Cicalbdbset_impl
 Cicalbdbset_options
 Cicalcalendar_impl
 Cicalclassify_map
 Cicalclassify_parts
 Cicalcluster_impl
 Cicalcompiter
 Cicalcomponent_impl
 Cicalcomponent_kind_map
 Cicaldatetimeperiodtype
 Cicaldirset_impl
 Cicaldirset_options
 CicaldurationtypeA struct representing a duration
 Cicalerror_state
 Cicalerror_string_map
 Cicalfileset_id
 Cicalfileset_impl
 Cicalfileset_optionsOptions for opening an icalfileset
 Cicalgauge_impl
 Cicalgauge_where
 Cicalgeotype
 Cicalparameter_impl
 Cicalparser_impl
 CicalperiodtypeStruct to represent a period in time
 Cicalproperty_impl
 Cicalrecur_iterator_impl
 Cicalrecur_parser
 Cicalrecurrencetype
 Cicalreqstattype
 Cicalset_impl
 Cicalsetiter
 Cicalspanlist_impl
 Cicaltime_span
 Cicaltimetype
 Cicaltimezonephase
 Cicaltimezonetype
 Cicaltriggertype
 ►Cicalvalue_impl
 CICPointerHolder
 Cleap
 CLexBuf
 Cmajor_content_type_map
 Cmime_impl
 Cminor_content_type_map
 Cobservance
 COFile
 CPreDefProp
 Cpvl_elem_t
 Cpvl_list_t
 Crdate
 Crecur_map
 Cskip_map
 Cslg_data
 Csspm_action_map
 Csspm_buffer
 Csspm_header
 Csspm_part
 CStrItem
 Ctext_part
 Cttinfo
 Ctzinfo
 Cut_instant
 CValueItem
 CVObject
 CVObjectIterator
 Cwd_map
 Cyy_buffer_state
 Cyy_trans_info
 Cyyalloc
 CYYSTYPE
 Czone_context
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/astime_8h.html b/apidocs/astime_8h.html index 7e0f90a1..ecf28061 100644 --- a/apidocs/astime_8h.html +++ b/apidocs/astime_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: astime.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures | Typedefs | Functions
-
astime.h File Reference
+
+
astime.h File Reference
@@ -79,127 +80,37 @@ $(function() {

Go to the source code of this file.

- - -

+

Data Structures

struct  ut_instant
 
struct  ut_instant_int
 
- - - - - - -

+

Typedefs

+
typedef struct ut_instant UTinstant
 
-typedef struct ut_instant_int UTinstantInt
 
-typedef struct ut_instant_int * UTinstantIntPtr
 
+
typedef struct ut_instant * UTinstantPtr
 
- - - - - - - - - + + + + + +

+

Functions

long caldat (UTinstantPtr))
 
void caldat_int (UTinstantIntPtr)
 
double juldat (UTinstantPtr))
 
void juldat_int (UTinstantIntPtr)
 
+long caldat (UTinstantPtr)
 Converts Julian date to year,mo,da.
 
+double juldat (UTinstantPtr)
 Returns Julian day from year,mo,da.
 

Detailed Description

-

contains definitions of structures used for time calculations.

-

Function Documentation

- -

◆ caldat()

- -
-
- - - - - - - - -
long caldat (UTinstantPtr )
-
-

Converts julian date to year,mo,da

Deprecated:
use caldat_int() instead
- -
-
- -

◆ caldat_int()

- -
-
- - - - - - - - -
void caldat_int (UTinstantIntPtr )
-
-

caldat computes the day of the week, the day of the year the gregorian (or julian) calendar date from the julian decimal date. for astronomical purposes, The Gregorian calendar reform occurred on 15 Oct. 1582. This is 05 Oct 1582 by the julian calendar.

-

Input: a ut_instant structure pointer, where the j_date element has been set. ( = 0 for 01 Jan 4713 B.C.)

-

output: will set all the other elements of the structure. As a convenience, the function will also return the year.

-

Reference: Astronomial formulae for calculators, meeus, p 23 from fortran program by F. Espenak - April 1982 Page 277, 50 Year canon of solar eclipses: 1986-2035

- -
-
- -

◆ juldat()

- -
-
- - - - - - - - -
double juldat (UTinstantPtr )
-
-

Returns julian day from year,mo,da

Deprecated:
use juldat_int() instead
- -
-
- -

◆ juldat_int()

- -
-
- - - - - - - - -
void juldat_int (UTinstantIntPtr )
-
-

juldat computes the julian decimal date (j_date) from the gregorian (or Julian) calendar date. for astronomical purposes, The Gregorian calendar reform occurred on 15 Oct. 1582. This is 05 Oct 1582 by the julian calendar. Input: a ut_instant structure pointer where Day, Month, Year have been set for the date in question.

-

Output: the j_date and weekday elements of the structure will be set. Also, the return value of the function will be the j_date too.

-

Reference: Astronomial formulae for calculators, meeus, p 23 from fortran program by F. Espenak - April 1982 Page 276, 50 Year canon of solar eclipses: 1986-2035

- -
-
-
+

contains definitions of structures used for time calculations.

+
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/astime_8h_source.html b/apidocs/astime_8h_source.html index ba58d034..8d2266d9 100644 --- a/apidocs/astime_8h_source.html +++ b/apidocs/astime_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: astime.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
astime.h
+
+
astime.h
-Go to the documentation of this file.
1/*
-
2 * This work is based on work from Hiram Clawson and has been modified to the
-
3 * needs of the libical project. The original copyright notice is as follows:
-
4 */
-
5/*
-
6 * Copyright (c) 1986-2000, Hiram Clawson
-
7 * All rights reserved.
-
8 *
-
9 * Redistribution and use in source and binary forms, with or
-
10 * without modification, are permitted provided that the following
-
11 * conditions are met:
-
12 *
-
13 * Redistributions of source code must retain the above
-
14 * copyright notice, this list of conditions and the
-
15 * following disclaimer.
-
16 *
-
17 * Redistributions in binary form must reproduce the
-
18 * above copyright notice, this list of conditions and
-
19 * the following disclaimer in the documentation and/or
-
20 * other materials provided with the distribution.
-
21 *
-
22 * Neither name of The Museum of Hiram nor the names of
-
23 * its contributors may be used to endorse or promote products
-
24 * derived from this software without specific prior
-
25 * written permission.
-
26 *
-
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
-
28 * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
-
29 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-
30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-
31 * IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-
32 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-
33 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-
36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
-
37 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
-
38 * THE POSSIBILITY OF SUCH DAMAGE.
-
39 */
-
40/*
-
41 * The modifications made are licensed as follows (to distinguish between
-
42 * the original code and the modifications made, refer to the source code
-
43 * history):
-
44 */
-
45 /*======================================================================
-
46
-
47 SPDX-FileCopyrightText: 2018, Markus Minichmayr
-
48 https://tapkey.com
-
49
-
50 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
51 ========================================================================*/
-
52
-
58#ifndef ICAL_ASTIME_H
-
59#define ICAL_ASTIME_H
-
60
-
61#include "libical_deprecated.h"
-
62#include "libical_ical_export.h"
-
63
-
64typedef struct ut_instant
-
65{
-
66 double j_date;
-
67 long year;
-
68 int month;
-
69 int day;
-
70 int i_hour;
-
71 int i_minute;
-
72 int i_second;
-
73 double d_hour;
-
74 double d_minute;
-
75 double d_second;
-
76 int weekday;
-
77 int day_of_year;
-
78} UTinstant, *UTinstantPtr;
-
79
-
80/* Functions in caldate.c */
-
81
-
85LIBICAL_ICAL_EXPORT LIBICAL_DEPRECATED(long caldat(UTinstantPtr));
-
86
-
90LIBICAL_ICAL_EXPORT LIBICAL_DEPRECATED(double juldat(UTinstantPtr));
-
91
-
92typedef struct ut_instant_int
-
93{
-
94 long j_date0;
-
95 long year;
-
96 int month;
-
97 int day;
-
98 int weekday;
-
99 int day_of_year;
-
100} UTinstantInt, *UTinstantIntPtr;
-
101
-
102/* Functions in caldate.c */
-
103
-
122void caldat_int(UTinstantIntPtr);
-
123
-
139void juldat_int(UTinstantIntPtr);
-
140
-
141#endif
-
juldat
double juldat(UTinstantPtr))
-
juldat_int
void juldat_int(UTinstantIntPtr)
-
caldat
long caldat(UTinstantPtr))
-
caldat_int
void caldat_int(UTinstantIntPtr)
-
ut_instant_int
Definition: astime.h:93
-
ut_instant_int::day
int day
Definition: astime.h:97
-
ut_instant_int::day_of_year
int day_of_year
Definition: astime.h:99
-
ut_instant_int::j_date0
long j_date0
Definition: astime.h:94
-
ut_instant_int::year
long year
Definition: astime.h:95
-
ut_instant_int::month
int month
Definition: astime.h:96
-
ut_instant_int::weekday
int weekday
Definition: astime.h:98
-
ut_instant
Definition: astime.h:65
-
ut_instant::month
int month
Definition: astime.h:68
-
ut_instant::day
int day
Definition: astime.h:69
-
ut_instant::weekday
int weekday
Definition: astime.h:76
-
ut_instant::day_of_year
int day_of_year
Definition: astime.h:77
-
ut_instant::d_hour
double d_hour
Definition: astime.h:73
-
ut_instant::year
long year
Definition: astime.h:67
-
ut_instant::d_second
double d_second
Definition: astime.h:75
-
ut_instant::i_minute
int i_minute
Definition: astime.h:71
-
ut_instant::d_minute
double d_minute
Definition: astime.h:74
-
ut_instant::j_date
double j_date
Definition: astime.h:66
-
ut_instant::i_hour
int i_hour
Definition: astime.h:70
-
ut_instant::i_second
int i_second
Definition: astime.h:72
+Go to the documentation of this file.
1 /*
+
2  * Copyright (c) 1986-2000, Hiram Clawson
+
3  * All rights reserved.
+
4  *
+
5  * Redistribution and use in source and binary forms, with or
+
6  * without modification, are permitted provided that the following
+
7  * conditions are met:
+
8  *
+
9  * Redistributions of source code must retain the above
+
10  * copyright notice, this list of conditions and the
+
11  * following disclaimer.
+
12  *
+
13  * Redistributions in binary form must reproduce the
+
14  * above copyright notice, this list of conditions and
+
15  * the following disclaimer in the documentation and/or
+
16  * other materials provided with the distribution.
+
17  *
+
18  * Neither name of The Museum of Hiram nor the names of
+
19  * its contributors may be used to endorse or promote products
+
20  * derived from this software without specific prior
+
21  * written permission.
+
22  *
+
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+
24  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+
25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+
26  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+
27  * IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+
28  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+
29  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+
32  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+
33  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+
34  * THE POSSIBILITY OF SUCH DAMAGE.
+
35  */
+
36 
+
42 #ifndef ICAL_ASTIME_H
+
43 #define ICAL_ASTIME_H
+
44 
+
45 #include "libical_ical_export.h"
+
46 
+
47 typedef struct ut_instant
+
48 {
+
49  double j_date;
+
50  long year;
+
51  int month;
+
52  int day;
+
53  int i_hour;
+
54  int i_minute;
+
55  int i_second;
+
56  double d_hour;
+
57  double d_minute;
+
58  double d_second;
+
59  int weekday;
+
60  int day_of_year;
+
61 } UTinstant, *UTinstantPtr;
+
62 
+
63 /* Functions in caldate.c */
+
64 
+
66 LIBICAL_ICAL_EXPORT long caldat(UTinstantPtr);
+
67 
+
69 LIBICAL_ICAL_EXPORT double juldat(UTinstantPtr);
+
70 
+
71 #endif
+
caldat
long caldat(UTinstantPtr)
Converts Julian date to year,mo,da.
+
juldat
double juldat(UTinstantPtr)
Returns Julian day from year,mo,da.
+
ut_instant
Definition: astime.h:48
+
ut_instant::month
int month
Definition: astime.h:51
+
ut_instant::day
int day
Definition: astime.h:52
+
ut_instant::weekday
int weekday
Definition: astime.h:59
+
ut_instant::day_of_year
int day_of_year
Definition: astime.h:60
+
ut_instant::d_hour
double d_hour
Definition: astime.h:56
+
ut_instant::year
long year
Definition: astime.h:50
+
ut_instant::d_second
double d_second
Definition: astime.h:58
+
ut_instant::i_minute
int i_minute
Definition: astime.h:54
+
ut_instant::d_minute
double d_minute
Definition: astime.h:57
+
ut_instant::j_date
double j_date
Definition: astime.h:49
+
ut_instant::i_hour
int i_hour
Definition: astime.h:53
+
ut_instant::i_second
int i_second
Definition: astime.h:55
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classICPointerHolder.html b/apidocs/classICPointerHolder.html index e3262c73..e5106d33 100644 --- a/apidocs/classICPointerHolder.html +++ b/apidocs/classICPointerHolder.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: ICPointerHolder< T > Class Template Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
ICPointerHolder< T > Class Template Reference
+
+
ICPointerHolder< T > Class Template Reference
- - - - - - - - + - - + - - + - - +

+

Public Member Functions

+
 ICPointerHolder (const ICPointerHolder &ip)
 
+
 ICPointerHolder (T *p)
 
+
 operator T* () const
 
+
bool operator!= (T *p)
 
+
T & operator* ()
 
+
 
T * operator-> () const
 
+
 
ICPointerHolder & operator= (ICPointerHolder &p)
 
+
 
ICPointerHolder & operator= (T *p)
 
+
 
bool operator== (T *p)
 
@@ -104,7 +105,7 @@ bool operator== (T *p)
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1ICalBDBSet.html b/apidocs/classLibICal_1_1ICalBDBSet.html index 3ccea333..615a14d2 100644 --- a/apidocs/classLibICal_1_1ICalBDBSet.html +++ b/apidocs/classLibICal_1_1ICalBDBSet.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::ICalBDBSet Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::ICalBDBSet Class Reference
+
+
LibICal::ICalBDBSet Class Reference
- - - - - - - - - + - - + - - - + - - + - - + - - + - - - -

+

Public Member Functions

+
 ICalBDBSet (const ICalBDBSet &)
 
+
 ICalBDBSet (const std::string &path, int flags)
 
+
icalerrorenum add_component (VComponent *child)
 
+
void clear ()
 
+
int count_components (icalcomponent_kind kind)
 
+
VComponent * fetch (std::string &uid)
 
+
 
VComponent * fetch_match (icalcomponent *c)
 
+
 
void free ()
 
+
VComponent * get_component ()
 
+
 
VComponent * get_current_component ()
 
+
 
VComponent * get_first_component ()
 
+
 
VComponent * get_next_component ()
 
+
 
int has_uid (std::string &uid)
 
+
ICalBDBSet operator= (const ICalBDBSet &)
 
+
std::string path ()
 
+
icalerrorenum remove_component (VComponent *child)
 
+
icalerrorenum select (icalgauge *gauge)
 
@@ -132,7 +133,7 @@ std::string path ()
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1ICalParameter.html b/apidocs/classLibICal_1_1ICalParameter.html index 5eb8baca..fe4ebceb 100644 --- a/apidocs/classLibICal_1_1ICalParameter.html +++ b/apidocs/classLibICal_1_1ICalParameter.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::ICalParameter Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
LibICal::ICalParameter Class Reference
+
+
LibICal::ICalParameter Class Reference
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - -

+

Public Member Functions

+
 ICalParameter (const ICalParameter &)
 
+
 ICalParameter (const icalparameter_kind &kind)
 
+
 ICalParameter (const icalparameter_kind &kind, const std::string &str)
 
+
 ICalParameter (const std::string &str)
 
+
 ICalParameter (icalparameter *v)
 
+
std::string as_ical_string ()
 
+
void detach ()
 
+
std::string get_altrep () const
 
+
std::string get_cn () const
 
+
icalparameter_cutype get_cutype () const
 
+
std::string get_delegatedfrom () const
 
+
std::string get_delegatedto () const
 
+
std::string get_dir () const
 
+
icalparameter_encoding get_encoding () const
 
+
icalparameter_fbtype get_fbtype () const
 
+
std::string get_fmttype () const
 
+
std::string get_language () const
 
+
std::string get_member () const
 
+
icalparameter_partstat get_partstat () const
 
+
icalparameter_range get_range () const
 
+
icalparameter_related get_related () const
 
+
icalparameter_reltype get_reltype () const
 
+
icalparameter_role get_role () const
 
+
icalparameter_rsvp get_rsvp () const
 
+
std::string get_sentby () const
 
+
std::string get_tzid () const
 
+
icalparameter_value get_value () const
 
+
std::string get_x () const
 
+
icalparameter_xliccomparetype get_xliccomparetype () const
 
+
icalparameter_xlicerrortype get_xlicerrortype () const
 
+
bool is_valid ()
 
+
icalparameter_kind isa ()
 
+
int isa_parameter (void *param)
 
+
 operator icalparameter * ()
 
+
ICalParameter & operator= (const ICalParameter &)
 
+
 
void set_altrep (const std::string &v)
 
+
void set_cn (const std::string &v)
 
+
void set_cutype (const icalparameter_cutype &v)
 
+
void set_delegatedfrom (const std::string &v)
 
+
void set_delegatedto (const std::string &v)
 
+
void set_dir (const std::string &v)
 
+
void set_encoding (const icalparameter_encoding &v)
 
+
void set_fbtype (const icalparameter_fbtype &v)
 
+
void set_fmttype (const std::string &v)
 
+
void set_language (const std::string &v)
 
+
void set_member (const std::string &v)
 
+
void set_partstat (const icalparameter_partstat &v)
 
+
void set_range (const icalparameter_range &v)
 
+
void set_related (const icalparameter_related &v)
 
+
void set_reltype (const icalparameter_reltype &v)
 
+
void set_role (const icalparameter_role &v)
 
+
void set_rsvp (const icalparameter_rsvp &v)
 
+
void set_sentby (const std::string &v)
 
+
void set_tzid (const std::string &v)
 
+
void set_value (const icalparameter_value &v)
 
+
void set_x (const std::string &v)
 
+
void set_xliccomparetype (const icalparameter_xliccomparetype &v)
 
+
void set_xlicerrortype (const icalparameter_xlicerrortype &v)
 
- - - - - - -

+

Static Public Member Functions

+
static std::string get_xname (ICalParameter &param)
 
+
static std::string get_xvalue (ICalParameter &param)
 
+
static std::string kind_to_string (const icalparameter_kind &kind)
 
+
static void set_xname (ICalParameter &param, const std::string &v)
 
+
static void set_xvalue (ICalParameter &param, const std::string &v)
 
+
static icalparameter_kind string_to_kind (const std::string &str)
 
@@ -277,7 +278,7 @@ static icalparameter_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1ICalProperty.html b/apidocs/classLibICal_1_1ICalProperty.html index 47f8f868..58ac7414 100644 --- a/apidocs/classLibICal_1_1ICalProperty.html +++ b/apidocs/classLibICal_1_1ICalProperty.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::ICalProperty Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
LibICal::ICalProperty Class Reference
+
+
LibICal::ICalProperty Class Reference
- - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

+

Public Member Functions

+
 ICalProperty (const ICalProperty &)
 
+
 ICalProperty (icalproperty *v)
 
+
 ICalProperty (icalproperty_kind kind)
 
+
 ICalProperty (icalproperty_kind kind, std::string str)
 
+
 ICalProperty (std::string str)
 
+
void add_parameter (ICalParameter &parameter)
 
+
std::string as_ical_string ()
 
+
int count_parameters ()
 
+
void detach ()
 
+
enum icalproperty_action get_action ()
 
+
icalattach * get_attach () const
 
+
 
std::string get_attendee () const
 
+
std::string get_calscale () const
 
+
std::string get_categories () const
 
+
enum icalproperty_class get_class () const
 
+
std::string get_comment () const
 
+
struct icaltimetype get_completed () const
 
+
std::string get_contact () const
 
+
struct icaltimetype get_created () const
 
+
std::string get_description () const
 
+
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
struct icaltimetype get_exdate () const
 
+
int get_expand () const
 
+
struct icalrecurrencetype get_exrule () const
 
ICalParameter * get_first_parameter (const icalparameter_kind &kind)
 
+
ICalParameter * get_first_parameter (const icalparameter_kind &kind)
 
struct icalperiodtype get_freebusy () const
 
+
struct icalgeotype get_geo () const
 
+
std::string get_grant () const
 
+
struct icaltimetype get_lastmodified () const
 
+
std::string get_location () const
 
+
int get_maxresults () const
 
+
int get_maxresultsize () const
 
+
enum icalproperty_method get_method () const
 
std::string get_name () const
 
+
ICalParameter * get_next_parameter (const icalparameter_kind &kind)
 
+
 
std::string get_organizer () const
 
+
std::string get_owner () const
 
+
std::string get_parameter_as_string (const std::string &name)
 
+
int get_percentcomplete () const
 
+
int get_priority () const
 
+
std::string get_prodid () const
 
+
std::string get_query () const
 
+
std::string get_queryname () const
 
+
struct icaldatetimeperiodtype get_rdate () const
 
+
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relatedto () const
 
+
std::string get_relcalid () const
 
+
int get_repeat () const
 
+
std::string get_requeststatus () const
 
+
std::string get_resources () const
 
+
struct icalrecurrencetype get_rrule () const
 
+
std::string get_scope () const
 
+
int get_sequence () const
 
+
enum icalproperty_status get_status () const
 
+
std::string get_summary () const
 
+
std::string get_target () const
 
+
enum icalproperty_transp get_transp () const
 
+
struct icaltriggertype get_trigger () const
 
+
std::string get_tzid () const
 
+
std::string get_tzname () const
 
+
int get_tzoffsetfrom () const
 
+
int get_tzoffsetto () const
 
+
std::string get_tzurl () const
 
+
std::string get_uid () const
 
+
std::string get_url () const
 
+
ICalValue * get_value ()
 
+
 
std::string get_value_as_string ()
 
+
std::string get_version () const
 
+
std::string get_x () const
 
+
std::string get_xlicclustercount () const
 
+
std::string get_xlicerror () const
 
+
std::string get_xlicmimecharset () const
 
+
std::string get_xlicmimecid () const
 
+
std::string get_xlicmimecontenttype () const
 
+
std::string get_xlicmimeencoding () const
 
+
std::string get_xlicmimefilename () const
 
+
std::string get_xlicmimeoptinfo () const
 
+
icalproperty_kind isa ()
 
+
int isa_property (void *property)
 
+
 operator icalproperty * ()
 
+
ICalProperty & operator= (const ICalProperty &)
 
+
 
int operator== (ICalProperty &rhs)
 
+
void remove_parameter_by_kind (const icalparameter_kind &kind)
 
+
void set_action (const enum icalproperty_action &val)
 
+
void set_attach (icalattach *val)
 
+
void set_attendee (const std::string &val)
 
+
void set_calscale (const std::string &val)
 
+
void set_categories (const std::string &val)
 
+
void set_class (const enum icalproperty_class &val)
 
+
void set_comment (const std::string &val)
 
+
void set_completed (const struct icaltimetype &val)
 
+
void set_contact (const std::string &val)
 
+
void set_created (const struct icaltimetype &val)
 
+
void set_description (const std::string &val)
 
+
void set_dtend (const struct icaltimetype &val)
 
+
void set_dtstamp (const struct icaltimetype &val)
 
+
void set_dtstart (const struct icaltimetype &val)
 
+
void set_due (const struct icaltimetype &val)
 
+
void set_duration (const struct icaldurationtype &val)
 
+
void set_exdate (const struct icaltimetype &val)
 
+
void set_expand (const int &val)
 
+
void set_exrule (const struct icalrecurrencetype &val)
 
+
void set_freebusy (const struct icalperiodtype &val)
 
+
void set_geo (const struct icalgeotype &val)
 
+
void set_grant (const std::string &val)
 
+
void set_lastmodified (const struct icaltimetype &val)
 
+
void set_location (const std::string &val)
 
+
void set_maxresults (const int &val)
 
+
void set_maxresultsize (const int &val)
 
+
void set_method (const enum icalproperty_method &val)
 
+
void set_organizer (const std::string &val)
 
+
void set_owner (const std::string &val)
 
+
void set_parameter (ICalParameter &parameter)
 
+
void set_parameter_from_string (const std::string &name, const std::string &val)
 
+
void set_percentcomplete (const int &val)
 
+
void set_priority (const int &val)
 
+
void set_prodid (const std::string &val)
 
+
void set_query (const std::string &val)
 
+
void set_queryname (const std::string &val)
 
+
void set_rdate (const struct icaldatetimeperiodtype &val)
 
+
void set_recurrenceid (const struct icaltimetype &val)
 
+
void set_relatedto (const std::string &val)
 
+
void set_relcalid (const std::string &val)
 
+
void set_repeat (const int &val)
 
+
void set_requeststatus (const std::string &val)
 
+
void set_resources (const std::string &val)
 
+
void set_rrule (const struct icalrecurrencetype &val)
 
+
void set_scope (const std::string &val)
 
+
void set_sequence (const int &val)
 
+
void set_status (const enum icalproperty_status &val)
 
+
void set_summary (const std::string &val)
 
+
void set_target (const std::string &val)
 
+
void set_transp (const enum icalproperty_transp &val)
 
+
void set_trigger (const struct icaltriggertype &val)
 
+
void set_tzid (const std::string &val)
 
+
void set_tzname (const std::string &val)
 
+
void set_tzoffsetfrom (const int &val)
 
+
void set_tzoffsetto (const int &val)
 
+
void set_tzurl (const std::string &val)
 
+
void set_uid (const std::string &val)
 
+
void set_url (const std::string &val)
 
void set_value (const ICalValue &val)
 
+
void set_value_from_string (const std::string &val, const std::string &kind)
 
+
void set_version (const std::string &val)
 
+
void set_x (const std::string &val)
 
+
void set_xlicclustercount (const std::string &val)
 
+
void set_xlicerror (const std::string &val)
 
+
void set_xlicmimecharset (const std::string &val)
 
+
void set_xlicmimecid (const std::string &val)
 
+
void set_xlicmimecontenttype (const std::string &val)
 
+
void set_xlicmimeencoding (const std::string &val)
 
+
void set_xlicmimefilename (const std::string &val)
 
+
void set_xlicmimeoptinfo (const std::string &val)
 
- - - - - - - - - - - - - - -

+

Static Public Member Functions

+
static int enum_belongs_to_property (const icalproperty_kind &kind, const int &e)
 
+
static std::string enum_to_string (const int &e)
 
+
static std::string get_x_name (ICalProperty &prop)
 
+
static int kind_and_string_to_enum (const icalproperty_kind &kind, const std::string &str)
 
+
static std::string kind_to_string (const icalproperty_kind &kind)
 
+
static icalvalue_kind kind_to_value_kind (const icalproperty_kind &kind)
 
+
static std::string method_to_string (const icalproperty_method &method)
 
+
static void set_x_name (ICalProperty &prop, const std::string &name)
 
+
static std::string status_to_string (const icalproperty_status &status)
 
+
static icalproperty_kind string_to_kind (const std::string &str)
 
+
static icalproperty_method string_to_method (const std::string &str)
 
+
static icalproperty_status string_to_status (const std::string &str)
 
+
static icalproperty_kind value_kind_to_kind (const icalvalue_kind &kind)
 
+
static icalvalue_kind value_to_value_kind (const icalparameter_value &val)
 

Member Function Documentation

- -

◆ get_first_parameter()

+ +

◆ get_first_parameter()

- + @@ -605,11 +606,11 @@ static icalvalue_kind 
ICalParameter * LibICal::ICalProperty::get_first_parameter ICalParameter* LibICal::ICalProperty::get_first_parameter ( const icalparameter_kind &  kind)valu
-

Iterate through the parameters

+

Iterate through the parameters

- +

◆ get_name()

@@ -623,11 +624,11 @@ static icalvalue_kind valu
-

Returns the name of the property – the type name converted to a string, or the value of get_x_name if the type is X property

+

Returns the name of the property – the type name converted to a string, or the value of get_x_name if the type is X property

- +

◆ set_value()

@@ -642,7 +643,7 @@ static icalvalue_kind valu
-

Access the value of the property

+

Access the value of the property

@@ -652,7 +653,7 @@ static icalvalue_kind valu
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1ICalSpanList.html b/apidocs/classLibICal_1_1ICalSpanList.html index b8ad652a..37293496 100644 --- a/apidocs/classLibICal_1_1ICalSpanList.html +++ b/apidocs/classLibICal_1_1ICalSpanList.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::ICalSpanList Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::ICalSpanList Class Reference
+
+
LibICal::ICalSpanList Class Reference
- -

#include <icalspanlist_cxx.h>

- - @@ -91,19 +90,19 @@ Public Member Functions - - + + - - +

+

Public Member Functions

+
 ICalSpanList (const ICalSpanList &v)
 
 ICalSpanList (icalcomponent *comp)
 
void dump ()
 
VComponent * get_vfreebusy (const char *organizer, const char *attendee)
 
VComponent * get_vfreebusy (const char *organizer, const char *attendee)
 
 operator icalspanlist * ()
 
+
ICalSpanList & operator= (const ICalSpanList &)
 
 

Detailed Description

-

This class wraps the icalspanlist routines in libicalss

-

Errors within libicalss are propagated via exceptions of type icalerrorenum. See icalerror.h for the complete list of exceptions that might be thrown.

+

This class wraps the icalspanlist routines in libicalss

+

Errors within libicalss are propagated via exceptions of type icalerrorenum. See icalerror.h for the complete list of exceptions that might be thrown.

Constructor & Destructor Documentation

- +

◆ ICalSpanList() [1/3]

@@ -134,11 +133,11 @@ Public Member Functions
-

Constructs an ICalSpanList from an icalset

+

Constructs an ICalSpanList from an icalset

- +

◆ ICalSpanList() [2/3]

@@ -161,11 +160,11 @@ Public Member Functions
-

Constructs an ICalSpanList from the VFREEBUSY chunk of a icalcomponent

+

Constructs an ICalSpanList from the VFREEBUSY chunk of a icalcomponent

- +

◆ ICalSpanList() [3/3]

@@ -188,11 +187,11 @@ Public Member Functions
-

Constructs an ICalSpanList from the VFREEBUSY chunk of a vcomponent

+

Constructs an ICalSpanList from the VFREEBUSY chunk of a vcomponent

- +

◆ ~ICalSpanList()

@@ -206,12 +205,12 @@ Public Member Functions
-

Destructor

+

Destructor

Member Function Documentation

- +

◆ as_vector()

@@ -226,11 +225,11 @@ Public Member Functions
-

Returns a vector of the number of events over delta t

+

Returns a vector of the number of events over delta t

- +

◆ dump()

@@ -244,18 +243,18 @@ Public Member Functions
-

Dumps the spanlist to STDOUT

+

Dumps the spanlist to STDOUT

- -

◆ get_vfreebusy()

+ +

◆ get_vfreebusy()

- + @@ -273,11 +272,11 @@ Public Member Functions
VComponent * LibICal::ICalSpanList::get_vfreebusy VComponent* LibICal::ICalSpanList::get_vfreebusy ( const char *  organizer,
-

Returns a VFREEBUSY icalcomponent

+

Returns a VFREEBUSY icalcomponent

- +

◆ operator icalspanlist *()

@@ -299,7 +298,7 @@ Public Member Functions
-

Returns the base data when casting

+

Returns the base data when casting

@@ -309,7 +308,7 @@ Public Member Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1ICalValue.html b/apidocs/classLibICal_1_1ICalValue.html index 3db60c1e..9a88bcfd 100644 --- a/apidocs/classLibICal_1_1ICalValue.html +++ b/apidocs/classLibICal_1_1ICalValue.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::ICalValue Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
LibICal::ICalValue Class Reference
+
+
LibICal::ICalValue Class Reference
- - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - -

+

Public Member Functions

+
 ICalValue (const ICalValue &)
 
+
 ICalValue (const icalvalue_kind &kind)
 
+
 ICalValue (const icalvalue_kind &kind, const std::string &str)
 
+
 ICalValue (icalvalue *)
 
+
std::string as_ical_string ()
 
+
void detach ()
 
+
enum icalproperty_action get_action () const
 
+
icalattach * get_attach ()
 
+
 
std::string get_binary () const
 
+
int get_boolean () const
 
+
std::string get_caladdress () const
 
+
enum icalproperty_class get_class () const
 
+
struct icaltimetype get_date () const
 
+
struct icaltimetype get_datetime () const
 
+
struct icaldatetimeperiodtype get_datetimeperiod ()
 
+
struct icaldurationtype get_duration () const
 
+
float get_float () const
 
+
struct icalgeotype get_geo () const
 
+
int get_integer () const
 
+
enum icalproperty_method get_method () const
 
+
struct icalperiodtype get_period () const
 
+
std::string get_query () const
 
+
struct icalrecurrencetype get_recur ()
 
+
enum icalproperty_status get_status () const
 
+
std::string get_string () const
 
+
std::string get_text () const
 
+
enum icalproperty_transp get_transp () const
 
+
struct icaltriggertype get_trigger ()
 
+
std::string get_uri () const
 
+
int get_utcoffset () const
 
+
bool is_valid ()
 
+
icalvalue_kind isa ()
 
+
int isa_value (void *)
 
+
std::string kind_to_string (const icalvalue_kind &kind)
 
+
 operator icalvalue * ()
 
+
ICalValue & operator= (const ICalValue &)
 
+
 
void set_action (const enum icalproperty_action &v)
 
+
void set_attach (icalattach *v)
 
+
void set_binary (const std::string &v)
 
+
void set_boolean (const int &v)
 
+
void set_caladdress (const std::string &v)
 
+
void set_class (const enum icalproperty_class &v)
 
+
void set_date (const struct icaltimetype &v)
 
+
void set_datetime (const struct icaltimetype &v)
 
+
void set_datetimeperiod (const struct icaldatetimeperiodtype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_float (const float &v)
 
+
void set_geo (const struct icalgeotype &v)
 
+
void set_integer (const int &v)
 
+
void set_method (const enum icalproperty_method &v)
 
+
void set_period (const struct icalperiodtype &v)
 
+
void set_query (const std::string &v)
 
+
void set_recur (const struct icalrecurrencetype &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_string (const std::string &v)
 
+
void set_text (const std::string &v)
 
+
void set_transp (const enum icalproperty_transp &v)
 
+
void set_trigger (const struct icaltriggertype &v)
 
+
void set_uri (const std::string &v)
 
+
void set_utcoffset (const int &v)
 
- - -

+

Static Public Member Functions

+
static icalparameter_xliccomparetype compare (ICalValue &a, ICalValue &b)
 
+
static icalvalue_kind string_to_kind (const std::string &str)
 
@@ -271,7 +272,7 @@ static icalvalue_kind stri
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VAgenda.html b/apidocs/classLibICal_1_1VAgenda.html index 6e841d6f..3557141c 100644 --- a/apidocs/classLibICal_1_1VAgenda.html +++ b/apidocs/classLibICal_1_1VAgenda.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VAgenda Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VAgenda Class Reference
+
+
LibICal::VAgenda Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::VAgenda:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VAgenda (const std::string &str)
 
+
 VAgenda (const VAgenda &)
 
+
 VAgenda (icalcomponent *v)
 
+
VAgenda & operator= (const VAgenda &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VAlarm.html b/apidocs/classLibICal_1_1VAlarm.html index 2217ab90..886b2c22 100644 --- a/apidocs/classLibICal_1_1VAlarm.html +++ b/apidocs/classLibICal_1_1VAlarm.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VAlarm Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VAlarm Class Reference
+
+
LibICal::VAlarm Class Reference
@@ -81,246 +82,246 @@ Inheritance diagram for LibICal::VAlarm:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VAlarm (const std::string &str)
 
+
 VAlarm (const VAlarm &)
 
+
 VAlarm (icalcomponent *v)
 
icalrequeststatus getTriggerTime (VComponent &c, struct icaltriggertype *tr)
 
+
VAlarm & operator= (const VAlarm &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 

Member Function Documentation

- +

◆ getTriggerTime()

@@ -345,7 +346,7 @@ static icalcomponent_kind 
-

compute the absolute trigger time for this alarm. trigger may be related to the containing component c. the result is populated in tr->time

+

compute the absolute trigger time for this alarm. trigger may be related to the containing component c. the result is populated in tr->time

@@ -355,7 +356,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VCalendar.html b/apidocs/classLibICal_1_1VCalendar.html index 31b61cda..be8dabae 100644 --- a/apidocs/classLibICal_1_1VCalendar.html +++ b/apidocs/classLibICal_1_1VCalendar.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VCalendar Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VCalendar Class Reference
+
+
LibICal::VCalendar Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::VCalendar:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VCalendar (const std::string &str)
 
+
 VCalendar (const VCalendar &)
 
+
 VCalendar (icalcomponent *v)
 
+
VCalendar & operator= (const VCalendar &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VComponent.html b/apidocs/classLibICal_1_1VComponent.html index 68b2052d..23c8ea68 100644 --- a/apidocs/classLibICal_1_1VComponent.html +++ b/apidocs/classLibICal_1_1VComponent.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VComponent Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
LibICal::VComponent Class Reference
+
+
LibICal::VComponent Class Reference

A class wrapping the libical icalcomponent functions. More...

- -

#include <vcomponent_cxx.h>

Inheritance diagram for LibICal::VComponent:
@@ -97,230 +96,230 @@ Inheritance diagram for LibICal::VComponent:
[legend]
- - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Static Public Member Functions

+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 

Detailed Description

-

A class wrapping the libical icalcomponent functions.

+

A class wrapping the libical icalcomponent functions.

Exceptions
@@ -328,14 +327,14 @@ static icalcomponent_kind 
icalerrorenumAny errors generated in libical are propagated via this exception type.

Member Function Documentation

- -

◆ get_current_component()

+ +

◆ get_current_component()

- + @@ -344,11 +343,11 @@ static icalcomponent_kind 
VComponent * LibICal::VComponent::get_current_component VComponent* LibICal::VComponent::get_current_component ( )

Iterate through components.

-

Iteration Routines. There are two forms of iterators, internal and external. The internal ones came first, and are almost completely sufficient, but they fail badly when you want to construct a loop that removes components from the container.

+

Iteration Routines. There are two forms of iterators, internal and external. The internal ones came first, and are almost completely sufficient, but they fail badly when you want to construct a loop that removes components from the container.

- +

◆ get_dtend()

@@ -362,47 +361,47 @@ static icalcomponent_kind 
-

For the icalcomponent routines only, dtend and duration are tied together. If you call the set routine for one and the other exists, the routine will calculate the change to the other. That is, if there is a DTEND and you call set_duration, the routine will modify DTEND to be the sum of DTSTART and the duration. If you call a get routine for one and the other exists, the routine will calculate the return value. If you call a set routine and neither exists, the routine will create the appropriate property

+

For the icalcomponent routines only, dtend and duration are tied together. If you call the set routine for one and the other exists, the routine will calculate the change to the other. That is, if there is a DTEND and you call set_duration, the routine will modify DTEND to be the sum of DTSTART and the duration. If you call a get routine for one and the other exists, the routine will calculate the return value. If you call a set routine and neither exists, the routine will create the appropriate property

- -

◆ get_first_real_component()

+ +

◆ get_first_real_component()

- +
VComponent * LibICal::VComponent::get_first_real_component VComponent* LibICal::VComponent::get_first_real_component ( )
-

For VCOMPONENT: Return a reference to the first VEVENT, VTODO, or VJOURNAL

+

For VCOMPONENT: Return a reference to the first VEVENT, VTODO, or VJOURNAL

- -

◆ get_inner()

+ +

◆ get_inner()

- +
VComponent * LibICal::VComponent::get_inner VComponent* LibICal::VComponent::get_inner ( )
-

Return the first VEVENT, VTODO or VJOURNAL sub-component if it is one of those types

+

Return the first VEVENT, VTODO or VJOURNAL sub-component if it is one of those types

- +

◆ get_span()

@@ -424,7 +423,7 @@ static icalcomponent_kind 
-

For VEVENT, VTODO, VJOURNAL and VTIMEZONE: report the start and end times of an event in UTC

+

For VEVENT, VTODO, VJOURNAL and VTIMEZONE: report the start and end times of an event in UTC

@@ -434,7 +433,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VComponent__inherit__graph.md5 b/apidocs/classLibICal_1_1VComponent__inherit__graph.md5 index 44791f3a..1c0cb0c7 100644 --- a/apidocs/classLibICal_1_1VComponent__inherit__graph.md5 +++ b/apidocs/classLibICal_1_1VComponent__inherit__graph.md5 @@ -1 +1 @@ -8f79e58e6d219f9fe4df625a82bbf380 \ No newline at end of file +61436c6dda444e3d235493c8b11201ad \ No newline at end of file diff --git a/apidocs/classLibICal_1_1VComponent__inherit__graph.png b/apidocs/classLibICal_1_1VComponent__inherit__graph.png index c29adb34..9c98034f 100644 Binary files a/apidocs/classLibICal_1_1VComponent__inherit__graph.png and b/apidocs/classLibICal_1_1VComponent__inherit__graph.png differ diff --git a/apidocs/classLibICal_1_1VEvent.html b/apidocs/classLibICal_1_1VEvent.html index 854de171..943846a6 100644 --- a/apidocs/classLibICal_1_1VEvent.html +++ b/apidocs/classLibICal_1_1VEvent.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VEvent Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VEvent Class Reference
+
+
LibICal::VEvent Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::VEvent:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VEvent (const std::string &str)
 
+
 VEvent (const VEvent &)
 
+
 VEvent (icalcomponent *v)
 
+
VEvent & operator= (const VEvent &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VFreeBusy.html b/apidocs/classLibICal_1_1VFreeBusy.html index eb1faf0c..5b416a06 100644 --- a/apidocs/classLibICal_1_1VFreeBusy.html +++ b/apidocs/classLibICal_1_1VFreeBusy.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VFreeBusy Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VFreeBusy Class Reference
+
+
LibICal::VFreeBusy Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::VFreeBusy:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VFreeBusy (const std::string &str)
 
+
 VFreeBusy (const VFreeBusy &)
 
+
 VFreeBusy (icalcomponent *v)
 
+
VFreeBusy & operator= (const VFreeBusy &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VJournal.html b/apidocs/classLibICal_1_1VJournal.html index 6b3711c3..cdaafa9b 100644 --- a/apidocs/classLibICal_1_1VJournal.html +++ b/apidocs/classLibICal_1_1VJournal.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VJournal Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VJournal Class Reference
+
+
LibICal::VJournal Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::VJournal:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VJournal (const std::string &str)
 
+
 VJournal (const VJournal &)
 
+
 VJournal (icalcomponent *v)
 
+
VJournal & operator= (const VJournal &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VQuery.html b/apidocs/classLibICal_1_1VQuery.html index 3bfe80cf..ca6d78cf 100644 --- a/apidocs/classLibICal_1_1VQuery.html +++ b/apidocs/classLibICal_1_1VQuery.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VQuery Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VQuery Class Reference
+
+
LibICal::VQuery Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::VQuery:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VQuery (const std::string &str)
 
+
 VQuery (const VQuery &)
 
+
 VQuery (icalcomponent *v)
 
+
VQuery & operator= (const VQuery &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VTimezone.html b/apidocs/classLibICal_1_1VTimezone.html index c18169c2..d4393096 100644 --- a/apidocs/classLibICal_1_1VTimezone.html +++ b/apidocs/classLibICal_1_1VTimezone.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VTimezone Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VTimezone Class Reference
+
+
LibICal::VTimezone Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::VTimezone:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VTimezone (const std::string &str)
 
+
 VTimezone (const VTimezone &)
 
+
 VTimezone (icalcomponent *v)
 
+
VTimezone & operator= (const VTimezone &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1VToDo.html b/apidocs/classLibICal_1_1VToDo.html index b4641f4e..e0b716ee 100644 --- a/apidocs/classLibICal_1_1VToDo.html +++ b/apidocs/classLibICal_1_1VToDo.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::VToDo Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::VToDo Class Reference
+
+
LibICal::VToDo Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::VToDo:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 VToDo (const std::string &str)
 
+
 VToDo (const VToDo &)
 
+
 VToDo (icalcomponent *v)
 
+
VToDo & operator= (const VToDo &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1XDaylight.html b/apidocs/classLibICal_1_1XDaylight.html index 965a7ee6..c3499688 100644 --- a/apidocs/classLibICal_1_1XDaylight.html +++ b/apidocs/classLibICal_1_1XDaylight.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::XDaylight Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::XDaylight Class Reference
+
+
LibICal::XDaylight Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::XDaylight:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 XDaylight (const std::string &str)
 
+
 XDaylight (const XDaylight &)
 
+
 XDaylight (icalcomponent *v)
 
+
XDaylight & operator= (const XDaylight &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classLibICal_1_1XStandard.html b/apidocs/classLibICal_1_1XStandard.html index a26d734d..e0776ee9 100644 --- a/apidocs/classLibICal_1_1XStandard.html +++ b/apidocs/classLibICal_1_1XStandard.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LibICal::XStandard Class Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Public Member Functions
-
LibICal::XStandard Class Reference
+
+
LibICal::XStandard Class Reference
@@ -81,239 +82,239 @@ Inheritance diagram for LibICal::XStandard:
[legend]
- - - - - - + - - - - - - - + - - + - + - - + - - - - + - - - - - - + + + - - + - - - - - - - + - - - - - - + + + + + - - - - + - - + - - - - - - - - - - - - + - - - + - - + - + - - - - - - - - - - - - - - - - - - + -

+

Public Member Functions

+
 XStandard (const std::string &str)
 
+
 XStandard (const XStandard &)
 
+
 XStandard (icalcomponent *v)
 
+
XStandard & operator= (const XStandard &)
 
 
- Public Member Functions inherited from LibICal::VComponent
+
 VComponent (const icalcomponent_kind &kind)
 
+
 VComponent (const std::string &str)
 
+
 VComponent (const VComponent &)
 
+
 VComponent (icalcomponent *v)
 
+
bool add (VComponent &)
 
+
void add_component (VComponent *child)
 
-void add_property (ICalProperty *property)
+void add_property (ICalProperty *property)
 Working with properties.
 
+
std::string as_ical_string ()
 
-icalcompiter begin_component (const icalcomponent_kind &kind)
+icalcompiter begin_component (const icalcomponent_kind &kind)
 Using external iterators.
 
-void convert_errors ()
+void convert_errors ()
 Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int count_components (const icalcomponent_kind &kind)
 
-int count_errors ()
+int count_errors ()
 Working with embedded error properties.
 
+
int count_properties (const icalproperty_kind &kind)
 
+
VComponent * current (icalcompiter *i)
 
+
 
void detach ()
 
+
icalcompiter end_component (const icalcomponent_kind &kind)
 
+
std::string get_comment () const
 
VComponent * get_current_component ()
 Iterate through components. More...
 
+
VComponent * get_current_component ()
 Iterate through components. More...
 
ICalProperty * get_current_property ()
 
+
 
std::string get_description () const
 
struct icaltimetype get_dtend () const
 
+
struct icaltimetype get_dtstamp () const
 
+
struct icaltimetype get_dtstart () const
 
+
struct icaltimetype get_due () const
 
+
struct icaldurationtype get_duration () const
 
+
VComponent * get_first_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_first_property (const icalproperty_kind &kind)
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
+
 
VComponent * get_first_real_component ()
 
VComponent * get_inner ()
 
std::string get_location () const
 
+
icalproperty_method get_method () const
 
+
VComponent * get_next_component (const icalcomponent_kind &kind)
 
+
 
ICalProperty * get_next_property (const icalproperty_kind &kind)
 
+
 
struct icaltimetype get_recurrenceid () const
 
+
std::string get_relcalid () const
 
+
int get_sequence () const
 
virtual struct icaltime_span get_span ()
 
+
int get_status () const
 
+
std::string get_summary () const
 
+
std::string get_uid () const
 
+
bool is_valid ()
 
+
icalcomponent_kind isa ()
 
+
int isa_component (void *component)
 
+
void new_from_string (const std::string &str)
 
+
VComponent * next (icalcompiter *i)
 
+
 
 operator icalcomponent * ()
 
+
VComponent & operator= (const VComponent &)
 
+
 
VComponent * prev (icalcompiter *i)
 
+
 
int recurrence_is_excluded (struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 
-bool remove (VComponent &, bool ignoreValue)
+bool remove (VComponent &, bool ignoreValue)
 Note: the VComponent kind have to be the same.
 
+
void remove_component (VComponent *child)
 
+
void remove_property (ICalProperty *property)
 
+
void set_comment (const std::string &v)
 
+
void set_description (const std::string &v)
 
+
void set_dtend (const struct icaltimetype &v)
 
+
void set_dtstamp (const struct icaltimetype &v)
 
+
void set_dtstart (const struct icaltimetype &v)
 
+
void set_due (const struct icaltimetype &v)
 
+
void set_duration (const struct icaldurationtype &v)
 
+
void set_location (const std::string &v)
 
+
void set_method (const icalproperty_method &method)
 
+
void set_recurrenceid (const struct icaltimetype &v)
 
+
void set_relcalid (const std::string &v)
 
+
void set_sequence (const int &v)
 
+
void set_status (const enum icalproperty_status &v)
 
+
void set_summary (const std::string &v)
 
+
void set_uid (const std::string &v)
 
-void strip_errors ()
+void strip_errors ()
 Remove all X-LIC-ERROR properties.
 
+
bool update (VComponent &, bool removeMissing)
 
- - - +

+

Additional Inherited Members

- Static Public Member Functions inherited from LibICal::VComponent
+
static std::string kind_to_string (const icalcomponent_kind &kind)
 
-static icalcomponent_kind string_to_kind (const std::string &str)
+static icalcomponent_kind string_to_kind (const std::string &str)
 Kind conversion routines.
 
@@ -323,7 +324,7 @@ static icalcomponent_kind 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/classes.html b/apidocs/classes.html index 958a1b2b..82e3ae9d 100644 --- a/apidocs/classes.html +++ b/apidocs/classes.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Data Structure Index @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -62,76 +62,77 @@ $(function() {
-
Data Structure Index
+
+
Data Structure Index
B | C | D | E | F | I | L | M | O | P | R | S | T | U | V | W | X | Y | Z | _
-
B
+
B
buffer_ring
-
C
+
C
conversion_table_struct
-
D
+
D
icalvalue_impl::data
-
E
+
E
encoding_map
expand_split_map_struct
-
F
+
F
freq_map
-
I
-
icalattach_impl
ICalBDBSet (LibICal)
icalbdbset_id
icalbdbset_impl
icalbdbset_options
icalcalendar_impl
icalclassify_map
icalclassify_parts
icalcluster_impl
icalcompiter
icalcomponent_impl
icalcomponent_kind_map
icaldatetimeperiodtype
icaldirset_impl
icaldirset_options
icaldurationtype
icalerror_state
icalerror_string_map
icalfileset_id
icalfileset_impl
icalfileset_options
icalgauge_impl
icalgauge_where
icalgeotype
ICalParameter (LibICal)
icalparameter_impl
icalparser_impl
icalperiodtype
ICalProperty (LibICal)
icalproperty_impl
icalrecur_iterator_impl
icalrecur_parser
icalrecurrencetype
icalreqstattype
icalset_impl
icalsetiter
ICalSpanList (LibICal)
icalspanlist_impl
icaltime_span
icaltimetype
icaltriggertype
ICalValue (LibICal)
icalvalue_impl
ICPointerHolder
+
I
+
icalattach_impl
ICalBDBSet (LibICal)
icalbdbset_id
icalbdbset_impl
icalbdbset_options
icalcalendar_impl
icalclassify_map
icalclassify_parts
icalcluster_impl
icalcompiter
icalcomponent_impl
icalcomponent_kind_map
icaldatetimeperiodtype
icaldirset_impl
icaldirset_options
icaldurationtype
icalerror_state
icalerror_string_map
icalfileset_id
icalfileset_impl
icalfileset_options
icalgauge_impl
icalgauge_where
icalgeotype
ICalParameter (LibICal)
icalparameter_impl
icalparser_impl
icalperiodtype
ICalProperty (LibICal)
icalproperty_impl
icalrecur_iterator_impl
icalrecur_parser
icalrecurrencetype
icalreqstattype
icalset_impl
icalsetiter
ICalSpanList (LibICal)
icalspanlist_impl
icaltime_span
icaltimetype
icaltimezonephase
icaltimezonetype
icaltriggertype
ICalValue (LibICal)
icalvalue_impl
ICPointerHolder
-
L
-
LexBuf
+
L
+
leap
LexBuf
-
M
+
M
major_content_type_map
mime_impl
minor_content_type_map
-
O
+
O
observance
OFile
-
P
+
P
PreDefProp
pvl_elem_t
pvl_list_t
-
R
+
R
rdate
recur_map
-
S
+
S
skip_map
slg_data
sspm_action_map
sspm_buffer
sspm_header
sspm_part
StrItem
-
T
-
text_part
+
T
+
text_part
ttinfo
tzinfo
-
U
-
ut_instant
ut_instant_int
+
U
+
ut_instant
-
V
+
V
VAgenda (LibICal)
VAlarm (LibICal)
ValueItem
VCalendar (LibICal)
VComponent (LibICal)
VEvent (LibICal)
VFreeBusy (LibICal)
VJournal (LibICal)
VObject
VObjectIterator
VQuery (LibICal)
VTimezone (LibICal)
VToDo (LibICal)
-
W
+
W
wd_map
-
X
+
X
XDaylight (LibICal)
XStandard (LibICal)
-
Y
-
yy_buffer_state
yy_trans_info
yyalloc
YYSTACKDATA
YYSTYPE
+
Y
+
yy_buffer_state
yy_trans_info
yyalloc
YYSTYPE
-
Z
+
Z
zone_context
-
_
-
_compat_tzids
_icalarray
_icalarray_sort_context
_icaltimezone
_icaltimezonechange
_icalvcal_defaults
+
_
+
_compat_tzids
_icalarray
_icaltimezone
_icaltimezonechange
_icalvcal_defaults
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/deprecated.html b/apidocs/deprecated.html deleted file mode 100644 index 20c26826..00000000 --- a/apidocs/deprecated.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - -Libical API Documentation: Deprecated List - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - - -
-
- - -
- -
- -
-
-
Deprecated List
-
-
-
-
Global caldat (UTinstantPtr))
-
use caldat_int() instead
-
Global icalcomponent_new_clone (icalcomponent *component))
-
Use icalcomponent_clone() instead
-
Global icalparameter_new_clone (icalparameter *p))
-
Use icalparameter_clone() instead
-
Global icalproperty_new_clone (icalproperty *prop))
-
use icalproperty_clone() instead
-
Global icalvalue_new_clone (const icalvalue *value))
-
Use icalvalue_clone() instead
-
Global juldat (UTinstantPtr))
-
use juldat_int() instead
-
-
-
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/dir_000002_000001.html b/apidocs/dir_000002_000001.html new file mode 100644 index 00000000..d3b625b9 --- /dev/null +++ b/apidocs/dir_000002_000001.html @@ -0,0 +1,75 @@ + + + + + + + +Libical API Documentation: libicalss -> libical Relation + + + + + + + + + +
+
+ + + + + + +
+
Libical API Documentation +  3.0 +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+

libicalss → libical Relation

File in src/libicalssIncludes file in src/libical
icalbdbset.cicalparser.h
icalbdbset.cicaltimezone.h
icalbdbset.cicalvalue.h
icalclassify.cicalmemory.h
icalclassify.hicalcomponent.h
icalcluster.hicalcomponent.h
icalcluster.hicalerror.h
icalfileset.cicalparser.h
icalfileset.cicalvalue.h
icalgauge.cicalerror.h
icalgauge.cicalvalue.h
icalgauge.hicalcomponent.h
icalgaugeimpl.hicalcomponent.h
icalmessage.cicalerror.h
icalmessage.cicalmemory.h
icalmessage.hicalcomponent.h
icalset.hicalcomponent.h
icalset.hicalerror.h
icalspanlist.cicaltimezone.h
icalspanlist_cxx.hicalcomponent.h
icalspanlist_cxx.hicaltime.h
icalsslexer.cicalmemory.h
icalssyacc.cicalerror.h
+ +
+Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1 +
+ + diff --git a/apidocs/dir_000002_000005.html b/apidocs/dir_000002_000005.html deleted file mode 100644 index afefddc0..00000000 --- a/apidocs/dir_000002_000005.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - -Libical API Documentation: libical -> src Relation - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-

libical → src Relation

File in src/libicalIncludes file in src
icalduration.clibical / icaltime.h
icalduration.hlibical / icaltime.h
icalperiod.hlibical / icaltime.h
icalrecur.hlibical / icaltime.h
icaltime.clibical / icaltime.h
icalvalue.clibical / icaltime.h
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/dir_000003_000001.html b/apidocs/dir_000003_000001.html new file mode 100644 index 00000000..ac08012e --- /dev/null +++ b/apidocs/dir_000003_000001.html @@ -0,0 +1,75 @@ + + + + + + + +Libical API Documentation: libicalvcal -> libical Relation + + + + + + + + + +
+
+ + + + + + +
+
Libical API Documentation +  3.0 +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+

libicalvcal → libical Relation

File in src/libicalvcalIncludes file in src/libical
icalvcal.cicalerror.h
icalvcal.cicaltimezone.h
icalvcal.cicalvalue.h
icalvcal.hicalcomponent.h
+ +
+Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1 +
+ + diff --git a/apidocs/dir_000003_000002.html b/apidocs/dir_000003_000002.html deleted file mode 100644 index 785746ef..00000000 --- a/apidocs/dir_000003_000002.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - -Libical API Documentation: libicalss -> libical Relation - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-

libicalss → libical Relation

File in src/libicalssIncludes file in src/libical
icalbdbset.cicalparser.h
icalbdbset.cicaltimezone.h
icalbdbset.cicalvalue.h
icalclassify.cicalmemory.h
icalclassify.hicalcomponent.h
icalcluster.hicalcomponent.h
icalcluster.hicalerror.h
icalfileset.cicalmemory.h
icalfileset.cicalparser.h
icalfileset.cicalvalue.h
icalgauge.cicalerror.h
icalgauge.cicalvalue.h
icalgauge.hicalcomponent.h
icalgaugeimpl.hicalcomponent.h
icalmessage.cicalerror.h
icalmessage.hicalcomponent.h
icalset.hicalcomponent.h
icalset.hicalerror.h
icalspanlist.cicaltimezone.h
icalspanlist_cxx.hicalcomponent.h
icalsslexer.cicalmemory.h
icalssyacc.cicalerror.h
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/dir_000003_000005.html b/apidocs/dir_000003_000005.html deleted file mode 100644 index 5467a43d..00000000 --- a/apidocs/dir_000003_000005.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - -Libical API Documentation: libicalss -> src Relation - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-

libicalss → src Relation

File in src/libicalssIncludes file in src
icalspanlist_cxx.hlibical / icaltime.h
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/dir_000004_000002.html b/apidocs/dir_000004_000002.html deleted file mode 100644 index 881248f3..00000000 --- a/apidocs/dir_000004_000002.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - -Libical API Documentation: libicalvcal -> libical Relation - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-

libicalvcal → libical Relation

File in src/libicalvcalIncludes file in src/libical
icalvcal.cicalerror.h
icalvcal.cicaltimezone.h
icalvcal.cicalvalue.h
icalvcal.hicalcomponent.h
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42.html b/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42.html index 24ca8e0e..5681e090 100644 --- a/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42.html +++ b/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: libicalvcal Directory Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
libicalvcal Directory Reference
+
+
libicalvcal Directory Reference
@@ -76,28 +77,14 @@ Directory dependency graph for libicalvcal:
- +
- - - - - - - - - - - - -

-Files

file  icalvcal.h [code]
 
file  libical_vcal_export.h [code]
 
file  vcaltmp.h [code]
 
file  vcc.h [code]
 
file  vobject.h [code]
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.map b/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.map index a4930f55..9af4cd95 100644 --- a/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.map +++ b/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.map @@ -1,6 +1,6 @@ - + diff --git a/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.md5 b/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.md5 index 161680fc..0503045d 100644 --- a/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.md5 +++ b/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.md5 @@ -1 +1 @@ -4d5b4d308163e04cc53ebe59369db225 \ No newline at end of file +065527acd39954aa0b19d618f138a04f \ No newline at end of file diff --git a/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.png b/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.png index 5c6d3501..0a469297 100644 Binary files a/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.png and b/apidocs/dir_3d1727d6b01241f7fe3ee38f31a35b42_dep.png differ diff --git a/apidocs/dir_5330c68354327086ecc8df050e51eedc.html b/apidocs/dir_5330c68354327086ecc8df050e51eedc.html index b164b352..87702331 100644 --- a/apidocs/dir_5330c68354327086ecc8df050e51eedc.html +++ b/apidocs/dir_5330c68354327086ecc8df050e51eedc.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: src Directory Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
src Directory Reference
+
+
src Directory Reference
- - -

+

Directories

directory  libical
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 12186de8..1355638e 100644 --- a/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: src Directory Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
src Directory Reference
+
+
src Directory Reference
@@ -74,31 +75,22 @@ Directory dependency graph for src:
src
- - - + - - + - +
- - - - - - -

+

Directories

directory  libical
 
directory  libicalss
 
directory  libicalvcal
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map b/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map index 4b96a2fb..24e420ea 100644 --- a/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map +++ b/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.map @@ -1,11 +1,8 @@ - - - + - - + - + diff --git a/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 b/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 index 81ec4ac2..f719d844 100644 --- a/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 +++ b/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.md5 @@ -1 +1 @@ -a2dd07ef25421bf81ec235606836441f \ No newline at end of file +613527239f72b418257801d1cbbc298f \ No newline at end of file diff --git a/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png b/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png index 7803c579..9440ee2d 100644 Binary files a/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png and b/apidocs/dir_68267d1309a1af8e8297ef4c3efbcdba_dep.png differ diff --git a/apidocs/dir_8e427daf5a9f830cf32cf5e679910194.html b/apidocs/dir_8e427daf5a9f830cf32cf5e679910194.html index c1811be6..c7677570 100644 --- a/apidocs/dir_8e427daf5a9f830cf32cf5e679910194.html +++ b/apidocs/dir_8e427daf5a9f830cf32cf5e679910194.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: libical Directory Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
libical Directory Reference
+
+
libical Directory Reference
-
-Directory dependency graph for libical:
-
-
libical
- - - - -
- - - - - - - -

-Files

file  icaltime.h [code]
 struct icaltimetype is a pseudo-object that abstracts time handling.
 
file  icalversion.h [code]
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.map b/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.map deleted file mode 100644 index 46c25d18..00000000 --- a/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.map +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.md5 b/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.md5 deleted file mode 100644 index 13b40e5d..00000000 --- a/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.md5 +++ /dev/null @@ -1 +0,0 @@ -b4d7f6895ae3ea3df58c09b67a2a2e5f \ No newline at end of file diff --git a/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.png b/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.png deleted file mode 100644 index 329113df..00000000 Binary files a/apidocs/dir_8e427daf5a9f830cf32cf5e679910194_dep.png and /dev/null differ diff --git a/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9.html b/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9.html index 3ac3bd3b..66ee8db3 100644 --- a/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9.html +++ b/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: libical Directory Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
libical Directory Reference
+
+
libical Directory Reference
-
-Directory dependency graph for libical:
-
-
libical
- - - - - - -
- - + - + - + - + - - - + - + - + - - - + - + - - - + - - - + - + - + - + - - - + - + - - - - + + - - - - - - - + + - + - + - - - - - - - - - - - - +

+

Files

file  astime.h [code]
file  astime.h [code]
 contains definitions of structures used for time calculations.
 
file  icalarray.h [code]
file  icalarray.h [code]
 An array of arbitrarily-sized elements which grows dynamically as elements are added.
 
file  icalattach.h [code]
file  icalattach.h [code]
 A set of functions to handle iCal attachments.
 
file  icalattachimpl.h [code]
file  icalcomponent.h [code]
 
file  icalcomponent.h [code]
 
file  icalduration.h [code]
file  icalduration.h [code]
 Methods for working with durations in iCal.
 
file  icalenums.h [code]
file  icalenums.h [code]
 
file  icalerror.h [code]
file  icalerror.h [code]
 Error handling for libical.
 
file  icallangbind.h [code]
 
file  icalmemory.h [code]
file  icalmemory.h [code]
 Common memory management routines.
 
file  icalmime.h [code]
file  icalparameter.h [code]
 
file  icalparameter.h [code]
 
file  icalparameter_cxx.h [code]
file  icalparameter_cxx.h [code]
 Definition of C++ Wrapper for icalparameter.c.
 
file  icalparameterimpl.h [code]
 
file  icalparser.h [code]
file  icalparser.h [code]
 Line-oriented parsing.
 
file  icalperiod.h [code]
file  icalperiod.h [code]
 Functions for working with iCal periods (of time).
 
file  icalproperty.h [code]
file  icalproperty.h [code]
 
file  icalproperty_cxx.h [code]
file  icalproperty_cxx.h [code]
 Definition of C++ Wrapper for icalproperty.c.
 
file  icalproperty_p.h [code]
 
file  icalrecur.h [code]
file  icalrecur.h [code]
 Routines for dealing with recurring time.
 
file  icalrestriction.h [code]
file  icalrestriction.h [code]
 Functions to check if an icalcomponent meets the restrictions imposed by the standard.
 
file  icaltimezone.h [code]
 Timezone handling routines.
 
file  icaltimezoneimpl.h [code]
file  icaltime.h [code]
 struct icaltimetype is a pseudo-object that abstracts time handling.
 
file  icaltypes.h [code]
 
file  icaltz-util.h [code]
 
file  icalvalue.h [code]
 
file  icalvalue_cxx.h [code]
file  icaltimezone.h [code]
 Timezone handling routines.
 
file  icalvalueimpl.h [code]
file  icalvalue.h [code]
 
file  icptrholder_cxx.h [code]
file  icptrholder_cxx.h [code]
 C++ template classes for managing C++ pointers returned by VComponent::get_..._component, VComponent::get_..._property, ICalProperty::get_..._value.
 
file  libical_deprecated.h [code]
 
file  libical_ical_export.h [code]
 
file  pvl.h [code]
 
file  qsort_gen.h [code]
 An implementation of qsort that is more flexible than the version provided with stdlib.
 
file  sspm.h [code]
 
file  vcomponent_cxx.h [code]
file  vcomponent_cxx.h [code]
 C++ classes for the icalcomponent wrapper (VToDo VEvent, etc..).
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.map b/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.map deleted file mode 100644 index 435b4ffd..00000000 --- a/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.map +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.md5 b/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.md5 deleted file mode 100644 index c03cf7ba..00000000 --- a/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.md5 +++ /dev/null @@ -1 +0,0 @@ -560e8ce96197fbed1e56dd7160d98e73 \ No newline at end of file diff --git a/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.png b/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.png deleted file mode 100644 index 60fae050..00000000 Binary files a/apidocs/dir_b7a0ea939f6e83384f3c571d31a84be9_dep.png and /dev/null differ diff --git a/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20.html b/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20.html index b5133fba..e06d7fa8 100644 --- a/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20.html +++ b/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: libicalss Directory Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
libicalss Directory Reference
+
+
libicalss Directory Reference
@@ -76,64 +77,38 @@ Directory dependency graph for libicalss:
- - - +
- - - - + - - - + - - - - - - - + - - - - - - - + - - - + - - - + - + - - - -

+

Files

file  icalbdbset.h [code]
 
file  icalbdbset_cxx.h [code]
file  icalbdbset_cxx.h [code]
 Definition of C++ Wrapper for icalbdbset.c.
 
file  icalbdbsetimpl.h [code]
 
file  icalcalendar.h [code]
file  icalcalendar.h [code]
 Routines for storing calendar data in a file system.
 
file  icalclassify.h [code]
 
file  icalcluster.h [code]
 
file  icalclusterimpl.h [code]
 
file  icaldirset.h [code]
file  icaldirset.h [code]
 icaldirset manages a database of ical components and offers interfaces for reading, writing and searching for components.
 
file  icaldirsetimpl.h [code]
 
file  icalfileset.h [code]
 
file  icalfilesetimpl.h [code]
 
file  icalgauge.h [code]
file  icalgauge.h [code]
 Routines implementing a filter for ical components.
 
file  icalgaugeimpl.h [code]
 
file  icalmessage.h [code]
file  icalset.h [code]
 
file  icalset.h [code]
 
file  icalspanlist.h [code]
file  icalspanlist.h [code]
 Code that supports collections of free/busy spans of time.
 
file  icalspanlist_cxx.h [code]
file  icalspanlist_cxx.h [code]
 C++ class wrapping the icalspanlist data structure.
 
file  icalssyacc.h [code]
 
file  libical_icalss_export.h [code]
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.map b/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.map index d46d7ca3..09b5697d 100644 --- a/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.map +++ b/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.map @@ -1,8 +1,6 @@ - - - + diff --git a/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.md5 b/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.md5 index 635e0295..62e295a6 100644 --- a/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.md5 +++ b/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.md5 @@ -1 +1 @@ -5ea02cc90bf0365087089d9ae4ece0f2 \ No newline at end of file +40c8b0a986458aeb85090cf6f4b3a548 \ No newline at end of file diff --git a/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.png b/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.png index 36f8003c..3a3132a7 100644 Binary files a/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.png and b/apidocs/dir_e5788c73bf8d77f47d4a3002d26bfd20_dep.png differ diff --git a/apidocs/dir_e68e8157741866f444e17edd764ebbae.html b/apidocs/dir_e68e8157741866f444e17edd764ebbae.html index 7458fe41..198a310e 100644 --- a/apidocs/dir_e68e8157741866f444e17edd764ebbae.html +++ b/apidocs/dir_e68e8157741866f444e17edd764ebbae.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: doc Directory Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
doc Directory Reference
+
+
doc Directory Reference
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/doxygen.css b/apidocs/doxygen.css index 90367372..ffbff022 100644 --- a/apidocs/doxygen.css +++ b/apidocs/doxygen.css @@ -1,4 +1,4 @@ -/* The standard CSS for doxygen 1.9.3 */ +/* The standard CSS for doxygen 1.9.1 */ body, table, div, p, dl { font: 400 14px/22px Roboto,sans-serif; @@ -228,33 +228,6 @@ a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { color: #4665A2; } -a.code.hl_class { /* style for links to class names in code snippets */ } -a.code.hl_struct { /* style for links to struct names in code snippets */ } -a.code.hl_union { /* style for links to union names in code snippets */ } -a.code.hl_interface { /* style for links to interface names in code snippets */ } -a.code.hl_protocol { /* style for links to protocol names in code snippets */ } -a.code.hl_category { /* style for links to category names in code snippets */ } -a.code.hl_exception { /* style for links to exception names in code snippets */ } -a.code.hl_service { /* style for links to service names in code snippets */ } -a.code.hl_singleton { /* style for links to singleton names in code snippets */ } -a.code.hl_concept { /* style for links to concept names in code snippets */ } -a.code.hl_namespace { /* style for links to namespace names in code snippets */ } -a.code.hl_package { /* style for links to package names in code snippets */ } -a.code.hl_define { /* style for links to macro names in code snippets */ } -a.code.hl_function { /* style for links to function names in code snippets */ } -a.code.hl_variable { /* style for links to variable names in code snippets */ } -a.code.hl_typedef { /* style for links to typedef names in code snippets */ } -a.code.hl_enumvalue { /* style for links to enum value names in code snippets */ } -a.code.hl_enumeration { /* style for links to enumeration names in code snippets */ } -a.code.hl_signal { /* style for links to Qt signal names in code snippets */ } -a.code.hl_slot { /* style for links to Qt slot names in code snippets */ } -a.code.hl_friend { /* style for links to friend names in code snippets */ } -a.code.hl_dcop { /* style for links to KDE3 DCOP names in code snippets */ } -a.code.hl_property { /* style for links to property names in code snippets */ } -a.code.hl_event { /* style for links to event names in code snippets */ } -a.code.hl_sequence { /* style for links to sequence names in code snippets */ } -a.code.hl_dictionary { /* style for links to dictionary names in code snippets */ } - /* @end */ dl.el { @@ -262,7 +235,7 @@ dl.el { } ul { - overflow: visible; + overflow: hidden; /*Fixed: list item bullets overlap floating elements*/ } #side-nav ul { @@ -340,7 +313,6 @@ div.line.glow { span.lineno { padding-right: 4px; - margin-right: 9px; text-align: right; border-right: 2px solid #0F0; background-color: #E8E8E8; @@ -467,12 +439,6 @@ img.footer { vertical-align: middle; } -.compoundTemplParams { - color: #4665A2; - font-size: 80%; - line-height: 120%; -} - /* @group Code Colorization */ span.keyword { @@ -1356,11 +1322,6 @@ dl.section dd { } -#projectrow -{ - height: 56px; -} - #projectlogo { text-align: center; @@ -1376,19 +1337,18 @@ dl.section dd { #projectalign { vertical-align: middle; - padding-left: 0.5em; } #projectname { - font: 200% Tahoma, Arial,sans-serif; + font: 300% Tahoma, Arial,sans-serif; margin: 0px; padding: 2px 0px; } #projectbrief { - font: 90% Tahoma, Arial,sans-serif; + font: 120% Tahoma, Arial,sans-serif; margin: 0px; padding: 0px; } @@ -1527,10 +1487,6 @@ span.emoji { */ } -span.obfuscator { - display: none; -} - .PageDocRTL-title div.toc li.level1 { margin-left: 0 !important; margin-right: 0; @@ -1585,7 +1541,7 @@ tr.heading h2 { #powerTip { cursor: default; - /*white-space: nowrap;*/ + white-space: nowrap; background-color: white; border: 1px solid gray; border-radius: 4px 4px 4px 4px; @@ -1824,10 +1780,6 @@ table.DocNodeLTR { margin-left: 0; } -code.JavaDocCode - direction:ltr; -} - tt, code, kbd, samp { display: inline-block; diff --git a/apidocs/files.html b/apidocs/files.html index 332078f6..6c1694bc 100644 --- a/apidocs/files.html +++ b/apidocs/files.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: File List @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -62,84 +62,77 @@ $(function() {
-
File List
+
+
File List
Here is a list of all documented files with brief descriptions:
-
[detail level 123]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
 ▼ src
 ▼ libical
 icaltime.hStruct icaltimetype is a pseudo-object that abstracts time handling
 icalversion.h
 ▼ src
 ▼ libical
 astime.hDefinitions of structures used for time calculations
 icalarray.hAn array of arbitrarily-sized elements which grows dynamically as elements are added
 icalattach.hA set of functions to handle iCal attachments
 icalattachimpl.h
 icalcomponent.h
 icalduration.hMethods for working with durations in iCal
 icalenums.h
 icalerror.hError handling for libical
 icallangbind.h
 icalmemory.hCommon memory management routines
 icalmime.h
 icalparameter.h
 icalparameter_cxx.hDefinition of C++ Wrapper for icalparameter.c
 icalparameterimpl.h
 icalparser.hLine-oriented parsing
 icalperiod.hFunctions for working with iCal periods (of time)
 icalproperty.h
 icalproperty_cxx.hDefinition of C++ Wrapper for icalproperty.c
 icalproperty_p.h
 icalrecur.hRoutines for dealing with recurring time
 icalrestriction.hFunctions to check if an icalcomponent meets the restrictions imposed by the standard
 icaltimezone.hTimezone handling routines
 icaltimezoneimpl.h
 icaltypes.h
 icaltz-util.h
 icalvalue.h
 icalvalue_cxx.h
 icalvalueimpl.h
 icptrholder_cxx.hC++ template classes for managing C++ pointers returned by VComponent::get_..._component, VComponent::get_..._property, ICalProperty::get_..._value
 libical_deprecated.h
 libical_ical_export.h
 pvl.h
 qsort_gen.hAn implementation of qsort that is more flexible than the version provided with stdlib
 sspm.h
 vcomponent_cxx.hC++ classes for the icalcomponent wrapper (VToDo VEvent, etc..)
 ▼ libicalss
 icalbdbset.h
 icalbdbset_cxx.hDefinition of C++ Wrapper for icalbdbset.c
 icalbdbsetimpl.h
 icalcalendar.hRoutines for storing calendar data in a file system
 icalclassify.h
 icalcluster.h
 icalclusterimpl.h
 icaldirset.hIcaldirset manages a database of ical components and offers interfaces for reading, writing and searching for components
 icaldirsetimpl.h
 icalfileset.h
 icalfilesetimpl.h
 icalgauge.hRoutines implementing a filter for ical components
 icalgaugeimpl.h
 icalmessage.h
 icalset.h
 icalspanlist.hCode that supports collections of free/busy spans of time
 icalspanlist_cxx.hC++ class wrapping the icalspanlist data structure
 icalssyacc.h
 libical_icalss_export.h
 ▼ libicalvcal
 icalvcal.h
 libical_vcal_export.h
 vcaltmp.h
 vcc.h
 vobject.h
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 astime.hDefinitions of structures used for time calculations
 icalarray.hAn array of arbitrarily-sized elements which grows dynamically as elements are added
 icalattach.hA set of functions to handle iCal attachments
 icalattachimpl.h
 icalbdbset.h
 icalbdbset_cxx.hDefinition of C++ Wrapper for icalbdbset.c
 icalbdbsetimpl.h
 icalcalendar.hRoutines for storing calendar data in a file system
 icalclassify.h
 icalcluster.h
 icalclusterimpl.h
 icalcomponent.h
 icaldirset.hIcaldirset manages a database of ical components and offers interfaces for reading, writing and searching for components
 icaldirsetimpl.h
 icalduration.hMethods for working with durations in iCal
 icalenums.h
 icalerror.hError handling for libical
 icalfileset.h
 icalfilesetimpl.h
 icalgauge.hRoutines implementing a filter for ical components
 icalgaugeimpl.h
 icallangbind.h
 icalmemory.hCommon memory management routines
 icalmessage.h
 icalmime.h
 icalparameter.h
 icalparameter_cxx.hDefinition of C++ Wrapper for icalparameter.c
 icalparameterimpl.h
 icalparser.hLine-oriented parsing
 icalperiod.hFunctions for working with iCal periods (of time)
 icalproperty.h
 icalproperty_cxx.hDefinition of C++ Wrapper for icalproperty.c
 icalproperty_p.h
 icalrecur.hRoutines for dealing with recurring time
 icalrestriction.hFunctions to check if an icalcomponent meets the restrictions imposed by the standard
 icalset.h
 icalspanlist.hCode that supports collections of free/busy spans of time
 icalspanlist_cxx.hC++ class wrapping the icalspanlist data structure
 icalssyacc.h
 icaltime.hStruct icaltimetype is a pseudo-object that abstracts time handling
 icaltimezone.hTimezone handling routines
 icaltimezoneimpl.h
 icaltypes.h
 icaltz-util.h
 icalvalue.h
 icalvalue_cxx.h
 icalvalueimpl.h
 icalvcal.h
 icalversion.h
 icptrholder_cxx.hC++ template classes for managing C++ pointers returned by VComponent::get_..._component, VComponent::get_..._property, ICalProperty::get_..._value
 libical_ical_export.h
 libical_icalss_export.h
 libical_vcal_export.h
 pvl.h
 sspm.h
 vcaltmp.h
 vcc.h
 vcomponent_cxx.hC++ classes for the icalcomponent wrapper (VToDo VEvent, etc..)
 vobject.h
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/functions.html b/apidocs/functions.html index aea52bab..06f4004b 100644 --- a/apidocs/functions.html +++ b/apidocs/functions.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Data Fields @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,189 +64,380 @@ $(function() {
Here is a list of all documented struct and union fields with links to the struct/union documentation for each field:
-

- a -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/functions_func.html b/apidocs/functions_func.html index 87b30009..537b2cf9 100644 --- a/apidocs/functions_func.html +++ b/apidocs/functions_func.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Data Fields - Functions @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -63,33 +63,77 @@ $(function() {
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/functions_vars.html b/apidocs/functions_vars.html index d5ce5c78..af13cd93 100644 --- a/apidocs/functions_vars.html +++ b/apidocs/functions_vars.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Data Fields - Variables @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,155 +64,302 @@ $(function() {
  -

- b -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals.html b/apidocs/globals.html index 55708976..8988bd64 100644 --- a/apidocs/globals.html +++ b/apidocs/globals.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,14 +64,15 @@ $(function() {
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
-

- c -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_defs.html b/apidocs/globals_defs.html index 0a95aafa..44ee06dd 100644 --- a/apidocs/globals_defs.html +++ b/apidocs/globals_defs.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -63,21 +63,41 @@ $(function() {
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_enum.html b/apidocs/globals_enum.html index 0e38639d..30584a27 100644 --- a/apidocs/globals_enum.html +++ b/apidocs/globals_enum.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -63,15 +63,23 @@ $(function() {
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_eval.html b/apidocs/globals_eval.html index e8380479..d3507dc5 100644 --- a/apidocs/globals_eval.html +++ b/apidocs/globals_eval.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -63,40 +63,98 @@ $(function() {
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_f.html b/apidocs/globals_f.html index 13f29737..0194cae1 100644 --- a/apidocs/globals_f.html +++ b/apidocs/globals_f.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,13 +64,15 @@ $(function() {
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
-

- f -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_func.html b/apidocs/globals_func.html index b68beba1..d18261d5 100644 --- a/apidocs/globals_func.html +++ b/apidocs/globals_func.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,14 +64,15 @@ $(function() {
  -

- c -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_func_f.html b/apidocs/globals_func_f.html index 97d4ef81..7dfcf3e4 100644 --- a/apidocs/globals_func_f.html +++ b/apidocs/globals_func_f.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,13 +64,15 @@ $(function() {
  -

- f -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_func_i.html b/apidocs/globals_func_i.html index acbd043f..d55d475e 100644 --- a/apidocs/globals_func_i.html +++ b/apidocs/globals_func_i.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,252 +64,687 @@ $(function() {
  -

- i -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_func_j.html b/apidocs/globals_func_j.html index 1692d002..0b6d616c 100644 --- a/apidocs/globals_func_j.html +++ b/apidocs/globals_func_j.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,14 +64,15 @@ $(function() {
  -

- j -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_func_q.html b/apidocs/globals_func_q.html deleted file mode 100644 index 64b2f848..00000000 --- a/apidocs/globals_func_q.html +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - -Libical API Documentation: Globals - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-  - -

- q -

-
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/globals_func_s.html b/apidocs/globals_func_s.html index 74b04175..7eba81a6 100644 --- a/apidocs/globals_func_s.html +++ b/apidocs/globals_func_s.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,13 +64,15 @@ $(function() {
  -

- s -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_i.html b/apidocs/globals_i.html index bdcf2a83..a4a39962 100644 --- a/apidocs/globals_i.html +++ b/apidocs/globals_i.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,301 +64,834 @@ $(function() {
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
-

- i -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_j.html b/apidocs/globals_j.html index 17d0796e..1091401c 100644 --- a/apidocs/globals_j.html +++ b/apidocs/globals_j.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,14 +64,15 @@ $(function() {
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
-

- j -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_q.html b/apidocs/globals_q.html deleted file mode 100644 index dab114b5..00000000 --- a/apidocs/globals_q.html +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - -Libical API Documentation: Globals - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
- -

- q -

-
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/globals_s.html b/apidocs/globals_s.html index 19b22056..71feac21 100644 --- a/apidocs/globals_s.html +++ b/apidocs/globals_s.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -64,13 +64,15 @@ $(function() {
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
-

- s -

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_type.html b/apidocs/globals_type.html index 20d6a8eb..1fe57928 100644 --- a/apidocs/globals_type.html +++ b/apidocs/globals_type.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -63,17 +63,29 @@ $(function() {
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/globals_vars.html b/apidocs/globals_vars.html index e682d4d6..d5a083cf 100644 --- a/apidocs/globals_vars.html +++ b/apidocs/globals_vars.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Globals @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -63,12 +63,14 @@ $(function() {
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/graph_legend.html b/apidocs/graph_legend.html index 05c6b034..ccd20a28 100644 --- a/apidocs/graph_legend.html +++ b/apidocs/graph_legend.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Graph Legend @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ @@ -62,11 +62,12 @@ $(function() {
-
Graph Legend
+
+
Graph Legend
-

This page explains how to interpret the graphs that are generated by doxygen.

-

Consider the following example:

/*! Invisible class because of truncation */
+

This page explains how to interpret the graphs that are generated by doxygen.

+

Consider the following example:

/*! Invisible class because of truncation */
class Invisible { };
/*! Truncated class, inheritance relation is hidden */
@@ -101,7 +102,7 @@ $(function() {
Used *m_usedClass;
};

This will result in the following graph:

-

The boxes in the above graph have the following meaning:

+

The boxes in the above graph have the following meaning:

  • A filled gray box represents the struct or class for which the graph is generated.
    • @@ -112,7 +113,7 @@ A box with a gray border denotes an undocumented struct or class.
  • A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.
-

The arrows have the following meaning:

+

The arrows have the following meaning:

  • A dark blue arrow is used to visualize a public inheritance relation between two classes.
    • @@ -128,7 +129,7 @@ A yellow dashed arrow denotes a relation between a template instance and the tem
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/hierarchy.html b/apidocs/hierarchy.html index f4b84cd8..030135c0 100644 --- a/apidocs/hierarchy.html +++ b/apidocs/hierarchy.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Class Hierarchy @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
@@ -62,7 +62,8 @@ $(function() {
-
Class Hierarchy
+
+
Class Hierarchy
@@ -71,109 +72,111 @@ This inheritance list is sorted roughly, but not completely, alphabetically:[detail level 12]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 C_compat_tzids
 C_icalarray
 C_icalarray_sort_context
 C_icaltimezone
 C_icaltimezonechange
 C_icalvcal_defaults
 Cbuffer_ring
 Cconversion_table_struct
 Cicalvalue_impl::data
 Cencoding_map
 Cexpand_split_map_struct
 Cfreq_map
 Cicalattach_impl
 CLibICal::ICalBDBSet
 Cicalbdbset_id
 Cicalbdbset_impl
 Cicalbdbset_options
 Cicalcalendar_impl
 Cicalclassify_map
 Cicalclassify_parts
 Cicalcluster_impl
 Cicalcompiter
 Cicalcomponent_impl
 Cicalcomponent_kind_map
 Cicaldatetimeperiodtype
 Cicaldirset_impl
 Cicaldirset_options
 CicaldurationtypeA struct representing a duration
 Cicalerror_state
 Cicalerror_string_map
 Cicalfileset_id
 Cicalfileset_impl
 Cicalfileset_optionsOptions for opening an icalfileset
 Cicalgauge_impl
 Cicalgauge_where
 Cicalgeotype
 CLibICal::ICalParameter
 Cicalparameter_impl
 Cicalparser_impl
 CicalperiodtypeStruct to represent a period in time
 CLibICal::ICalProperty
 Cicalproperty_impl
 Cicalrecur_iterator_impl
 Cicalrecur_parser
 Cicalrecurrencetype
 Cicalreqstattype
 Cicalset_impl
 Cicalsetiter
 CLibICal::ICalSpanList
 Cicalspanlist_impl
 Cicaltime_span
 Cicaltimetype
 Cicaltriggertype
 CLibICal::ICalValue
 Cicalvalue_impl
 CICPointerHolder< T >
 CLexBuf
 Cmajor_content_type_map
 Cmime_impl
 Cminor_content_type_map
 Cobservance
 COFile
 CPreDefProp
 Cpvl_elem_t
 Cpvl_list_t
 Crdate
 Crecur_map
 Cskip_map
 Cslg_data
 Csspm_action_map
 Csspm_buffer
 Csspm_header
 Csspm_part
 CStrItem
 Ctext_part
 Cut_instant
 Cut_instant_int
 CValueItem
 ▼CLibICal::VComponentA class wrapping the libical icalcomponent functions
 CLibICal::VAgenda
 CLibICal::VAlarm
 CLibICal::VCalendar
 CLibICal::VEvent
 CLibICal::VFreeBusy
 CLibICal::VJournal
 CLibICal::VQuery
 CLibICal::VTimezone
 CLibICal::VToDo
 CLibICal::XDaylight
 CLibICal::XStandard
 CVObject
 CVObjectIterator
 Cwd_map
 Cyy_buffer_state
 Cyy_trans_info
 Cyyalloc
 CYYSTACKDATA
 CYYSTYPE
 Czone_context
 C_icaltimezone
 C_icaltimezonechange
 C_icalvcal_defaults
 Cbuffer_ring
 Cconversion_table_struct
 Cicalvalue_impl::data
 Cencoding_map
 Cexpand_split_map_struct
 Cfreq_map
 Cicalattach_impl
 CLibICal::ICalBDBSet
 Cicalbdbset_id
 Cicalbdbset_impl
 Cicalbdbset_options
 Cicalcalendar_impl
 Cicalclassify_map
 Cicalclassify_parts
 Cicalcluster_impl
 Cicalcompiter
 Cicalcomponent_impl
 Cicalcomponent_kind_map
 Cicaldatetimeperiodtype
 Cicaldirset_impl
 Cicaldirset_options
 CicaldurationtypeA struct representing a duration
 Cicalerror_state
 Cicalerror_string_map
 Cicalfileset_id
 Cicalfileset_impl
 Cicalfileset_optionsOptions for opening an icalfileset
 Cicalgauge_impl
 Cicalgauge_where
 Cicalgeotype
 CLibICal::ICalParameter
 Cicalparameter_impl
 Cicalparser_impl
 CicalperiodtypeStruct to represent a period in time
 CLibICal::ICalProperty
 Cicalproperty_impl
 Cicalrecur_iterator_impl
 Cicalrecur_parser
 Cicalrecurrencetype
 Cicalreqstattype
 Cicalset_impl
 Cicalsetiter
 CLibICal::ICalSpanList
 Cicalspanlist_impl
 Cicaltime_span
 Cicaltimetype
 Cicaltimezonephase
 Cicaltimezonetype
 Cicaltriggertype
 CLibICal::ICalValue
 Cicalvalue_impl
 CICPointerHolder< T >
 Cleap
 CLexBuf
 Cmajor_content_type_map
 Cmime_impl
 Cminor_content_type_map
 Cobservance
 COFile
 CPreDefProp
 Cpvl_elem_t
 Cpvl_list_t
 Crdate
 Crecur_map
 Cskip_map
 Cslg_data
 Csspm_action_map
 Csspm_buffer
 Csspm_header
 Csspm_part
 CStrItem
 Ctext_part
 Cttinfo
 Ctzinfo
 Cut_instant
 CValueItem
 ►CLibICal::VComponentA class wrapping the libical icalcomponent functions
 CVObject
 CVObjectIterator
 Cwd_map
 Cyy_buffer_state
 Cyy_trans_info
 Cyyalloc
 CYYSTYPE
 Czone_context
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalarray_8h.html b/apidocs/icalarray_8h.html index 48014615..e115af38 100644 --- a/apidocs/icalarray_8h.html +++ b/apidocs/icalarray_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalarray.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures | Typedefs | Functions
-
icalarray.h File Reference
+
+
icalarray.h File Reference
@@ -79,35 +80,35 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

struct  _icalarray
 
- - +

+

Typedefs

-typedef struct _icalarray icalarray
+typedef struct _icalarray icalarray
 A struct representing an icalarray object.
 
- - - - - - - + + + + + + - - - + + + @@ -116,9 +117,9 @@ Functions

+

Functions

void icalarray_append (icalarray *array, const void *element)
 Appends an element to an array. More...
 
icalarray * icalarray_copy (icalarray *array)
 Copies an existing icalarray and its elements, creating a new one. More...
 
void * icalarray_element_at (icalarray *array, size_t position)
 Access an array element. More...
 
icalarray * icalarray_copy (icalarray *array)
 Copies an existing icalarray and its elements, creating a new one. More...
 
void * icalarray_element_at (icalarray *array, size_t position)
 Access an array element. More...
 
void icalarray_free (icalarray *array)
 Frees an array object and everything that it contains. More...
 
icalarray * icalarray_new (size_t element_size, size_t increment_size)
 Creates a new icalarray object. More...
 
icalarray * icalarray_new (size_t element_size, size_t increment_size)
 Creates a new icalarray object. More...
 
void icalarray_remove_element_at (icalarray *array, size_t position)
 Removes a given element from an array. More...
 
 

Detailed Description

-

An array of arbitrarily-sized elements which grows dynamically as elements are added.

+

An array of arbitrarily-sized elements which grows dynamically as elements are added.

Function Documentation

- +

◆ icalarray_append()

@@ -156,30 +157,30 @@ Functions
Error handling
If array or element is NULL, using this function results in undefined behaviour (most likely a segfault).
Ownership
The element does not get consumed by the method, since it creates a copy of it
Usage
// create new array
-
icalarray *array = icalarray_new(sizeof(int), 1);
+
icalarray *array = icalarray_new(sizeof(int), 1);
// append data to it
int data = 42;
-
icalarray_append(array, &data);
+
icalarray_append(array, &data);
// release array
-
icalarray_free(array);
-
icalarray_free
void icalarray_free(icalarray *array)
Frees an array object and everything that it contains.
Definition: icalarray.c:91
-
icalarray_append
void icalarray_append(icalarray *array, const void *element)
Appends an element to an array.
Definition: icalarray.c:106
-
icalarray_new
icalarray * icalarray_new(size_t element_size, size_t increment_size)
Creates a new icalarray object.
Definition: icalarray.c:25
-
_icalarray
Definition: icalarray.h:30
+
icalarray_free(array);
+
icalarray_new
icalarray * icalarray_new(size_t element_size, size_t increment_size)
Creates a new icalarray object.
Definition: icalarray.c:31
+
icalarray_free
void icalarray_free(icalarray *array)
Frees an array object and everything that it contains.
Definition: icalarray.c:90
+
icalarray_append
void icalarray_append(icalarray *array, const void *element)
Appends an element to an array.
Definition: icalarray.c:105
+
_icalarray
Definition: icalarray.h:36
- -

◆ icalarray_copy()

+ +

◆ icalarray_copy()

- + @@ -200,33 +201,33 @@ Functions
Error handling
If array is NULL, this method will return NULL. If there was an error allocating memory while creating the copy, it will set icalerrno to ICAL_ALLOCATION_ERROR.
Ownership
The created copy is owned by the caller of the function, and needs to be released with icalarray_free() after it's no longer being used.
Usage
// create new array
-
icalarray *array = icalarray_new(sizeof(int), 1);
+
icalarray *array = icalarray_new(sizeof(int), 1);
// fill array
int a = 4;
-
icalarray_append(array, &a);
+
icalarray_append(array, &a);
// create copy of array
-
icalarray *copy = icalarray_copy(array);
-
assert(*icalarray_element_at(copy, 0) == a);
+
icalarray *copy = icalarray_copy(array);
+
assert(*icalarray_element_at(copy, 0) == a);
// release arrays
-
icalarray_free(array);
-
icalarray_free(copy);
-
icalarray_element_at
void * icalarray_element_at(icalarray *array, size_t position)
Access an array element.
Definition: icalarray.c:122
-
icalarray_copy
icalarray * icalarray_copy(icalarray *array)
Copies an existing icalarray and its elements, creating a new one.
Definition: icalarray.c:54
+
icalarray_free(array);
+
icalarray_free(copy);
+
icalarray_element_at
void * icalarray_element_at(icalarray *array, size_t position)
Access an array element.
Definition: icalarray.c:117
+
icalarray_copy
icalarray * icalarray_copy(icalarray *array)
Copies an existing icalarray and its elements, creating a new one.
Definition: icalarray.c:60
- -

◆ icalarray_element_at()

+ +

◆ icalarray_element_at()

icalarray * icalarray_copy icalarray* icalarray_copy ( icalarray *  array)
- + @@ -258,14 +259,14 @@ Functions
Error handling
If array is NULL, using this function results in undefined behaviour. If position is not a valid position in the array, using this function results in undefined behaviour.
Ownership
The element is owned by the icalarray, it must not be freed by the user.
Usage
// create new array
-
icalarray *array = icalarray_new(sizeof(int), 1);
+
icalarray *array = icalarray_new(sizeof(int), 1);
// fill array
int a = 4;
-
icalarray_append(array, &a);
+
icalarray_append(array, &a);
// access array element
-
int *element = icalarray_element_at(array, 0);
+
int *element = icalarray_element_at(array, 0);
assert(element != NULL);
assert(*element == a);
@@ -274,12 +275,12 @@ Functions
assert(*icalarray_element(array) == 14);
// release memory
-
icalarray_free(array);
+
icalarray_free(array);
- +

◆ icalarray_free()

@@ -303,22 +304,22 @@ Functions
Example
// creating an array
-
icalarray *array = icalarray_new(sizeof(int), 1);
+
icalarray *array = icalarray_new(sizeof(int), 1);
// releasing it
-
icalarray_free(array);
+
icalarray_free(array);
- -

◆ icalarray_new()

+ +

◆ icalarray_new()

void * icalarray_element_at void* icalarray_element_at ( icalarray *  array,
- + @@ -351,20 +352,20 @@ Functions
Error handling
If element_size or increment_size is not at least 1, using the icalarray object results in undefined behaviour. If there is an error while creating the object, it returns NULL and sets icalerrno to ICAL_NEWFAILED_ERROR.
Ownership
The returned icalarray object is owned by the caller of the function, and needs to be released properly after it's no longer needed with icalarray_free().
Usage
// create new array
-
icalarray *array = icalarray_new(sizeof(int), 1);
+
icalarray *array = icalarray_new(sizeof(int), 1);
// use array
int a = 4;
-
icalarray_append(array, &a);
-
assert(*icalarray_element_at(array, 0) == a);
+
icalarray_append(array, &a);
+
assert(*icalarray_element_at(array, 0) == a);
// release memory
-
icalarray_free(array);
+
icalarray_free(array);
- +

◆ icalarray_remove_element_at()

@@ -401,41 +402,41 @@ Functions

Removes the element at the given position from the array.

Error handling
If array is NULL, using this function results in undefined behaviour. If the array is empty, using this function results in undefined behaviour. If the position is non-existent, it removes the last element.
Usage
// create new array
-
icalarray *array = icalarray_new(sizeof(int), 2);
+
icalarray *array = icalarray_new(sizeof(int), 2);
// fill array
int data;
data = 4;
-
icalarray_append(array, &a);
+
icalarray_append(array, &a);
data = 9;
-
icalarray_append(array, &a);
+
icalarray_append(array, &a);
data = 7;
-
icalarray_append(array, &a);
+
icalarray_append(array, &a);
data = 10;
-
icalarray_append(array, &a);
+
icalarray_append(array, &a);
// check array
-
assert(*icalarray_element_at(array, 0) == 4);
-
assert(*icalarray_element_at(array, 1) == 9);
-
assert(*icalarray_element_at(array, 2) == 7);
-
assert(*icalarray_element_at(array, 3) == 10);
+
assert(*icalarray_element_at(array, 0) == 4);
+
assert(*icalarray_element_at(array, 1) == 9);
+
assert(*icalarray_element_at(array, 2) == 7);
+
assert(*icalarray_element_at(array, 3) == 10);
// remove the second element
-
icalarray_remove_element_at(array, 1);
+
icalarray_remove_element_at(array, 1);
// check array
-
assert(*icalarray_element_at(array, 0) == 4);
-
assert(*icalarray_element_at(array, 1) == 7);
-
assert(*icalarray_element_at(array, 2) == 10);
+
assert(*icalarray_element_at(array, 0) == 4);
+
assert(*icalarray_element_at(array, 1) == 7);
+
assert(*icalarray_element_at(array, 2) == 10);
// release array
-
icalarray_free(array);
-
icalarray_remove_element_at
void icalarray_remove_element_at(icalarray *array, size_t position)
Removes a given element from an array.
Definition: icalarray.c:130
+
icalarray_free(array);
+
icalarray_remove_element_at
void icalarray_remove_element_at(icalarray *array, size_t position)
Removes a given element from an array.
Definition: icalarray.c:125
- +

◆ icalarray_sort()

@@ -477,24 +478,24 @@ Functions
int main(int argc, char *argv[]) {
int numbers[] = {5, 2, 7, 4, 3, 1, 0, 8, 6, 9};
-
icalarray *array = icalarray_new(sizeof(int), 3);
+
icalarray *array = icalarray_new(sizeof(int), 3);
// fill array
for(int i = 0; i < 10; i++) {
-
icalarray_append(array, &numbers[i]);
+
icalarray_append(array, &numbers[i]);
}
// sort array
-
icalarray_sort(array, compare_ints);
+
icalarray_sort(array, compare_ints);
// print numbers
for(int i = 0; i < 10; i++) {
-
printf("%i\n", *((int*)icalarray_element_at(array, i)));
+
printf("%i\n", *((int*)icalarray_element_at(array, i)));
}
return 0;
}
-
icalarray_sort
void icalarray_sort(icalarray *array, int(*compare)(const void *, const void *))
Sorts the elements of an icalarray using the given comparison function.
Definition: icalarray.c:162
+
icalarray_sort
void icalarray_sort(icalarray *array, int(*compare)(const void *, const void *))
Sorts the elements of an icalarray using the given comparison function.
Definition: icalarray.c:136
@@ -502,7 +503,7 @@ Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalarray_8h_source.html b/apidocs/icalarray_8h_source.html index 10434be1..3e4317c9 100644 --- a/apidocs/icalarray_8h_source.html +++ b/apidocs/icalarray_8h_source.html @@ -2,8 +2,8 @@ - - + +Libical API Documentation: icalarray.h Source File @@ -19,9 +19,10 @@
icalarray * icalarray_new icalarray* icalarray_new ( size_t  element_size,
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalarray.h
+
+
icalarray.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalarray.h
-
3 CREATOR: Damon Chaplin 07 March 2001
-
4
-
5 SPDX-FileCopyrightText: 2001, Ximian, Inc.
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
17#ifndef ICALARRAY_H
-
18#define ICALARRAY_H
-
19
-
20#include "libical_ical_export.h"
-
21
-
22#include <stddef.h>
-
23
-
28typedef struct _icalarray icalarray;
-
29struct _icalarray
-
30{
-
31 size_t element_size;
-
32 size_t increment_size;
-
33 size_t num_elements;
-
34 size_t space_allocated;
-
35 void **chunks;
-
36};
-
37
-
75LIBICAL_ICAL_EXPORT icalarray *icalarray_new(size_t element_size, size_t increment_size);
-
76
-
113LIBICAL_ICAL_EXPORT icalarray *icalarray_copy(icalarray *array);
-
114
-
128LIBICAL_ICAL_EXPORT void icalarray_free(icalarray *array);
-
129
-
159LIBICAL_ICAL_EXPORT void icalarray_append(icalarray *array, const void *element);
-
160
-
207LIBICAL_ICAL_EXPORT void icalarray_remove_element_at(icalarray *array, size_t position);
-
208
-
249LIBICAL_ICAL_EXPORT void *icalarray_element_at(icalarray *array, size_t position);
-
250
-
288LIBICAL_ICAL_EXPORT void icalarray_sort(icalarray *array,
-
289 int (*compare) (const void *, const void *));
-
290
-
291#endif /* ICALARRAY_H */
-
icalarray_element_at
void * icalarray_element_at(icalarray *array, size_t position)
Access an array element.
Definition: icalarray.c:122
-
icalarray_copy
icalarray * icalarray_copy(icalarray *array)
Copies an existing icalarray and its elements, creating a new one.
Definition: icalarray.c:54
-
icalarray_free
void icalarray_free(icalarray *array)
Frees an array object and everything that it contains.
Definition: icalarray.c:91
-
icalarray_sort
void icalarray_sort(icalarray *array, int(*compare)(const void *, const void *))
Sorts the elements of an icalarray using the given comparison function.
Definition: icalarray.c:162
-
icalarray_append
void icalarray_append(icalarray *array, const void *element)
Appends an element to an array.
Definition: icalarray.c:106
-
icalarray_new
icalarray * icalarray_new(size_t element_size, size_t increment_size)
Creates a new icalarray object.
Definition: icalarray.c:25
-
icalarray_remove_element_at
void icalarray_remove_element_at(icalarray *array, size_t position)
Removes a given element from an array.
Definition: icalarray.c:130
-
_icalarray
Definition: icalarray.h:30
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalarray.h
+
3  CREATOR: Damon Chaplin 07 March 2001
+
4 
+
5  (C) COPYRIGHT 2001, Ximian, Inc.
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
25 #ifndef ICALARRAY_H
+
26 #define ICALARRAY_H
+
27 
+
28 #include "libical_ical_export.h"
+
29 
+
34 typedef struct _icalarray icalarray;
+
35 struct _icalarray
+
36 {
+
37  size_t element_size;
+
38  size_t increment_size;
+
39  size_t num_elements;
+
40  size_t space_allocated;
+
41  void **chunks;
+
42 };
+
43 
+
81 LIBICAL_ICAL_EXPORT icalarray *icalarray_new(size_t element_size, size_t increment_size);
+
82 
+
119 LIBICAL_ICAL_EXPORT icalarray *icalarray_copy(icalarray *array);
+
120 
+
134 LIBICAL_ICAL_EXPORT void icalarray_free(icalarray *array);
+
135 
+
165 LIBICAL_ICAL_EXPORT void icalarray_append(icalarray *array, const void *element);
+
166 
+
213 LIBICAL_ICAL_EXPORT void icalarray_remove_element_at(icalarray *array, size_t position);
+
214 
+
255 LIBICAL_ICAL_EXPORT void *icalarray_element_at(icalarray *array, size_t position);
+
256 
+
294 LIBICAL_ICAL_EXPORT void icalarray_sort(icalarray *array,
+
295  int (*compare) (const void *, const void *));
+
296 
+
297 #endif /* ICALARRAY_H */
+
icalarray_new
icalarray * icalarray_new(size_t element_size, size_t increment_size)
Creates a new icalarray object.
Definition: icalarray.c:31
+
icalarray_free
void icalarray_free(icalarray *array)
Frees an array object and everything that it contains.
Definition: icalarray.c:90
+
icalarray_sort
void icalarray_sort(icalarray *array, int(*compare)(const void *, const void *))
Sorts the elements of an icalarray using the given comparison function.
Definition: icalarray.c:136
+
icalarray_element_at
void * icalarray_element_at(icalarray *array, size_t position)
Access an array element.
Definition: icalarray.c:117
+
icalarray_append
void icalarray_append(icalarray *array, const void *element)
Appends an element to an array.
Definition: icalarray.c:105
+
icalarray_copy
icalarray * icalarray_copy(icalarray *array)
Copies an existing icalarray and its elements, creating a new one.
Definition: icalarray.c:60
+
icalarray_remove_element_at
void icalarray_remove_element_at(icalarray *array, size_t position)
Removes a given element from an array.
Definition: icalarray.c:125
+
_icalarray
Definition: icalarray.h:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalattach_8h.html b/apidocs/icalattach_8h.html index 1f178f5b..9e44aa65 100644 --- a/apidocs/icalattach_8h.html +++ b/apidocs/icalattach_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalattach.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
icalattach.h File Reference
+
+
icalattach.h File Reference
@@ -78,7 +79,7 @@ $(function() {

Go to the source code of this file.

- @@ -87,23 +88,23 @@ Typedefs

+

Typedefs

typedef struct icalattach_impl icalattach
 An iCal attach object representing a link to a document object. More...
 Function to be called to free the data of an icalattach object. More...
 
- - - - + + + - - - - - - - - - + + + + + + + + + @@ -112,11 +113,11 @@ Functions

+

Functions

unsigned char * icalattach_get_data (icalattach *attach)
 Returns the data of the icalattach object. More...
 
unsigned char * icalattach_get_data (icalattach *attach)
 Returns the data of the icalattach object. More...
 
int icalattach_get_is_url (icalattach *attach)
 Determines if attach is an URL. More...
 
const char * icalattach_get_url (icalattach *attach)
 Returns the URL of the icalattach object. More...
 
icalattach * icalattach_new_from_data (const char *data, icalattach_free_fn_t free_fn, void *free_fn_data)
 Creates new icalattach object from data. More...
 
icalattach * icalattach_new_from_url (const char *url)
 Creates new icalattach object from a URL. More...
 
const char * icalattach_get_url (icalattach *attach)
 Returns the URL of the icalattach object. More...
 
icalattach * icalattach_new_from_data (const char *data, icalattach_free_fn_t free_fn, void *free_fn_data)
 Creates new icalattach object from data. More...
 
icalattach * icalattach_new_from_url (const char *url)
 Creates new icalattach object from a URL. More...
 
void icalattach_ref (icalattach *attach)
 Increments reference count of the icalattach. More...
 
 

Detailed Description

-

A set of functions to handle iCal attachments.

-

With the ATTACH property, the iCal standard defines a way to associate a document object with a calendar component.

-

These are represented with icalattach objects in libical. This file contains functions to create and work with these objects.

+

A set of functions to handle iCal attachments.

+

With the ATTACH property, the iCal standard defines a way to associate a document object with a calendar component.

+

These are represented with icalattach objects in libical. This file contains functions to create and work with these objects.

Typedef Documentation

- +

◆ icalattach

@@ -129,11 +130,11 @@ Functions

An iCal attach object representing a link to a document object.

-

Represents an association with a document object. icalattach objects are reference counted, meaning that if the last reference to them is removed (with icalattach_unref()), they are destroyed.

+

Represents an association with a document object. icalattach objects are reference counted, meaning that if the last reference to them is removed (with icalattach_unref()), they are destroyed.

- +

◆ icalattach_free_fn_t

@@ -147,19 +148,19 @@ Functions

Function to be called to free the data of an icalattach object.

Warning
Currently not used
-

This function type is used to free the data from an icalattach object created with icalattach_new_from_data(). It is currently not used

+

This function type is used to free the data from an icalattach object created with icalattach_new_from_data(). It is currently not used

Function Documentation

- -

◆ icalattach_get_data()

+ +

◆ icalattach_get_data()

- + @@ -183,7 +184,7 @@ Functions - +

◆ icalattach_get_is_url()

@@ -207,32 +208,32 @@ Functions
Returns
1 if it is a URL, otherwise 0.
-
See also
icalattach_get_url()
+
See also
icalattach_get_url()
Error handling
Returns NULL and sets icalerrno to ICAL_BADARG_ERROR if attach is NULL.
Usage
// creates new
-
icalattach *attach = icalattach_new_from_url("http://example.com");
+
icalattach *attach = icalattach_new_from_url("http://example.com");
// checks if it is a URL
-
assert(icalattach_get_is_url(attach));
+
assert(icalattach_get_is_url(attach));
// release it
-
icalattach_unref(attach);
-
icalattach_unref
void icalattach_unref(icalattach *attach)
Decrements reference count of the icalattach.
Definition: icalattach.c:92
-
icalattach_get_is_url
int icalattach_get_is_url(icalattach *attach)
Determines if attach is an URL.
Definition: icalattach.c:111
-
icalattach_new_from_url
icalattach * icalattach_new_from_url(const char *url)
Creates new icalattach object from a URL.
Definition: icalattach.c:22
-
icalattach_impl
Definition: icalattachimpl.h:18
+
icalattach_unref(attach);
+
icalattach_unref
void icalattach_unref(icalattach *attach)
Decrements reference count of the icalattach.
Definition: icalattach.c:99
+
icalattach_get_is_url
int icalattach_get_is_url(icalattach *attach)
Determines if attach is an URL.
Definition: icalattach.c:118
+
icalattach_new_from_url
icalattach * icalattach_new_from_url(const char *url)
Creates new icalattach object from a URL.
Definition: icalattach.c:29
+
icalattach_impl
Definition: icalattachimpl.h:26
- -

◆ icalattach_get_url()

+ +

◆ icalattach_get_url()

unsigned char * icalattach_get_data unsigned char* icalattach_get_data ( icalattach *  attach)
- + @@ -254,27 +255,27 @@ Functions
Error handling
Returns NULL and set icalerrno to ICAL_BADARG_ERROR if attach is NULL. Undefined behaviour if the object is not a URL (check with icalattach_get_is_url()).
Ownership
The string returned is owned by libical and must not be freed by the caller.
Usage
// creates new
-
icalattach *attach = icalattach_new_from_url("http://example.com");
+
icalattach *attach = icalattach_new_from_url("http://example.com");
// checks it
-
assert(icalattach_get_is_url(attach));
-
assert(0 == strcmp(icalattach_get_url(attach), "http://example.com"));
+
assert(icalattach_get_is_url(attach));
+
assert(0 == strcmp(icalattach_get_url(attach), "http://example.com"));
// release it
-
icalattach_unref(attach);
-
icalattach_get_url
const char * icalattach_get_url(icalattach *attach)
Returns the URL of the icalattach object.
Definition: icalattach.c:118
+
icalattach_unref(attach);
+
icalattach_get_url
const char * icalattach_get_url(icalattach *attach)
Returns the URL of the icalattach object.
Definition: icalattach.c:125
- -

◆ icalattach_new_from_data()

+ +

◆ icalattach_new_from_data()

const char * icalattach_get_url const char* icalattach_get_url ( icalattach *  attach)
- + @@ -315,14 +316,14 @@ Functions - -

◆ icalattach_new_from_url()

+ +

◆ icalattach_new_from_url()

icalattach * icalattach_new_from_data icalattach* icalattach_new_from_data ( const char *  data,
- + @@ -343,19 +344,19 @@ Functions
Error handling
If url is NULL, it returns NULL and sets icalerrno to ICAL_BADARG_ERROR. If there was an error allocating memory, it returns NULL and sets errno to ENOMEM.
Ownership
The returned icalattach object is owned by the caller of the function. icalattach objects are reference counted, which means that after use, icalattach_unref() needs to be called to signal that they are not used anymore.
Usage
// creates new
-
icalattach *attach = icalattach_new_from_url("http://example.com");
+
icalattach *attach = icalattach_new_from_url("http://example.com");
// checks it
-
assert(icalattach_get_is_url(attach));
-
assert(0 == strcmp(icalattach_get_url(attach), "http://example.com"));
+
assert(icalattach_get_is_url(attach));
+
assert(0 == strcmp(icalattach_get_url(attach), "http://example.com"));
// release it
-
icalattach_unref(attach);
+
icalattach_unref(attach);
- +

◆ icalattach_ref()

@@ -384,7 +385,7 @@ Functions
- +

◆ icalattach_unref()

@@ -412,10 +413,10 @@ Functions
Error handling
If attach is NULL, or the reference count is smaller than 0, it sets icalerrno to ICAL_BADARG_ERROR.
Ownership
Calling this function releases the icalattach back to the library, and it must not be used afterwards.
Usage
// creates new
-
icalattach *attach = icalattach_new_from_url("http://example.com");
+
icalattach *attach = icalattach_new_from_url("http://example.com");
// release it
-
icalattach_unref(attach);
+
icalattach_unref(attach);
@@ -423,7 +424,7 @@ Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalattach_8h_source.html b/apidocs/icalattach_8h_source.html index 856a83e7..cbb1e183 100644 --- a/apidocs/icalattach_8h_source.html +++ b/apidocs/icalattach_8h_source.html @@ -2,8 +2,8 @@ - - + +Libical API Documentation: icalattach.h Source File @@ -19,9 +19,10 @@
icalattach * icalattach_new_from_url icalattach* icalattach_new_from_url ( const char *  url)
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalattach.h
+
+
icalattach.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalattach.h
-
3 CREATOR: acampi 28 May 02
-
4
-
5 SPDX-FileCopyrightText: 2002, Andrea Campi <a.campi@inet.it>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
23#ifndef ICALATTACH_H
-
24#define ICALATTACH_H
-
25
-
26#include "libical_ical_export.h"
-
27
-
36typedef struct icalattach_impl icalattach;
-
37
-
46typedef void (*icalattach_free_fn_t) (char *data, void *user_data);
-
47
-
78LIBICAL_ICAL_EXPORT icalattach *icalattach_new_from_url(const char *url);
-
79
-
99LIBICAL_ICAL_EXPORT icalattach *icalattach_new_from_data(const char *data,
-
100 icalattach_free_fn_t free_fn,
-
101 void *free_fn_data);
-
102
-
117LIBICAL_ICAL_EXPORT void icalattach_ref(icalattach *attach);
-
118
-
144LIBICAL_ICAL_EXPORT void icalattach_unref(icalattach *attach);
-
145
-
168LIBICAL_ICAL_EXPORT int icalattach_get_is_url(icalattach *attach);
-
169
-
200LIBICAL_ICAL_EXPORT const char *icalattach_get_url(icalattach *attach);
-
201
-
219LIBICAL_ICAL_EXPORT unsigned char *icalattach_get_data(icalattach *attach);
-
220
-
221#endif /* !ICALATTACH_H */
-
icalattach_new_from_data
icalattach * icalattach_new_from_data(const char *data, icalattach_free_fn_t free_fn, void *free_fn_data)
Creates new icalattach object from data.
Definition: icalattach.c:53
-
icalattach_free_fn_t
void(* icalattach_free_fn_t)(char *data, void *user_data)
Function to be called to free the data of an icalattach object.
Definition: icalattach.h:46
-
icalattach_unref
void icalattach_unref(icalattach *attach)
Decrements reference count of the icalattach.
Definition: icalattach.c:92
-
icalattach_get_is_url
int icalattach_get_is_url(icalattach *attach)
Determines if attach is an URL.
Definition: icalattach.c:111
-
icalattach_ref
void icalattach_ref(icalattach *attach)
Increments reference count of the icalattach.
Definition: icalattach.c:84
-
icalattach_get_data
unsigned char * icalattach_get_data(icalattach *attach)
Returns the data of the icalattach object.
Definition: icalattach.c:126
-
icalattach_get_url
const char * icalattach_get_url(icalattach *attach)
Returns the URL of the icalattach object.
Definition: icalattach.c:118
-
icalattach_new_from_url
icalattach * icalattach_new_from_url(const char *url)
Creates new icalattach object from a URL.
Definition: icalattach.c:22
-
icalattach_impl
Definition: icalattachimpl.h:18
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalattach.h
+
3  CREATOR: acampi 28 May 02
+
4 
+
5  (C) COPYRIGHT 2002, Andrea Campi <a.campi@inet.it>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
31 #ifndef ICALATTACH_H
+
32 #define ICALATTACH_H
+
33 
+
34 #include "libical_ical_export.h"
+
35 
+
44 typedef struct icalattach_impl icalattach;
+
45 
+
54 typedef void (*icalattach_free_fn_t) (char *data, void *user_data);
+
55 
+
86 LIBICAL_ICAL_EXPORT icalattach *icalattach_new_from_url(const char *url);
+
87 
+
107 LIBICAL_ICAL_EXPORT icalattach *icalattach_new_from_data(const char *data,
+
108  icalattach_free_fn_t free_fn,
+
109  void *free_fn_data);
+
110 
+
125 LIBICAL_ICAL_EXPORT void icalattach_ref(icalattach *attach);
+
126 
+
152 LIBICAL_ICAL_EXPORT void icalattach_unref(icalattach *attach);
+
153 
+
176 LIBICAL_ICAL_EXPORT int icalattach_get_is_url(icalattach *attach);
+
177 
+
208 LIBICAL_ICAL_EXPORT const char *icalattach_get_url(icalattach *attach);
+
209 
+
227 LIBICAL_ICAL_EXPORT unsigned char *icalattach_get_data(icalattach *attach);
+
228 
+
229 #endif /* !ICALATTACH_H */
+
icalattach_get_data
unsigned char * icalattach_get_data(icalattach *attach)
Returns the data of the icalattach object.
Definition: icalattach.c:133
+
icalattach_free_fn_t
void(* icalattach_free_fn_t)(char *data, void *user_data)
Function to be called to free the data of an icalattach object.
Definition: icalattach.h:54
+
icalattach_unref
void icalattach_unref(icalattach *attach)
Decrements reference count of the icalattach.
Definition: icalattach.c:99
+
icalattach_get_is_url
int icalattach_get_is_url(icalattach *attach)
Determines if attach is an URL.
Definition: icalattach.c:118
+
icalattach_new_from_url
icalattach * icalattach_new_from_url(const char *url)
Creates new icalattach object from a URL.
Definition: icalattach.c:29
+
icalattach_ref
void icalattach_ref(icalattach *attach)
Increments reference count of the icalattach.
Definition: icalattach.c:91
+
icalattach_new_from_data
icalattach * icalattach_new_from_data(const char *data, icalattach_free_fn_t free_fn, void *free_fn_data)
Creates new icalattach object from data.
Definition: icalattach.c:60
+
icalattach_get_url
const char * icalattach_get_url(icalattach *attach)
Returns the URL of the icalattach object.
Definition: icalattach.c:125
+
icalattach_impl
Definition: icalattachimpl.h:26
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalattachimpl_8h_source.html b/apidocs/icalattachimpl_8h_source.html index 94713cb4..f7f4083b 100644 --- a/apidocs/icalattachimpl_8h_source.html +++ b/apidocs/icalattachimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalattachimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalattachimpl.h
+
+
icalattachimpl.h
-
1/*======================================================================
-
2 FILE: icalattachimpl.h
-
3 CREATOR: acampi 28 May 02
-
4
-
5 SPDX-FileCopyrightText: 2000, Andrea Campi <a.campi@inet.it>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALATTACHIMPL_H
-
12#define ICALATTACHIMPL_H
-
13
-
14#include "icalattach.h"
-
15
-
16/* Private structure for ATTACH values */
-
17struct icalattach_impl
-
18{
-
19 /* Reference count */
-
20 int refcount;
-
21
-
22 union
-
23 {
-
24 /* URL attachment data */
-
25 struct
-
26 {
-
27 char *url;
-
28 } url;
-
29
-
30 /* Inline data */
-
31 struct
-
32 {
-
33 char *data;
-
34 icalattach_free_fn_t free_fn;
-
35 void *free_fn_data;
-
36 } data;
-
37 } u;
-
38
-
39 /* TRUE if URL, FALSE if inline data */
-
40 unsigned int is_url:1;
-
41};
-
42
-
43#endif
+
1 /*======================================================================
+
2  FILE: icalattachimpl.h
+
3  CREATOR: acampi 28 May 02
+
4 
+
5  (C) COPYRIGHT 2000, Andrea Campi <a.campi@inet.it>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALATTACHIMPL_H
+
20 #define ICALATTACHIMPL_H
+
21 
+
22 #include "icalattach.h"
+
23 
+
24 /* Private structure for ATTACH values */
+
25 struct icalattach_impl
+
26 {
+
27  /* Reference count */
+
28  int refcount;
+
29 
+
30  union
+
31  {
+
32  /* URL attachment data */
+
33  struct
+
34  {
+
35  char *url;
+
36  } url;
+
37 
+
38  /* Inline data */
+
39  struct
+
40  {
+
41  char *data;
+
42  icalattach_free_fn_t free_fn;
+
43  void *free_fn_data;
+
44  } data;
+
45  } u;
+
46 
+
47  /* TRUE if URL, FALSE if inline data */
+
48  unsigned int is_url:1;
+
49 };
+
50 
+
51 #endif
icalattach.h
A set of functions to handle iCal attachments.
-
icalattach_free_fn_t
void(* icalattach_free_fn_t)(char *data, void *user_data)
Function to be called to free the data of an icalattach object.
Definition: icalattach.h:46
-
icalattach_impl
Definition: icalattachimpl.h:18
+
icalattach_free_fn_t
void(* icalattach_free_fn_t)(char *data, void *user_data)
Function to be called to free the data of an icalattach object.
Definition: icalattach.h:54
+
icalattach_impl
Definition: icalattachimpl.h:26
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalbdbset_8h_source.html b/apidocs/icalbdbset_8h_source.html index 7f569844..c0ca6ecb 100644 --- a/apidocs/icalbdbset_8h_source.html +++ b/apidocs/icalbdbset_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalbdbset.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalbdbset.h
+
+
icalbdbset.h
-
1/*======================================================================
-
2 FILE: icalbdbset.h
-
3
-
4 SPDX-FileCopyrightText: 2001, Critical Path
-
5
-
6 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
7
-
8======================================================================*/
-
9
-
10#ifndef ICALBDBSET_H
-
11#define ICALBDBSET_H
-
12
-
13#include "libical_icalss_export.h"
-
14#include "icalset.h"
-
15
-
16#include <db.h>
-
17
-
18typedef struct icalbdbset_impl icalbdbset;
-
19
-
20enum icalbdbset_subdb_type
-
21{ ICALBDB_CALENDARS, ICALBDB_EVENTS, ICALBDB_TODOS, ICALBDB_REMINDERS };
-
22typedef enum icalbdbset_subdb_type icalbdbset_subdb_type;
-
23
-
25LIBICAL_ICALSS_EXPORT int icalbdbset_init_dbenv(char *db_env_dir,
-
26 void (*logDbFunc) (const DB_ENV *,
-
27 const char *, const char *));
-
28
-
29LIBICAL_ICALSS_EXPORT icalset *icalbdbset_init(icalset *set, const char *dsn, void *options);
-
30
-
31LIBICAL_ICALSS_EXPORT int icalbdbset_cleanup(void);
-
32
-
33LIBICAL_ICALSS_EXPORT void icalbdbset_checkpoint(void);
-
34
-
35LIBICAL_ICALSS_EXPORT void icalbdbset_rmdbLog(void);
-
36
-
39LIBICAL_ICALSS_EXPORT icalset *icalbdbset_new(const char *database_filename,
-
40 icalbdbset_subdb_type subdb_type,
-
41 int dbtype, u_int32_t flag);
-
42
-
43LIBICAL_ICALSS_EXPORT DB *icalbdbset_bdb_open_secondary(DB *dbp,
-
44 const char *subdb,
-
45 const char *sindex,
-
46 int (*callback) (DB *db,
-
47 const DBT *dbt1,
-
48 const DBT *dbt2,
-
49 DBT *dbt3), int type);
-
50
-
51LIBICAL_ICALSS_EXPORT char *icalbdbset_parse_data(DBT *dbt, char *(*pfunc) (const DBT *dbt));
-
52
-
53LIBICAL_ICALSS_EXPORT void icalbdbset_free(icalset *set);
-
54
-
55/* cursor operations */
-
56LIBICAL_ICALSS_EXPORT int icalbdbset_acquire_cursor(DB *dbp, DB_TXN *tid, DBC ** rdbcp);
-
57
-
58LIBICAL_ICALSS_EXPORT int icalbdbset_cget(DBC *dbcp, DBT *key, DBT *data,
-
59 u_int32_t access_method);
-
60
-
61LIBICAL_ICALSS_EXPORT int icalbdbset_cput(DBC *dbcp, DBT *key, DBT *data,
-
62 u_int32_t access_method);
-
63
-
64LIBICAL_ICALSS_EXPORT int icalbdbset_get_first(DBC *dbcp, DBT *key, DBT *data);
-
65
-
66LIBICAL_ICALSS_EXPORT int icalbdbset_get_next(DBC *dbcp, DBT *key, DBT *data);
-
67
-
68LIBICAL_ICALSS_EXPORT int icalbdbset_get_last(DBC *dbcp, DBT *key, DBT *data);
-
69
-
70LIBICAL_ICALSS_EXPORT int icalbdbset_get_key(DBC *dbcp, DBT *key, DBT *data);
-
71
-
72LIBICAL_ICALSS_EXPORT int icalbdbset_delete(DB *dbp, DBT *key);
-
73
-
74LIBICAL_ICALSS_EXPORT int icalbdbset_put(DB *dbp, DBT *key, DBT *data, u_int32_t access_method);
-
75
-
76LIBICAL_ICALSS_EXPORT int icalbdbset_get(DB *dbp, DB_TXN *tid, DBT *key, DBT *data,
-
77 u_int32_t flags);
-
78
-
79LIBICAL_ICALSS_EXPORT const char *icalbdbset_path(icalset *set);
-
80
-
81LIBICAL_ICALSS_EXPORT const char *icalbdbset_subdb(icalset *set);
-
82
-
83/* Mark the set as changed, so it will be written to disk when it
-
84 is freed. Commit writes to disk immediately. */
-
85LIBICAL_ICALSS_EXPORT void icalbdbset_mark(icalset *set);
-
86
-
87LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_commit(icalset *set);
-
88
-
89LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_add_component(icalset *set, icalcomponent *child);
-
90
-
91LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_remove_component(icalset *set,
-
92 icalcomponent *child);
-
93
-
94LIBICAL_ICALSS_EXPORT int icalbdbset_count_components(icalset *set, icalcomponent_kind kind);
-
95
-
96/* Restrict the component returned by icalbdbset_first, _next to those
-
97 that pass the gauge. _clear removes the gauge */
-
98LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_select(icalset *store, icalgauge *gauge);
-
99
-
100LIBICAL_ICALSS_EXPORT void icalbdbset_clear(icalset *store);
-
101
-
102/* Gets and searches for a component by uid */
-
103LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_fetch(icalset *set,
-
104 icalcomponent_kind kind, const char *uid);
-
105
-
106LIBICAL_ICALSS_EXPORT int icalbdbset_has_uid(icalset *set, const char *uid);
-
107
-
108LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_fetch_match(icalset *set, icalcomponent *c);
-
109
-
110LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_modify(icalset *set, icalcomponent *old,
-
111 icalcomponent *newc);
-
112
-
113/* cluster management functions */
-
114LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_set_cluster(icalset *set, icalcomponent *cluster);
-
115
-
116LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_free_cluster(icalset *set);
-
117
-
118LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_cluster(icalset *set);
-
119
-
120/* Iterate through components. If a gauge has been defined, these
-
121 will skip over components that do not pass the gauge */
-
122
-
123LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_current_component(icalset *set);
-
124
-
125LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_first_component(icalset *set);
-
126
-
127LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_next_component(icalset *set);
-
128
-
129/* External iterator for thread safety */
-
130LIBICAL_ICALSS_EXPORT icalsetiter icalbdbset_begin_component(icalset *set,
-
131 icalcomponent_kind kind,
-
132 icalgauge *gauge, const char *tzid);
-
133
-
134LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_form_a_matched_recurrence_component(icalsetiter *
-
135 itr);
-
136
-
137LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbsetiter_to_next(icalset *set, icalsetiter *i);
-
138
-
139LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbsetiter_to_prior(icalset *set, icalsetiter *i);
-
140
-
141/* Return a reference to the internal component. You probably should
-
142 not be using this. */
-
143
-
144LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_component(icalset *set);
-
145
-
146LIBICAL_ICALSS_EXPORT DB_ENV *icalbdbset_get_env(void);
-
147
-
148LIBICAL_ICALSS_EXPORT int icalbdbset_begin_transaction(DB_TXN *parent_id, DB_TXN ** txnid);
-
149
-
150LIBICAL_ICALSS_EXPORT int icalbdbset_commit_transaction(DB_TXN *txnid);
-
151
-
152LIBICAL_ICALSS_EXPORT DB *icalbdbset_bdb_open(const char *path,
-
153 const char *subdb,
-
154 int type, int mode, u_int32_t flag);
-
155
-
156typedef struct icalbdbset_options
-
157{
-
158 icalbdbset_subdb_type subdb;
-
159 int dbtype;
-
160 int mode;
-
161 u_int32_t flag;
-
162 char *(*pfunc) (const DBT *dbt);
-
164 int (*callback) (DB *db,
-
166 const DBT *dbt1, const DBT *dbt2, DBT *dbt3);
-
167} icalbdbset_options;
-
168
-
169#endif /* !ICALBDBSET_H */
-
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:67
+
1 /*======================================================================
+
2  FILE: icalbdbset.h
+
3 
+
4  (C) COPYRIGHT 2001, Critical Path
+
5 
+
6  This library is free software; you can redistribute it and/or modify
+
7  it under the terms of either:
+
8 
+
9  The LGPL as published by the Free Software Foundation, version
+
10  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
11 
+
12  Or:
+
13 
+
14  The Mozilla Public License Version 2.0. You may obtain a copy of
+
15  the License at https://www.mozilla.org/MPL/
+
16 ======================================================================*/
+
17 
+
18 #ifndef ICALBDBSET_H
+
19 #define ICALBDBSET_H
+
20 
+
21 #include "libical_icalss_export.h"
+
22 #include "icalset.h"
+
23 
+
24 #include <db.h>
+
25 
+
26 typedef struct icalbdbset_impl icalbdbset;
+
27 
+
28 enum icalbdbset_subdb_type
+
29 { ICALBDB_CALENDARS, ICALBDB_EVENTS, ICALBDB_TODOS, ICALBDB_REMINDERS };
+
30 typedef enum icalbdbset_subdb_type icalbdbset_subdb_type;
+
31 
+
33 LIBICAL_ICALSS_EXPORT int icalbdbset_init_dbenv(char *db_env_dir,
+
34  void (*logDbFunc) (const DB_ENV *,
+
35  const char *, const char *));
+
36 
+
37 LIBICAL_ICALSS_EXPORT icalset *icalbdbset_init(icalset *set, const char *dsn, void *options);
+
38 
+
39 LIBICAL_ICALSS_EXPORT int icalbdbset_cleanup(void);
+
40 
+
41 LIBICAL_ICALSS_EXPORT void icalbdbset_checkpoint(void);
+
42 
+
43 LIBICAL_ICALSS_EXPORT void icalbdbset_rmdbLog(void);
+
44 
+
47 LIBICAL_ICALSS_EXPORT icalset *icalbdbset_new(const char *database_filename,
+
48  icalbdbset_subdb_type subdb_type,
+
49  int dbtype, u_int32_t flag);
+
50 
+
51 LIBICAL_ICALSS_EXPORT DB *icalbdbset_bdb_open_secondary(DB *dbp,
+
52  const char *subdb,
+
53  const char *sindex,
+
54  int (*callback) (DB *db,
+
55  const DBT *dbt1,
+
56  const DBT *dbt2,
+
57  DBT *dbt3), int type);
+
58 
+
59 LIBICAL_ICALSS_EXPORT char *icalbdbset_parse_data(DBT *dbt, char *(*pfunc) (const DBT *dbt));
+
60 
+
61 LIBICAL_ICALSS_EXPORT void icalbdbset_free(icalset *set);
+
62 
+
63 /* cursor operations */
+
64 LIBICAL_ICALSS_EXPORT int icalbdbset_acquire_cursor(DB *dbp, DB_TXN *tid, DBC ** rdbcp);
+
65 
+
66 LIBICAL_ICALSS_EXPORT int icalbdbset_cget(DBC *dbcp, DBT *key, DBT *data,
+
67  u_int32_t access_method);
+
68 
+
69 LIBICAL_ICALSS_EXPORT int icalbdbset_cput(DBC *dbcp, DBT *key, DBT *data,
+
70  u_int32_t access_method);
+
71 
+
72 LIBICAL_ICALSS_EXPORT int icalbdbset_get_first(DBC *dbcp, DBT *key, DBT *data);
+
73 
+
74 LIBICAL_ICALSS_EXPORT int icalbdbset_get_next(DBC *dbcp, DBT *key, DBT *data);
+
75 
+
76 LIBICAL_ICALSS_EXPORT int icalbdbset_get_last(DBC *dbcp, DBT *key, DBT *data);
+
77 
+
78 LIBICAL_ICALSS_EXPORT int icalbdbset_get_key(DBC *dbcp, DBT *key, DBT *data);
+
79 
+
80 LIBICAL_ICALSS_EXPORT int icalbdbset_delete(DB *dbp, DBT *key);
+
81 
+
82 LIBICAL_ICALSS_EXPORT int icalbdbset_put(DB *dbp, DBT *key, DBT *data, u_int32_t access_method);
+
83 
+
84 LIBICAL_ICALSS_EXPORT int icalbdbset_get(DB *dbp, DB_TXN *tid, DBT *key, DBT *data,
+
85  u_int32_t flags);
+
86 
+
87 LIBICAL_ICALSS_EXPORT const char *icalbdbset_path(icalset *set);
+
88 
+
89 LIBICAL_ICALSS_EXPORT const char *icalbdbset_subdb(icalset *set);
+
90 
+
91 /* Mark the set as changed, so it will be written to disk when it
+
92  is freed. Commit writes to disk immediately. */
+
93 LIBICAL_ICALSS_EXPORT void icalbdbset_mark(icalset *set);
+
94 
+
95 LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_commit(icalset *set);
+
96 
+
97 LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_add_component(icalset *set, icalcomponent *child);
+
98 
+
99 LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_remove_component(icalset *set,
+
100  icalcomponent *child);
+
101 
+
102 LIBICAL_ICALSS_EXPORT int icalbdbset_count_components(icalset *set, icalcomponent_kind kind);
+
103 
+
104 /* Restrict the component returned by icalbdbset_first, _next to those
+
105  that pass the gauge. _clear removes the gauge */
+
106 LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_select(icalset *store, icalgauge *gauge);
+
107 
+
108 LIBICAL_ICALSS_EXPORT void icalbdbset_clear(icalset *store);
+
109 
+
110 /* Gets and searches for a component by uid */
+
111 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_fetch(icalset *set,
+
112  icalcomponent_kind kind, const char *uid);
+
113 
+
114 LIBICAL_ICALSS_EXPORT int icalbdbset_has_uid(icalset *set, const char *uid);
+
115 
+
116 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_fetch_match(icalset *set, icalcomponent *c);
+
117 
+
118 LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_modify(icalset *set, icalcomponent *old,
+
119  icalcomponent *newc);
+
120 
+
121 /* cluster management functions */
+
122 LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_set_cluster(icalset *set, icalcomponent *cluster);
+
123 
+
124 LIBICAL_ICALSS_EXPORT icalerrorenum icalbdbset_free_cluster(icalset *set);
+
125 
+
126 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_cluster(icalset *set);
+
127 
+
128 /* Iterate through components. If a gauge has been defined, these
+
129  will skip over components that do not pass the gauge */
+
130 
+
131 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_current_component(icalset *set);
+
132 
+
133 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_first_component(icalset *set);
+
134 
+
135 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_next_component(icalset *set);
+
136 
+
137 /* External iterator for thread safety */
+
138 LIBICAL_ICALSS_EXPORT icalsetiter icalbdbset_begin_component(icalset *set,
+
139  icalcomponent_kind kind,
+
140  icalgauge *gauge, const char *tzid);
+
141 
+
142 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_form_a_matched_recurrence_component(icalsetiter *
+
143  itr);
+
144 
+
145 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbsetiter_to_next(icalset *set, icalsetiter *i);
+
146 
+
147 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbsetiter_to_prior(icalset *set, icalsetiter *i);
+
148 
+
149 /* Return a reference to the internal component. You probably should
+
150  not be using this. */
+
151 
+
152 LIBICAL_ICALSS_EXPORT icalcomponent *icalbdbset_get_component(icalset *set);
+
153 
+
154 LIBICAL_ICALSS_EXPORT DB_ENV *icalbdbset_get_env(void);
+
155 
+
156 LIBICAL_ICALSS_EXPORT int icalbdbset_begin_transaction(DB_TXN *parent_id, DB_TXN ** txnid);
+
157 
+
158 LIBICAL_ICALSS_EXPORT int icalbdbset_commit_transaction(DB_TXN *txnid);
+
159 
+
160 LIBICAL_ICALSS_EXPORT DB *icalbdbset_bdb_open(const char *path,
+
161  const char *subdb,
+
162  int type, int mode, u_int32_t flag);
+
163 
+
164 typedef struct icalbdbset_options
+
165 {
+
166  icalbdbset_subdb_type subdb;
+
167  int dbtype;
+
168  int mode;
+
169  u_int32_t flag;
+
170  char *(*pfunc) (const DBT *dbt);
+
172  int (*callback) (DB *db,
+
174  const DBT *dbt1, const DBT *dbt2, DBT *dbt3);
+
175 } icalbdbset_options;
+
176 
+
177 #endif /* !ICALBDBSET_H */
+
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:76
-
icalbdbset_impl
Definition: icalbdbsetimpl.h:20
-
icalbdbset_options
Definition: icalbdbset.h:157
-
icalbdbset_options::dbtype
int dbtype
Definition: icalbdbset.h:159
-
icalbdbset_options::flag
u_int32_t flag
Definition: icalbdbset.h:161
-
icalbdbset_options::subdb
icalbdbset_subdb_type subdb
Definition: icalbdbset.h:158
-
icalbdbset_options::mode
int mode
Definition: icalbdbset.h:160
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-
icalset_impl
Definition: icalset.h:52
-
icalsetiter
Definition: icalset.h:43
+
icalbdbset_impl
Definition: icalbdbsetimpl.h:28
+
icalbdbset_options
Definition: icalbdbset.h:165
+
icalbdbset_options::dbtype
int dbtype
Definition: icalbdbset.h:167
+
icalbdbset_options::flag
u_int32_t flag
Definition: icalbdbset.h:169
+
icalbdbset_options::subdb
icalbdbset_subdb_type subdb
Definition: icalbdbset.h:166
+
icalbdbset_options::mode
int mode
Definition: icalbdbset.h:168
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
+
icalset_impl
Definition: icalset.h:61
+
icalsetiter
Definition: icalset.h:52
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalbdbset__cxx_8h.html b/apidocs/icalbdbset__cxx_8h.html index 0b5b95ad..df225ffc 100644 --- a/apidocs/icalbdbset__cxx_8h.html +++ b/apidocs/icalbdbset__cxx_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalbdbset_cxx.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures
-
icalbdbset_cxx.h File Reference
+
+
icalbdbset_cxx.h File Reference
@@ -77,20 +78,23 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

class  LibICal::ICalBDBSet
 

Detailed Description

-

Definition of C++ Wrapper for icalbdbset.c.

+

Definition of C++ Wrapper for icalbdbset.c.

Author
dml 12/12/01
-

SPDX-FileCopyrightText: 2001, Critical Path

-

SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0

+

(C) COPYRIGHT 2001, Critical Path

+

This library is free software; you can redistribute it and/or modify it under the terms of either:

+

The LGPL as published by the Free Software Foundation, version 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html

+

Or:

+

The Mozilla Public License Version 2.0. You may obtain a copy of the License at https://www.mozilla.org/MPL/

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalbdbset__cxx_8h_source.html b/apidocs/icalbdbset__cxx_8h_source.html index b339fddb..91c84eed 100644 --- a/apidocs/icalbdbset__cxx_8h_source.html +++ b/apidocs/icalbdbset__cxx_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalbdbset_cxx.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalbdbset_cxx.h
+
+
icalbdbset_cxx.h
-Go to the documentation of this file.
1
-
11#ifndef ICALBDBSET_CXX_H
-
12#define ICALBDBSET_CXX_H
-
13
-
14#include "libical_icalss_export.h"
-
15
-
16#include <string>
-
17
-
18namespace LibICal
-
19{
-
20
-
21 class VComponent;
-
22
-
23 class LIBICAL_ICALSS_EXPORT ICalBDBSet
-
24 {
-
25 public:
-
26
-
27 ICalBDBSet();
-
28 ICalBDBSet(const ICalBDBSet &);
-
29 ICalBDBSet(const std::string &path, int flags);
-
30 ICalBDBSet operator=(const ICalBDBSet &);
-
31 ~ICalBDBSet();
-
32
-
33 public:
-
34
-
35 void free();
-
36 std::string path();
-
37
-
38 icalerrorenum add_component(VComponent *child);
-
39 icalerrorenum remove_component(VComponent *child);
-
40 int count_components(icalcomponent_kind kind);
-
41
-
42 // Restrict the component returned by icalbdbset_first, _next to those
-
43 // that pass the gauge. _clear removes the gauge
-
44 icalerrorenum select(icalgauge *gauge);
-
45 void clear();
-
46
-
47 // Get and search for a component by uid
-
48 VComponent *fetch(std::string &uid);
-
49 VComponent *fetch_match(icalcomponent *c);
-
50 int has_uid(std::string &uid);
-
51
-
52 // Iterate through components. If a gauge has been defined, these
-
53 // will skip over components that do not pass the gauge
-
54 VComponent *get_current_component();
-
55 VComponent *get_first_component();
-
56 VComponent *get_next_component();
-
57
-
58 VComponent *get_component();
-
59
-
60 };
-
61
-
62} // namespace LibICal
-
63
-
64#endif
-
LibICal::ICalBDBSet
Definition: icalbdbset_cxx.h:24
-
LibICal::VComponent
A class wrapping the libical icalcomponent functions.
Definition: vcomponent_cxx.h:40
-
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:67
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
+Go to the documentation of this file.
1 
+
20 #ifndef ICALBDBSET_CXX_H
+
21 #define ICALBDBSET_CXX_H
+
22 
+
23 #include "libical_icalss_export.h"
+
24 
+
25 #include <string>
+
26 
+
27 namespace LibICal
+
28 {
+
29 
+
30  class VComponent;
+
31 
+
32  class LIBICAL_ICALSS_EXPORT ICalBDBSet
+
33  {
+
34  public:
+
35 
+
36  ICalBDBSet();
+
37  ICalBDBSet(const ICalBDBSet &);
+
38  ICalBDBSet(const std::string &path, int flags);
+
39  ICalBDBSet operator=(const ICalBDBSet &);
+
40  ~ICalBDBSet();
+
41 
+
42  public:
+
43 
+
44  void free();
+
45  std::string path();
+
46 
+
47  icalerrorenum add_component(VComponent *child);
+
48  icalerrorenum remove_component(VComponent *child);
+
49  int count_components(icalcomponent_kind kind);
+
50 
+
51  // Restrict the component returned by icalbdbset_first, _next to those
+
52  // that pass the gauge. _clear removes the gauge
+
53  icalerrorenum select(icalgauge *gauge);
+
54  void clear();
+
55 
+
56  // Get and search for a component by uid
+
57  VComponent *fetch(std::string &uid);
+
58  VComponent *fetch_match(icalcomponent *c);
+
59  int has_uid(std::string &uid);
+
60 
+
61  // Iterate through components. If a gauge has been defined, these
+
62  // will skip over components that do not pass the gauge
+
63  VComponent *get_current_component();
+
64  VComponent *get_first_component();
+
65  VComponent *get_next_component();
+
66 
+
67  VComponent *get_component();
+
68 
+
69  };
+
70 
+
71 } // namespace LibICal
+
72 
+
73 #endif
+
LibICal::ICalBDBSet
Definition: icalbdbset_cxx.h:33
+
LibICal::VComponent
A class wrapping the libical icalcomponent functions.
Definition: vcomponent_cxx.h:48
+
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:76
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalbdbsetimpl_8h_source.html b/apidocs/icalbdbsetimpl_8h_source.html index 6d783d3c..fbf872de 100644 --- a/apidocs/icalbdbsetimpl_8h_source.html +++ b/apidocs/icalbdbsetimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalbdbsetimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalbdbsetimpl.h
+
+
icalbdbsetimpl.h
-
1/*======================================================================
-
2 FILE: icalbdbsetimpl.h
-
3
-
4 SPDX-FileCopyrightText: 2001, Critical Path
-
5
-
6 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
7
-
8======================================================================*/
-
9
-
10#ifndef ICALBDBSETIMPL_H
-
11#define ICALBDBSETIMPL_H
-
12
-
13#include "icalset.h"
-
14#include <db.h>
-
15
-
16/* This definition is in its own file so it can be kept out of the
-
17 main header file, but used by "friend classes" like icaldirset*/
-
18
-
19struct icalbdbset_impl
-
20{
-
21 icalset super;
-
22 const char *path;
-
23 const char *subdb;
-
24 const char *sindex;
-
25 const char *key;
-
26 void *data;
-
27 int datasize;
-
28 int changed;
-
29 icalcomponent *cluster;
-
30 icalgauge *gauge;
-
31 DB_ENV *dbenv;
-
32 DB *dbp;
-
33 DB *sdbp;
-
34 DBC *dbcp;
-
35};
-
36
-
37#endif
+
1 /*======================================================================
+
2  FILE: icalbdbsetimpl.h
+
3 
+
4  (C) COPYRIGHT 2001, Critical Path
+
5 
+
6  This library is free software; you can redistribute it and/or modify
+
7  it under the terms of either:
+
8 
+
9  The LGPL as published by the Free Software Foundation, version
+
10  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
11 
+
12  Or:
+
13 
+
14  The Mozilla Public License Version 2.0. You may obtain a copy of
+
15  the License at https://www.mozilla.org/MPL/
+
16 ======================================================================*/
+
17 
+
18 #ifndef ICALBDBSETIMPL_H
+
19 #define ICALBDBSETIMPL_H
+
20 
+
21 #include "icalset.h"
+
22 #include <db.h>
+
23 
+
24 /* This definition is in its own file so it can be kept out of the
+
25  main header file, but used by "friend classes" like icaldirset*/
+
26 
+
27 struct icalbdbset_impl
+
28 {
+
29  icalset super;
+
30  const char *path;
+
31  const char *subdb;
+
32  const char *sindex;
+
33  const char *key;
+
34  void *data;
+
35  int datasize;
+
36  int changed;
+
37  icalcomponent *cluster;
+
38  icalgauge *gauge;
+
39  DB_ENV *dbenv;
+
40  DB *dbp;
+
41  DB *sdbp;
+
42  DBC *dbcp;
+
43 };
+
44 
+
45 #endif
-
icalbdbset_impl
Definition: icalbdbsetimpl.h:20
-
icalbdbset_impl::super
icalset super
Definition: icalbdbsetimpl.h:21
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-
icalset_impl
Definition: icalset.h:52
+
icalbdbset_impl
Definition: icalbdbsetimpl.h:28
+
icalbdbset_impl::super
icalset super
Definition: icalbdbsetimpl.h:29
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
+
icalset_impl
Definition: icalset.h:61
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalcalendar_8h.html b/apidocs/icalcalendar_8h.html index 1c6b50c6..878aa569 100644 --- a/apidocs/icalcalendar_8h.html +++ b/apidocs/icalcalendar_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcalendar.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
icalcalendar.h File Reference
+
+
icalcalendar.h File Reference
@@ -78,52 +79,52 @@ $(function() {

Go to the source code of this file.

- -

+

Typedefs

+
typedef struct icalcalendar_impl icalcalendar
 
- - - - - + - - + - - + - - + - - - - + -

+

Functions

+
void icalcalendar_free (icalcalendar *calendar)
 
+
icalset * icalcalendar_get_booked (icalcalendar *calendar)
 
+
 
icalset * icalcalendar_get_freebusy (icalcalendar *calendar)
 
+
 
icalset * icalcalendar_get_incoming (icalcalendar *calendar)
 
+
 
icalset * icalcalendar_get_properties (icalcalendar *calendar)
 
+
 
int icalcalendar_islocked (icalcalendar *calendar)
 
+
int icalcalendar_lock (icalcalendar *calendar)
 
+
icalcalendar * icalcalendar_new (const char *dir)
 
+
 
int icalcalendar_ownlock (icalcalendar *calendar)
 
+
int icalcalendar_unlock (icalcalendar *calendar)
 

Detailed Description

-

Routines for storing calendar data in a file system.

-

The calendar has two icaldirsets, one for incoming components and one for booked components. It also has interfaces to access the free/busy list and a list of calendar properties

+

Routines for storing calendar data in a file system.

+

The calendar has two icaldirsets, one for incoming components and one for booked components. It also has interfaces to access the free/busy list and a list of calendar properties

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalcalendar_8h_source.html b/apidocs/icalcalendar_8h_source.html index 69d2c044..7e990eaa 100644 --- a/apidocs/icalcalendar_8h_source.html +++ b/apidocs/icalcalendar_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcalendar.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalcalendar.h
+
+
icalcalendar.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalcalendar.h
-
3 CREATOR: eric 23 December 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
13#ifndef ICALCALENDAR_H
-
14#define ICALCALENDAR_H
-
15
-
16#include "libical_icalss_export.h"
-
17#include "icalset.h"
-
18
-
28typedef struct icalcalendar_impl icalcalendar;
-
29
-
30LIBICAL_ICALSS_EXPORT icalcalendar *icalcalendar_new(const char *dir);
-
31
-
32LIBICAL_ICALSS_EXPORT void icalcalendar_free(icalcalendar *calendar);
-
33
-
34LIBICAL_ICALSS_EXPORT int icalcalendar_lock(icalcalendar *calendar);
-
35
-
36LIBICAL_ICALSS_EXPORT int icalcalendar_unlock(icalcalendar *calendar);
-
37
-
38LIBICAL_ICALSS_EXPORT int icalcalendar_islocked(icalcalendar *calendar);
-
39
-
40LIBICAL_ICALSS_EXPORT int icalcalendar_ownlock(icalcalendar *calendar);
-
41
-
42LIBICAL_ICALSS_EXPORT icalset *icalcalendar_get_booked(icalcalendar *calendar);
-
43
-
44LIBICAL_ICALSS_EXPORT icalset *icalcalendar_get_incoming(icalcalendar *calendar);
-
45
-
46LIBICAL_ICALSS_EXPORT icalset *icalcalendar_get_properties(icalcalendar *calendar);
-
47
-
48LIBICAL_ICALSS_EXPORT icalset *icalcalendar_get_freebusy(icalcalendar *calendar);
-
49
-
50#endif /* !ICALCALENDAR_H */
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalcalendar.h
+
3  CREATOR: eric 23 December 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
22 #ifndef ICALCALENDAR_H
+
23 #define ICALCALENDAR_H
+
24 
+
25 #include "libical_icalss_export.h"
+
26 #include "icalset.h"
+
27 
+
37 typedef struct icalcalendar_impl icalcalendar;
+
38 
+
39 LIBICAL_ICALSS_EXPORT icalcalendar *icalcalendar_new(const char *dir);
+
40 
+
41 LIBICAL_ICALSS_EXPORT void icalcalendar_free(icalcalendar *calendar);
+
42 
+
43 LIBICAL_ICALSS_EXPORT int icalcalendar_lock(icalcalendar *calendar);
+
44 
+
45 LIBICAL_ICALSS_EXPORT int icalcalendar_unlock(icalcalendar *calendar);
+
46 
+
47 LIBICAL_ICALSS_EXPORT int icalcalendar_islocked(icalcalendar *calendar);
+
48 
+
49 LIBICAL_ICALSS_EXPORT int icalcalendar_ownlock(icalcalendar *calendar);
+
50 
+
51 LIBICAL_ICALSS_EXPORT icalset *icalcalendar_get_booked(icalcalendar *calendar);
+
52 
+
53 LIBICAL_ICALSS_EXPORT icalset *icalcalendar_get_incoming(icalcalendar *calendar);
+
54 
+
55 LIBICAL_ICALSS_EXPORT icalset *icalcalendar_get_properties(icalcalendar *calendar);
+
56 
+
57 LIBICAL_ICALSS_EXPORT icalset *icalcalendar_get_freebusy(icalcalendar *calendar);
+
58 
+
59 #endif /* !ICALCALENDAR_H */
-
icalcalendar_impl
Definition: icalcalendar.c:30
-
icalset_impl
Definition: icalset.h:52
+
icalcalendar_impl
Definition: icalcalendar.c:38
+
icalset_impl
Definition: icalset.h:61
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalclassify_8h_source.html b/apidocs/icalclassify_8h_source.html index f5596bdb..83f3b183 100644 --- a/apidocs/icalclassify_8h_source.html +++ b/apidocs/icalclassify_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalclassify.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalclassify.h
+
+
icalclassify.h
-
1/*======================================================================
-
2 FILE: icalclassify.h
-
3 CREATOR: eric 21 Aug 2000
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 =========================================================================*/
-
10
-
11#ifndef ICALCLASSIFY_H
-
12#define ICALCLASSIFY_H
-
13
-
14#include "libical_icalss_export.h"
-
15#include "icalset.h"
-
16#include "icalcomponent.h"
-
17
-
18LIBICAL_ICALSS_EXPORT icalproperty_xlicclass icalclassify(icalcomponent *c,
-
19 icalcomponent *match, const char *user);
-
20
-
21LIBICAL_ICALSS_EXPORT icalcomponent *icalclassify_find_overlaps(icalset *set,
-
22 icalcomponent *comp);
-
23
-
24#endif /* ICALCLASSIFY_H */
+
1 /*======================================================================
+
2  FILE: icalclassify.h
+
3  CREATOR: eric 21 Aug 2000
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17  =========================================================================*/
+
18 
+
19 #ifndef ICALCLASSIFY_H
+
20 #define ICALCLASSIFY_H
+
21 
+
22 #include "libical_icalss_export.h"
+
23 #include "icalset.h"
+
24 #include "icalcomponent.h"
+
25 
+
26 LIBICAL_ICALSS_EXPORT icalproperty_xlicclass icalclassify(icalcomponent *c,
+
27  icalcomponent *match, const char *user);
+
28 
+
29 LIBICAL_ICALSS_EXPORT icalcomponent *icalclassify_find_overlaps(icalset *set,
+
30  icalcomponent *comp);
+
31 
+
32 #endif /* ICALCLASSIFY_H */
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalset_impl
Definition: icalset.h:52
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalset_impl
Definition: icalset.h:61
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalcluster_8h_source.html b/apidocs/icalcluster_8h_source.html index 12ade5fb..d681a230 100644 --- a/apidocs/icalcluster_8h_source.html +++ b/apidocs/icalcluster_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcluster.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalcluster.h
+
+
icalcluster.h
-
1/*======================================================================
-
2 FILE: icalcluster.h
-
3 CREATOR: acampi 13 March 2002
-
4
-
5 SPDX-FileCopyrightText: 2002 Andrea Campi <a.campi@inet.it>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALCLUSTER_H
-
12#define ICALCLUSTER_H
-
13
-
14#include "libical_deprecated.h"
-
15#include "libical_icalss_export.h"
-
16#include "icalcomponent.h"
-
17#include "icalerror.h"
-
18
-
19typedef struct icalcluster_impl icalcluster;
-
20
-
26LIBICAL_ICALSS_EXPORT icalcluster *icalcluster_new(const char *key, icalcomponent *data);
-
27
-
33LIBICAL_ICALSS_EXPORT icalcluster *icalcluster_clone(const icalcluster *cluster);
-
34
-
35LIBICAL_ICALSS_EXPORT void icalcluster_free(icalcluster *cluster);
-
36
-
37LIBICAL_ICALSS_EXPORT const char *icalcluster_key(icalcluster *cluster);
-
38
-
39LIBICAL_ICALSS_EXPORT int icalcluster_is_changed(icalcluster *cluster);
-
40
-
41LIBICAL_ICALSS_EXPORT void icalcluster_mark(icalcluster *cluster);
-
42
-
43LIBICAL_ICALSS_EXPORT void icalcluster_commit(icalcluster *cluster);
-
44
-
45LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_component(icalcluster *cluster);
-
46
-
47LIBICAL_ICALSS_EXPORT int icalcluster_count_components(icalcluster *cluster,
-
48 icalcomponent_kind kind);
-
49
-
50LIBICAL_ICALSS_EXPORT icalerrorenum icalcluster_add_component(icalcluster *cluster,
-
51 icalcomponent *child);
-
52
-
53LIBICAL_ICALSS_EXPORT icalerrorenum icalcluster_remove_component(icalcluster *cluster,
-
54 icalcomponent *child);
-
55
-
56LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_current_component(icalcluster *cluster);
-
57
-
58LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_first_component(icalcluster *cluster);
-
59
-
60LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_next_component(icalcluster *cluster);
-
61
-
66LIBICAL_ICALSS_EXPORT LIBICAL_DEPRECATED(icalcluster *icalcluster_new_clone(
-
67 const icalcluster *cluster));
-
68
-
69#endif /* !ICALCLUSTER_H */
+
1 /*======================================================================
+
2  FILE: icalcluster.h
+
3  CREATOR: acampi 13 March 2002
+
4 
+
5  Copyright (C) 2002 Andrea Campi <a.campi@inet.it>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALCLUSTER_H
+
20 #define ICALCLUSTER_H
+
21 
+
22 #include "libical_icalss_export.h"
+
23 #include "icalcomponent.h"
+
24 #include "icalerror.h"
+
25 
+
26 typedef struct icalcluster_impl icalcluster;
+
27 
+
28 LIBICAL_ICALSS_EXPORT icalcluster *icalcluster_new(const char *key, icalcomponent *data);
+
29 
+
30 LIBICAL_ICALSS_EXPORT icalcluster *icalcluster_new_clone(const icalcluster *cluster);
+
31 
+
32 LIBICAL_ICALSS_EXPORT void icalcluster_free(icalcluster *cluster);
+
33 
+
34 LIBICAL_ICALSS_EXPORT const char *icalcluster_key(icalcluster *cluster);
+
35 
+
36 LIBICAL_ICALSS_EXPORT int icalcluster_is_changed(icalcluster *cluster);
+
37 
+
38 LIBICAL_ICALSS_EXPORT void icalcluster_mark(icalcluster *cluster);
+
39 
+
40 LIBICAL_ICALSS_EXPORT void icalcluster_commit(icalcluster *cluster);
+
41 
+
42 LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_component(icalcluster *cluster);
+
43 
+
44 LIBICAL_ICALSS_EXPORT int icalcluster_count_components(icalcluster *cluster,
+
45  icalcomponent_kind kind);
+
46 
+
47 LIBICAL_ICALSS_EXPORT icalerrorenum icalcluster_add_component(icalcluster *cluster,
+
48  icalcomponent *child);
+
49 
+
50 LIBICAL_ICALSS_EXPORT icalerrorenum icalcluster_remove_component(icalcluster *cluster,
+
51  icalcomponent *child);
+
52 
+
53 LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_current_component(icalcluster *cluster);
+
54 
+
55 LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_first_component(icalcluster *cluster);
+
56 
+
57 LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_next_component(icalcluster *cluster);
+
58 
+
59 #endif /* !ICALCLUSTER_H */
icalerror.h
Error handling for libical.
-
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:67
-
icalcluster_impl
Definition: icalclusterimpl.h:20
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:76
+
icalcluster_impl
Definition: icalclusterimpl.h:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalclusterimpl_8h_source.html b/apidocs/icalclusterimpl_8h_source.html index 0f50028a..34dc0dda 100644 --- a/apidocs/icalclusterimpl_8h_source.html +++ b/apidocs/icalclusterimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalclusterimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalclusterimpl.h
+
+
icalclusterimpl.h
-
1/*======================================================================
-
2 FILE: icalfilesetimpl.h
-
3 CREATOR: acampi 13 March 2002
-
4
-
5 SPDX-FileCopyrightText: 2002 Andrea Campi <a.campi@inet.it>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALCLUSTERIMPL_H
-
12#define ICALCLUSTERIMPL_H
-
13
-
14/* This definition is in its own file so it can be kept out of the
-
15 main header file, but used by "friend classes" like icaldirset*/
-
16
-
17#define ICALCLUSTER_ID "clus"
-
18
-
19struct icalcluster_impl
-
20{
-
21 char id[5]; /* clus */
-
22
-
23 char *key;
-
24 icalcomponent *data;
-
25 int changed;
-
26};
-
27
-
28#endif
-
icalcluster_impl
Definition: icalclusterimpl.h:20
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
1 /*======================================================================
+
2  FILE: icalfilesetimpl.h
+
3  CREATOR: acampi 13 March 2002
+
4 
+
5  Copyright (C) 2002 Andrea Campi <a.campi@inet.it>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALCLUSTERIMPL_H
+
20 #define ICALCLUSTERIMPL_H
+
21 
+
22 /* This definition is in its own file so it can be kept out of the
+
23  main header file, but used by "friend classes" like icaldirset*/
+
24 
+
25 #define ICALCLUSTER_ID "clus"
+
26 
+
27 struct icalcluster_impl
+
28 {
+
29  char id[5]; /* clus */
+
30 
+
31  char *key;
+
32  icalcomponent *data;
+
33  int changed;
+
34 };
+
35 
+
36 #endif
+
icalcluster_impl
Definition: icalclusterimpl.h:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalcomponent_8h.html b/apidocs/icalcomponent_8h.html index 2caef850..f68b4a20 100644 --- a/apidocs/icalcomponent_8h.html +++ b/apidocs/icalcomponent_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcomponent.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures | Typedefs | Functions
-
icalcomponent.h File Reference
+
+
icalcomponent.h File Reference

Go to the source code of this file.

-

+

Data Structures

struct  icalcompiter
 
- - -

+

Typedefs

+
typedef struct icalcompiter icalcompiter
 
+
typedef struct icalcomponent_impl icalcomponent
 
- - - - + - - + - - + - - - - + - - + - - - - - + - - - - + - - - - - - - - + - - + - - + - + - @@ -180,176 +173,165 @@ struct icaltimetype < - - - + - - - - - - - + + + + + + - - + + - - - + - - + - - + - - - - + + + - - - - - - - + + + + - - - - + - - - - - + - - - - - - - - - - - - + + + + + + + + + - - + - - + - - + - - + - - + - - + - - - - + - - + - - + - - - - + - - + - - + - - - - - + + + + - - + - - + - - + - - + - + - - - - - @@ -361,55 +343,51 @@ void  - - + - - - - - - - - - - + - - - + + + - - - + + + @@ -418,28 +396,7 @@ void 

+

Functions

+
icalcomponent * icalcompiter_deref (icalcompiter *i)
 
+
 
icalcomponent * icalcompiter_next (icalcompiter *i)
 
+
 
icalcomponent * icalcompiter_prior (icalcompiter *i)
 
+
 
void icalcomponent_add_component (icalcomponent *parent, icalcomponent *child)
 
+
void icalcomponent_add_property (icalcomponent *component, icalproperty *property)
 
+
char * icalcomponent_as_ical_string (icalcomponent *component)
 
+
 
char * icalcomponent_as_ical_string_r (icalcomponent *component)
 
+
 
icalcompiter icalcomponent_begin_component (icalcomponent *component, icalcomponent_kind kind)
 
+
int icalcomponent_check_restrictions (icalcomponent *comp)
 
icalcomponent * icalcomponent_clone (const icalcomponent *component)
 Deeply clones an icalcomponent. Returns a pointer to the memory for the newly cloned icalcomponent. More...
 
-void icalcomponent_convert_errors (icalcomponent *component)
+void icalcomponent_convert_errors (icalcomponent *component)
 Converts some X-LIC-ERROR properties into RETURN-STATUS properties.
 
+
int icalcomponent_count_components (icalcomponent *component, icalcomponent_kind kind)
 
int icalcomponent_count_errors (icalcomponent *component)
 Returns the number of errors encountered parsing the data. More...
 
+
int icalcomponent_count_properties (icalcomponent *component, icalproperty_kind kind)
 
+
icalcompiter icalcomponent_end_component (icalcomponent *component, icalcomponent_kind kind)
 
void icalcomponent_foreach_recurrence (icalcomponent *comp, struct icaltimetype start, struct icaltimetype end, void(*callback)(icalcomponent *comp, struct icaltime_span *span, void *data), void *callback_data)
 Cycles through all recurrences of an event. More...
 
-void icalcomponent_foreach_tzid (icalcomponent *comp, void(*callback)(icalparameter *param, void *data), void *callback_data)
+void icalcomponent_foreach_tzid (icalcomponent *comp, void(*callback)(icalparameter *param, void *data), void *callback_data)
 Calls the given function for each TZID parameter found in the component, and any subcomponents.
 
+
void icalcomponent_free (icalcomponent *component)
 
+
const char * icalcomponent_get_comment (icalcomponent *comp)
 
const char * icalcomponent_get_component_name (const icalcomponent *comp)
 
-char * icalcomponent_get_component_name_r (const icalcomponent *comp)
 
+
 
icalcomponent * icalcomponent_get_current_component (icalcomponent *component)
 
+
 
icalproperty * icalcomponent_get_current_property (icalcomponent *component)
 
+
 
const char * icalcomponent_get_description (icalcomponent *comp)
 
 
struct icaltimetype icalcomponent_get_dtend (icalcomponent *comp)
 Gets the DTEND property as an icaltime. More...
 
+
struct icaltimetype icalcomponent_get_dtstamp (icalcomponent *comp)
 
struct icaltimetype icalcomponent_get_dtstart (icalcomponent *comp)
struct icaldurationtype icalcomponent_get_duration (icalcomponent *comp)
 Gets the DURATION property as an icalduration. More...
 
+
icalcomponent * icalcomponent_get_first_component (icalcomponent *component, icalcomponent_kind kind)
 
+
 
icalproperty * icalcomponent_get_first_property (icalcomponent *component, icalproperty_kind kind)
 
-icalcomponent * icalcomponent_get_first_real_component (icalcomponent *c)
 Returns a reference to the first VEVENT, VTODO or VJOURNAL in the component.
 
icalcomponent * icalcomponent_get_inner (icalcomponent *comp)
 
+
 
+icalcomponent * icalcomponent_get_first_real_component (icalcomponent *c)
 Returns a reference to the first VEVENT, VTODO or VJOURNAL in the component.
 
icalcomponent * icalcomponent_get_inner (icalcomponent *comp)
 
const char * icalcomponent_get_location (icalcomponent *comp)
 
-icalproperty_method icalcomponent_get_method (icalcomponent *comp)
 
+icalproperty_method icalcomponent_get_method (icalcomponent *comp)
 Returns the METHOD property.
 
+
icalcomponent * icalcomponent_get_next_component (icalcomponent *component, icalcomponent_kind kind)
 
+
 
icalproperty * icalcomponent_get_next_property (icalcomponent *component, icalproperty_kind kind)
 
+
 
icalcomponent * icalcomponent_get_parent (icalcomponent *component)
 
+
 
struct icaltimetype icalcomponent_get_recurrenceid (icalcomponent *comp)
 
const char * icalcomponent_get_relcalid (icalcomponent *comp)
 Gets the RELCALID property of a component. More...
 
+
const char * icalcomponent_get_relcalid (icalcomponent *comp)
 Gets the RELCALID property of a component. More...
 
int icalcomponent_get_sequence (icalcomponent *comp)
 
struct icaltime_span icalcomponent_get_span (icalcomponent *comp)
 Gets the timespan covered by this component, in UTC. More...
 
+
enum icalproperty_status icalcomponent_get_status (icalcomponent *comp)
 
+
const char * icalcomponent_get_summary (icalcomponent *comp)
 
-icaltimezone * icalcomponent_get_timezone (icalcomponent *comp, const char *tzid)
 Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.
 
+
 
+icaltimezone * icalcomponent_get_timezone (icalcomponent *comp, const char *tzid)
 Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.
 
const char * icalcomponent_get_uid (icalcomponent *comp)
 
-const char * icalcomponent_get_x_name (icalcomponent *comp)
 
+
 
int icalcomponent_is_valid (icalcomponent *component)
 
+
icalcomponent_kind icalcomponent_isa (const icalcomponent *component)
 
+
int icalcomponent_isa_component (void *component)
 
+
int icalcomponent_kind_is_valid (const icalcomponent_kind kind)
 
+
const char * icalcomponent_kind_to_string (icalcomponent_kind kind)
 
 
void icalcomponent_merge_component (icalcomponent *comp, icalcomponent *comp_to_merge)
 
-icalcomponent * icalcomponent_new (icalcomponent_kind kind)
 Constructor.
 
icalcomponent * icalcomponent_new_clone (icalcomponent *component))
 Deeply clones an icalcomponent. Returns a pointer to the memory for the newly cloned icalcomponent. More...
 
-icalcomponent * icalcomponent_new_from_string (const char *str)
 Constructor.
 
-icalcomponent * icalcomponent_new_participant (void)
 
+
+icalcomponent * icalcomponent_new (icalcomponent_kind kind)
 Constructor.
 
+icalcomponent * icalcomponent_new_clone (icalcomponent *component)
 Constructor.
 
+icalcomponent * icalcomponent_new_from_string (const char *str)
 Constructor.
 
icalcomponent * icalcomponent_new_vagenda (void)
 
+
 
icalcomponent * icalcomponent_new_valarm (void)
 
+
 
icalcomponent * icalcomponent_new_vavailability (void)
 
+
 
icalcomponent * icalcomponent_new_vcalendar (void)
 
+
 
icalcomponent * icalcomponent_new_vevent (void)
 
+
 
icalcomponent * icalcomponent_new_vfreebusy (void)
 
+
 
icalcomponent * icalcomponent_new_vjournal (void)
 
-icalcomponent * icalcomponent_new_vlocation (void)
 
+
 
icalcomponent * icalcomponent_new_vpatch (void)
 
+
 
icalcomponent * icalcomponent_new_vpoll (void)
 
+
 
icalcomponent * icalcomponent_new_vquery (void)
 
-icalcomponent * icalcomponent_new_vresource (void)
 
+
 
icalcomponent * icalcomponent_new_vtimezone (void)
 
+
 
icalcomponent * icalcomponent_new_vtodo (void)
 
+
 
icalcomponent * icalcomponent_new_vvoter (void)
 
-icalcomponent * icalcomponent_new_x (const char *x_name)
 Constructor.
 
+
 
+icalcomponent * icalcomponent_new_x (const char *x_name)
 Constructor.
 
icalcomponent * icalcomponent_new_xavailable (void)
 
+
 
icalcomponent * icalcomponent_new_xdaylight (void)
 
+
 
icalcomponent * icalcomponent_new_xpatch (void)
 
+
 
icalcomponent * icalcomponent_new_xstandard (void)
 
+
 
icalcomponent * icalcomponent_new_xvote (void)
 
 
void icalcomponent_normalize (icalcomponent *comp)
 Normalizes (reorders and sorts the properties) the specified icalcomponent comp. More...
 
+
void icalcomponent_remove_component (icalcomponent *parent, icalcomponent *child)
 
+
void icalcomponent_remove_property (icalcomponent *component, icalproperty *property)
 
+
void icalcomponent_set_comment (icalcomponent *comp, const char *v)
 
+
void icalcomponent_set_description (icalcomponent *comp, const char *v)
 
void icalcomponent_set_dtend (icalcomponent *comp, struct icaltimetype v)
 Sets the DTEND property to given icaltime. More...
 
+
void icalcomponent_set_dtstamp (icalcomponent *comp, struct icaltimetype v)
 
void icalcomponent_set_dtstart (icalcomponent *comp, struct icaltimetype v)
icalcomponent_set_dts
void icalcomponent_set_duration (icalcomponent *comp, struct icaldurationtype v)
 Sets the DURATION property to given icalduration. More...
 
+
void icalcomponent_set_location (icalcomponent *comp, const char *v)
 
-void icalcomponent_set_method (icalcomponent *comp, icalproperty_method method)
+void icalcomponent_set_method (icalcomponent *comp, icalproperty_method method)
 Sets the METHOD property to the given method.
 
+
void icalcomponent_set_parent (icalcomponent *component, icalcomponent *parent)
 
+
void icalcomponent_set_recurrenceid (icalcomponent *comp, struct icaltimetype v)
 
void icalcomponent_set_relcalid (icalcomponent *comp, const char *v)
 Sets the RELCALID property of a component. More...
 
+
void icalcomponent_set_sequence (icalcomponent *comp, int v)
 
+
void icalcomponent_set_status (icalcomponent *comp, enum icalproperty_status v)
 
+
void icalcomponent_set_summary (icalcomponent *comp, const char *v)
 
+
void icalcomponent_set_uid (icalcomponent *comp, const char *v)
 
-void icalcomponent_set_x_name (icalcomponent *comp, const char *name)
 
+
icalcomponent_kind icalcomponent_string_to_kind (const char *string)
 
-void icalcomponent_strip_errors (icalcomponent *component)
+void icalcomponent_strip_errors (icalcomponent *component)
 Removes all X-LIC-ERROR properties.
 
-icalcomponent * icalcomponent_vanew (icalcomponent_kind kind,...)
 Constructor.
 
icalcomponent * icalcomponent_vanew (icalcomponent_kind kind,...)
 Constructor. More...
 
struct icaltimetype icalproperty_get_datetime_with_component (icalproperty *prop, icalcomponent *comp)
 Gets a DATE or DATE-TIME property as an icaltime. More...
 
-icalcomponent * icalproperty_get_parent (const icalproperty *property)
 Returns the parent icalcomponent for the specified property.
 
+icalcomponent * icalproperty_get_parent (const icalproperty *property)
 Returns the parent icalcomponent for the specified property.
 
int icalproperty_recurrence_is_excluded (icalcomponent *comp, struct icaltimetype *dtstart, struct icaltimetype *recurtime)
 Decides if a recurrence is acceptable. More...
 
icalcomponent_strip_e
 

Function Documentation

- -

◆ icalcomponent_clone()

- -
-
- - - - - - - - -
icalcomponent * icalcomponent_clone (const icalcomponent * component)
-
- -

Deeply clones an icalcomponent. Returns a pointer to the memory for the newly cloned icalcomponent.

-
Since
3.1.0
- -
-
- +

◆ icalcomponent_count_errors()

@@ -456,11 +413,11 @@ void icalcomponent_strip_e

Returns the number of errors encountered parsing the data.

-

This function counts the number times the X-LIC-ERROR occurs in the data structure.

+

This function counts the number times the X-LIC-ERROR occurs in the data structure.

- +

◆ icalcomponent_foreach_recurrence()

@@ -516,31 +473,12 @@ void icalcomponent_strip_e

This function will call the specified callback function for once for the base value of DTSTART, and foreach recurring date/time value.

-

It will filter out events that are specified as an EXDATE or an EXRULE.

-

TODO: We do not filter out duplicate RRULES/RDATES TODO: We do not handle RDATEs with explicit periods

+

It will filter out events that are specified as an EXDATE or an EXRULE.

+

TODO: We do not filter out duplicate RRULES/RDATES TODO: We do not handle RDATEs with explicit periods

- -

◆ icalcomponent_get_component_name()

- -
-
- - - - - - - - -
const char * icalcomponent_get_component_name (const icalcomponent * comp)
-
-

Returns the name of the component – the type name converted to a string, or the value of _get_x_name if the type is and X component

- -
-
- +

◆ icalcomponent_get_dtend()

@@ -557,16 +495,16 @@ void icalcomponent_strip_e

Gets the DTEND property as an icaltime.

-

If a DTEND property is not present but a DURATION is, we use that to determine the proper end.

-

If DTSTART is a DATE-TIME with a timezone parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.

-

For the icalcomponent routines only, dtend and duration are tied together. If you call the get routine for one and the other exists, the routine will calculate the return value. That is, if there is a DTEND and you call get_duration, the routine will return the difference between DTEND and DTSTART.

-

When DURATION and DTEND are both missing, for VEVENT an implicit DTEND is calculated based of DTSTART; for AVAILABLE, VAVAILABILITY, and VFREEBUSY null-time is returned.

-

Returns null-time, unless called on AVAILABLE, VEVENT, VAVAILABILITY, or VFREEBUSY components.

-

FIXME this is useless until we can flag the failure

+

If a DTEND property is not present but a DURATION is, we use that to determine the proper end.

+

If DTSTART is a DATE-TIME with a timezone parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.

+

For the icalcomponent routines only, dtend and duration are tied together. If you call the get routine for one and the other exists, the routine will calculate the return value. That is, if there is a DTEND and you call get_duration, the routine will return the difference between DTEND and DTSTART.

+

When DURATION and DTEND are both missing, for VEVENT an implicit DTEND is calculated based of DTSTART; for AVAILABLE, VAVAILABILITY, and VFREEBUSY null-time is returned.

+

Returns null-time, unless called on AVAILABLE, VEVENT, VAVAILABILITY, or VFREEBUSY components.

+

FIXME this is useless until we can flag the failure

- +

◆ icalcomponent_get_dtstart()

@@ -583,12 +521,12 @@ void icalcomponent_strip_e

Gets the DTSTART property as an icaltime.

-

If DTSTART is a DATE-TIME with a timezone parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.

-

FIXME this is useless until we can flag the failure

+

If DTSTART is a DATE-TIME with a timezone parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.

+

FIXME this is useless until we can flag the failure

- +

◆ icalcomponent_get_due()

@@ -615,7 +553,7 @@ void icalcomponent_strip_e
- +

◆ icalcomponent_get_duration()

@@ -632,19 +570,19 @@ void icalcomponent_strip_e

Gets the DURATION property as an icalduration.

-

For the icalcomponent routines only, DTEND and DURATION are tied together. If you call the get routine for one and the other exists, the routine will calculate the return value. That is, if there is a DTEND and you call get_duration, the routine will return the difference between DTEND and DTSTART in AVAILABLE, VEVENT, or VAVAILABILITY; and the difference between DUE and DTSTART in VTODO. When both DURATION and DTEND are missing from VEVENT an implicit duration is returned, based on the value-type of DTSTART. Otherwise null-duration is returned.

-

FIXME We assume DTSTART and DTEND are not in different time zones. The standard actually allows different time zones.

+

For the icalcomponent routines only, DTEND and DURATION are tied together. If you call the get routine for one and the other exists, the routine will calculate the return value. That is, if there is a DTEND and you call get_duration, the routine will return the difference between DTEND and DTSTART in AVAILABLE, VEVENT, or VAVAILABILITY; and the difference between DUE and DTSTART in VTODO. When both DURATION and DTEND are missing from VEVENT an implicit duration is returned, based on the value-type of DTSTART. Otherwise null-duration is returned.

+

FIXME We assume DTSTART and DTEND are not in different time zones. The standard actually allows different time zones.

- -

◆ icalcomponent_get_inner()

+ +

◆ icalcomponent_get_inner()

- + @@ -652,18 +590,18 @@ void 
icalcomponent * icalcomponent_get_inner icalcomponent* icalcomponent_get_inner ( icalcomponent *  comp)icalcomponent_strip_e
-

Return the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types

+

Return the first VEVENT, VTODO or VJOURNAL sub-component of cop, or comp if it is one of those types

- -

◆ icalcomponent_get_relcalid()

+ +

◆ icalcomponent_get_relcalid()

- + @@ -682,7 +620,7 @@ void 
const char * icalcomponent_get_relcalid const char* icalcomponent_get_relcalid ( icalcomponent *  comp)icalcomponent_strip_e - +

◆ icalcomponent_get_span()

@@ -699,13 +637,13 @@ void 
icalcomponent_strip_e

Gets the timespan covered by this component, in UTC.

-

See icalcomponent_foreach_recurrence() for a better way to extract spans from an component.

-

This method can be called on either a VCALENDAR or any real component. If the VCALENDAR contains no real component, but contains a VTIMEZONE, we return that span instead. This might not be a desirable behavior; we keep it for now for backward compatibility, but it might be deprecated at a future time.

-

FIXME this API needs to be clarified. DTEND is defined as the first available time after the end of this event, so the span should actually end 1 second before DTEND.

+

See icalcomponent_foreach_recurrence() for a better way to extract spans from an component.

+

This method can be called on either a VCALENDAR or any real component. If the VCALENDAR contains no real component, but contains a VTIMEZONE, we return that span instead. This might not be a desirable behavior; we keep it for now for backward compatibility, but it might be deprecated at a future time.

+

FIXME this API needs to be clarified. DTEND is defined as the first available time after the end of this event, so the span should actually end 1 second before DTEND.

- +

◆ icalcomponent_merge_component()

@@ -730,33 +668,11 @@ void 
icalcomponent_strip_e
-

This takes 2 VCALENDAR components and merges the second one into the first, resolving any problems with conflicting TZIDs. comp_to_merge will no longer exist after calling this function.

+

This takes 2 VCALENDAR components and merges the second one into the first, resolving any problems with conflicting TZIDs. comp_to_merge will no longer exist after calling this function.

- -

◆ icalcomponent_new_clone()

- -
-
- - - - - - - - -
icalcomponent * icalcomponent_new_clone (icalcomponent * component)
-
- -

Deeply clones an icalcomponent. Returns a pointer to the memory for the newly cloned icalcomponent.

-
Since
3.1.0
-
Deprecated:
Use icalcomponent_clone() instead
- -
-
- +

◆ icalcomponent_normalize()

@@ -777,7 +693,7 @@ void icalcomponent_strip_e
- +

◆ icalcomponent_set_dtend()

@@ -804,13 +720,13 @@ void icalcomponent_strip_e

Sets the DTEND property to given icaltime.

-

This method respects the icaltime type (DATE vs DATE-TIME) and timezone (or lack thereof).

-

This also checks that a DURATION property isn't already there, and returns an error if it is. It's the caller's responsibility to remove it.

-

For the icalcomponent routines only, DTEND and DURATION are tied together. If you call this routine and DURATION exists, no action will be taken and icalerrno will be set to ICAL_MALFORMEDDATA_ERROR. If neither exists, the routine will create the appropriate property.

+

This method respects the icaltime type (DATE vs DATE-TIME) and timezone (or lack thereof).

+

This also checks that a DURATION property isn't already there, and returns an error if it is. It's the caller's responsibility to remove it.

+

For the icalcomponent routines only, DTEND and DURATION are tied together. If you call this routine and DURATION exists, no action will be taken and icalerrno will be set to ICAL_MALFORMEDDATA_ERROR. If neither exists, the routine will create the appropriate property.

- +

◆ icalcomponent_set_dtstart()

@@ -837,11 +753,11 @@ void icalcomponent_strip_e

Sets the DTSTART property to the given icaltime,.

-

This method respects the icaltime type (DATE vs DATE-TIME) and timezone (or lack thereof).

+

This method respects the icaltime type (DATE vs DATE-TIME) and timezone (or lack thereof).

- +

◆ icalcomponent_set_due()

@@ -883,7 +799,7 @@ void icalcomponent_strip_e
- +

◆ icalcomponent_set_duration()

@@ -910,13 +826,13 @@ void icalcomponent_strip_e

Sets the DURATION property to given icalduration.

-

This method respects the icaltime type (DATE vs DATE-TIME) and timezone (or lack thereof).

-

This also checks that a DTEND property isn't already there, and returns an error if it is. It's the caller's responsibility to remove it.

-

For the icalcomponent routines only, DTEND and DURATION are tied together. If you call this routine and DTEND exists, no action will be taken and icalerrno will be set to ICAL_MALFORMEDDATA_ERROR. If neither exists, the routine will create the appropriate property.

+

This method respects the icaltime type (DATE vs DATE-TIME) and timezone (or lack thereof).

+

This also checks that a DTEND property isn't already there, and returns an error if it is. It's the caller's responsibility to remove it.

+

For the icalcomponent routines only, DTEND and DURATION are tied together. If you call this routine and DTEND exists, no action will be taken and icalerrno will be set to ICAL_MALFORMEDDATA_ERROR. If neither exists, the routine will create the appropriate property.

- +

◆ icalcomponent_set_relcalid()

@@ -953,7 +869,38 @@ void icalcomponent_strip_e
- + +

◆ icalcomponent_vanew()

+ +
+
+ + + + + + + + + + + + + + + + + + +
icalcomponent* icalcomponent_vanew (icalcomponent_kind kind,
 ... 
)
+
+ +

Constructor.

+

Make sure to pass NULL (not 0) as the final argument!

+ +
+
+

◆ icalproperty_get_datetime_with_component()

@@ -980,15 +927,15 @@ void icalcomponent_strip_e

Gets a DATE or DATE-TIME property as an icaltime.

-

Computes the datetime corresponding to the specified icalproperty and icalcomponent. If the property is a DATE-TIME with a TZID parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.

-

Call icaltime_is_null_time() on the returned value to detect failures.

+

Computes the datetime corresponding to the specified icalproperty and icalcomponent. If the property is a DATE-TIME with a TZID parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.

+

Call icaltime_is_null_time() on the returned value to detect failures.

Since
3.0.5

If the property is a DATE-TIME with a TZID parameter and a corresponding VTIMEZONE is present in the component, the returned component will already be in the correct timezone; otherwise the caller is responsible for converting it.

-

The comp can be NULL, in which case the parent of the prop is used to find the corresponding time zone.

+

The comp can be NULL, in which case the parent of the prop is used to find the corresponding time zone.

- +

◆ icalproperty_recurrence_is_excluded()

@@ -1031,21 +978,21 @@ void icalcomponent_strip_e
Returns
true if the recurrence value is excluded, false otherwise.

This function decides if a specific recurrence value is excluded by EXRULE or EXDATE properties.

-

It's not the most efficient code. You might get better performance if you assume that recurtime is always increasing for each call. Then you could:

+

It's not the most efficient code. You might get better performance if you assume that recurtime is always increasing for each call. Then you could:

  • sort the EXDATE values
  • save the state of each EXRULE iterator for the next call.
-

In this case though you don't need to worry how you call this function. It will always return the correct result.

-

first test against the exdate values

-

MATCHED

-

Now test against the EXRULEs

-

MATCH

-

exrule_time > recurtime

+

In this case though you don't need to worry how you call this function. It will always return the correct result.

+

first test against the exdate values

+

MATCHED

+

Now test against the EXRULEs

+

MATCH

+

exrule_time > recurtime

- +

◆ icalproperty_set_parent()

@@ -1079,7 +1026,7 @@ void icalcomponent_strip_e
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalcomponent_8h_source.html b/apidocs/icalcomponent_8h_source.html index 633c59a3..bbc2ea4f 100644 --- a/apidocs/icalcomponent_8h_source.html +++ b/apidocs/icalcomponent_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcomponent.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalcomponent.h
+
+
icalcomponent.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalcomponent.h
-
3 CREATOR: eric 20 March 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
15#ifndef ICALCOMPONENT_H
-
16#define ICALCOMPONENT_H
-
17
-
18#include "libical_deprecated.h"
-
19#include "libical_ical_export.h"
-
20#include "icalenums.h" /* Defines icalcomponent_kind */
-
21#include "icalproperty.h"
-
22#include "pvl.h"
-
23
-
24typedef struct icalcomponent_impl icalcomponent;
-
25
-
26/* This is exposed so that callers will not have to allocate and
-
27 deallocate iterators. Pretend that you can't see it. */
-
28typedef struct icalcompiter
-
29{
-
30 icalcomponent_kind kind;
-
31 pvl_elem iter;
-
32
-
33} icalcompiter;
-
34
-
37LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new(icalcomponent_kind kind);
-
38
-
44LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_clone(const icalcomponent *component);
-
45
-
48LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_from_string(const char *str);
-
49
-
52LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_vanew(icalcomponent_kind kind, ...);
-
53
-
56LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_x(const char *x_name);
-
57
-
58/*** @brief Destructor
-
59 */
-
60LIBICAL_ICAL_EXPORT void icalcomponent_free(icalcomponent *component);
-
61
-
62LIBICAL_ICAL_EXPORT char *icalcomponent_as_ical_string(icalcomponent *component);
-
63
-
64LIBICAL_ICAL_EXPORT char *icalcomponent_as_ical_string_r(icalcomponent *component);
-
65
-
66LIBICAL_ICAL_EXPORT int icalcomponent_is_valid(icalcomponent *component);
-
67
-
68LIBICAL_ICAL_EXPORT icalcomponent_kind icalcomponent_isa(const icalcomponent *component);
-
69
-
70LIBICAL_ICAL_EXPORT int icalcomponent_isa_component(void *component);
-
71
-
72/* Deal with X components */
-
73
-
74LIBICAL_ICAL_EXPORT void icalcomponent_set_x_name(icalcomponent *comp, const char *name);
-
75LIBICAL_ICAL_EXPORT const char *icalcomponent_get_x_name(icalcomponent *comp);
-
76
-
80LIBICAL_ICAL_EXPORT const char *icalcomponent_get_component_name(const icalcomponent *comp);
-
81LIBICAL_ICAL_EXPORT char *icalcomponent_get_component_name_r(const icalcomponent *comp);
-
82
-
87LIBICAL_ICAL_EXPORT LIBICAL_DEPRECATED(icalcomponent *icalcomponent_new_clone(
-
88 icalcomponent *component));
-
89
-
90/***** Working with Properties *****/
-
91
-
92LIBICAL_ICAL_EXPORT void icalcomponent_add_property(icalcomponent *component,
-
93 icalproperty *property);
-
94
-
95LIBICAL_ICAL_EXPORT void icalcomponent_remove_property(icalcomponent *component,
-
96 icalproperty *property);
-
97
-
98LIBICAL_ICAL_EXPORT int icalcomponent_count_properties(icalcomponent *component,
-
99 icalproperty_kind kind);
-
100
-
105LIBICAL_ICAL_EXPORT void icalproperty_set_parent(icalproperty *property,
-
106 icalcomponent *component);
-
107
-
111LIBICAL_ICAL_EXPORT icalcomponent *icalproperty_get_parent(const icalproperty *property);
-
112
-
113/* Iterate through the properties */
-
114LIBICAL_ICAL_EXPORT icalproperty *icalcomponent_get_current_property(icalcomponent *component);
-
115
-
116LIBICAL_ICAL_EXPORT icalproperty *icalcomponent_get_first_property(icalcomponent *component,
-
117 icalproperty_kind kind);
-
118LIBICAL_ICAL_EXPORT icalproperty *icalcomponent_get_next_property(icalcomponent *component,
-
119 icalproperty_kind kind);
-
120
-
121/***** Working with Components *****/
-
122
-
125LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_inner(icalcomponent *comp);
-
126
-
127LIBICAL_ICAL_EXPORT void icalcomponent_add_component(icalcomponent *parent, icalcomponent *child);
-
128
-
129LIBICAL_ICAL_EXPORT void icalcomponent_remove_component(icalcomponent *parent,
-
130 icalcomponent *child);
-
131
-
132LIBICAL_ICAL_EXPORT int icalcomponent_count_components(icalcomponent *component,
-
133 icalcomponent_kind kind);
-
134
-
140LIBICAL_ICAL_EXPORT void icalcomponent_merge_component(icalcomponent *comp,
-
141 icalcomponent *comp_to_merge);
-
142
-
143/* Iteration Routines. There are two forms of iterators, internal and
-
144external. The internal ones came first, and are almost completely
-
145sufficient, but they fail badly when you want to construct a loop that
-
146removes components from the container.*/
-
147
-
148/* Iterate through components */
-
149LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_current_component(icalcomponent *component);
-
150
-
151LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_first_component(icalcomponent *component,
-
152 icalcomponent_kind kind);
-
153LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_next_component(icalcomponent *component,
-
154 icalcomponent_kind kind);
-
155
-
156/* Using external iterators */
-
157LIBICAL_ICAL_EXPORT icalcompiter icalcomponent_begin_component(icalcomponent *component,
-
158 icalcomponent_kind kind);
-
159
-
160LIBICAL_ICAL_EXPORT icalcompiter icalcomponent_end_component(icalcomponent *component,
-
161 icalcomponent_kind kind);
-
162
-
163LIBICAL_ICAL_EXPORT icalcomponent *icalcompiter_next(icalcompiter * i);
-
164
-
165LIBICAL_ICAL_EXPORT icalcomponent *icalcompiter_prior(icalcompiter * i);
-
166
-
167LIBICAL_ICAL_EXPORT icalcomponent *icalcompiter_deref(icalcompiter * i);
-
168
-
169/***** Working with embedded error properties *****/
-
170
-
171/* Check the component against itip rules and insert error properties*/
-
172/* Working with embedded error properties */
-
173LIBICAL_ICAL_EXPORT int icalcomponent_check_restrictions(icalcomponent *comp);
-
174
-
180LIBICAL_ICAL_EXPORT int icalcomponent_count_errors(icalcomponent *component);
-
181
-
183LIBICAL_ICAL_EXPORT void icalcomponent_strip_errors(icalcomponent *component);
-
184
-
186LIBICAL_ICAL_EXPORT void icalcomponent_convert_errors(icalcomponent *component);
-
187
-
188/* Internal operations. They are private, and you should not be using them. */
-
189LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_parent(icalcomponent *component);
-
190
-
191LIBICAL_ICAL_EXPORT void icalcomponent_set_parent(icalcomponent *component,
-
192 icalcomponent *parent);
-
193
-
194/* Kind conversion routines */
-
195
-
196LIBICAL_ICAL_EXPORT int icalcomponent_kind_is_valid(const icalcomponent_kind kind);
-
197
-
198LIBICAL_ICAL_EXPORT icalcomponent_kind icalcomponent_string_to_kind(const char *string);
-
199
-
200LIBICAL_ICAL_EXPORT const char *icalcomponent_kind_to_string(icalcomponent_kind kind);
-
201
-
202/************* Derived class methods. ****************************
-
203
-
204If the code was in an OO language, the remaining routines would be
-
205members of classes derived from icalcomponent. Don't call them on the
-
206wrong component subtypes. */
-
207
-
211LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_first_real_component(icalcomponent *c);
-
212
-
229LIBICAL_ICAL_EXPORT struct icaltime_span icalcomponent_get_span(icalcomponent *comp);
-
230
-
231/******************** Convenience routines **********************/
-
232
-
238LIBICAL_ICAL_EXPORT void icalcomponent_set_dtstart(icalcomponent *comp, struct icaltimetype v);
-
239
-
249LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtstart(icalcomponent *comp);
-
250
-
251/* For the icalcomponent routines only, dtend and duration are tied
-
252 together. If you call the get routine for one and the other exists,
-
253 the routine will calculate the return value. That is, if there is a
-
254 DTEND and you call get_duration, the routine will return the difference
-
255 between DTEND and DTSTART. However, if you call a set routine for
-
256 one and the other exists, no action will be taken and icalerrno will
-
257 be set to ICAL_MALFORMEDDATA_ERROR. If you call a set routine and
-
258 neither exists, the routine will create the appropriate property. */
-
259
-
285LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtend(icalcomponent *comp);
-
286
-
302LIBICAL_ICAL_EXPORT void icalcomponent_set_dtend(icalcomponent *comp, struct icaltimetype v);
-
303
-
311LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_due(icalcomponent *comp);
-
312
-
324LIBICAL_ICAL_EXPORT void icalcomponent_set_due(icalcomponent *comp, struct icaltimetype v);
-
325
-
341LIBICAL_ICAL_EXPORT void icalcomponent_set_duration(icalcomponent *comp,
-
342 struct icaldurationtype v);
-
343
-
356LIBICAL_ICAL_EXPORT struct icaldurationtype icalcomponent_get_duration(icalcomponent *comp);
-
357
-
360LIBICAL_ICAL_EXPORT void icalcomponent_set_method(icalcomponent *comp, icalproperty_method method);
-
361
-
364LIBICAL_ICAL_EXPORT icalproperty_method icalcomponent_get_method(icalcomponent *comp);
-
365
-
366LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtstamp(icalcomponent *comp);
-
367
-
368LIBICAL_ICAL_EXPORT void icalcomponent_set_dtstamp(icalcomponent *comp, struct icaltimetype v);
-
369
-
370LIBICAL_ICAL_EXPORT void icalcomponent_set_summary(icalcomponent *comp, const char *v);
-
371
-
372LIBICAL_ICAL_EXPORT const char *icalcomponent_get_summary(icalcomponent *comp);
-
373
-
374LIBICAL_ICAL_EXPORT void icalcomponent_set_comment(icalcomponent *comp, const char *v);
-
375
-
376LIBICAL_ICAL_EXPORT const char *icalcomponent_get_comment(icalcomponent *comp);
-
377
-
378LIBICAL_ICAL_EXPORT void icalcomponent_set_uid(icalcomponent *comp, const char *v);
-
379
-
380LIBICAL_ICAL_EXPORT const char *icalcomponent_get_uid(icalcomponent *comp);
-
381
-
382LIBICAL_ICAL_EXPORT void icalcomponent_set_relcalid(icalcomponent *comp, const char *v);
-
383
-
384LIBICAL_ICAL_EXPORT const char *icalcomponent_get_relcalid(icalcomponent *comp);
-
385
-
386LIBICAL_ICAL_EXPORT void icalcomponent_set_recurrenceid(icalcomponent *comp,
-
387 struct icaltimetype v);
-
388
-
389LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_recurrenceid(icalcomponent *comp);
-
390
-
391LIBICAL_ICAL_EXPORT void icalcomponent_set_description(icalcomponent *comp, const char *v);
-
392
-
393LIBICAL_ICAL_EXPORT const char *icalcomponent_get_description(icalcomponent *comp);
-
394
-
395LIBICAL_ICAL_EXPORT void icalcomponent_set_location(icalcomponent *comp, const char *v);
-
396
-
397LIBICAL_ICAL_EXPORT const char *icalcomponent_get_location(icalcomponent *comp);
-
398
-
399LIBICAL_ICAL_EXPORT void icalcomponent_set_sequence(icalcomponent *comp, int v);
-
400
-
401LIBICAL_ICAL_EXPORT int icalcomponent_get_sequence(icalcomponent *comp);
-
402
-
403LIBICAL_ICAL_EXPORT void icalcomponent_set_status(icalcomponent *comp, enum icalproperty_status v);
-
404
-
405LIBICAL_ICAL_EXPORT enum icalproperty_status icalcomponent_get_status(icalcomponent *comp);
-
406
-
410LIBICAL_ICAL_EXPORT void icalcomponent_foreach_tzid(icalcomponent *comp,
-
411 void (*callback) (icalparameter *param,
-
412 void *data),
-
413 void *callback_data);
-
414
-
418LIBICAL_ICAL_EXPORT icaltimezone *icalcomponent_get_timezone(icalcomponent *comp,
-
419 const char *tzid);
-
420
-
443LIBICAL_ICAL_EXPORT int icalproperty_recurrence_is_excluded(icalcomponent *comp,
-
444 struct icaltimetype *dtstart,
-
445 struct icaltimetype *recurtime);
-
446
-
465LIBICAL_ICAL_EXPORT void icalcomponent_foreach_recurrence(icalcomponent *comp,
-
466 struct icaltimetype start,
-
467 struct icaltimetype end,
-
468 void (*callback) (icalcomponent *comp,
-
469 struct icaltime_span *
-
470 span, void *data),
-
471 void *callback_data);
-
472
-
477LIBICAL_ICAL_EXPORT void icalcomponent_normalize(icalcomponent *comp);
-
478
-
489LIBICAL_ICAL_EXPORT struct icaltimetype icalproperty_get_datetime_with_component(
-
490 icalproperty *prop,
-
491 icalcomponent *comp);
-
492/*************** Type Specific routines ***************/
-
493
-
494LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vcalendar(void);
-
495
-
496LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vevent(void);
-
497
-
498LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vtodo(void);
-
499
-
500LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vjournal(void);
-
501
-
502LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_valarm(void);
-
503
-
504LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vfreebusy(void);
-
505
-
506LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vtimezone(void);
-
507
-
508LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xstandard(void);
-
509
-
510LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xdaylight(void);
-
511
-
512LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vagenda(void);
-
513
-
514LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vquery(void);
-
515
-
516LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vavailability(void);
-
517
-
518LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xavailable(void);
-
519
-
520LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vpoll(void);
-
521
-
522LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vvoter(void);
-
523
-
524LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xvote(void);
-
525
-
526LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vpatch(void);
-
527
-
528LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xpatch(void);
-
529
-
530LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_participant(void);
-
531
-
532LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vlocation(void);
-
533
-
534LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vresource(void);
-
535
-
536#endif /* !ICALCOMPONENT_H */
-
icalcomponent_convert_errors
void icalcomponent_convert_errors(icalcomponent *component)
Converts some X-LIC-ERROR properties into RETURN-STATUS properties.
Definition: icalcomponent.c:1065
-
icalcomponent_set_relcalid
void icalcomponent_set_relcalid(icalcomponent *comp, const char *v)
Sets the RELCALID property of a component.
Definition: icalcomponent.c:2400
-
icalcomponent_get_dtend
struct icaltimetype icalcomponent_get_dtend(icalcomponent *comp)
Gets the DTEND property as an icaltime.
Definition: icalcomponent.c:1411
-
icalcomponent_get_dtstart
struct icaltimetype icalcomponent_get_dtstart(icalcomponent *comp)
Gets the DTSTART property as an icaltime.
Definition: icalcomponent.c:1398
-
icalcomponent_clone
icalcomponent * icalcomponent_clone(const icalcomponent *component)
Deeply clones an icalcomponent. Returns a pointer to the memory for the newly cloned icalcomponent.
Definition: icalcomponent.c:133
-
icalcomponent_get_method
icalproperty_method icalcomponent_get_method(icalcomponent *comp)
Returns the METHOD property.
Definition: icalcomponent.c:1356
-
icalcomponent_foreach_recurrence
void icalcomponent_foreach_recurrence(icalcomponent *comp, struct icaltimetype start, struct icaltimetype end, void(*callback)(icalcomponent *comp, struct icaltime_span *span, void *data), void *callback_data)
Cycles through all recurrences of an event.
Definition: icalcomponent.c:857
-
icalproperty_get_parent
icalcomponent * icalproperty_get_parent(const icalproperty *property)
Returns the parent icalcomponent for the specified property.
Definition: icalproperty.c:911
-
icalcomponent_set_dtstart
void icalcomponent_set_dtstart(icalcomponent *comp, struct icaltimetype v)
Sets the DTSTART property to the given icaltime,.
Definition: icalcomponent.c:1378
-
icalcomponent_strip_errors
void icalcomponent_strip_errors(icalcomponent *component)
Removes all X-LIC-ERROR properties.
Definition: icalcomponent.c:1039
-
icalcomponent_normalize
void icalcomponent_normalize(icalcomponent *comp)
Normalizes (reorders and sorts the properties) the specified icalcomponent comp.
Definition: icalcomponent.c:2623
-
icalproperty_get_datetime_with_component
struct icaltimetype icalproperty_get_datetime_with_component(icalproperty *prop, icalcomponent *comp)
Gets a DATE or DATE-TIME property as an icaltime.
Definition: icalproperty.c:1048
-
icalcomponent_vanew
icalcomponent * icalcomponent_vanew(icalcomponent_kind kind,...)
Constructor.
Definition: icalcomponent.c:110
-
icalcomponent_set_method
void icalcomponent_set_method(icalcomponent *comp, icalproperty_method method)
Sets the METHOD property to the given method.
Definition: icalcomponent.c:1344
-
icalcomponent_new
icalcomponent * icalcomponent_new(icalcomponent_kind kind)
Constructor.
Definition: icalcomponent.c:103
-
icalcomponent_get_inner
icalcomponent * icalcomponent_get_inner(icalcomponent *comp)
Definition: icalcomponent.c:1335
-
icalproperty_set_parent
void icalproperty_set_parent(icalproperty *property, icalcomponent *component)
Sets the parent icalcomponent for the specified icalproperty property.
Definition: icalproperty.c:904
-
icalcomponent_get_first_real_component
icalcomponent * icalcomponent_get_first_real_component(icalcomponent *c)
Returns a reference to the first VEVENT, VTODO or VJOURNAL in the component.
Definition: icalcomponent.c:650
-
icalcomponent_get_relcalid
const char * icalcomponent_get_relcalid(icalcomponent *comp)
Gets the RELCALID property of a component.
Definition: icalcomponent.c:2418
-
icalcomponent_get_due
struct icaltimetype icalcomponent_get_due(icalcomponent *comp)
Returns the time a VTODO task is DUE.
Definition: icalcomponent.c:2440
-
icalcomponent_merge_component
void icalcomponent_merge_component(icalcomponent *comp, icalcomponent *comp_to_merge)
Definition: icalcomponent.c:1987
-
icalcomponent_count_errors
int icalcomponent_count_errors(icalcomponent *component)
Returns the number of errors encountered parsing the data.
Definition: icalcomponent.c:1013
-
icalcomponent_get_duration
struct icaldurationtype icalcomponent_get_duration(icalcomponent *comp)
Gets the DURATION property as an icalduration.
Definition: icalcomponent.c:1510
-
icalproperty_recurrence_is_excluded
int icalproperty_recurrence_is_excluded(icalcomponent *comp, struct icaltimetype *dtstart, struct icaltimetype *recurtime)
Decides if a recurrence is acceptable.
Definition: icalcomponent.c:741
-
icalcomponent_get_timezone
icaltimezone * icalcomponent_get_timezone(icalcomponent *comp, const char *tzid)
Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.
Definition: icalcomponent.c:2272
-
icalcomponent_set_dtend
void icalcomponent_set_dtend(icalcomponent *comp, struct icaltimetype v)
Sets the DTEND property to given icaltime.
Definition: icalcomponent.c:1468
-
icalcomponent_get_span
struct icaltime_span icalcomponent_get_span(icalcomponent *comp)
Gets the timespan covered by this component, in UTC.
Definition: icalcomponent.c:673
-
icalcomponent_get_component_name
const char * icalcomponent_get_component_name(const icalcomponent *comp)
Definition: icalcomponent.c:354
-
icalcomponent_new_x
icalcomponent * icalcomponent_new_x(const char *x_name)
Constructor.
Definition: icalcomponent.c:166
-
icalcomponent_set_duration
void icalcomponent_set_duration(icalcomponent *comp, struct icaldurationtype v)
Sets the DURATION property to given icalduration.
Definition: icalcomponent.c:1493
-
icalcomponent_foreach_tzid
void icalcomponent_foreach_tzid(icalcomponent *comp, void(*callback)(icalparameter *param, void *data), void *callback_data)
Calls the given function for each TZID parameter found in the component, and any subcomponents.
Definition: icalcomponent.c:2235
-
icalcomponent_set_due
void icalcomponent_set_due(icalcomponent *comp, struct icaltimetype v)
Sets the due date of a VTODO task.
Definition: icalcomponent.c:2462
-
icalcomponent_new_from_string
icalcomponent * icalcomponent_new_from_string(const char *str)
Constructor.
Definition: icalcomponent.c:128
-
icalcomponent_new_clone
icalcomponent * icalcomponent_new_clone(icalcomponent *component))
Deeply clones an icalcomponent. Returns a pointer to the memory for the newly cloned icalcomponent.
Definition: icalcomponent.c:161
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalcomponent.h
+
3  CREATOR: eric 20 March 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
23 #ifndef ICALCOMPONENT_H
+
24 #define ICALCOMPONENT_H
+
25 
+
26 #include "libical_ical_export.h"
+
27 #include "icalenums.h" /* Defines icalcomponent_kind */
+
28 #include "icalproperty.h"
+
29 #include "pvl.h"
+
30 
+
31 typedef struct icalcomponent_impl icalcomponent;
+
32 
+
33 /* This is exposed so that callers will not have to allocate and
+
34  deallocate iterators. Pretend that you can't see it. */
+
35 typedef struct icalcompiter
+
36 {
+
37  icalcomponent_kind kind;
+
38  pvl_elem iter;
+
39 
+
40 } icalcompiter;
+
41 
+
44 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new(icalcomponent_kind kind);
+
45 
+
48 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_clone(icalcomponent *component);
+
49 
+
52 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_from_string(const char *str);
+
53 
+
58 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_vanew(icalcomponent_kind kind, ...);
+
59 
+
62 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_x(const char *x_name);
+
63 
+
64 /*** @brief Destructor
+
65  */
+
66 LIBICAL_ICAL_EXPORT void icalcomponent_free(icalcomponent *component);
+
67 
+
68 LIBICAL_ICAL_EXPORT char *icalcomponent_as_ical_string(icalcomponent *component);
+
69 
+
70 LIBICAL_ICAL_EXPORT char *icalcomponent_as_ical_string_r(icalcomponent *component);
+
71 
+
72 LIBICAL_ICAL_EXPORT int icalcomponent_is_valid(icalcomponent *component);
+
73 
+
74 LIBICAL_ICAL_EXPORT icalcomponent_kind icalcomponent_isa(const icalcomponent *component);
+
75 
+
76 LIBICAL_ICAL_EXPORT int icalcomponent_isa_component(void *component);
+
77 
+
78 /*
+
79  * Working with properties
+
80  */
+
81 
+
82 LIBICAL_ICAL_EXPORT void icalcomponent_add_property(icalcomponent *component,
+
83  icalproperty *property);
+
84 
+
85 LIBICAL_ICAL_EXPORT void icalcomponent_remove_property(icalcomponent *component,
+
86  icalproperty *property);
+
87 
+
88 LIBICAL_ICAL_EXPORT int icalcomponent_count_properties(icalcomponent *component,
+
89  icalproperty_kind kind);
+
90 
+
95 LIBICAL_ICAL_EXPORT void icalproperty_set_parent(icalproperty *property,
+
96  icalcomponent *component);
+
97 
+
101 LIBICAL_ICAL_EXPORT icalcomponent *icalproperty_get_parent(const icalproperty *property);
+
102 
+
103 /* Iterate through the properties */
+
104 LIBICAL_ICAL_EXPORT icalproperty *icalcomponent_get_current_property(icalcomponent *component);
+
105 
+
106 LIBICAL_ICAL_EXPORT icalproperty *icalcomponent_get_first_property(icalcomponent *component,
+
107  icalproperty_kind kind);
+
108 LIBICAL_ICAL_EXPORT icalproperty *icalcomponent_get_next_property(icalcomponent *component,
+
109  icalproperty_kind kind);
+
110 
+
111 /*
+
112  * Working with components
+
113  */
+
114 
+
117 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_inner(icalcomponent *comp);
+
118 
+
119 LIBICAL_ICAL_EXPORT void icalcomponent_add_component(icalcomponent *parent, icalcomponent *child);
+
120 
+
121 LIBICAL_ICAL_EXPORT void icalcomponent_remove_component(icalcomponent *parent,
+
122  icalcomponent *child);
+
123 
+
124 LIBICAL_ICAL_EXPORT int icalcomponent_count_components(icalcomponent *component,
+
125  icalcomponent_kind kind);
+
126 
+
132 LIBICAL_ICAL_EXPORT void icalcomponent_merge_component(icalcomponent *comp,
+
133  icalcomponent *comp_to_merge);
+
134 
+
135 /* Iteration Routines. There are two forms of iterators, internal and
+
136 external. The internal ones came first, and are almost completely
+
137 sufficient, but they fail badly when you want to construct a loop that
+
138 removes components from the container.*/
+
139 
+
140 /* Iterate through components */
+
141 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_current_component(icalcomponent *component);
+
142 
+
143 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_first_component(icalcomponent *component,
+
144  icalcomponent_kind kind);
+
145 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_next_component(icalcomponent *component,
+
146  icalcomponent_kind kind);
+
147 
+
148 /* Using external iterators */
+
149 LIBICAL_ICAL_EXPORT icalcompiter icalcomponent_begin_component(icalcomponent *component,
+
150  icalcomponent_kind kind);
+
151 
+
152 LIBICAL_ICAL_EXPORT icalcompiter icalcomponent_end_component(icalcomponent *component,
+
153  icalcomponent_kind kind);
+
154 
+
155 LIBICAL_ICAL_EXPORT icalcomponent *icalcompiter_next(icalcompiter * i);
+
156 
+
157 LIBICAL_ICAL_EXPORT icalcomponent *icalcompiter_prior(icalcompiter * i);
+
158 
+
159 LIBICAL_ICAL_EXPORT icalcomponent *icalcompiter_deref(icalcompiter * i);
+
160 
+
161 /* Working with embedded error properties */
+
162 
+
163 /* Check the component against itip rules and insert error properties*/
+
164 /* Working with embedded error properties */
+
165 LIBICAL_ICAL_EXPORT int icalcomponent_check_restrictions(icalcomponent *comp);
+
166 
+
172 LIBICAL_ICAL_EXPORT int icalcomponent_count_errors(icalcomponent *component);
+
173 
+
175 LIBICAL_ICAL_EXPORT void icalcomponent_strip_errors(icalcomponent *component);
+
176 
+
178 LIBICAL_ICAL_EXPORT void icalcomponent_convert_errors(icalcomponent *component);
+
179 
+
180 /* Internal operations. They are private, and you should not be using them. */
+
181 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_parent(icalcomponent *component);
+
182 
+
183 LIBICAL_ICAL_EXPORT void icalcomponent_set_parent(icalcomponent *component,
+
184  icalcomponent *parent);
+
185 
+
186 /* Kind conversion routines */
+
187 
+
188 LIBICAL_ICAL_EXPORT int icalcomponent_kind_is_valid(const icalcomponent_kind kind);
+
189 
+
190 LIBICAL_ICAL_EXPORT icalcomponent_kind icalcomponent_string_to_kind(const char *string);
+
191 
+
192 LIBICAL_ICAL_EXPORT const char *icalcomponent_kind_to_string(icalcomponent_kind kind);
+
193 
+
194 /************* Derived class methods. ****************************
+
195 
+
196 If the code was in an OO language, the remaining routines would be
+
197 members of classes derived from icalcomponent. Don't call them on the
+
198 wrong component subtypes. */
+
199 
+
203 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_get_first_real_component(icalcomponent *c);
+
204 
+
221 LIBICAL_ICAL_EXPORT struct icaltime_span icalcomponent_get_span(icalcomponent *comp);
+
222 
+
223 /******************** Convenience routines **********************/
+
224 
+
230 LIBICAL_ICAL_EXPORT void icalcomponent_set_dtstart(icalcomponent *comp, struct icaltimetype v);
+
231 
+
241 LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtstart(icalcomponent *comp);
+
242 
+
243 /* For the icalcomponent routines only, dtend and duration are tied
+
244  together. If you call the get routine for one and the other exists,
+
245  the routine will calculate the return value. That is, if there is a
+
246  DTEND and you call get_duration, the routine will return the difference
+
247  between DTEND and DTSTART. However, if you call a set routine for
+
248  one and the other exists, no action will be taken and icalerrno will
+
249  be set to ICAL_MALFORMEDDATA_ERROR. If you call a set routine and
+
250  neither exists, the routine will create the appropriate property. */
+
251 
+
277 LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtend(icalcomponent *comp);
+
278 
+
294 LIBICAL_ICAL_EXPORT void icalcomponent_set_dtend(icalcomponent *comp, struct icaltimetype v);
+
295 
+
303 LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_due(icalcomponent *comp);
+
304 
+
316 LIBICAL_ICAL_EXPORT void icalcomponent_set_due(icalcomponent *comp, struct icaltimetype v);
+
317 
+
333 LIBICAL_ICAL_EXPORT void icalcomponent_set_duration(icalcomponent *comp,
+
334  struct icaldurationtype v);
+
335 
+
348 LIBICAL_ICAL_EXPORT struct icaldurationtype icalcomponent_get_duration(icalcomponent *comp);
+
349 
+
352 LIBICAL_ICAL_EXPORT void icalcomponent_set_method(icalcomponent *comp, icalproperty_method method);
+
353 
+
356 LIBICAL_ICAL_EXPORT icalproperty_method icalcomponent_get_method(icalcomponent *comp);
+
357 
+
358 LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_dtstamp(icalcomponent *comp);
+
359 
+
360 LIBICAL_ICAL_EXPORT void icalcomponent_set_dtstamp(icalcomponent *comp, struct icaltimetype v);
+
361 
+
362 LIBICAL_ICAL_EXPORT void icalcomponent_set_summary(icalcomponent *comp, const char *v);
+
363 
+
364 LIBICAL_ICAL_EXPORT const char *icalcomponent_get_summary(icalcomponent *comp);
+
365 
+
366 LIBICAL_ICAL_EXPORT void icalcomponent_set_comment(icalcomponent *comp, const char *v);
+
367 
+
368 LIBICAL_ICAL_EXPORT const char *icalcomponent_get_comment(icalcomponent *comp);
+
369 
+
370 LIBICAL_ICAL_EXPORT void icalcomponent_set_uid(icalcomponent *comp, const char *v);
+
371 
+
372 LIBICAL_ICAL_EXPORT const char *icalcomponent_get_uid(icalcomponent *comp);
+
373 
+
374 LIBICAL_ICAL_EXPORT void icalcomponent_set_relcalid(icalcomponent *comp, const char *v);
+
375 
+
376 LIBICAL_ICAL_EXPORT const char *icalcomponent_get_relcalid(icalcomponent *comp);
+
377 
+
378 LIBICAL_ICAL_EXPORT void icalcomponent_set_recurrenceid(icalcomponent *comp,
+
379  struct icaltimetype v);
+
380 
+
381 LIBICAL_ICAL_EXPORT struct icaltimetype icalcomponent_get_recurrenceid(icalcomponent *comp);
+
382 
+
383 LIBICAL_ICAL_EXPORT void icalcomponent_set_description(icalcomponent *comp, const char *v);
+
384 
+
385 LIBICAL_ICAL_EXPORT const char *icalcomponent_get_description(icalcomponent *comp);
+
386 
+
387 LIBICAL_ICAL_EXPORT void icalcomponent_set_location(icalcomponent *comp, const char *v);
+
388 
+
389 LIBICAL_ICAL_EXPORT const char *icalcomponent_get_location(icalcomponent *comp);
+
390 
+
391 LIBICAL_ICAL_EXPORT void icalcomponent_set_sequence(icalcomponent *comp, int v);
+
392 
+
393 LIBICAL_ICAL_EXPORT int icalcomponent_get_sequence(icalcomponent *comp);
+
394 
+
395 LIBICAL_ICAL_EXPORT void icalcomponent_set_status(icalcomponent *comp, enum icalproperty_status v);
+
396 
+
397 LIBICAL_ICAL_EXPORT enum icalproperty_status icalcomponent_get_status(icalcomponent *comp);
+
398 
+
402 LIBICAL_ICAL_EXPORT void icalcomponent_foreach_tzid(icalcomponent *comp,
+
403  void (*callback) (icalparameter *param,
+
404  void *data),
+
405  void *callback_data);
+
406 
+
410 LIBICAL_ICAL_EXPORT icaltimezone *icalcomponent_get_timezone(icalcomponent *comp,
+
411  const char *tzid);
+
412 
+
435 LIBICAL_ICAL_EXPORT int icalproperty_recurrence_is_excluded(icalcomponent *comp,
+
436  struct icaltimetype *dtstart,
+
437  struct icaltimetype *recurtime);
+
438 
+
457 LIBICAL_ICAL_EXPORT void icalcomponent_foreach_recurrence(icalcomponent *comp,
+
458  struct icaltimetype start,
+
459  struct icaltimetype end,
+
460  void (*callback) (icalcomponent *comp,
+
461  struct icaltime_span *
+
462  span, void *data),
+
463  void *callback_data);
+
464 
+
469 LIBICAL_ICAL_EXPORT void icalcomponent_normalize(icalcomponent *comp);
+
470 
+
481 LIBICAL_ICAL_EXPORT struct icaltimetype icalproperty_get_datetime_with_component(
+
482  icalproperty *prop,
+
483  icalcomponent *comp);
+
484 /*************** Type Specific routines ***************/
+
485 
+
486 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vcalendar(void);
+
487 
+
488 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vevent(void);
+
489 
+
490 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vtodo(void);
+
491 
+
492 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vjournal(void);
+
493 
+
494 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_valarm(void);
+
495 
+
496 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vfreebusy(void);
+
497 
+
498 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vtimezone(void);
+
499 
+
500 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xstandard(void);
+
501 
+
502 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xdaylight(void);
+
503 
+
504 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vagenda(void);
+
505 
+
506 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vquery(void);
+
507 
+
508 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vavailability(void);
+
509 
+
510 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xavailable(void);
+
511 
+
512 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vpoll(void);
+
513 
+
514 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vvoter(void);
+
515 
+
516 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xvote(void);
+
517 
+
518 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_vpatch(void);
+
519 
+
520 LIBICAL_ICAL_EXPORT icalcomponent *icalcomponent_new_xpatch(void);
+
521 
+
522 #endif /* !ICALCOMPONENT_H */
+
icalcomponent_convert_errors
void icalcomponent_convert_errors(icalcomponent *component)
Converts some X-LIC-ERROR properties into RETURN-STATUS properties.
Definition: icalcomponent.c:995
+
icalcomponent_set_relcalid
void icalcomponent_set_relcalid(icalcomponent *comp, const char *v)
Sets the RELCALID property of a component.
Definition: icalcomponent.c:2307
+
icalcomponent_vanew
icalcomponent * icalcomponent_vanew(icalcomponent_kind kind,...)
Constructor.
Definition: icalcomponent.c:116
+
icalcomponent_get_dtend
struct icaltimetype icalcomponent_get_dtend(icalcomponent *comp)
Gets the DTEND property as an icaltime.
Definition: icalcomponent.c:1336
+
icalcomponent_get_dtstart
struct icaltimetype icalcomponent_get_dtstart(icalcomponent *comp)
Gets the DTSTART property as an icaltime.
Definition: icalcomponent.c:1323
+
icalcomponent_new_from_string
icalcomponent * icalcomponent_new_from_string(const char *str)
Constructor.
Definition: icalcomponent.c:135
+
icalcomponent_get_timezone
icaltimezone * icalcomponent_get_timezone(icalcomponent *comp, const char *tzid)
Returns the icaltimezone in the component corresponding to the TZID, or NULL if it can't be found.
Definition: icalcomponent.c:2179
+
icalcomponent_get_method
icalproperty_method icalcomponent_get_method(icalcomponent *comp)
Returns the METHOD property.
Definition: icalcomponent.c:1281
+
icalcomponent_foreach_recurrence
void icalcomponent_foreach_recurrence(icalcomponent *comp, struct icaltimetype start, struct icaltimetype end, void(*callback)(icalcomponent *comp, struct icaltime_span *span, void *data), void *callback_data)
Cycles through all recurrences of an event.
Definition: icalcomponent.c:787
+
icalcomponent_set_dtstart
void icalcomponent_set_dtstart(icalcomponent *comp, struct icaltimetype v)
Sets the DTSTART property to the given icaltime,.
Definition: icalcomponent.c:1303
+
icalcomponent_get_relcalid
const char * icalcomponent_get_relcalid(icalcomponent *comp)
Gets the RELCALID property of a component.
Definition: icalcomponent.c:2325
+
icalcomponent_strip_errors
void icalcomponent_strip_errors(icalcomponent *component)
Removes all X-LIC-ERROR properties.
Definition: icalcomponent.c:969
+
icalcomponent_normalize
void icalcomponent_normalize(icalcomponent *comp)
Normalizes (reorders and sorts the properties) the specified icalcomponent comp.
Definition: icalcomponent.c:2530
+
icalproperty_get_parent
icalcomponent * icalproperty_get_parent(const icalproperty *property)
Returns the parent icalcomponent for the specified property.
Definition: icalproperty.c:915
+
icalcomponent_new
icalcomponent * icalcomponent_new(icalcomponent_kind kind)
Constructor.
Definition: icalcomponent.c:111
+
icalproperty_get_datetime_with_component
struct icaltimetype icalproperty_get_datetime_with_component(icalproperty *prop, icalcomponent *comp)
Gets a DATE or DATE-TIME property as an icaltime.
Definition: icalproperty.c:1052
+
icalcomponent_set_method
void icalcomponent_set_method(icalcomponent *comp, icalproperty_method method)
Sets the METHOD property to the given method.
Definition: icalcomponent.c:1269
+
icalproperty_set_parent
void icalproperty_set_parent(icalproperty *property, icalcomponent *component)
Sets the parent icalcomponent for the specified icalproperty property.
Definition: icalproperty.c:908
+
icalcomponent_get_due
struct icaltimetype icalcomponent_get_due(icalcomponent *comp)
Returns the time a VTODO task is DUE.
Definition: icalcomponent.c:2347
+
icalcomponent_merge_component
void icalcomponent_merge_component(icalcomponent *comp, icalcomponent *comp_to_merge)
Definition: icalcomponent.c:1897
+
icalcomponent_count_errors
int icalcomponent_count_errors(icalcomponent *component)
Returns the number of errors encountered parsing the data.
Definition: icalcomponent.c:943
+
icalcomponent_get_duration
struct icaldurationtype icalcomponent_get_duration(icalcomponent *comp)
Gets the DURATION property as an icalduration.
Definition: icalcomponent.c:1435
+
icalproperty_recurrence_is_excluded
int icalproperty_recurrence_is_excluded(icalcomponent *comp, struct icaltimetype *dtstart, struct icaltimetype *recurtime)
Decides if a recurrence is acceptable.
Definition: icalcomponent.c:672
+
icalcomponent_new_x
icalcomponent * icalcomponent_new_x(const char *x_name)
Constructor.
Definition: icalcomponent.c:168
+
icalcomponent_set_dtend
void icalcomponent_set_dtend(icalcomponent *comp, struct icaltimetype v)
Sets the DTEND property to given icaltime.
Definition: icalcomponent.c:1393
+
icalcomponent_get_span
struct icaltime_span icalcomponent_get_span(icalcomponent *comp)
Gets the timespan covered by this component, in UTC.
Definition: icalcomponent.c:604
+
icalcomponent_new_clone
icalcomponent * icalcomponent_new_clone(icalcomponent *component)
Constructor.
Definition: icalcomponent.c:140
+
icalcomponent_set_duration
void icalcomponent_set_duration(icalcomponent *comp, struct icaldurationtype v)
Sets the DURATION property to given icalduration.
Definition: icalcomponent.c:1418
+
icalcomponent_get_inner
icalcomponent * icalcomponent_get_inner(icalcomponent *comp)
Definition: icalcomponent.c:1260
+
icalcomponent_foreach_tzid
void icalcomponent_foreach_tzid(icalcomponent *comp, void(*callback)(icalparameter *param, void *data), void *callback_data)
Calls the given function for each TZID parameter found in the component, and any subcomponents.
Definition: icalcomponent.c:2142
+
icalcomponent_set_due
void icalcomponent_set_due(icalcomponent *comp, struct icaltimetype v)
Sets the due date of a VTODO task.
Definition: icalcomponent.c:2369
+
icalcomponent_get_first_real_component
icalcomponent * icalcomponent_get_first_real_component(icalcomponent *c)
Returns a reference to the first VEVENT, VTODO or VJOURNAL in the component.
Definition: icalcomponent.c:581
-
_icaltimezone
Definition: icaltimezoneimpl.h:15
-
icalcompiter
Definition: icalcomponent.h:29
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:28
-
icaltime_span
Definition: icaltime.h:88
-
icaltimetype
Definition: icaltime.h:97
-
pvl_elem_t
Definition: pvl.h:26
+
_icaltimezone
Definition: icaltimezoneimpl.h:23
+
icalcompiter
Definition: icalcomponent.h:36
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
+
icaltime_span
Definition: icaltime.h:96
+
icaltimetype
Definition: icaltime.h:105
+
pvl_elem_t
Definition: pvl.h:34
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaldirset_8h.html b/apidocs/icaldirset_8h.html index 27cc9416..09517836 100644 --- a/apidocs/icaldirset_8h.html +++ b/apidocs/icaldirset_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaldirset.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures | Typedefs | Functions
-
icaldirset.h File Reference
+
+
icaldirset.h File Reference
@@ -79,97 +80,97 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

struct  icaldirset_options
 
- - -

+

Typedefs

+
typedef struct icaldirset_impl icaldirset
 
+
typedef struct icaldirset_options icaldirset_options
 
- - - - - - - - + - - + - - - + - - + - - + - - - + - - - - + - - + - - + - + - - - - + - +

+

Functions

icalerrorenum icaldirset_add_component (icalset *store, icalcomponent *comp)
 
+
icalsetiter icaldirset_begin_component (icalset *set, icalcomponent_kind kind, icalgauge *gauge, const char *tzid)
 
+
void icaldirset_clear (icalset *store)
 
+
icalerrorenum icaldirset_commit (icalset *set)
 
+
int icaldirset_count_components (icalset *store, icalcomponent_kind kind)
 
+
icalcomponent * icaldirset_fetch (icalset *store, icalcomponent_kind kind, const char *uid)
 
+
 
icalcomponent * icaldirset_fetch_match (icalset *set, icalcomponent *c)
 
+
 
void icaldirset_free (icalset *set)
 
+
icalcomponent * icaldirset_get_current_component (icalset *store)
 
+
 
icalcomponent * icaldirset_get_first_component (icalset *store)
 
+
 
icalcomponent * icaldirset_get_next_component (icalset *store)
 
+
 
int icaldirset_has_uid (icalset *store, const char *uid)
 
+
icalset * icaldirset_init (icalset *set, const char *dsn, void *options)
 
+
 
void icaldirset_mark (icalset *set)
 
+
icalerrorenum icaldirset_modify (icalset *store, icalcomponent *oldc, icalcomponent *newc)
 
+
icalset * icaldirset_new (const char *path)
 
+
 
icalset * icaldirset_new_reader (const char *path)
 
+
 
icalset * icaldirset_new_writer (const char *path)
 
+
 
const char * icaldirset_path (icalset *set)
 
 
icalerrorenum icaldirset_remove_component (icalset *store, icalcomponent *comp)
 
+
icalerrorenum icaldirset_select (icalset *store, icalgauge *gauge)
 
+
icalcomponent * icaldirsetiter_to_next (icalset *set, icalsetiter *i)
 
+
 
icalcomponent * icaldirsetiter_to_prior (icalset *set, icalsetiter *i)
 
 

Detailed Description

-

icaldirset manages a database of ical components and offers interfaces for reading, writing and searching for components.

-

icaldirset groups components in to clusters based on their DTSTAMP time – all components that start in the same month are grouped together in a single file. All files in a sotre are kept in a single directory.

-

The primary interfaces are icaldirset__get_first_component and icaldirset_get_next_component. These routine iterate through all of the components in the store, subject to the current gauge. A gauge is an icalcomponent that is tested against other components for a match. If a gauge has been set with icaldirset_select, icaldirset_first and icaldirset_next will only return components that match the gauge.

-

The Store generated UIDs for all objects that are stored if they do not already have a UID. The UID is the name of the cluster (month & year as MMYYYY) plus a unique serial number. The serial number is stored as a property of the cluster.

+

icaldirset manages a database of ical components and offers interfaces for reading, writing and searching for components.

+

icaldirset groups components in to clusters based on their DTSTAMP time – all components that start in the same month are grouped together in a single file. All files in a sotre are kept in a single directory.

+

The primary interfaces are icaldirset__get_first_component and icaldirset_get_next_component. These routine iterate through all of the components in the store, subject to the current gauge. A gauge is an icalcomponent that is tested against other components for a match. If a gauge has been set with icaldirset_select, icaldirset_first and icaldirset_next will only return components that match the gauge.

+

The Store generated UIDs for all objects that are stored if they do not already have a UID. The UID is the name of the cluster (month & year as MMYYYY) plus a unique serial number. The serial number is stored as a property of the cluster.

Function Documentation

- +

◆ icaldirset_add_component()

@@ -194,11 +195,11 @@ const char * icaldirset_pa
-

This assumes that the top level component is a VCALENDAR, and there is an inner component of type VEVENT, VTODO or VJOURNAL. The inner component must have a DSTAMP property

+

This assumes that the top level component is a VCALENDAR, and there is an inner component of type VEVENT, VTODO or VJOURNAL. The inner component must have a DSTAMP property

- +

◆ icaldirset_remove_component()

@@ -223,14 +224,14 @@ const char * icaldirset_pa
-

Remove a component in the current cluster. HACK. This routine is a "friend" of icalfileset, and breaks its encapsulation. It was either do it this way, or add several layers of interfaces that had no other use.

+

Remove a component in the current cluster. HACK. This routine is a "friend" of icalfileset, and breaks its encapsulation. It was either do it this way, or add several layers of interfaces that had no other use.

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaldirset_8h_source.html b/apidocs/icaldirset_8h_source.html index 1be7b1e8..8e34b333 100644 --- a/apidocs/icaldirset_8h_source.html +++ b/apidocs/icaldirset_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaldirset.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icaldirset.h
+
+
icaldirset.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icaldirset.h
-
3 CREATOR: eric 28 November 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
39#ifndef ICALDIRSET_H
-
40#define ICALDIRSET_H
-
41
-
42#include "libical_icalss_export.h"
-
43#include "icalset.h"
-
44
-
45/* icaldirset Routines for storing, fetching, and searching for ical
-
46 * objects in a database */
-
47
-
48typedef struct icaldirset_impl icaldirset;
-
49
-
50LIBICAL_ICALSS_EXPORT icalset *icaldirset_new(const char *path);
-
51
-
52LIBICAL_ICALSS_EXPORT icalset *icaldirset_new_reader(const char *path);
-
53
-
54LIBICAL_ICALSS_EXPORT icalset *icaldirset_new_writer(const char *path);
-
55
-
56LIBICAL_ICALSS_EXPORT icalset *icaldirset_init(icalset *set, const char *dsn, void *options);
-
57
-
58LIBICAL_ICALSS_EXPORT void icaldirset_free(icalset *set);
-
59
-
60LIBICAL_ICALSS_EXPORT const char *icaldirset_path(icalset *set);
-
61
-
62/* Marks the cluster as changed, so it will be written to disk when it
-
63 is freed. Commit writes to disk immediately*/
-
64LIBICAL_ICALSS_EXPORT void icaldirset_mark(icalset *set);
-
65
-
66LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_commit(icalset *set);
-
67
-
73LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_add_component(icalset *store, icalcomponent *comp);
-
74LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_remove_component(icalset *store,
-
75 icalcomponent *comp);
-
76
-
77LIBICAL_ICALSS_EXPORT int icaldirset_count_components(icalset *store, icalcomponent_kind kind);
-
78
-
79/* Restricts the component returned by icaldirset_first, _next to those
-
80 that pass the gauge. _clear removes the gauge. */
-
81LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_select(icalset *store, icalgauge *gauge);
-
82
-
83LIBICAL_ICALSS_EXPORT void icaldirset_clear(icalset *store);
-
84
-
85/* Gets a component by uid */
-
86LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_fetch(icalset *store,
-
87 icalcomponent_kind kind, const char *uid);
-
88
-
89LIBICAL_ICALSS_EXPORT int icaldirset_has_uid(icalset *store, const char *uid);
-
90
-
91LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_fetch_match(icalset *set, icalcomponent *c);
-
92
-
93/* Modifies components according to the MODIFY method of CAP. Works on
-
94 the currently selected components. */
-
95LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_modify(icalset *store,
-
96 icalcomponent *oldc, icalcomponent *newc);
-
97
-
98/* Iterates through the components. If a gauge has been defined, these
-
99 will skip over components that do not pass the gauge */
-
100
-
101LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_get_current_component(icalset *store);
-
102
-
103LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_get_first_component(icalset *store);
-
104
-
105LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_get_next_component(icalset *store);
-
106
-
107/* External iterator for thread safety */
-
108LIBICAL_ICALSS_EXPORT icalsetiter icaldirset_begin_component(icalset *set,
-
109 icalcomponent_kind kind,
-
110 icalgauge *gauge, const char *tzid);
-
111
-
112LIBICAL_ICALSS_EXPORT icalcomponent *icaldirsetiter_to_next(icalset *set, icalsetiter *i);
-
113
-
114LIBICAL_ICALSS_EXPORT icalcomponent *icaldirsetiter_to_prior(icalset *set, icalsetiter *i);
-
115
-
116typedef struct icaldirset_options
-
117{
-
118 int flags;
-
119} icaldirset_options;
-
120
-
121#endif /* !ICALDIRSET_H */
-
icaldirset_add_component
icalerrorenum icaldirset_add_component(icalset *store, icalcomponent *comp)
Definition: icaldirset.c:288
-
icaldirset_remove_component
icalerrorenum icaldirset_remove_component(icalset *store, icalcomponent *comp)
Definition: icaldirset.c:375
-
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:67
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icaldirset.h
+
3  CREATOR: eric 28 November 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
48 #ifndef ICALDIRSET_H
+
49 #define ICALDIRSET_H
+
50 
+
51 #include "libical_icalss_export.h"
+
52 #include "icalset.h"
+
53 
+
54 /* icaldirset Routines for storing, fetching, and searching for ical
+
55  * objects in a database */
+
56 
+
57 typedef struct icaldirset_impl icaldirset;
+
58 
+
59 LIBICAL_ICALSS_EXPORT icalset *icaldirset_new(const char *path);
+
60 
+
61 LIBICAL_ICALSS_EXPORT icalset *icaldirset_new_reader(const char *path);
+
62 
+
63 LIBICAL_ICALSS_EXPORT icalset *icaldirset_new_writer(const char *path);
+
64 
+
65 LIBICAL_ICALSS_EXPORT icalset *icaldirset_init(icalset *set, const char *dsn, void *options);
+
66 
+
67 LIBICAL_ICALSS_EXPORT void icaldirset_free(icalset *set);
+
68 
+
69 LIBICAL_ICALSS_EXPORT const char *icaldirset_path(icalset *set);
+
70 
+
71 /* Marks the cluster as changed, so it will be written to disk when it
+
72  is freed. Commit writes to disk immediately*/
+
73 LIBICAL_ICALSS_EXPORT void icaldirset_mark(icalset *set);
+
74 
+
75 LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_commit(icalset *set);
+
76 
+
82 LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_add_component(icalset *store, icalcomponent *comp);
+
83 LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_remove_component(icalset *store,
+
84  icalcomponent *comp);
+
85 
+
86 LIBICAL_ICALSS_EXPORT int icaldirset_count_components(icalset *store, icalcomponent_kind kind);
+
87 
+
88 /* Restricts the component returned by icaldirset_first, _next to those
+
89  that pass the gauge. _clear removes the gauge. */
+
90 LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_select(icalset *store, icalgauge *gauge);
+
91 
+
92 LIBICAL_ICALSS_EXPORT void icaldirset_clear(icalset *store);
+
93 
+
94 /* Gets a component by uid */
+
95 LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_fetch(icalset *store,
+
96  icalcomponent_kind kind, const char *uid);
+
97 
+
98 LIBICAL_ICALSS_EXPORT int icaldirset_has_uid(icalset *store, const char *uid);
+
99 
+
100 LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_fetch_match(icalset *set, icalcomponent *c);
+
101 
+
102 /* Modifies components according to the MODIFY method of CAP. Works on
+
103  the currently selected components. */
+
104 LIBICAL_ICALSS_EXPORT icalerrorenum icaldirset_modify(icalset *store,
+
105  icalcomponent *oldc, icalcomponent *newc);
+
106 
+
107 /* Iterates through the components. If a gauge has been defined, these
+
108  will skip over components that do not pass the gauge */
+
109 
+
110 LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_get_current_component(icalset *store);
+
111 
+
112 LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_get_first_component(icalset *store);
+
113 
+
114 LIBICAL_ICALSS_EXPORT icalcomponent *icaldirset_get_next_component(icalset *store);
+
115 
+
116 /* External iterator for thread safety */
+
117 LIBICAL_ICALSS_EXPORT icalsetiter icaldirset_begin_component(icalset *set,
+
118  icalcomponent_kind kind,
+
119  icalgauge *gauge, const char *tzid);
+
120 
+
121 LIBICAL_ICALSS_EXPORT icalcomponent *icaldirsetiter_to_next(icalset *set, icalsetiter *i);
+
122 
+
123 LIBICAL_ICALSS_EXPORT icalcomponent *icaldirsetiter_to_prior(icalset *set, icalsetiter *i);
+
124 
+
125 typedef struct icaldirset_options
+
126 {
+
127  int flags;
+
128 } icaldirset_options;
+
129 
+
130 #endif /* !ICALDIRSET_H */
+
icaldirset_add_component
icalerrorenum icaldirset_add_component(icalset *store, icalcomponent *comp)
Definition: icaldirset.c:297
+
icaldirset_remove_component
icalerrorenum icaldirset_remove_component(icalset *store, icalcomponent *comp)
Definition: icaldirset.c:384
+
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:76
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icaldirset_impl
Definition: icaldirsetimpl.h:22
-
icaldirset_impl::options
icaldirset_options options
Definition: icaldirsetimpl.h:25
-
icaldirset_impl::gauge
icalgauge * gauge
Definition: icaldirsetimpl.h:27
-
icaldirset_options
Definition: icaldirset.h:117
-
icaldirset_options::flags
int flags
Definition: icaldirset.h:118
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-
icalset_impl
Definition: icalset.h:52
-
icalsetiter
Definition: icalset.h:43
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icaldirset_impl
Definition: icaldirsetimpl.h:31
+
icaldirset_impl::options
icaldirset_options options
Definition: icaldirsetimpl.h:34
+
icaldirset_impl::gauge
icalgauge * gauge
Definition: icaldirsetimpl.h:36
+
icaldirset_options
Definition: icaldirset.h:126
+
icaldirset_options::flags
int flags
Definition: icaldirset.h:127
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
+
icalset_impl
Definition: icalset.h:61
+
icalsetiter
Definition: icalset.h:52
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaldirsetimpl_8h_source.html b/apidocs/icaldirsetimpl_8h_source.html index b6809d7a..67a7f542 100644 --- a/apidocs/icaldirsetimpl_8h_source.html +++ b/apidocs/icaldirsetimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaldirsetimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icaldirsetimpl.h
+
+
icaldirsetimpl.h
-
1/*======================================================================
-
2 FILE: icaldirsetimpl.h
-
3 CREATOR: eric 21 Aug 2000
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
13#ifndef ICALDIRSETIMPL_H
-
14#define ICALDIRSETIMPL_H
-
15
-
16#include "icalcluster.h"
-
17
-
18/* This definition is in its own file so it can be kept out of the
-
19 main header file, but used by "friend classes" like icalset*/
-
20
-
21struct icaldirset_impl
-
22{
-
23 icalset super;
-
24 char *dir;
-
25 icaldirset_options options;
-
26 icalcluster *cluster;
-
27 icalgauge *gauge;
-
28 int first_component;
-
29 pvl_list directory;
-
30 pvl_elem directory_iterator;
-
31};
-
32
-
33#endif
-
icalcluster_impl
Definition: icalclusterimpl.h:20
-
icaldirset_impl
Definition: icaldirsetimpl.h:22
-
icaldirset_impl::super
icalset super
Definition: icaldirsetimpl.h:23
-
icaldirset_impl::options
icaldirset_options options
Definition: icaldirsetimpl.h:25
-
icaldirset_impl::gauge
icalgauge * gauge
Definition: icaldirsetimpl.h:27
-
icaldirset_impl::dir
char * dir
Definition: icaldirsetimpl.h:24
-
icaldirset_impl::first_component
int first_component
Definition: icaldirsetimpl.h:28
-
icaldirset_impl::cluster
icalcluster * cluster
Definition: icaldirsetimpl.h:26
-
icaldirset_impl::directory_iterator
pvl_elem directory_iterator
Definition: icaldirsetimpl.h:30
-
icaldirset_impl::directory
pvl_list directory
Definition: icaldirsetimpl.h:29
-
icaldirset_options
Definition: icaldirset.h:117
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-
icalset_impl
Definition: icalset.h:52
-
pvl_elem_t
Definition: pvl.h:26
-
pvl_list_t
Definition: pvl.c:59
+
1 /*======================================================================
+
2  FILE: icaldirsetimpl.h
+
3  CREATOR: eric 21 Aug 2000
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
22 #ifndef ICALDIRSETIMPL_H
+
23 #define ICALDIRSETIMPL_H
+
24 
+
25 #include "icalcluster.h"
+
26 
+
27 /* This definition is in its own file so it can be kept out of the
+
28  main header file, but used by "friend classes" like icalset*/
+
29 
+
30 struct icaldirset_impl
+
31 {
+
32  icalset super;
+
33  char *dir;
+
34  icaldirset_options options;
+
35  icalcluster *cluster;
+
36  icalgauge *gauge;
+
37  int first_component;
+
38  pvl_list directory;
+
39  pvl_elem directory_iterator;
+
40 };
+
41 
+
42 #endif
+
icalcluster_impl
Definition: icalclusterimpl.h:28
+
icaldirset_impl
Definition: icaldirsetimpl.h:31
+
icaldirset_impl::super
icalset super
Definition: icaldirsetimpl.h:32
+
icaldirset_impl::options
icaldirset_options options
Definition: icaldirsetimpl.h:34
+
icaldirset_impl::gauge
icalgauge * gauge
Definition: icaldirsetimpl.h:36
+
icaldirset_impl::dir
char * dir
Definition: icaldirsetimpl.h:33
+
icaldirset_impl::first_component
int first_component
Definition: icaldirsetimpl.h:37
+
icaldirset_impl::cluster
icalcluster * cluster
Definition: icaldirsetimpl.h:35
+
icaldirset_impl::directory_iterator
pvl_elem directory_iterator
Definition: icaldirsetimpl.h:39
+
icaldirset_impl::directory
pvl_list directory
Definition: icaldirsetimpl.h:38
+
icaldirset_options
Definition: icaldirset.h:126
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
+
icalset_impl
Definition: icalset.h:61
+
pvl_elem_t
Definition: pvl.h:34
+
pvl_list_t
Definition: pvl.c:65
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalduration_8h.html b/apidocs/icalduration_8h.html index 107a2dc2..62c0fe54 100644 --- a/apidocs/icalduration_8h.html +++ b/apidocs/icalduration_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalduration.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures | Macros | Functions
-
icalduration.h File Reference
+
+
icalduration.h File Reference
@@ -79,24 +80,24 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

struct  icaldurationtype
 A struct representing a duration. More...
 
- -

+

Macros

+
#define ICALDURATIONTYPE_INITIALIZER   { 0, 0, 0, 0, 0, 0 }
 
- - - - - + + + + @@ -126,16 +127,16 @@ Functions

+

Functions

char * icaldurationtype_as_ical_string (struct icaldurationtype d)
 
char * icaldurationtype_as_ical_string_r (struct icaldurationtype d)
 
char * icaldurationtype_as_ical_string (struct icaldurationtype d)
 
char * icaldurationtype_as_ical_string_r (struct icaldurationtype d)
 
int icaldurationtype_as_int (struct icaldurationtype duration)
 Converts an icaldurationtype into the duration in seconds as int. More...
 
 

Detailed Description

-

Methods for working with durations in iCal.

+

Methods for working with durations in iCal.

Function Documentation

- -

◆ icaldurationtype_as_ical_string()

+ +

◆ icaldurationtype_as_ical_string()

- + @@ -143,41 +144,40 @@ Functions
char * icaldurationtype_as_ical_string char* icaldurationtype_as_ical_string ( struct icaldurationtype  d)
-

Converts an icaldurationtype into the iCal format as string.

Parameters
+

Converts an icaldurationtype into the iCal format as string.

Parameters
dis the icaldurationtype to convert to iCal format
Returns
A string representing duration d in iCal format
-
See also
icaldurationtype_as_ical_string_r()
-
Ownership
The string returned by this function is owned by the caller and needs to be released with icalmemory_free_buffer() after it's no longer needed.
+
See also
icaldurationtype_as_ical_string_r()
+
Ownership
The string returned by this function is owned by the caller and needs to be released with free() after it's no longer needed.
Usage
// create new duration
-
struct icaldurationtype duration;
-
duration = icaldurationtype_from_int(3424224);
+
struct icaldurationtype duration;
+
duration = icaldurationtype_from_int(3424224);
// print as ical-formatted string
-
char *ical = icaldurationtype_as_ical_string(duration);
+
char *ical = icaldurationtype_as_ical_string(duration);
printf("%s\n", ical);
// release string
-
icalmemory_free_buffer(ical);
-
icaldurationtype_from_int
struct icaldurationtype icaldurationtype_from_int(int t)
Creates a new icaldurationtype from a duration in seconds.
Definition: icalduration.c:23
-
icaldurationtype_as_ical_string
char * icaldurationtype_as_ical_string(struct icaldurationtype d)
Definition: icalduration.c:202
-
icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition: icalmemory.c:359
-
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:28
+
free(ical);
+
icaldurationtype_as_ical_string
char * icaldurationtype_as_ical_string(struct icaldurationtype d)
Definition: icalduration.c:211
+
icaldurationtype_from_int
struct icaldurationtype icaldurationtype_from_int(int t)
Creates a new icaldurationtype from a duration in seconds.
Definition: icalduration.c:32
+
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
- -

◆ icaldurationtype_as_ical_string_r()

+ +

◆ icaldurationtype_as_ical_string_r()

- + @@ -185,26 +185,26 @@ Functions
char * icaldurationtype_as_ical_string_r char* icaldurationtype_as_ical_string_r ( struct icaldurationtype  d)
-

Converts an icaldurationtype into the iCal format as string.

Parameters
+

Converts an icaldurationtype into the iCal format as string.

Parameters
dis the icaldurationtype to convert to iCal format
Returns
A string representing duration d in iCal format
-
See also
icaldurationtype_as_ical_string()
+
See also
icaldurationtype_as_ical_string()
Ownership
The string returned by this function is owned by libical and must not be released by the caller of the function.
Usage
// create new duration
-
struct icaldurationtype duration;
-
duration = icaldurationtype_from_int(3424224);
+
struct icaldurationtype duration;
+
duration = icaldurationtype_from_int(3424224);
// print as ical-formatted string
-
printf("%s\n", icaldurationtype_as_ical_string(duration));
+
printf("%s\n", icaldurationtype_as_ical_string(duration));
- +

◆ icaldurationtype_as_int()

@@ -229,17 +229,17 @@ Functions
Returns
An int representing the duration in seconds
Usage
// create icaldurationtype with given duration
-
struct icaldurationtype duration;
-
duration = icaldurationtype_from_int(3532342);
+
struct icaldurationtype duration;
+
duration = icaldurationtype_from_int(3532342);
// get the duration in seconds and verify it
-
assert(icaldurationtype_as_int(duration) == 3532342);
-
icaldurationtype_as_int
int icaldurationtype_as_int(struct icaldurationtype duration)
Converts an icaldurationtype into the duration in seconds as int.
Definition: icalduration.c:260
+
assert(icaldurationtype_as_int(duration) == 3532342);
+
icaldurationtype_as_int
int icaldurationtype_as_int(struct icaldurationtype duration)
Converts an icaldurationtype into the duration in seconds as int.
Definition: icalduration.c:270
- +

◆ icaldurationtype_bad_duration()

@@ -259,18 +259,18 @@ Functions
Returns
A bad duration
See also
icaldurationtype_is_bad_duration()
Usage
// create bad duration
-
struct icaldurationtype duration;
-
duration = icaldurationtype_bad_duration();
+
struct icaldurationtype duration;
+
duration = icaldurationtype_bad_duration();
// make sure it's bad
-
assert(icaldurationtype_is_bad_duration(duration));
-
icaldurationtype_bad_duration
struct icaldurationtype icaldurationtype_bad_duration(void)
Creates a bad duration (used to indicate error).
Definition: icalduration.c:295
-
icaldurationtype_is_bad_duration
int icaldurationtype_is_bad_duration(struct icaldurationtype d)
Checks if a duration is a bad duration.
Definition: icalduration.c:304
+
assert(icaldurationtype_is_bad_duration(duration));
+
icaldurationtype_bad_duration
struct icaldurationtype icaldurationtype_bad_duration(void)
Creates a bad duration (used to indicate error).
Definition: icalduration.c:304
+
icaldurationtype_is_bad_duration
int icaldurationtype_is_bad_duration(struct icaldurationtype d)
Checks if a duration is a bad duration.
Definition: icalduration.c:313
- +

◆ icaldurationtype_from_int()

@@ -295,8 +295,8 @@ Functions
Returns
An icaldurationtype representing the duration t in seconds
Example
// create a new icaldurationtype with a duration of 60 seconds
-
struct icaldurationtype duration;
-
duration = icaldurationtype_from_int(60);
+
struct icaldurationtype duration;
+
duration = icaldurationtype_from_int(60);
// verify that the duration is one minute
assert(duration.minutes == 1);
@@ -304,7 +304,7 @@ Functions
- +

◆ icaldurationtype_from_string()

@@ -330,17 +330,17 @@ Functions
Returns
An icaldurationtype representing the duration dur
Error handling
When given bad input, it sets icalerrno to ICAL_MALFORMEDDATA_ERROR and returns icaldurationtype_bad_duration().
Usage
// create a new icaldurationtype
-
struct icaldurationtype duration;
-
duration = icaldurationtype_from_string("+PT05M");
+
struct icaldurationtype duration;
+
duration = icaldurationtype_from_string("+PT05M");
// verify that it's 5 minutes
assert(duration.minutes == 5);
-
icaldurationtype_from_string
struct icaldurationtype icaldurationtype_from_string(const char *dur)
Creates a new icaldurationtype from a duration given as a string.
Definition: icalduration.c:53
+
icaldurationtype_from_string
struct icaldurationtype icaldurationtype_from_string(const char *dur)
Creates a new icaldurationtype from a duration given as a string.
Definition: icalduration.c:62
- +

◆ icaldurationtype_is_bad_duration()

@@ -366,16 +366,16 @@ Functions
Returns
1 if the duration is a bad duration, 0 otherwise
See also
icalduration_bad_duration()
Usage
// make bad duration
-
struct icaldurationtype duration;
-
duration = icaldurationtype_bad_duration();
+
struct icaldurationtype duration;
+
duration = icaldurationtype_bad_duration();
// check bad duration
-
assert(icaldurationtype_is_bad_duration(duration));
+
assert(icaldurationtype_is_bad_duration(duration));
- +

◆ icaldurationtype_is_null_duration()

@@ -401,18 +401,18 @@ Functions
Returns
1 if the duration is a null duration, 0 otherwise
See also
icalduration_null_duration()
Usage
// make null duration
-
struct icaldurationtype duration;
-
duration = icaldurationtype_null_duration();
+
struct icaldurationtype duration;
+
duration = icaldurationtype_null_duration();
// check null duration
-
assert(icaldurationtype_is_null_duration(duration));
-
icaldurationtype_null_duration
struct icaldurationtype icaldurationtype_null_duration(void)
Creates a duration with zero length.
Definition: icalduration.c:270
-
icaldurationtype_is_null_duration
int icaldurationtype_is_null_duration(struct icaldurationtype d)
Checks if a duration is a null duration.
Definition: icalduration.c:279
+
assert(icaldurationtype_is_null_duration(duration));
+
icaldurationtype_null_duration
struct icaldurationtype icaldurationtype_null_duration(void)
Creates a duration with zero length.
Definition: icalduration.c:279
+
icaldurationtype_is_null_duration
int icaldurationtype_is_null_duration(struct icaldurationtype d)
Checks if a duration is a null duration.
Definition: icalduration.c:288
- +

◆ icaldurationtype_null_duration()

@@ -432,8 +432,8 @@ Functions
Returns
An icaldurationtype with a zero length
See also
icaldurationtype_is_null_duration()
Usage
// create null duration
-
struct icaldurationtype duration;
-
duration = icaldurationtype_null_duration();
+
struct icaldurationtype duration;
+
duration = icaldurationtype_null_duration();
// make sure it's zero length
assert(duration.days == 0);
@@ -447,7 +447,7 @@ Functions
- +

◆ icaltime_add()

@@ -482,23 +482,23 @@ Functions
Returns
The new icaltimetype which has been added the duration to
-
Example
struct icaltimetype time;
-
struct icaldurationtype duration;
+
Example
struct icaltimetype time;
+
struct icaldurationtype duration;
// create time and duration objects
-
time = icaltime_today();
-
duration = icaldurationtype_from_int(60);
+
time = icaltime_today();
+
duration = icaldurationtype_from_int(60);
// add the duration to the time object
-
time = icaltime_add(time, duration);
-
icaltime_add
struct icaltimetype icaltime_add(struct icaltimetype t, struct icaldurationtype d)
Adds a duration to an icaltime object and returns the result.
Definition: icalduration.c:309
-
icaltime_today
struct icaltimetype icaltime_today(void)
Convenience constructor.
Definition: icaltime.c:217
-
icaltimetype
Definition: icaltime.h:97
+
time = icaltime_add(time, duration);
+
icaltime_add
struct icaltimetype icaltime_add(struct icaltimetype t, struct icaldurationtype d)
Adds a duration to an icaltime object and returns the result.
Definition: icalduration.c:318
+
icaltime_today
struct icaltimetype icaltime_today(void)
Convenience constructor.
Definition: icaltime.c:232
+
icaltimetype
Definition: icaltime.h:105
- +

◆ icaltime_subtract()

@@ -533,14 +533,14 @@ Functions
Returns
An icaldurationtype representing the duration the elapsed between t1 and t2
-
Usage
struct icaltimetype t1 = icaltime_from_day_of_year(111, 2018);
-
struct icaltimetype t2 = icaltime_from_day_of_year(112, 2018);
-
struct icaldurationtype duration;
+
Usage
struct icaltimetype t1 = icaltime_from_day_of_year(111, 2018);
+
struct icaltimetype t2 = icaltime_from_day_of_year(112, 2018);
+
struct icaldurationtype duration;
// calculate duration between time points
-
duration = icaltime_subtract(t1, t2);
-
icaltime_subtract
struct icaldurationtype icaltime_subtract(struct icaltimetype t1, struct icaltimetype t2)
Returns the difference between two icaltimetype as a duration.
Definition: icalduration.c:330
-
icaltime_from_day_of_year
struct icaltimetype icaltime_from_day_of_year(const int doy, const int year)
Constructor.
Definition: icaltime.c:511
+
duration = icaltime_subtract(t1, t2);
+
icaltime_subtract
struct icaldurationtype icaltime_subtract(struct icaltimetype t1, struct icaltimetype t2)
Returns the difference between two icaltimetype as a duration.
Definition: icalduration.c:339
+
icaltime_from_day_of_year
struct icaltimetype icaltime_from_day_of_year(const int doy, const int year)
Constructor.
Definition: icaltime.c:535
@@ -548,7 +548,7 @@ Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalduration_8h_source.html b/apidocs/icalduration_8h_source.html index ce394d2b..9c554305 100644 --- a/apidocs/icalduration_8h_source.html +++ b/apidocs/icalduration_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalduration.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalduration.h
+
+
icalduration.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalduration.h
-
3 CREATOR: eric 26 Jan 2001
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
13#ifndef ICALDURATION_H
-
14#define ICALDURATION_H
-
15
-
21#include "libical_ical_export.h"
-
22#include "icaltime.h"
-
23
-
27struct icaldurationtype
-
28{
-
29 int is_neg;
-
30 unsigned int days;
-
31 unsigned int weeks;
-
32 unsigned int hours;
-
33 unsigned int minutes;
-
34 unsigned int seconds;
-
35};
-
36
-
37#define ICALDURATIONTYPE_INITIALIZER { 0, 0, 0, 0, 0, 0 }
-
38
-
54LIBICAL_ICAL_EXPORT struct icaldurationtype icaldurationtype_from_int(int t);
-
55
-
75LIBICAL_ICAL_EXPORT struct icaldurationtype icaldurationtype_from_string(const char *dur);
-
76
-
92LIBICAL_ICAL_EXPORT int icaldurationtype_as_int(struct icaldurationtype duration);
-
93
-
118LIBICAL_ICAL_EXPORT char *icaldurationtype_as_ical_string(struct icaldurationtype d);
-
119
-
140LIBICAL_ICAL_EXPORT char *icaldurationtype_as_ical_string_r(struct icaldurationtype d);
-
141
-
163LIBICAL_ICAL_EXPORT struct icaldurationtype icaldurationtype_null_duration(void);
-
164
-
180LIBICAL_ICAL_EXPORT struct icaldurationtype icaldurationtype_bad_duration(void);
-
181
-
198LIBICAL_ICAL_EXPORT int icaldurationtype_is_null_duration(struct icaldurationtype d);
-
199
-
216LIBICAL_ICAL_EXPORT int icaldurationtype_is_bad_duration(struct icaldurationtype d);
-
217
-
237LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_add(struct icaltimetype t,
-
238 struct icaldurationtype d);
-
239
-
257LIBICAL_ICAL_EXPORT struct icaldurationtype icaltime_subtract(struct icaltimetype t1,
-
258 struct icaltimetype t2);
-
259
-
260#endif /* !ICALDURATION_H */
-
icaldurationtype_from_string
struct icaldurationtype icaldurationtype_from_string(const char *dur)
Creates a new icaldurationtype from a duration given as a string.
Definition: icalduration.c:53
-
icaldurationtype_as_int
int icaldurationtype_as_int(struct icaldurationtype duration)
Converts an icaldurationtype into the duration in seconds as int.
Definition: icalduration.c:260
-
icaldurationtype_bad_duration
struct icaldurationtype icaldurationtype_bad_duration(void)
Creates a bad duration (used to indicate error).
Definition: icalduration.c:295
-
icaldurationtype_from_int
struct icaldurationtype icaldurationtype_from_int(int t)
Creates a new icaldurationtype from a duration in seconds.
Definition: icalduration.c:23
-
icaldurationtype_is_bad_duration
int icaldurationtype_is_bad_duration(struct icaldurationtype d)
Checks if a duration is a bad duration.
Definition: icalduration.c:304
-
icaltime_subtract
struct icaldurationtype icaltime_subtract(struct icaltimetype t1, struct icaltimetype t2)
Returns the difference between two icaltimetype as a duration.
Definition: icalduration.c:330
-
icaltime_add
struct icaltimetype icaltime_add(struct icaltimetype t, struct icaldurationtype d)
Adds a duration to an icaltime object and returns the result.
Definition: icalduration.c:309
-
icaldurationtype_as_ical_string_r
char * icaldurationtype_as_ical_string_r(struct icaldurationtype d)
Definition: icalduration.c:211
-
icaldurationtype_null_duration
struct icaldurationtype icaldurationtype_null_duration(void)
Creates a duration with zero length.
Definition: icalduration.c:270
-
icaldurationtype_as_ical_string
char * icaldurationtype_as_ical_string(struct icaldurationtype d)
Definition: icalduration.c:202
-
icaldurationtype_is_null_duration
int icaldurationtype_is_null_duration(struct icaldurationtype d)
Checks if a duration is a null duration.
Definition: icalduration.c:279
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalduration.h
+
3  CREATOR: eric 26 Jan 2001
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
22 #ifndef ICALDURATION_H
+
23 #define ICALDURATION_H
+
24 
+
30 #include "libical_ical_export.h"
+
31 #include "icaltime.h"
+
32 
+
36 struct icaldurationtype
+
37 {
+
38  int is_neg;
+
39  unsigned int days;
+
40  unsigned int weeks;
+
41  unsigned int hours;
+
42  unsigned int minutes;
+
43  unsigned int seconds;
+
44 };
+
45 
+
46 #define ICALDURATIONTYPE_INITIALIZER { 0, 0, 0, 0, 0, 0 }
+
47 
+
63 LIBICAL_ICAL_EXPORT struct icaldurationtype icaldurationtype_from_int(int t);
+
64 
+
84 LIBICAL_ICAL_EXPORT struct icaldurationtype icaldurationtype_from_string(const char *dur);
+
85 
+
101 LIBICAL_ICAL_EXPORT int icaldurationtype_as_int(struct icaldurationtype duration);
+
102 
+
127 LIBICAL_ICAL_EXPORT char *icaldurationtype_as_ical_string(struct icaldurationtype d);
+
128 
+
149 LIBICAL_ICAL_EXPORT char *icaldurationtype_as_ical_string_r(struct icaldurationtype d);
+
150 
+
172 LIBICAL_ICAL_EXPORT struct icaldurationtype icaldurationtype_null_duration(void);
+
173 
+
189 LIBICAL_ICAL_EXPORT struct icaldurationtype icaldurationtype_bad_duration(void);
+
190 
+
207 LIBICAL_ICAL_EXPORT int icaldurationtype_is_null_duration(struct icaldurationtype d);
+
208 
+
225 LIBICAL_ICAL_EXPORT int icaldurationtype_is_bad_duration(struct icaldurationtype d);
+
226 
+
246 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_add(struct icaltimetype t,
+
247  struct icaldurationtype d);
+
248 
+
266 LIBICAL_ICAL_EXPORT struct icaldurationtype icaltime_subtract(struct icaltimetype t1,
+
267  struct icaltimetype t2);
+
268 
+
269 #endif /* !ICALDURATION_H */
+
icaldurationtype_from_string
struct icaldurationtype icaldurationtype_from_string(const char *dur)
Creates a new icaldurationtype from a duration given as a string.
Definition: icalduration.c:62
+
icaldurationtype_as_int
int icaldurationtype_as_int(struct icaldurationtype duration)
Converts an icaldurationtype into the duration in seconds as int.
Definition: icalduration.c:270
+
icaldurationtype_bad_duration
struct icaldurationtype icaldurationtype_bad_duration(void)
Creates a bad duration (used to indicate error).
Definition: icalduration.c:304
+
icaldurationtype_as_ical_string_r
char * icaldurationtype_as_ical_string_r(struct icaldurationtype d)
Definition: icalduration.c:220
+
icaldurationtype_as_ical_string
char * icaldurationtype_as_ical_string(struct icaldurationtype d)
Definition: icalduration.c:211
+
icaldurationtype_from_int
struct icaldurationtype icaldurationtype_from_int(int t)
Creates a new icaldurationtype from a duration in seconds.
Definition: icalduration.c:32
+
icaldurationtype_is_bad_duration
int icaldurationtype_is_bad_duration(struct icaldurationtype d)
Checks if a duration is a bad duration.
Definition: icalduration.c:313
+
icaltime_subtract
struct icaldurationtype icaltime_subtract(struct icaltimetype t1, struct icaltimetype t2)
Returns the difference between two icaltimetype as a duration.
Definition: icalduration.c:339
+
icaltime_add
struct icaltimetype icaltime_add(struct icaltimetype t, struct icaldurationtype d)
Adds a duration to an icaltime object and returns the result.
Definition: icalduration.c:318
+
icaldurationtype_null_duration
struct icaldurationtype icaldurationtype_null_duration(void)
Creates a duration with zero length.
Definition: icalduration.c:279
+
icaldurationtype_is_null_duration
int icaldurationtype_is_null_duration(struct icaldurationtype d)
Checks if a duration is a null duration.
Definition: icalduration.c:288
icaltime.h
struct icaltimetype is a pseudo-object that abstracts time handling.
-
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:28
-
icaltimetype
Definition: icaltime.h:97
+
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
+
icaltimetype
Definition: icaltime.h:105
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalenums_8h.html b/apidocs/icalenums_8h.html index 2c40db97..c926f6a4 100644 --- a/apidocs/icalenums_8h.html +++ b/apidocs/icalenums_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalenums.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Typedefs | Enumerations | Functions
-
icalenums.h File Reference
+
+
icalenums.h File Reference

Go to the source code of this file.

- - - - - - - - - - - -

+

Macros

+
#define icalenum_component_kind_to_string(x)   icalcomponent_kind_to_string(x)
 
+
#define icalenum_method_to_string(x)   icalproperty_method_to_string(x)
 
+
#define icalenum_property_kind_to_string(x)   icalproperty_kind_to_string(x)
 
+
#define icalenum_property_kind_to_value_kind(x)   icalproperty_kind_to_value_kind(x)
 
+
#define icalenum_status_to_string(x)   icalproperty_status_to_string(x)
 
+
#define icalenum_string_to_component_kind(x)   icalcomponent_string_to_kind(x)
 
+
#define icalenum_string_to_method(x)   icalproperty_string_to_method(x)
 
+
#define icalenum_string_to_property_kind(x)   icalproperty_string_to_kind(x)
 
+
#define icalenum_string_to_status(x)   icalproperty_string_to_status(x)
 
+
#define icalenum_string_to_value_kind(x)   icalvalue_string_to_kind(x)
 
+
#define icalenum_value_kind_to_string(x)   icalvalue_kind_to_string(x)
 
- - -

+

Typedefs

+
typedef enum icalcomponent_kind icalcomponent_kind
 
+
typedef enum icalrequeststatus icalrequeststatus
 
- - , ICAL_VPATCH_COMPONENT ,
  ICAL_XPATCH_COMPONENT -, ICAL_PARTICIPANT_COMPONENT -, ICAL_VLOCATION_COMPONENT -, ICAL_VRESOURCE_COMPONENT -,
-  ICAL_NUM_COMPONENT_TYPES
} - }

+

Enumerations

enum  icalcomponent_kind {
+
enum  icalcomponent_kind {
  ICAL_NO_COMPONENT , ICAL_ANY_COMPONENT , ICAL_XROOT_COMPONENT @@ -166,15 +167,10 @@ Enumerations
 
enum  icalrequeststatus {
+
enum  icalrequeststatus {
  ICAL_UNKNOWN_STATUS , ICAL_2_0_SUCCESS_STATUS , ICAL_2_1_FALLBACK_STATUS @@ -227,36 +223,36 @@ Enumerations
 
- - + - - - - - - - - - + + + + + + + + - +

+

Functions

-icalrequeststatus icalenum_num_to_reqstat (short major, short minor)
+icalrequeststatus icalenum_num_to_reqstat (short major, short minor)
 Returns a request status for major/minor status numbers.
 
+
char * icalenum_reqstat_code (icalrequeststatus stat)
 
-char * icalenum_reqstat_code_r (icalrequeststatus stat)
 Returns the code for a request status.
 
-const char * icalenum_reqstat_desc (icalrequeststatus stat)
 Returns the descriptive text for a request status.
 
-short icalenum_reqstat_major (icalrequeststatus stat)
 
+char * icalenum_reqstat_code_r (icalrequeststatus stat)
 Returns the code for a request status.
 
+const char * icalenum_reqstat_desc (icalrequeststatus stat)
 Returns the descriptive text for a request status.
 
+short icalenum_reqstat_major (icalrequeststatus stat)
 Returns the major number for a request status.
 
-short icalenum_reqstat_minor (icalrequeststatus stat)
+short icalenum_reqstat_minor (icalrequeststatus stat)
 Returns the minor number for a request status.
 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalenums_8h_source.html b/apidocs/icalenums_8h_source.html index ae13167b..3c9bf6ab 100644 --- a/apidocs/icalenums_8h_source.html +++ b/apidocs/icalenums_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalenums.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalenums.h
+
+
icalenums.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalenums.h
-
3
-
4 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
5
-
6 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
7
-
8 Contributions from:
-
9 Graham Davison <g.m.davison@computer.org>
-
10======================================================================*/
-
11
-
12#ifndef ICALENUMS_H
-
13#define ICALENUMS_H
-
14
-
15#include "libical_ical_export.h"
-
16
-
19/***********************************************************************
-
20 * Component enumerations
-
21**********************************************************************/
-
22
-
23typedef enum icalcomponent_kind
-
24{
-
25 ICAL_NO_COMPONENT,
-
26 ICAL_ANY_COMPONENT, /* Used to select all components */
-
27 ICAL_XROOT_COMPONENT,
-
28 ICAL_XATTACH_COMPONENT, /* MIME attached data, returned by parser. */
-
29 ICAL_VEVENT_COMPONENT,
-
30 ICAL_VTODO_COMPONENT,
-
31 ICAL_VJOURNAL_COMPONENT,
-
32 ICAL_VCALENDAR_COMPONENT,
-
33 ICAL_VAGENDA_COMPONENT,
-
34 ICAL_VFREEBUSY_COMPONENT,
-
35 ICAL_VALARM_COMPONENT,
-
36 ICAL_XAUDIOALARM_COMPONENT,
-
37 ICAL_XDISPLAYALARM_COMPONENT,
-
38 ICAL_XEMAILALARM_COMPONENT,
-
39 ICAL_XPROCEDUREALARM_COMPONENT,
-
40 ICAL_VTIMEZONE_COMPONENT,
-
41 ICAL_XSTANDARD_COMPONENT,
-
42 ICAL_XDAYLIGHT_COMPONENT,
-
43 ICAL_X_COMPONENT,
-
44 ICAL_VSCHEDULE_COMPONENT,
-
45 ICAL_VQUERY_COMPONENT,
-
46 ICAL_VREPLY_COMPONENT,
-
47 ICAL_VCAR_COMPONENT,
-
48 ICAL_VCOMMAND_COMPONENT,
-
49 ICAL_XLICINVALID_COMPONENT,
-
50 ICAL_XLICMIMEPART_COMPONENT, /* A non-stardard component that mirrors
-
51 structure of MIME data */
-
52 ICAL_VAVAILABILITY_COMPONENT,
-
53 ICAL_XAVAILABLE_COMPONENT,
-
54 ICAL_VPOLL_COMPONENT,
-
55 ICAL_VVOTER_COMPONENT,
-
56 ICAL_XVOTE_COMPONENT,
-
57 ICAL_VPATCH_COMPONENT,
-
58 ICAL_XPATCH_COMPONENT,
-
59 ICAL_PARTICIPANT_COMPONENT,
-
60 ICAL_VLOCATION_COMPONENT,
-
61 ICAL_VRESOURCE_COMPONENT,
-
62 ICAL_NUM_COMPONENT_TYPES /* MUST be last (unless we can put NO_COMP last) */
-
63} icalcomponent_kind;
-
64
-
65/***********************************************************************
-
66 * Request Status codes
-
67 **********************************************************************/
-
68
-
69typedef enum icalrequeststatus
-
70{
-
71 ICAL_UNKNOWN_STATUS,
-
72 ICAL_2_0_SUCCESS_STATUS,
-
73 ICAL_2_1_FALLBACK_STATUS,
-
74 ICAL_2_2_IGPROP_STATUS,
-
75 ICAL_2_3_IGPARAM_STATUS,
-
76 ICAL_2_4_IGXPROP_STATUS,
-
77 ICAL_2_5_IGXPARAM_STATUS,
-
78 ICAL_2_6_IGCOMP_STATUS,
-
79 ICAL_2_7_FORWARD_STATUS,
-
80 ICAL_2_8_ONEEVENT_STATUS,
-
81 ICAL_2_9_TRUNC_STATUS,
-
82 ICAL_2_10_ONETODO_STATUS,
-
83 ICAL_2_11_TRUNCRRULE_STATUS,
-
84 ICAL_3_0_INVPROPNAME_STATUS,
-
85 ICAL_3_1_INVPROPVAL_STATUS,
-
86 ICAL_3_2_INVPARAM_STATUS,
-
87 ICAL_3_3_INVPARAMVAL_STATUS,
-
88 ICAL_3_4_INVCOMP_STATUS,
-
89 ICAL_3_5_INVTIME_STATUS,
-
90 ICAL_3_6_INVRULE_STATUS,
-
91 ICAL_3_7_INVCU_STATUS,
-
92 ICAL_3_8_NOAUTH_STATUS,
-
93 ICAL_3_9_BADVERSION_STATUS,
-
94 ICAL_3_10_TOOBIG_STATUS,
-
95 ICAL_3_11_MISSREQCOMP_STATUS,
-
96 ICAL_3_12_UNKCOMP_STATUS,
-
97 ICAL_3_13_BADCOMP_STATUS,
-
98 ICAL_3_14_NOCAP_STATUS,
-
99 ICAL_3_15_INVCOMMAND,
-
100 ICAL_4_0_BUSY_STATUS,
-
101 ICAL_4_1_STORE_ACCESS_DENIED,
-
102 ICAL_4_2_STORE_FAILED,
-
103 ICAL_4_3_STORE_NOT_FOUND,
-
104 ICAL_5_0_MAYBE_STATUS,
-
105 ICAL_5_1_UNAVAIL_STATUS,
-
106 ICAL_5_2_NOSERVICE_STATUS,
-
107 ICAL_5_3_NOSCHED_STATUS,
-
108 ICAL_6_1_CONTAINER_NOT_FOUND,
-
109 ICAL_9_0_UNRECOGNIZED_COMMAND
-
110} icalrequeststatus;
-
111
-
114LIBICAL_ICAL_EXPORT const char *icalenum_reqstat_desc(icalrequeststatus stat);
-
115
-
118LIBICAL_ICAL_EXPORT short icalenum_reqstat_major(icalrequeststatus stat);
-
119
-
122LIBICAL_ICAL_EXPORT short icalenum_reqstat_minor(icalrequeststatus stat);
-
123
-
126LIBICAL_ICAL_EXPORT icalrequeststatus icalenum_num_to_reqstat(short major, short minor);
-
127
-
128LIBICAL_ICAL_EXPORT char *icalenum_reqstat_code(icalrequeststatus stat);
-
129
-
132LIBICAL_ICAL_EXPORT char *icalenum_reqstat_code_r(icalrequeststatus stat);
-
133
-
134/***********************************************************************
-
135 * Conversion functions
-
136**********************************************************************/
-
137
-
138/* These routines used to be in icalenums.c, but were moved into the
-
139 icalproperty, icalparameter, icalvalue, or icalcomponent modules. */
-
140
-
141/*const char* icalproperty_kind_to_string(icalproperty_kind kind);*/
-
142#define icalenum_property_kind_to_string(x) icalproperty_kind_to_string(x)
-
143
-
144/*icalproperty_kind icalproperty_string_to_kind(const char* string)*/
-
145#define icalenum_string_to_property_kind(x) icalproperty_string_to_kind(x)
-
146
-
147/*icalvalue_kind icalproperty_kind_to_value_kind(icalproperty_kind kind);*/
-
148#define icalenum_property_kind_to_value_kind(x) icalproperty_kind_to_value_kind(x)
-
149
-
150/*const char* icalenum_method_to_string(icalproperty_method);*/
-
151#define icalenum_method_to_string(x) icalproperty_method_to_string(x)
-
152
-
153/*icalproperty_method icalenum_string_to_method(const char* string);*/
-
154#define icalenum_string_to_method(x) icalproperty_string_to_method(x)
-
155
-
156/*const char* icalenum_status_to_string(icalproperty_status);*/
-
157#define icalenum_status_to_string(x) icalproperty_status_to_string(x)
-
158
-
159/*icalproperty_status icalenum_string_to_status(const char* string);*/
-
160#define icalenum_string_to_status(x) icalproperty_string_to_status(x)
-
161
-
162/*icalvalue_kind icalenum_string_to_value_kind(const char* str);*/
-
163#define icalenum_string_to_value_kind(x) icalvalue_string_to_kind(x)
-
164
-
165/*const char* icalenum_value_kind_to_string(icalvalue_kind kind);*/
-
166#define icalenum_value_kind_to_string(x) icalvalue_kind_to_string(x)
-
167
-
168/*const char* icalenum_component_kind_to_string(icalcomponent_kind kind);*/
-
169#define icalenum_component_kind_to_string(x) icalcomponent_kind_to_string(x)
-
170
-
171/*icalcomponent_kind icalenum_string_to_component_kind(const char* string);*/
-
172#define icalenum_string_to_component_kind(x) icalcomponent_string_to_kind(x)
-
173
-
174#endif /* !ICALENUMS_H */
-
icalenum_reqstat_desc
const char * icalenum_reqstat_desc(icalrequeststatus stat)
Returns the descriptive text for a request status.
Definition: icalenums.c:72
-
icalenum_reqstat_major
short icalenum_reqstat_major(icalrequeststatus stat)
Returns the major number for a request status.
Definition: icalenums.c:112
-
icalenum_num_to_reqstat
icalrequeststatus icalenum_num_to_reqstat(short major, short minor)
Returns a request status for major/minor status numbers.
Definition: icalenums.c:138
-
icalenum_reqstat_minor
short icalenum_reqstat_minor(icalrequeststatus stat)
Returns the minor number for a request status.
Definition: icalenums.c:125
-
icalenum_reqstat_code_r
char * icalenum_reqstat_code_r(icalrequeststatus stat)
Returns the code for a request status.
Definition: icalenums.c:95
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalenums.h
+
3 
+
4  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
5 
+
6  This library is free software; you can redistribute it and/or modify
+
7  it under the terms of either:
+
8 
+
9  The LGPL as published by the Free Software Foundation, version
+
10  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
11 
+
12  Or:
+
13 
+
14  The Mozilla Public License Version 2.0. You may obtain a copy of
+
15  the License at https://www.mozilla.org/MPL/
+
16 
+
17  Contributions from:
+
18  Graham Davison <g.m.davison@computer.org>
+
19 ======================================================================*/
+
20 
+
21 #ifndef ICALENUMS_H
+
22 #define ICALENUMS_H
+
23 
+
24 #include "libical_ical_export.h"
+
25 
+
28 /***********************************************************************
+
29  * Component enumerations
+
30 **********************************************************************/
+
31 
+
32 typedef enum icalcomponent_kind
+
33 {
+
34  ICAL_NO_COMPONENT,
+
35  ICAL_ANY_COMPONENT, /* Used to select all components */
+
36  ICAL_XROOT_COMPONENT,
+
37  ICAL_XATTACH_COMPONENT, /* MIME attached data, returned by parser. */
+
38  ICAL_VEVENT_COMPONENT,
+
39  ICAL_VTODO_COMPONENT,
+
40  ICAL_VJOURNAL_COMPONENT,
+
41  ICAL_VCALENDAR_COMPONENT,
+
42  ICAL_VAGENDA_COMPONENT,
+
43  ICAL_VFREEBUSY_COMPONENT,
+
44  ICAL_VALARM_COMPONENT,
+
45  ICAL_XAUDIOALARM_COMPONENT,
+
46  ICAL_XDISPLAYALARM_COMPONENT,
+
47  ICAL_XEMAILALARM_COMPONENT,
+
48  ICAL_XPROCEDUREALARM_COMPONENT,
+
49  ICAL_VTIMEZONE_COMPONENT,
+
50  ICAL_XSTANDARD_COMPONENT,
+
51  ICAL_XDAYLIGHT_COMPONENT,
+
52  ICAL_X_COMPONENT,
+
53  ICAL_VSCHEDULE_COMPONENT,
+
54  ICAL_VQUERY_COMPONENT,
+
55  ICAL_VREPLY_COMPONENT,
+
56  ICAL_VCAR_COMPONENT,
+
57  ICAL_VCOMMAND_COMPONENT,
+
58  ICAL_XLICINVALID_COMPONENT,
+
59  ICAL_XLICMIMEPART_COMPONENT, /* A non-stardard component that mirrors
+
60  structure of MIME data */
+
61  ICAL_VAVAILABILITY_COMPONENT,
+
62  ICAL_XAVAILABLE_COMPONENT,
+
63  ICAL_VPOLL_COMPONENT,
+
64  ICAL_VVOTER_COMPONENT,
+
65  ICAL_XVOTE_COMPONENT,
+
66  ICAL_VPATCH_COMPONENT,
+
67  ICAL_XPATCH_COMPONENT
+
68 } icalcomponent_kind;
+
69 
+
70 /***********************************************************************
+
71  * Request Status codes
+
72  **********************************************************************/
+
73 
+
74 typedef enum icalrequeststatus
+
75 {
+
76  ICAL_UNKNOWN_STATUS,
+
77  ICAL_2_0_SUCCESS_STATUS,
+
78  ICAL_2_1_FALLBACK_STATUS,
+
79  ICAL_2_2_IGPROP_STATUS,
+
80  ICAL_2_3_IGPARAM_STATUS,
+
81  ICAL_2_4_IGXPROP_STATUS,
+
82  ICAL_2_5_IGXPARAM_STATUS,
+
83  ICAL_2_6_IGCOMP_STATUS,
+
84  ICAL_2_7_FORWARD_STATUS,
+
85  ICAL_2_8_ONEEVENT_STATUS,
+
86  ICAL_2_9_TRUNC_STATUS,
+
87  ICAL_2_10_ONETODO_STATUS,
+
88  ICAL_2_11_TRUNCRRULE_STATUS,
+
89  ICAL_3_0_INVPROPNAME_STATUS,
+
90  ICAL_3_1_INVPROPVAL_STATUS,
+
91  ICAL_3_2_INVPARAM_STATUS,
+
92  ICAL_3_3_INVPARAMVAL_STATUS,
+
93  ICAL_3_4_INVCOMP_STATUS,
+
94  ICAL_3_5_INVTIME_STATUS,
+
95  ICAL_3_6_INVRULE_STATUS,
+
96  ICAL_3_7_INVCU_STATUS,
+
97  ICAL_3_8_NOAUTH_STATUS,
+
98  ICAL_3_9_BADVERSION_STATUS,
+
99  ICAL_3_10_TOOBIG_STATUS,
+
100  ICAL_3_11_MISSREQCOMP_STATUS,
+
101  ICAL_3_12_UNKCOMP_STATUS,
+
102  ICAL_3_13_BADCOMP_STATUS,
+
103  ICAL_3_14_NOCAP_STATUS,
+
104  ICAL_3_15_INVCOMMAND,
+
105  ICAL_4_0_BUSY_STATUS,
+
106  ICAL_4_1_STORE_ACCESS_DENIED,
+
107  ICAL_4_2_STORE_FAILED,
+
108  ICAL_4_3_STORE_NOT_FOUND,
+
109  ICAL_5_0_MAYBE_STATUS,
+
110  ICAL_5_1_UNAVAIL_STATUS,
+
111  ICAL_5_2_NOSERVICE_STATUS,
+
112  ICAL_5_3_NOSCHED_STATUS,
+
113  ICAL_6_1_CONTAINER_NOT_FOUND,
+
114  ICAL_9_0_UNRECOGNIZED_COMMAND
+
115 } icalrequeststatus;
+
116 
+
119 LIBICAL_ICAL_EXPORT const char *icalenum_reqstat_desc(icalrequeststatus stat);
+
120 
+
123 LIBICAL_ICAL_EXPORT short icalenum_reqstat_major(icalrequeststatus stat);
+
124 
+
127 LIBICAL_ICAL_EXPORT short icalenum_reqstat_minor(icalrequeststatus stat);
+
128 
+
131 LIBICAL_ICAL_EXPORT icalrequeststatus icalenum_num_to_reqstat(short major, short minor);
+
132 
+
133 LIBICAL_ICAL_EXPORT char *icalenum_reqstat_code(icalrequeststatus stat);
+
134 
+
137 LIBICAL_ICAL_EXPORT char *icalenum_reqstat_code_r(icalrequeststatus stat);
+
138 
+
139 /***********************************************************************
+
140  * Conversion functions
+
141 **********************************************************************/
+
142 
+
143 /* These routines used to be in icalenums.c, but were moved into the
+
144  icalproperty, icalparameter, icalvalue, or icalcomponent modules. */
+
145 
+
146 /*const char* icalproperty_kind_to_string(icalproperty_kind kind);*/
+
147 #define icalenum_property_kind_to_string(x) icalproperty_kind_to_string(x)
+
148 
+
149 /*icalproperty_kind icalproperty_string_to_kind(const char* string)*/
+
150 #define icalenum_string_to_property_kind(x) icalproperty_string_to_kind(x)
+
151 
+
152 /*icalvalue_kind icalproperty_kind_to_value_kind(icalproperty_kind kind);*/
+
153 #define icalenum_property_kind_to_value_kind(x) icalproperty_kind_to_value_kind(x)
+
154 
+
155 /*const char* icalenum_method_to_string(icalproperty_method);*/
+
156 #define icalenum_method_to_string(x) icalproperty_method_to_string(x)
+
157 
+
158 /*icalproperty_method icalenum_string_to_method(const char* string);*/
+
159 #define icalenum_string_to_method(x) icalproperty_string_to_method(x)
+
160 
+
161 /*const char* icalenum_status_to_string(icalproperty_status);*/
+
162 #define icalenum_status_to_string(x) icalproperty_status_to_string(x)
+
163 
+
164 /*icalproperty_status icalenum_string_to_status(const char* string);*/
+
165 #define icalenum_string_to_status(x) icalproperty_string_to_status(x)
+
166 
+
167 /*icalvalue_kind icalenum_string_to_value_kind(const char* str);*/
+
168 #define icalenum_string_to_value_kind(x) icalvalue_string_to_kind(x)
+
169 
+
170 /*const char* icalenum_value_kind_to_string(icalvalue_kind kind);*/
+
171 #define icalenum_value_kind_to_string(x) icalvalue_kind_to_string(x)
+
172 
+
173 /*const char* icalenum_component_kind_to_string(icalcomponent_kind kind);*/
+
174 #define icalenum_component_kind_to_string(x) icalcomponent_kind_to_string(x)
+
175 
+
176 /*icalcomponent_kind icalenum_string_to_component_kind(const char* string);*/
+
177 #define icalenum_string_to_component_kind(x) icalcomponent_string_to_kind(x)
+
178 
+
179 #endif /* !ICALENUMS_H */
+
icalenum_reqstat_desc
const char * icalenum_reqstat_desc(icalrequeststatus stat)
Returns the descriptive text for a request status.
Definition: icalenums.c:80
+
icalenum_reqstat_major
short icalenum_reqstat_major(icalrequeststatus stat)
Returns the major number for a request status.
Definition: icalenums.c:120
+
icalenum_num_to_reqstat
icalrequeststatus icalenum_num_to_reqstat(short major, short minor)
Returns a request status for major/minor status numbers.
Definition: icalenums.c:146
+
icalenum_reqstat_minor
short icalenum_reqstat_minor(icalrequeststatus stat)
Returns the minor number for a request status.
Definition: icalenums.c:133
+
icalenum_reqstat_code_r
char * icalenum_reqstat_code_r(icalrequeststatus stat)
Returns the code for a request status.
Definition: icalenums.c:103
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalerror_8h.html b/apidocs/icalerror_8h.html index 593137c9..a26a4d16 100644 --- a/apidocs/icalerror_8h.html +++ b/apidocs/icalerror_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalerror.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Typedefs | Enumerations | Functions
-
icalerror.h File Reference
+
+
icalerror.h File Reference
@@ -80,15 +81,15 @@ $(function() {

Go to the source code of this file.

- - - + @@ -109,32 +110,32 @@ Macros - - - - - +

+

Macros

#define ICAL_ERRORS_ARE_FATAL   0
 Determines if all libical errors are fatal and lead to the process aborting. More...
 
+
#define ICAL_SETERROR_ISFUNC
 
#define icalerrno   (*(icalerrno_return()))
#define icalerrno   (*(icalerrno_return()))
 Access the current icalerrno value. More...
 
#define icalerror_assert(test, message)
#define icalerror_check_arg_rz(test, arg)
 Checks the assertion test and raises error on failure, returns 0. More...
 
+
#define icalerror_check_component_type(value, type)   ;
 
+
#define icalerror_check_parameter_type(value, type)   ;
 
+
#define icalerror_check_property_type(value, type)   ;
 
+
#define icalerror_check_value_type(value, type)   ;
 
#define icalerror_warn(message)   {icalerrprintf("%s:%d: %s\n", __FILE__, __LINE__, message);}
#define icalerror_warn(message)   {fprintf(stderr, "%s:%d: %s\n", __FILE__, __LINE__, message);}
 Prints a formatted warning message to stderr. More...
 
- - -

+

Typedefs

+
typedef enum icalerrorenum icalerrorenum
 
+
typedef enum icalerrorstate icalerrorstate
 
-

+

Enumerations

enum  icalerrorenum {
  ICAL_NO_ERROR = 0 @@ -162,14 +163,14 @@ Enumerations
 Determine if an error is fatal or non-fatal. More...
 
- - - - + + + @@ -185,9 +186,9 @@ Functions - - - + + + @@ -202,18 +203,18 @@ Functions - - - + + +

+

Functions

void ical_bt (void)
 Prints backtrace. More...
 
icalerrorenum * icalerrno_return (void)
 Returns the current icalerrno value. More...
 
icalerrorenum * icalerrno_return (void)
 Returns the current icalerrno value. More...
 
void icalerror_clear_errno (void)
 Resets icalerrno to ICAL_NO_ERROR. More...
 
int icalerror_get_errors_are_fatal (void)
 Determine if errors are fatal. More...
 
const char * icalerror_perror (void)
 Returns the description string for the current error in icalerrno. More...
 
const char * icalerror_perror (void)
 Returns the description string for the current error in icalerrno. More...
 
void icalerror_restore (const char *error, icalerrorstate es)
 
void icalerror_set_errno (icalerrorenum x)
void icalerror_stop_here (void)
 Triggered before any error is called. More...
 
const char * icalerror_strerror (icalerrorenum e)
 Finds the description string for error. More...
 
const char * icalerror_strerror (icalerrorenum e)
 Finds the description string for error. More...
 
icalerrorstate icalerror_supress (const char *error)
 Suppresses a given error. More...
 

Detailed Description

-

Error handling for libical.

-

Most routines will set the global error value icalerrno on errors. This variable is an enumeration; permissible values can be found in icalerror.h. If the routine returns an enum icalerrorenum, then the return value will be the same as icalerrno. You can use icalerror_strerror() to get a string that describes the error, or icalerror_perror() to get a string describing the current error set in icalerrno.

+

Error handling for libical.

+

Most routines will set the global error value icalerrno on errors. This variable is an enumeration; permissible values can be found in icalerror.h. If the routine returns an enum icalerrorenum, then the return value will be the same as icalerrno. You can use icalerror_strerror() to get a string that describes the error, or icalerror_perror() to get a string describing the current error set in icalerrno.

Macro Definition Documentation

- +

◆ ICAL_ERRORS_ARE_FATAL

@@ -226,19 +227,19 @@ Functions

Determines if all libical errors are fatal and lead to the process aborting.

-

If set to 1, all libical errors are fatal and lead to the process aborting upon encountering on. Otherwise, errors are nonfatal.

-

Can be checked with libical_get_errors_are_fatal().

+

If set to 1, all libical errors are fatal and lead to the process aborting upon encountering on. Otherwise, errors are nonfatal.

+

Can be checked with libical_get_errors_are_fatal().

- +

◆ icalerrno

- +
#define icalerrno   (*(icalerrno_return()))#define icalerrno   (*(icalerrno_return()))
@@ -246,20 +247,20 @@ Functions

Access the current icalerrno value.

Returns
The current icalerrno value
Note
Pseudo-variable that can be used to access the current icalerrno.
-
Usage
if(icalerrno == ICAL_PARSE_ERROR) {
+
Usage
if(icalerrno == ICAL_PARSE_ERROR) {
// ...
}
// resets error
-
icalerrno = ICAL_NO_ERROR;
-
ICAL_NO_ERROR
@ ICAL_NO_ERROR
Definition: icalerror.h:69
-
ICAL_PARSE_ERROR
@ ICAL_PARSE_ERROR
Definition: icalerror.h:84
-
icalerrno
#define icalerrno
Access the current icalerrno value.
Definition: icalerror.h:135
+
icalerrno = ICAL_NO_ERROR;
+
ICAL_NO_ERROR
@ ICAL_NO_ERROR
Definition: icalerror.h:78
+
ICAL_PARSE_ERROR
@ ICAL_PARSE_ERROR
Definition: icalerror.h:93
+
icalerrno
#define icalerrno
Access the current icalerrno value.
Definition: icalerror.h:144
- +

◆ icalerror_assert

@@ -297,7 +298,7 @@ Functions
- +

◆ icalerror_check_arg

@@ -323,9 +324,9 @@ Functions
Value:
if (!(test)) { \
-
icalerror_set_errno(ICAL_BADARG_ERROR); \
+
icalerror_set_errno(ICAL_BADARG_ERROR); \
}
-
ICAL_BADARG_ERROR
@ ICAL_BADARG_ERROR
Definition: icalerror.h:72
+
ICAL_BADARG_ERROR
@ ICAL_BADARG_ERROR
Definition: icalerror.h:81

Checks the assertion test and raises error on failure.

Parameters
@@ -336,18 +337,18 @@ Functions

This function checks the assertion test, which is used to test if the parameter arg is correct. If the assertion fails, it sets icalerrno to ICAL_BADARG_ERROR.

-
Example
void test_function(icalcomponent *component) {
-
icalerror_check_arg(component != 0, "component");
+
Example
void test_function(icalcomponent *component) {
+
icalerror_check_arg(component != 0, "component");
// use component
}
-
icalerror_check_arg
#define icalerror_check_arg(test, arg)
Checks the assertion test and raises error on failure.
Definition: icalerror.h:432
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
icalerror_check_arg
#define icalerror_check_arg(test, arg)
Checks the assertion test and raises error on failure.
Definition: icalerror.h:441
+
icalcomponent_impl
Definition: icalcomponent.c:36
- +

◆ icalerror_check_arg_re

@@ -380,7 +381,7 @@ Functions
Value:
if (!(test)) { \
icalerror_stop_here(); \
-
icalassert(0); \
+
assert(0); \
return error; \
}
@@ -394,19 +395,19 @@ Functions

This function checks the assertion test, which is used to test if the parameter arg is correct. If the assertion fails, it aborts the process with assert(0) and causes the enclosing function to return error.

-
Example
icalcomponent *test_function(icalcomponent *component) {
-
icalerror_check_arg_re(component != 0, "component", NULL);
+
Example
icalcomponent *test_function(icalcomponent *component) {
+
icalerror_check_arg_re(component != 0, "component", NULL);
// use component
-
return icalcomponent_get_first_real_component(component);
+
return icalcomponent_get_first_real_component(component);
}
-
icalcomponent_get_first_real_component
icalcomponent * icalcomponent_get_first_real_component(icalcomponent *c)
Returns a reference to the first VEVENT, VTODO or VJOURNAL in the component.
Definition: icalcomponent.c:650
-
icalerror_check_arg_re
#define icalerror_check_arg_re(test, arg, error)
Checks the assertion test and raises error on failure, returns error.
Definition: icalerror.h:509
+
icalcomponent_get_first_real_component
icalcomponent * icalcomponent_get_first_real_component(icalcomponent *c)
Returns a reference to the first VEVENT, VTODO or VJOURNAL in the component.
Definition: icalcomponent.c:581
+
icalerror_check_arg_re
#define icalerror_check_arg_re(test, arg, error)
Checks the assertion test and raises error on failure, returns error.
Definition: icalerror.h:518
- +

◆ icalerror_check_arg_rv

@@ -432,7 +433,7 @@ Functions
Value:
if (!(test)) { \
-
icalerror_set_errno(ICAL_BADARG_ERROR); \
+
icalerror_set_errno(ICAL_BADARG_ERROR); \
return; \
}
@@ -445,17 +446,17 @@ Functions

This function checks the assertion test, which is used to test if the parameter arg is correct. If the assertion fails, it sets icalerrno to ICAL_BADARG_ERROR and causes the enclosing function to return void.

-
Example
void test_function(icalcomponent *component) {
-
icalerror_check_arg_rv(component != 0, "component");
+
Example
void test_function(icalcomponent *component) {
+
icalerror_check_arg_rv(component != 0, "component");
// use component
}
-
icalerror_check_arg_rv
#define icalerror_check_arg_rv(test, arg)
Checks the assertion test and raises error on failure, returns void.
Definition: icalerror.h:456
+
icalerror_check_arg_rv
#define icalerror_check_arg_rv(test, arg)
Checks the assertion test and raises error on failure, returns void.
Definition: icalerror.h:465
- +

◆ icalerror_check_arg_rx

@@ -487,7 +488,7 @@ Functions
Value:
if (!(test)) { \
-
icalerror_set_errno(ICAL_BADARG_ERROR); \
+
icalerror_set_errno(ICAL_BADARG_ERROR); \
return x; \
}
@@ -501,18 +502,18 @@ Functions

This function checks the assertion test, which is used to test if the parameter arg is correct. If the assertion fails, it sets icalerrno to ICAL_BADARG_ERROR and causes the enclosing function to return x.

-
Example
icalcomponent *test_function(icalcomponent *component) {
-
icalerror_check_arg_rx(component != 0, "component", NULL);
+
Example
icalcomponent *test_function(icalcomponent *component) {
+
icalerror_check_arg_rx(component != 0, "component", NULL);
// use component
-
return icalcomponent_get_first_real_component(component);
+
return icalcomponent_get_first_real_component(component);
}
-
icalerror_check_arg_rx
#define icalerror_check_arg_rx(test, arg, x)
Checks the assertion test and raises error on failure, returns x.
Definition: icalerror.h:537
+
icalerror_check_arg_rx
#define icalerror_check_arg_rx(test, arg, x)
Checks the assertion test and raises error on failure, returns x.
Definition: icalerror.h:546
- +

◆ icalerror_check_arg_rz

@@ -538,7 +539,7 @@ Functions
Value:
if (!(test)) { \
-
icalerror_set_errno(ICAL_BADARG_ERROR); \
+
icalerror_set_errno(ICAL_BADARG_ERROR); \
return 0; \
}
@@ -551,18 +552,18 @@ Functions

This function checks the assertion test, which is used to test if the parameter arg is correct. If the assertion fails, it sets icalerrno to ICAL_BADARG_ERROR and causes the enclosing function to return 0.

-
Example
int test_function(icalcomponent *component) {
-
icalerror_check_arg_rz(component != 0, "component");
+
Example
int test_function(icalcomponent *component) {
+
icalerror_check_arg_rz(component != 0, "component");
// use component
return icalcomponent_count_kinds(component, ICAL_ANY_COMPONENT);
}
-
icalerror_check_arg_rz
#define icalerror_check_arg_rz(test, arg)
Checks the assertion test and raises error on failure, returns 0.
Definition: icalerror.h:482
+
icalerror_check_arg_rz
#define icalerror_check_arg_rz(test, arg)
Checks the assertion test and raises error on failure, returns 0.
Definition: icalerror.h:491
- +

◆ icalerror_warn

@@ -573,7 +574,7 @@ Functions (   message) -    {icalerrprintf("%s:%d: %s\n", __FILE__, __LINE__, message);} +    {fprintf(stderr, "%s:%d: %s\n", __FILE__, __LINE__, message);}
@@ -585,14 +586,14 @@ Functions -
Usage
icalerror_warn("Non-standard tag encountered");
-
icalerror_warn
#define icalerror_warn(message)
Prints a formatted warning message to stderr.
Definition: icalerror.h:183
+
Usage
icalerror_warn("Non-standard tag encountered");
+
icalerror_warn
#define icalerror_warn(message)
Prints a formatted warning message to stderr.
Definition: icalerror.h:192

Enumeration Type Documentation

- +

◆ icalerrorenum

@@ -605,35 +606,35 @@ Functions

Represents the different types of errors that can be triggered in libical.

-

Each of these values represent a different type of error, which is stored in icalerrno on exit of the library function (or can be returned, but if it is, icalerrno is also set).

+

Each of these values represent a different type of error, which is stored in icalerrno on exit of the library function (or can be returned, but if it is, icalerrno is also set).

- - - - - - - - - - -
Enumerator
ICAL_NO_ERROR 

No error happened.

+
Enumerator
ICAL_NO_ERROR 

No error happened.

ICAL_BADARG_ERROR 

A bad argument was passed to a function.

+
ICAL_BADARG_ERROR 

A bad argument was passed to a function.

ICAL_NEWFAILED_ERROR 

An error occurred while creating a new object with a *_new() routine.

+
ICAL_NEWFAILED_ERROR 

An error occurred while creating a new object with a *_new() routine.

ICAL_ALLOCATION_ERROR 

An error occurred while allocating some memory.

+
ICAL_ALLOCATION_ERROR 

An error occurred while allocating some memory.

ICAL_MALFORMEDDATA_ERROR 

Malformed data was passed to a function.

+
ICAL_MALFORMEDDATA_ERROR 

Malformed data was passed to a function.

ICAL_PARSE_ERROR 

An error occurred while parsing part of an iCal component.

+
ICAL_PARSE_ERROR 

An error occurred while parsing part of an iCal component.

ICAL_INTERNAL_ERROR 

An internal error happened in library code.

+
ICAL_INTERNAL_ERROR 

An internal error happened in library code.

ICAL_FILE_ERROR 

An error happened while working with a file.

+
ICAL_FILE_ERROR 

An error happened while working with a file.

ICAL_USAGE_ERROR 

Failure to properly sequence calls to a set of interfaces.

+
ICAL_USAGE_ERROR 

Failure to properly sequence calls to a set of interfaces.

ICAL_UNIMPLEMENTED_ERROR 

An unimplemented function was called.

+
ICAL_UNIMPLEMENTED_ERROR 

An unimplemented function was called.

ICAL_UNKNOWN_ERROR 

An unknown error occurred.

+
ICAL_UNKNOWN_ERROR 

An unknown error occurred.

- +

◆ icalerrorstate

@@ -647,20 +648,20 @@ Functions

Determine if an error is fatal or non-fatal.

- - - -
Enumerator
ICAL_ERROR_FATAL 

Fatal.

+
Enumerator
ICAL_ERROR_FATAL 

Fatal.

ICAL_ERROR_NONFATAL 

Non-fatal.

+
ICAL_ERROR_NONFATAL 

Non-fatal.

ICAL_ERROR_DEFAULT 

Fatal if icalerror_errors_are_fatal(), non-fatal otherwise.

+
ICAL_ERROR_DEFAULT 

Fatal if icalerror_errors_are_fatal(), non-fatal otherwise.

ICAL_ERROR_UNKNOWN 

Asked state for an unknown error type.

+
ICAL_ERROR_UNKNOWN 

Asked state for an unknown error type.

Function Documentation

- +

◆ ical_bt()

@@ -678,22 +679,22 @@ Functions

Prints backtrace.

Note
Only works on systems that support it (HAVE_BACKTRACE enabled).
-
Usage
if(icalerrno != ICAL_NO_ERROR) {
-
ical_bt();
+
Usage
if(icalerrno != ICAL_NO_ERROR) {
+
ical_bt();
}
-
ical_bt
void ical_bt(void)
Prints backtrace.
Definition: icalerror.c:254
+
ical_bt
void ical_bt(void)
Prints backtrace.
Definition: icalerror.c:260
- -

◆ icalerrno_return()

+ +

◆ icalerrno_return()

- + @@ -705,13 +706,13 @@ Functions

Returns the current icalerrno value.

Returns
A pointer to the current icalerrno value

Yields a pointer to the current icalerrno value. This can be used to access (read from and write to) it.

-
Examples
assert(*icalerrno_return() == icalerrno);
-
icalerrno_return
icalerrorenum * icalerrno_return(void)
Returns the current icalerrno value.
Definition: icalerror.c:62
+
Examples
assert(*icalerrno_return() == icalerrno);
+
icalerrno_return
icalerrorenum * icalerrno_return(void)
Returns the current icalerrno value.
Definition: icalerror.c:70
- +

◆ icalerror_clear_errno()

@@ -728,16 +729,16 @@ Functions

Resets icalerrno to ICAL_NO_ERROR.

-
Usage
if(icalerrno == ICAL_PARSE_ERROR) {
+
Usage
if(icalerrno == ICAL_PARSE_ERROR) {
// ignore parsing errors
-
icalerror_clear_errno();
+
icalerror_clear_errno();
}
-
icalerror_clear_errno
void icalerror_clear_errno(void)
Resets icalerrno to ICAL_NO_ERROR.
Definition: icalerror.c:89
+
icalerror_clear_errno
void icalerror_clear_errno(void)
Resets icalerrno to ICAL_NO_ERROR.
Definition: icalerror.c:95
- +

◆ icalerror_crash_here()

@@ -754,11 +755,11 @@ Functions

Triggered to abort the process.

-

This routine is called to abort the process in the case of an error.

+

This routine is called to abort the process in the case of an error.

- +

◆ icalerror_error_from_string()

@@ -783,15 +784,15 @@ Functions
Returns
An icalerrorenum representing the error
Error handling
If the error specified in str can't be found, instead ICAL_UNKNOWN_ERROR is returned.
-
Usage
assert(icalerror_error_from_string("PARSE") == ICAL_PARSE_ERROR);
-
assert(icalerror_error_from_string("NONSENSE") == ICAL_UNKNOWN_ERROR);
-
ICAL_UNKNOWN_ERROR
@ ICAL_UNKNOWN_ERROR
Definition: icalerror.h:99
-
icalerror_error_from_string
icalerrorenum icalerror_error_from_string(const char *str)
Reads an error from a string.
Definition: icalerror.c:175
+
Usage
assert(icalerror_error_from_string("PARSE") == ICAL_PARSE_ERROR);
+
assert(icalerror_error_from_string("NONSENSE") == ICAL_UNKNOWN_ERROR);
+
ICAL_UNKNOWN_ERROR
@ ICAL_UNKNOWN_ERROR
Definition: icalerror.h:108
+
icalerror_error_from_string
icalerrorenum icalerror_error_from_string(const char *str)
Reads an error from a string.
Definition: icalerror.c:181
- +

◆ icalerror_get_error_state()

@@ -818,7 +819,7 @@ Functions
- +

◆ icalerror_get_errors_are_fatal()

@@ -836,25 +837,25 @@ Functions

Determine if errors are fatal.

Returns
True if libical errors are fatal
-
Usage
if(icalerror_get_errors_are_fatal()) {
+
Usage
if(icalerror_get_errors_are_fatal()) {
// since errors are fatal, this will abort the
// program.
-
icalerror_set_errno(ICAL_PARSE_ERROR);
+
icalerror_set_errno(ICAL_PARSE_ERROR);
}
-
icalerror_get_errors_are_fatal
int icalerror_get_errors_are_fatal(void)
Determine if errors are fatal.
Definition: icalerror.c:105
-
icalerror_set_errno
void icalerror_set_errno(icalerrorenum x)
Sets the icalerrno to a given error.
Definition: icalerror.c:111
+
icalerror_get_errors_are_fatal
int icalerror_get_errors_are_fatal(void)
Determine if errors are fatal.
Definition: icalerror.c:111
+
icalerror_set_errno
void icalerror_set_errno(icalerrorenum x)
Sets the icalerrno to a given error.
Definition: icalerror.c:117
- -

◆ icalerror_perror()

+ +

◆ icalerror_perror()

icalerrorenum * icalerrno_return icalerrorenum* icalerrno_return ( void  )
- + @@ -866,15 +867,15 @@ Functions

Returns the description string for the current error in icalerrno.

Error handling
If the type of error e wasn't found, it returns the description for ICAL_UNKNOWN_ERROR.
Ownership
The string that is returned is owned by the library and must not be free'd() by the user.
-
Usage
if(icalerrno != ICAL_NO_ERROR) {
-
printf("%s\n", icalerror_perror());
+
Usage
if(icalerrno != ICAL_NO_ERROR) {
+
printf("%s\n", icalerror_perror());
}
-
icalerror_perror
const char * icalerror_perror(void)
Returns the description string for the current error in icalerrno.
Definition: icalerror.c:203
+
icalerror_perror
const char * icalerror_perror(void)
Returns the description string for the current error in icalerrno.
Definition: icalerror.c:209
- +

◆ icalerror_restore()

@@ -899,7 +900,7 @@ Functions
const char * icalerror_perror const char* icalerror_perror ( void  )
-

Assigns the given error the given icalerrorstate (severity).

Parameters
+

Assigns the given error the given icalerrorstate (severity).

Parameters
@@ -908,20 +909,20 @@ Functions

Calling the function changes the icalerrorstate of the given error.

Usage
// suppress internal errors
-
icalerror_supress("INTERNAL");
+
icalerror_supress("INTERNAL");
// ...
// restore internal errors
-
icalerror_restore("INTERNAL", ICAL_ERROR_DEFAULT);
-
ICAL_ERROR_DEFAULT
@ ICAL_ERROR_DEFAULT
Definition: icalerror.h:214
-
icalerror_restore
void icalerror_restore(const char *error, icalerrorstate es)
Definition: icalerror.c:208
-
icalerror_supress
icalerrorstate icalerror_supress(const char *error)
Suppresses a given error.
Definition: icalerror.c:188
+
icalerror_restore("INTERNAL", ICAL_ERROR_DEFAULT);
+
ICAL_ERROR_DEFAULT
@ ICAL_ERROR_DEFAULT
Definition: icalerror.h:223
+
icalerror_restore
void icalerror_restore(const char *error, icalerrorstate es)
Definition: icalerror.c:214
+
icalerror_supress
icalerrorstate icalerror_supress(const char *error)
Suppresses a given error.
Definition: icalerror.c:194
- +

◆ icalerror_set_errno()

@@ -945,12 +946,12 @@ Functions

Sets icalerrno to the error given in x. Additionally, if the error is an ICAL_ERROR_FATAL or if it's an ICAL_ERROR_DEFAULT and ICAL_ERRORS_ARE_FATAL is true, it prints a warning to stderr and aborts the process.

-
Usage
icalerror_set_errno(ICAL_PARSE_ERROR);
+
Usage
icalerror_set_errno(ICAL_PARSE_ERROR);
- +

◆ icalerror_set_error_state()

@@ -985,14 +986,14 @@ Functions

Sets the severity of a given error. For example, it can be used to set the severity of an ICAL_PARSE_ERROR to be an ICAL_ERROR_NONFATAL.

-
Usage
icalerror_set_error_state(ICAL_PARSE_ERROR, ICAL_ERROR_NONFATAL);
-
ICAL_ERROR_NONFATAL
@ ICAL_ERROR_NONFATAL
Definition: icalerror.h:211
-
icalerror_set_error_state
void icalerror_set_error_state(icalerrorenum error, icalerrorstate state)
Sets the icalerrorstate for a given icalerrorenum error.
Definition: icalerror.c:217
+
Usage
icalerror_set_error_state(ICAL_PARSE_ERROR, ICAL_ERROR_NONFATAL);
+
ICAL_ERROR_NONFATAL
@ ICAL_ERROR_NONFATAL
Definition: icalerror.h:220
+
icalerror_set_error_state
void icalerror_set_error_state(icalerrorenum error, icalerrorstate state)
Sets the icalerrorstate for a given icalerrorenum error.
Definition: icalerror.c:223
- +

◆ icalerror_set_errors_are_fatal()

@@ -1016,14 +1017,14 @@ Functions
Warning
NOT THREAD SAFE: it is recommended that you do not change this in a multithreaded program.
-
Usage
icalerror_set_errors_are_fatal(true); // default
-
icalerror_set_errors_are_fatal(false);
-
icalerror_set_errors_are_fatal
void icalerror_set_errors_are_fatal(int fatal)
Change if errors are fatal.
Definition: icalerror.c:100
+
Usage
icalerror_set_errors_are_fatal(true); // default
+
icalerror_set_errors_are_fatal(false);
+
icalerror_set_errors_are_fatal
void icalerror_set_errors_are_fatal(int fatal)
Change if errors are fatal.
Definition: icalerror.c:106
- +

◆ icalerror_stop_here()

@@ -1040,19 +1041,19 @@ Functions

Triggered before any error is called.

-

This routine is called before any error is triggered. It is called by icalerror_set_errno(), so it does not appear in all of the macros below.

-

This routine can be used while debugging by setting a breakpoint here.

+

This routine is called before any error is triggered. It is called by icalerror_set_errno(), so it does not appear in all of the macros below.

+

This routine can be used while debugging by setting a breakpoint here.

- -

◆ icalerror_strerror()

+ +

◆ icalerror_strerror()

errorThe error in question
esThe icalerrorstate (severity) to set it to
- + @@ -1071,15 +1072,15 @@ Functions
Returns
A string describing the error that occurred
Error handling
If the type of error e wasn't found, it returns the description for ICAL_UNKNOWN_ERROR.
Ownership
The string that is returned is owned by the library and must not be free'd() by the user.
-
Usage
if(icalerrno != ICAL_NO_ERROR) {
-
printf("%s\n", icalerror_strerror(icalerrno));
+
Usage
if(icalerrno != ICAL_NO_ERROR) {
+
printf("%s\n", icalerror_strerror(icalerrno));
}
-
icalerror_strerror
const char * icalerror_strerror(icalerrorenum e)
Finds the description string for error.
Definition: icalerror.c:241
+
icalerror_strerror
const char * icalerror_strerror(icalerrorenum e)
Finds the description string for error.
Definition: icalerror.c:247
- +

◆ icalerror_supress()

@@ -1105,7 +1106,7 @@ Functions
Returns
The previous icalerrorstate (severity)

Calling this function causes the given error to be listed as ICAL_ERROR_NONFATAL, and thus suppressed. Error states can be restored with icalerror_restore().

Usage
// suppresses internal errors
-
icalerror_supress("INTERNAL");
+
icalerror_supress("INTERNAL");
@@ -1113,7 +1114,7 @@ Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalerror_8h_source.html b/apidocs/icalerror_8h_source.html index 79a2430d..90aa04bb 100644 --- a/apidocs/icalerror_8h_source.html +++ b/apidocs/icalerror_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalerror.h Source File @@ -19,9 +19,10 @@
const char * icalerror_strerror const char* icalerror_strerror ( icalerrorenum  e)
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalerror.h
+
+
icalerror.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalerror.h
-
3 CREATOR: eric 09 May 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The original code is icalerror.h
-
10======================================================================*/
-
11
-
12#ifndef ICALERROR_H
-
13#define ICALERROR_H
-
14
-
15#include "libical_ical_export.h"
-
16#include <assert.h>
-
17#include <stdio.h>
-
18
-
31#define ICAL_SETERROR_ISFUNC
-
32
-
43LIBICAL_ICAL_EXPORT void icalerror_stop_here(void);
-
44
-
51LIBICAL_ICAL_EXPORT void icalerror_crash_here(void);
-
52
-
53#ifndef _MSC_VER
-
54#pragma GCC visibility push(default)
-
55#endif
-
66typedef enum icalerrorenum
-
67{
-
69 ICAL_NO_ERROR = 0,
-
70
-
72 ICAL_BADARG_ERROR,
-
73
-
75 ICAL_NEWFAILED_ERROR,
-
76
-
78 ICAL_ALLOCATION_ERROR,
-
79
-
81 ICAL_MALFORMEDDATA_ERROR,
-
82
-
84 ICAL_PARSE_ERROR,
-
85
-
87 ICAL_INTERNAL_ERROR, /* Like assert --internal consist. prob */
-
88
-
90 ICAL_FILE_ERROR,
-
91
-
93 ICAL_USAGE_ERROR,
-
94
-
96 ICAL_UNIMPLEMENTED_ERROR,
-
97
-
99 ICAL_UNKNOWN_ERROR /* Used for problems in input to icalerror_strerror() */
-
100} icalerrorenum;
-
101#ifndef _MSC_VER
-
102#pragma GCC visibility pop
-
103#endif
-
104
-
117LIBICAL_ICAL_EXPORT icalerrorenum *icalerrno_return(void);
-
118
-
135#define icalerrno (*(icalerrno_return()))
-
136
-
149LIBICAL_ICAL_EXPORT void icalerror_set_errors_are_fatal(int fatal);
-
150
-
164LIBICAL_ICAL_EXPORT int icalerror_get_errors_are_fatal(void);
-
165
-
166/* Warning messages */
-
167
-
179#ifdef __GNUC__ca
-
180#define icalerror_warn(message) \
-
181{icalerrprintf("%s(), %s:%d: %s\n", __FUNCTION__, __FILE__, __LINE__, message);}
-
182#else /* __GNU_C__ */
-
183#define icalerror_warn(message) \
-
184{icalerrprintf("%s:%d: %s\n", __FILE__, __LINE__, message);}
-
185#endif /* __GNU_C__ */
-
186
-
198LIBICAL_ICAL_EXPORT void icalerror_clear_errno(void);
-
199
-
205typedef enum icalerrorstate
-
206{
-
208 ICAL_ERROR_FATAL,
-
209
-
211 ICAL_ERROR_NONFATAL,
-
212
-
214 ICAL_ERROR_DEFAULT,
-
215
-
217 ICAL_ERROR_UNKNOWN
-
218} icalerrorstate;
-
219
-
240LIBICAL_ICAL_EXPORT const char *icalerror_strerror(icalerrorenum e);
-
241
-
260LIBICAL_ICAL_EXPORT const char *icalerror_perror(void);
-
261
-
273LIBICAL_ICAL_EXPORT void ical_bt(void);
-
274
-
288LIBICAL_ICAL_EXPORT void icalerror_set_error_state(icalerrorenum error, icalerrorstate state);
-
289
-
295LIBICAL_ICAL_EXPORT icalerrorstate icalerror_get_error_state(icalerrorenum error);
-
296
-
312LIBICAL_ICAL_EXPORT icalerrorenum icalerror_error_from_string(const char *str);
-
313
-
329#if !defined(ICAL_SETERROR_ISFUNC)
-
330#define icalerror_set_errno(x) \
-
331icalerrno = x; \
-
332if(icalerror_get_error_state(x) == ICAL_ERROR_FATAL || \
-
333 (icalerror_get_error_state(x) == ICAL_ERROR_DEFAULT && \
-
334 icalerror_get_errors_are_fatal() == 1)){ \
-
335 icalerror_warn(icalerror_strerror(x)); \
-
336 ical_bt(); \
-
337 icalassert(0); \
-
338} }
-
339#else
-
354LIBICAL_ICAL_EXPORT void icalerror_set_errno(icalerrorenum x);
-
355#endif
-
356
-
369#if !defined(ICAL_ERRORS_ARE_FATAL)
-
370#define ICAL_ERRORS_ARE_FATAL 0
-
371#endif
-
372
-
373#if ICAL_ERRORS_ARE_FATAL == 1
-
374#undef NDEBUG
-
375#endif
-
376
-
377#define icalerror_check_value_type(value,type);
-
378#define icalerror_check_property_type(value,type);
-
379#define icalerror_check_parameter_type(value,type);
-
380#define icalerror_check_component_type(value,type);
-
381
-
382/* Assert with a message */
-
394#if ICAL_ERRORS_ARE_FATAL == 1
-
395
-
396#ifdef __GNUC__
-
397#define icalerror_assert(test,message) \
-
398if (!(test)) { \
-
399 icalerrprintf("%s(), %s:%d: %s\n", __FUNCTION__, __FILE__, __LINE__, message); \
-
400 icalerror_stop_here(); \
-
401 abort();}
-
402#else /*__GNUC__*/
-
403#define icalerror_assert(test,message) \
-
404if (!(test)) { \
-
405 icalerrprintf("%s:%d: %s\n", __FILE__, __LINE__, message); \
-
406 icalerror_stop_here(); \
-
407 abort();}
-
408#endif /*__GNUC__*/
-
409
-
410#else /* ICAL_ERRORS_ARE_FATAL */
-
411#define icalerror_assert(test,message)
-
412#endif /* ICAL_ERRORS_ARE_FATAL */
-
413
-
432#define icalerror_check_arg(test,arg) \
-
433if (!(test)) { \
-
434 icalerror_set_errno(ICAL_BADARG_ERROR); \
-
435}
-
436
-
456#define icalerror_check_arg_rv(test,arg) \
-
457if (!(test)) { \
-
458 icalerror_set_errno(ICAL_BADARG_ERROR); \
-
459 return; \
-
460}
-
461
-
482#define icalerror_check_arg_rz(test,arg) \
-
483if (!(test)) { \
-
484 icalerror_set_errno(ICAL_BADARG_ERROR); \
-
485 return 0; \
-
486}
-
487
-
509#define icalerror_check_arg_re(test,arg,error) \
-
510if (!(test)) { \
-
511 icalerror_stop_here(); \
-
512 icalassert(0); \
-
513 return error; \
-
514}
-
515
-
537#define icalerror_check_arg_rx(test,arg,x) \
-
538if (!(test)) { \
-
539 icalerror_set_errno(ICAL_BADARG_ERROR); \
-
540 return x; \
-
541}
-
542
-
543/* String interfaces to set an error to NONFATAL and restore it to its original value */
-
544
-
560LIBICAL_ICAL_EXPORT icalerrorstate icalerror_supress(const char *error);
-
561
-
580LIBICAL_ICAL_EXPORT void icalerror_restore(const char *error, icalerrorstate es);
-
581
-
582#endif /* !ICALERROR_H */
-
icalerrno_return
icalerrorenum * icalerrno_return(void)
Returns the current icalerrno value.
Definition: icalerror.c:62
-
icalerror_set_errors_are_fatal
void icalerror_set_errors_are_fatal(int fatal)
Change if errors are fatal.
Definition: icalerror.c:100
-
icalerror_crash_here
void icalerror_crash_here(void)
Triggered to abort the process.
Definition: icalerror.c:76
-
ical_bt
void ical_bt(void)
Prints backtrace.
Definition: icalerror.c:254
-
icalerrorstate
icalerrorstate
Determine if an error is fatal or non-fatal.
Definition: icalerror.h:206
-
ICAL_ERROR_UNKNOWN
@ ICAL_ERROR_UNKNOWN
Definition: icalerror.h:217
-
ICAL_ERROR_FATAL
@ ICAL_ERROR_FATAL
Definition: icalerror.h:208
-
ICAL_ERROR_DEFAULT
@ ICAL_ERROR_DEFAULT
Definition: icalerror.h:214
-
ICAL_ERROR_NONFATAL
@ ICAL_ERROR_NONFATAL
Definition: icalerror.h:211
-
icalerror_get_errors_are_fatal
int icalerror_get_errors_are_fatal(void)
Determine if errors are fatal.
Definition: icalerror.c:105
-
icalerror_perror
const char * icalerror_perror(void)
Returns the description string for the current error in icalerrno.
Definition: icalerror.c:203
-
icalerror_get_error_state
icalerrorstate icalerror_get_error_state(icalerrorenum error)
Gets the error state (severity) for a given error.
Definition: icalerror.c:228
-
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:67
-
ICAL_NEWFAILED_ERROR
@ ICAL_NEWFAILED_ERROR
Definition: icalerror.h:75
-
ICAL_BADARG_ERROR
@ ICAL_BADARG_ERROR
Definition: icalerror.h:72
-
ICAL_FILE_ERROR
@ ICAL_FILE_ERROR
Definition: icalerror.h:90
-
ICAL_ALLOCATION_ERROR
@ ICAL_ALLOCATION_ERROR
Definition: icalerror.h:78
-
ICAL_INTERNAL_ERROR
@ ICAL_INTERNAL_ERROR
Definition: icalerror.h:87
-
ICAL_NO_ERROR
@ ICAL_NO_ERROR
Definition: icalerror.h:69
-
ICAL_MALFORMEDDATA_ERROR
@ ICAL_MALFORMEDDATA_ERROR
Definition: icalerror.h:81
-
ICAL_UNKNOWN_ERROR
@ ICAL_UNKNOWN_ERROR
Definition: icalerror.h:99
-
ICAL_PARSE_ERROR
@ ICAL_PARSE_ERROR
Definition: icalerror.h:84
-
ICAL_UNIMPLEMENTED_ERROR
@ ICAL_UNIMPLEMENTED_ERROR
Definition: icalerror.h:96
-
ICAL_USAGE_ERROR
@ ICAL_USAGE_ERROR
Definition: icalerror.h:93
-
icalerror_set_error_state
void icalerror_set_error_state(icalerrorenum error, icalerrorstate state)
Sets the icalerrorstate for a given icalerrorenum error.
Definition: icalerror.c:217
-
icalerror_strerror
const char * icalerror_strerror(icalerrorenum e)
Finds the description string for error.
Definition: icalerror.c:241
-
icalerror_set_errno
void icalerror_set_errno(icalerrorenum x)
Sets the icalerrno to a given error.
Definition: icalerror.c:111
-
icalerror_restore
void icalerror_restore(const char *error, icalerrorstate es)
Definition: icalerror.c:208
-
icalerror_stop_here
void icalerror_stop_here(void)
Triggered before any error is called.
Definition: icalerror.c:71
-
icalerror_error_from_string
icalerrorenum icalerror_error_from_string(const char *str)
Reads an error from a string.
Definition: icalerror.c:175
-
icalerror_clear_errno
void icalerror_clear_errno(void)
Resets icalerrno to ICAL_NO_ERROR.
Definition: icalerror.c:89
-
icalerror_supress
icalerrorstate icalerror_supress(const char *error)
Suppresses a given error.
Definition: icalerror.c:188
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalerror.h
+
3  CREATOR: eric 09 May 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The original code is icalerror.h
+
19 ======================================================================*/
+
20 
+
21 #ifndef ICALERROR_H
+
22 #define ICALERROR_H
+
23 
+
24 #include "libical_ical_export.h"
+
25 #include <assert.h>
+
26 #include <stdio.h>
+
27 
+
40 #define ICAL_SETERROR_ISFUNC
+
41 
+
52 LIBICAL_ICAL_EXPORT void icalerror_stop_here(void);
+
53 
+
60 LIBICAL_ICAL_EXPORT void icalerror_crash_here(void);
+
61 
+
62 #ifndef _MSC_VER
+
63 #pragma GCC visibility push(default)
+
64 #endif
+
75 typedef enum icalerrorenum
+
76 {
+
78  ICAL_NO_ERROR = 0,
+
79 
+
81  ICAL_BADARG_ERROR,
+
82 
+
84  ICAL_NEWFAILED_ERROR,
+
85 
+
87  ICAL_ALLOCATION_ERROR,
+
88 
+
90  ICAL_MALFORMEDDATA_ERROR,
+
91 
+
93  ICAL_PARSE_ERROR,
+
94 
+
96  ICAL_INTERNAL_ERROR, /* Like assert --internal consist. prob */
+
97 
+
99  ICAL_FILE_ERROR,
+
100 
+
102  ICAL_USAGE_ERROR,
+
103 
+
105  ICAL_UNIMPLEMENTED_ERROR,
+
106 
+
108  ICAL_UNKNOWN_ERROR /* Used for problems in input to icalerror_strerror() */
+
109 } icalerrorenum;
+
110 #ifndef _MSC_VER
+
111 #pragma GCC visibility pop
+
112 #endif
+
113 
+
126 LIBICAL_ICAL_EXPORT icalerrorenum *icalerrno_return(void);
+
127 
+
144 #define icalerrno (*(icalerrno_return()))
+
145 
+
158 LIBICAL_ICAL_EXPORT void icalerror_set_errors_are_fatal(int fatal);
+
159 
+
173 LIBICAL_ICAL_EXPORT int icalerror_get_errors_are_fatal(void);
+
174 
+
175 /* Warning messages */
+
176 
+
188 #ifdef __GNUC__ca
+
189 #define icalerror_warn(message) \
+
190 {fprintf(stderr, "%s(), %s:%d: %s\n", __FUNCTION__, __FILE__, __LINE__, message);}
+
191 #else /* __GNU_C__ */
+
192 #define icalerror_warn(message) \
+
193 {fprintf(stderr, "%s:%d: %s\n", __FILE__, __LINE__, message);}
+
194 #endif /* __GNU_C__ */
+
195 
+
207 LIBICAL_ICAL_EXPORT void icalerror_clear_errno(void);
+
208 
+
214 typedef enum icalerrorstate
+
215 {
+
217  ICAL_ERROR_FATAL,
+
218 
+
220  ICAL_ERROR_NONFATAL,
+
221 
+
223  ICAL_ERROR_DEFAULT,
+
224 
+
226  ICAL_ERROR_UNKNOWN
+
227 } icalerrorstate;
+
228 
+
249 LIBICAL_ICAL_EXPORT const char *icalerror_strerror(icalerrorenum e);
+
250 
+
269 LIBICAL_ICAL_EXPORT const char *icalerror_perror(void);
+
270 
+
282 LIBICAL_ICAL_EXPORT void ical_bt(void);
+
283 
+
297 LIBICAL_ICAL_EXPORT void icalerror_set_error_state(icalerrorenum error, icalerrorstate state);
+
298 
+
304 LIBICAL_ICAL_EXPORT icalerrorstate icalerror_get_error_state(icalerrorenum error);
+
305 
+
321 LIBICAL_ICAL_EXPORT icalerrorenum icalerror_error_from_string(const char *str);
+
322 
+
338 #if !defined(ICAL_SETERROR_ISFUNC)
+
339 #define icalerror_set_errno(x) \
+
340 icalerrno = x; \
+
341 if(icalerror_get_error_state(x) == ICAL_ERROR_FATAL || \
+
342  (icalerror_get_error_state(x) == ICAL_ERROR_DEFAULT && \
+
343  icalerror_get_errors_are_fatal() == 1)){ \
+
344  icalerror_warn(icalerror_strerror(x)); \
+
345  ical_bt(); \
+
346  assert(0); \
+
347 } }
+
348 #else
+
363 LIBICAL_ICAL_EXPORT void icalerror_set_errno(icalerrorenum x);
+
364 #endif
+
365 
+
378 #if !defined(ICAL_ERRORS_ARE_FATAL)
+
379 #define ICAL_ERRORS_ARE_FATAL 0
+
380 #endif
+
381 
+
382 #if ICAL_ERRORS_ARE_FATAL == 1
+
383 #undef NDEBUG
+
384 #endif
+
385 
+
386 #define icalerror_check_value_type(value,type);
+
387 #define icalerror_check_property_type(value,type);
+
388 #define icalerror_check_parameter_type(value,type);
+
389 #define icalerror_check_component_type(value,type);
+
390 
+
391 /* Assert with a message */
+
403 #if ICAL_ERRORS_ARE_FATAL == 1
+
404 
+
405 #ifdef __GNUC__
+
406 #define icalerror_assert(test,message) \
+
407 if (!(test)) { \
+
408  fprintf(stderr, "%s(), %s:%d: %s\n", __FUNCTION__, __FILE__, __LINE__, message); \
+
409  icalerror_stop_here(); \
+
410  abort();}
+
411 #else /*__GNUC__*/
+
412 #define icalerror_assert(test,message) \
+
413 if (!(test)) { \
+
414  fprintf(stderr, "%s:%d: %s\n", __FILE__, __LINE__, message); \
+
415  icalerror_stop_here(); \
+
416  abort();}
+
417 #endif /*__GNUC__*/
+
418 
+
419 #else /* ICAL_ERRORS_ARE_FATAL */
+
420 #define icalerror_assert(test,message)
+
421 #endif /* ICAL_ERRORS_ARE_FATAL */
+
422 
+
441 #define icalerror_check_arg(test,arg) \
+
442 if (!(test)) { \
+
443  icalerror_set_errno(ICAL_BADARG_ERROR); \
+
444 }
+
445 
+
465 #define icalerror_check_arg_rv(test,arg) \
+
466 if (!(test)) { \
+
467  icalerror_set_errno(ICAL_BADARG_ERROR); \
+
468  return; \
+
469 }
+
470 
+
491 #define icalerror_check_arg_rz(test,arg) \
+
492 if (!(test)) { \
+
493  icalerror_set_errno(ICAL_BADARG_ERROR); \
+
494  return 0; \
+
495 }
+
496 
+
518 #define icalerror_check_arg_re(test,arg,error) \
+
519 if (!(test)) { \
+
520  icalerror_stop_here(); \
+
521  assert(0); \
+
522  return error; \
+
523 }
+
524 
+
546 #define icalerror_check_arg_rx(test,arg,x) \
+
547 if (!(test)) { \
+
548  icalerror_set_errno(ICAL_BADARG_ERROR); \
+
549  return x; \
+
550 }
+
551 
+
552 /* String interfaces to set an error to NONFATAL and restore it to its original value */
+
553 
+
569 LIBICAL_ICAL_EXPORT icalerrorstate icalerror_supress(const char *error);
+
570 
+
589 LIBICAL_ICAL_EXPORT void icalerror_restore(const char *error, icalerrorstate es);
+
590 
+
591 #endif /* !ICALERROR_H */
+
icalerror_set_errors_are_fatal
void icalerror_set_errors_are_fatal(int fatal)
Change if errors are fatal.
Definition: icalerror.c:106
+
icalerror_crash_here
void icalerror_crash_here(void)
Triggered to abort the process.
Definition: icalerror.c:84
+
ical_bt
void ical_bt(void)
Prints backtrace.
Definition: icalerror.c:260
+
icalerrorstate
icalerrorstate
Determine if an error is fatal or non-fatal.
Definition: icalerror.h:215
+
ICAL_ERROR_UNKNOWN
@ ICAL_ERROR_UNKNOWN
Definition: icalerror.h:226
+
ICAL_ERROR_FATAL
@ ICAL_ERROR_FATAL
Definition: icalerror.h:217
+
ICAL_ERROR_DEFAULT
@ ICAL_ERROR_DEFAULT
Definition: icalerror.h:223
+
ICAL_ERROR_NONFATAL
@ ICAL_ERROR_NONFATAL
Definition: icalerror.h:220
+
icalerror_get_errors_are_fatal
int icalerror_get_errors_are_fatal(void)
Determine if errors are fatal.
Definition: icalerror.c:111
+
icalerror_perror
const char * icalerror_perror(void)
Returns the description string for the current error in icalerrno.
Definition: icalerror.c:209
+
icalerror_get_error_state
icalerrorstate icalerror_get_error_state(icalerrorenum error)
Gets the error state (severity) for a given error.
Definition: icalerror.c:234
+
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:76
+
ICAL_NEWFAILED_ERROR
@ ICAL_NEWFAILED_ERROR
Definition: icalerror.h:84
+
ICAL_BADARG_ERROR
@ ICAL_BADARG_ERROR
Definition: icalerror.h:81
+
ICAL_FILE_ERROR
@ ICAL_FILE_ERROR
Definition: icalerror.h:99
+
ICAL_ALLOCATION_ERROR
@ ICAL_ALLOCATION_ERROR
Definition: icalerror.h:87
+
ICAL_INTERNAL_ERROR
@ ICAL_INTERNAL_ERROR
Definition: icalerror.h:96
+
ICAL_NO_ERROR
@ ICAL_NO_ERROR
Definition: icalerror.h:78
+
ICAL_MALFORMEDDATA_ERROR
@ ICAL_MALFORMEDDATA_ERROR
Definition: icalerror.h:90
+
ICAL_UNKNOWN_ERROR
@ ICAL_UNKNOWN_ERROR
Definition: icalerror.h:108
+
ICAL_PARSE_ERROR
@ ICAL_PARSE_ERROR
Definition: icalerror.h:93
+
ICAL_UNIMPLEMENTED_ERROR
@ ICAL_UNIMPLEMENTED_ERROR
Definition: icalerror.h:105
+
ICAL_USAGE_ERROR
@ ICAL_USAGE_ERROR
Definition: icalerror.h:102
+
icalerror_set_error_state
void icalerror_set_error_state(icalerrorenum error, icalerrorstate state)
Sets the icalerrorstate for a given icalerrorenum error.
Definition: icalerror.c:223
+
icalerror_set_errno
void icalerror_set_errno(icalerrorenum x)
Sets the icalerrno to a given error.
Definition: icalerror.c:117
+
icalerror_restore
void icalerror_restore(const char *error, icalerrorstate es)
Definition: icalerror.c:214
+
icalerror_stop_here
void icalerror_stop_here(void)
Triggered before any error is called.
Definition: icalerror.c:79
+
icalerror_error_from_string
icalerrorenum icalerror_error_from_string(const char *str)
Reads an error from a string.
Definition: icalerror.c:181
+
icalerrno_return
icalerrorenum * icalerrno_return(void)
Returns the current icalerrno value.
Definition: icalerror.c:70
+
icalerror_strerror
const char * icalerror_strerror(icalerrorenum e)
Finds the description string for error.
Definition: icalerror.c:247
+
icalerror_clear_errno
void icalerror_clear_errno(void)
Resets icalerrno to ICAL_NO_ERROR.
Definition: icalerror.c:95
+
icalerror_supress
icalerrorstate icalerror_supress(const char *error)
Suppresses a given error.
Definition: icalerror.c:194
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalfileset_8h_source.html b/apidocs/icalfileset_8h_source.html index 55f69e39..a83ab06a 100644 --- a/apidocs/icalfileset_8h_source.html +++ b/apidocs/icalfileset_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalfileset.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalfileset.h
+
+
icalfileset.h
-
1/*======================================================================
-
2 FILE: icalfileset.h
-
3 CREATOR: eric 23 December 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
13#ifndef ICALFILESET_H
-
14#define ICALFILESET_H
-
15
-
16#include "libical_icalss_export.h"
-
17#include "icalcluster.h"
-
18#include "icalset.h"
-
19
-
20typedef struct icalfileset_impl icalfileset;
-
21
-
22LIBICAL_ICALSS_EXPORT icalset *icalfileset_new(const char *path);
-
23
-
24LIBICAL_ICALSS_EXPORT icalset *icalfileset_new_reader(const char *path);
-
25
-
26LIBICAL_ICALSS_EXPORT icalset *icalfileset_new_writer(const char *path);
-
27
-
28LIBICAL_ICALSS_EXPORT icalset *icalfileset_init(icalset *set, const char *dsn, void *options);
-
29
-
30LIBICAL_ICALSS_EXPORT icalcluster *icalfileset_produce_icalcluster(const char *path);
-
31
-
32LIBICAL_ICALSS_EXPORT void icalfileset_free(icalset *cluster);
-
33
-
34LIBICAL_ICALSS_EXPORT const char *icalfileset_path(icalset *cluster);
-
35
-
36/* Mark the cluster as changed, so it will be written to disk when it
-
37 is freed. Commit writes to disk immediately. */
-
38LIBICAL_ICALSS_EXPORT void icalfileset_mark(icalset *set);
-
39
-
40LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_commit(icalset *set);
-
41
-
42LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_add_component(icalset *set, icalcomponent *child);
-
43
-
44LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_remove_component(icalset *set,
-
45 icalcomponent *child);
-
46
-
47LIBICAL_ICALSS_EXPORT int icalfileset_count_components(icalset *set, icalcomponent_kind kind);
-
48
-
53LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_select(icalset *set, icalgauge *gauge);
-
54
-
56LIBICAL_ICALSS_EXPORT void icalfileset_clear(icalset *set);
-
57
-
59LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_fetch(icalset *set,
-
60 icalcomponent_kind kind, const char *uid);
-
61
-
62LIBICAL_ICALSS_EXPORT int icalfileset_has_uid(icalset *set, const char *uid);
-
63
-
64LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_fetch_match(icalset *set, icalcomponent *c);
-
65
-
71LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_modify(icalset *set,
-
72 icalcomponent *oldcomp,
-
73 icalcomponent *newcomp);
-
74
-
75/* Iterates through components. If a gauge has been defined, these
-
76 will skip over components that do not pass the gauge */
-
77
-
78LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_current_component(icalset *cluster);
-
79
-
80LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_first_component(icalset *cluster);
-
81
-
82LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_next_component(icalset *cluster);
-
83
-
84/* External iterator for thread safety */
-
85LIBICAL_ICALSS_EXPORT icalsetiter icalfileset_begin_component(icalset *set,
-
86 icalcomponent_kind kind,
-
87 icalgauge *gauge, const char *tzid);
-
88
-
89LIBICAL_ICALSS_EXPORT icalcomponent *icalfilesetiter_to_next(icalset *set, icalsetiter *iter);
-
90
-
91LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_form_a_matched_recurrence_component(icalsetiter *
-
92 itr);
-
93
-
97LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_component(icalset *cluster);
-
98
-
105typedef struct icalfileset_options
-
106{
-
107 int flags;
-
108 int mode;
-
109 int safe_saves;
-
110 icalcluster *cluster;
-
111} icalfileset_options;
-
112
-
113extern icalfileset_options icalfileset_options_default;
-
114
-
115#endif /* !ICALFILESET_H */
-
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:67
+
1 /*======================================================================
+
2  FILE: icalfileset.h
+
3  CREATOR: eric 23 December 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
22 #ifndef ICALFILESET_H
+
23 #define ICALFILESET_H
+
24 
+
25 #include "libical_icalss_export.h"
+
26 #include "icalcluster.h"
+
27 #include "icalset.h"
+
28 
+
29 typedef struct icalfileset_impl icalfileset;
+
30 
+
31 LIBICAL_ICALSS_EXPORT icalset *icalfileset_new(const char *path);
+
32 
+
33 LIBICAL_ICALSS_EXPORT icalset *icalfileset_new_reader(const char *path);
+
34 
+
35 LIBICAL_ICALSS_EXPORT icalset *icalfileset_new_writer(const char *path);
+
36 
+
37 LIBICAL_ICALSS_EXPORT icalset *icalfileset_init(icalset *set, const char *dsn, void *options);
+
38 
+
39 LIBICAL_ICALSS_EXPORT icalcluster *icalfileset_produce_icalcluster(const char *path);
+
40 
+
41 LIBICAL_ICALSS_EXPORT void icalfileset_free(icalset *cluster);
+
42 
+
43 LIBICAL_ICALSS_EXPORT const char *icalfileset_path(icalset *cluster);
+
44 
+
45 /* Mark the cluster as changed, so it will be written to disk when it
+
46  is freed. Commit writes to disk immediately. */
+
47 LIBICAL_ICALSS_EXPORT void icalfileset_mark(icalset *set);
+
48 
+
49 LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_commit(icalset *set);
+
50 
+
51 LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_add_component(icalset *set, icalcomponent *child);
+
52 
+
53 LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_remove_component(icalset *set,
+
54  icalcomponent *child);
+
55 
+
56 LIBICAL_ICALSS_EXPORT int icalfileset_count_components(icalset *set, icalcomponent_kind kind);
+
57 
+
62 LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_select(icalset *set, icalgauge *gauge);
+
63 
+
65 LIBICAL_ICALSS_EXPORT void icalfileset_clear(icalset *set);
+
66 
+
68 LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_fetch(icalset *set,
+
69  icalcomponent_kind kind, const char *uid);
+
70 
+
71 LIBICAL_ICALSS_EXPORT int icalfileset_has_uid(icalset *set, const char *uid);
+
72 
+
73 LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_fetch_match(icalset *set, icalcomponent *c);
+
74 
+
80 LIBICAL_ICALSS_EXPORT icalerrorenum icalfileset_modify(icalset *set,
+
81  icalcomponent *oldcomp,
+
82  icalcomponent *newcomp);
+
83 
+
84 /* Iterates through components. If a gauge has been defined, these
+
85  will skip over components that do not pass the gauge */
+
86 
+
87 LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_current_component(icalset *cluster);
+
88 
+
89 LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_first_component(icalset *cluster);
+
90 
+
91 LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_next_component(icalset *cluster);
+
92 
+
93 /* External iterator for thread safety */
+
94 LIBICAL_ICALSS_EXPORT icalsetiter icalfileset_begin_component(icalset *set,
+
95  icalcomponent_kind kind,
+
96  icalgauge *gauge, const char *tzid);
+
97 
+
98 LIBICAL_ICALSS_EXPORT icalcomponent *icalfilesetiter_to_next(icalset *set, icalsetiter *iter);
+
99 
+
100 LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_form_a_matched_recurrence_component(icalsetiter *
+
101  itr);
+
102 
+
106 LIBICAL_ICALSS_EXPORT icalcomponent *icalfileset_get_component(icalset *cluster);
+
107 
+
114 typedef struct icalfileset_options
+
115 {
+
116  int flags;
+
117  int mode;
+
118  int safe_saves;
+
119  icalcluster *cluster;
+
120 } icalfileset_options;
+
121 
+
122 extern icalfileset_options icalfileset_options_default;
+
123 
+
124 #endif /* !ICALFILESET_H */
+
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:76
-
icalcluster_impl
Definition: icalclusterimpl.h:20
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalfileset_impl
Definition: icalfilesetimpl.h:19
-
icalfileset_impl::path
char * path
Definition: icalfilesetimpl.h:21
-
icalfileset_impl::gauge
icalgauge * gauge
Definition: icalfilesetimpl.h:25
-
icalfileset_impl::options
icalfileset_options options
Definition: icalfilesetimpl.h:22
-
icalfileset_impl::cluster
icalcomponent * cluster
Definition: icalfilesetimpl.h:24
-
icalfileset_options
Options for opening an icalfileset.
Definition: icalfileset.h:106
-
icalfileset_options::mode
int mode
Definition: icalfileset.h:108
-
icalfileset_options::cluster
icalcluster * cluster
Definition: icalfileset.h:110
-
icalfileset_options::flags
int flags
Definition: icalfileset.h:107
-
icalfileset_options::safe_saves
int safe_saves
Definition: icalfileset.h:109
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-
icalset_impl
Definition: icalset.h:52
-
icalsetiter
Definition: icalset.h:43
+
icalcluster_impl
Definition: icalclusterimpl.h:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalfileset_impl
Definition: icalfilesetimpl.h:28
+
icalfileset_impl::path
char * path
Definition: icalfilesetimpl.h:30
+
icalfileset_impl::gauge
icalgauge * gauge
Definition: icalfilesetimpl.h:34
+
icalfileset_impl::options
icalfileset_options options
Definition: icalfilesetimpl.h:31
+
icalfileset_impl::cluster
icalcomponent * cluster
Definition: icalfilesetimpl.h:33
+
icalfileset_options
Options for opening an icalfileset.
Definition: icalfileset.h:115
+
icalfileset_options::mode
int mode
Definition: icalfileset.h:117
+
icalfileset_options::cluster
icalcluster * cluster
Definition: icalfileset.h:119
+
icalfileset_options::flags
int flags
Definition: icalfileset.h:116
+
icalfileset_options::safe_saves
int safe_saves
Definition: icalfileset.h:118
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
+
icalset_impl
Definition: icalset.h:61
+
icalsetiter
Definition: icalset.h:52
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalfilesetimpl_8h_source.html b/apidocs/icalfilesetimpl_8h_source.html index 7e0e0a2a..0eb28093 100644 --- a/apidocs/icalfilesetimpl_8h_source.html +++ b/apidocs/icalfilesetimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalfilesetimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalfilesetimpl.h
+
+
icalfilesetimpl.h
-
1/*======================================================================
-
2 FILE: icalfilesetimpl.h
-
3 CREATOR: eric 23 December 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
13#ifndef ICALFILESETIMPL_H
-
14#define ICALFILESETIMPL_H
-
15
-
16#include "icalfileset.h"
-
17
-
18struct icalfileset_impl
-
19{
-
20 icalset super;
-
21 char *path;
-
22 icalfileset_options options;
-
24 icalcomponent *cluster;
-
25 icalgauge *gauge;
-
26 int changed;
-
27 int fd;
-
28};
-
29
-
30#endif
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalfileset_impl
Definition: icalfilesetimpl.h:19
-
icalfileset_impl::path
char * path
Definition: icalfilesetimpl.h:21
-
icalfileset_impl::gauge
icalgauge * gauge
Definition: icalfilesetimpl.h:25
-
icalfileset_impl::options
icalfileset_options options
Definition: icalfilesetimpl.h:22
-
icalfileset_impl::super
icalset super
Definition: icalfilesetimpl.h:20
-
icalfileset_impl::fd
int fd
Definition: icalfilesetimpl.h:27
-
icalfileset_impl::changed
int changed
Definition: icalfilesetimpl.h:26
-
icalfileset_impl::cluster
icalcomponent * cluster
Definition: icalfilesetimpl.h:24
-
icalfileset_options
Options for opening an icalfileset.
Definition: icalfileset.h:106
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-
icalset_impl
Definition: icalset.h:52
+
1 /*======================================================================
+
2  FILE: icalfilesetimpl.h
+
3  CREATOR: eric 23 December 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
22 #ifndef ICALFILESETIMPL_H
+
23 #define ICALFILESETIMPL_H
+
24 
+
25 #include "icalfileset.h"
+
26 
+
27 struct icalfileset_impl
+
28 {
+
29  icalset super;
+
30  char *path;
+
31  icalfileset_options options;
+
33  icalcomponent *cluster;
+
34  icalgauge *gauge;
+
35  int changed;
+
36  int fd;
+
37 };
+
38 
+
39 #endif
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalfileset_impl
Definition: icalfilesetimpl.h:28
+
icalfileset_impl::path
char * path
Definition: icalfilesetimpl.h:30
+
icalfileset_impl::gauge
icalgauge * gauge
Definition: icalfilesetimpl.h:34
+
icalfileset_impl::options
icalfileset_options options
Definition: icalfilesetimpl.h:31
+
icalfileset_impl::super
icalset super
Definition: icalfilesetimpl.h:29
+
icalfileset_impl::fd
int fd
Definition: icalfilesetimpl.h:36
+
icalfileset_impl::changed
int changed
Definition: icalfilesetimpl.h:35
+
icalfileset_impl::cluster
icalcomponent * cluster
Definition: icalfilesetimpl.h:33
+
icalfileset_options
Options for opening an icalfileset.
Definition: icalfileset.h:115
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
+
icalset_impl
Definition: icalset.h:61
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalgauge_8h.html b/apidocs/icalgauge_8h.html index 3161da20..0d274ecb 100644 --- a/apidocs/icalgauge_8h.html +++ b/apidocs/icalgauge_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalgauge.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
icalgauge.h File Reference
+
+
icalgauge.h File Reference
@@ -78,13 +79,13 @@ $(function() {

Go to the source code of this file.

- -

+

Typedefs

+
typedef struct icalgauge_impl icalgauge
 
- @@ -92,19 +93,19 @@ Functions - - - +

+

Functions

int icalgauge_compare (icalgauge *g, icalcomponent *comp)
 Returns true if comp matches the gauge. More...
void icalgauge_dump (icalgauge *gauge)
 Debug. More...
 
+
void icalgauge_free (icalgauge *gauge)
 
int icalgauge_get_expand (icalgauge *gauge)
 
+
icalgauge * icalgauge_new_from_sql (const char *sql, int expand)
 
 

Detailed Description

-

Routines implementing a filter for ical components.

+

Routines implementing a filter for ical components.

Function Documentation

- +

◆ icalgauge_compare()

@@ -131,12 +132,12 @@ void icalgauge_free (<

Returns true if comp matches the gauge.

-

The component must be in canonical form – a VCALENDAR with one VEVENT, VTODO or VJOURNAL sub component

-

needs to use recurrence-id to do comparison

+

The component must be in canonical form – a VCALENDAR with one VEVENT, VTODO or VJOURNAL sub component

+

needs to use recurrence-id to do comparison

- +

◆ icalgauge_dump()

@@ -153,11 +154,11 @@ void icalgauge_free (<

Debug.

-

Prints gauge information to STDOUT.

+

Prints gauge information to STDOUT.

- +

◆ icalgauge_get_expand()

@@ -172,14 +173,14 @@ void icalgauge_free (<
-

Returns the expand value for the specified icalgauge. If gauge is NULL a value of -1 is returned.

+

Returns the expand value for the specified icalgauge. If gauge is NULL a value of -1 is returned.

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalgauge_8h_source.html b/apidocs/icalgauge_8h_source.html index 2f7494dc..1ad967d2 100644 --- a/apidocs/icalgauge_8h_source.html +++ b/apidocs/icalgauge_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalgauge.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalgauge.h
+
+
icalgauge.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalgauge.h
-
3 CREATOR: eric 23 December 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
13#ifndef ICALGAUGE_H
-
14#define ICALGAUGE_H
-
15
-
16#include "libical_icalss_export.h"
-
17#include "icalcomponent.h"
-
18
-
23typedef struct icalgauge_impl icalgauge;
-
24
-
25LIBICAL_ICALSS_EXPORT icalgauge *icalgauge_new_from_sql(const char *sql, int expand);
-
26
-
31LIBICAL_ICALSS_EXPORT int icalgauge_get_expand(icalgauge *gauge);
-
32
-
33LIBICAL_ICALSS_EXPORT void icalgauge_free(icalgauge *gauge);
-
34
-
39LIBICAL_ICALSS_EXPORT void icalgauge_dump(icalgauge *gauge);
-
40
-
47LIBICAL_ICALSS_EXPORT int icalgauge_compare(icalgauge *g, icalcomponent *comp);
-
48
-
49#endif /* ICALGAUGE_H */
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalgauge.h
+
3  CREATOR: eric 23 December 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
22 #ifndef ICALGAUGE_H
+
23 #define ICALGAUGE_H
+
24 
+
25 #include "libical_icalss_export.h"
+
26 #include "icalcomponent.h"
+
27 
+
32 typedef struct icalgauge_impl icalgauge;
+
33 
+
34 LIBICAL_ICALSS_EXPORT icalgauge *icalgauge_new_from_sql(const char *sql, int expand);
+
35 
+
40 LIBICAL_ICALSS_EXPORT int icalgauge_get_expand(icalgauge *gauge);
+
41 
+
42 LIBICAL_ICALSS_EXPORT void icalgauge_free(icalgauge *gauge);
+
43 
+
48 LIBICAL_ICALSS_EXPORT void icalgauge_dump(icalgauge *gauge);
+
49 
+
56 LIBICAL_ICALSS_EXPORT int icalgauge_compare(icalgauge *g, icalcomponent *comp);
+
57 
+
58 #endif /* ICALGAUGE_H */
-
icalgauge_get_expand
int icalgauge_get_expand(icalgauge *gauge)
Definition: icalgauge.c:59
-
icalgauge_dump
void icalgauge_dump(icalgauge *gauge)
Debug.
Definition: icalgauge.c:419
-
icalgauge_compare
int icalgauge_compare(icalgauge *g, icalcomponent *comp)
Returns true if comp matches the gauge.
Definition: icalgauge.c:249
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
+
icalgauge_get_expand
int icalgauge_get_expand(icalgauge *gauge)
Definition: icalgauge.c:68
+
icalgauge_dump
void icalgauge_dump(icalgauge *gauge)
Debug.
Definition: icalgauge.c:428
+
icalgauge_compare
int icalgauge_compare(icalgauge *g, icalcomponent *comp)
Returns true if comp matches the gauge.
Definition: icalgauge.c:258
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalgaugeimpl_8h_source.html b/apidocs/icalgaugeimpl_8h_source.html index ce454ccc..2bc75e9f 100644 --- a/apidocs/icalgaugeimpl_8h_source.html +++ b/apidocs/icalgaugeimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalgaugeimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalgaugeimpl.h
+
+
icalgaugeimpl.h
-
1/*======================================================================
-
2 FILE: icalgaugeimpl.h
-
3 CREATOR: eric 09 Aug 2000
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALGAUGEIMPL_H
-
12#define ICALGAUGEIMPL_H
-
13
-
14#include "icalcomponent.h"
-
15
-
16typedef enum icalgaugecompare
-
17{
-
18 ICALGAUGECOMPARE_EQUAL = ICAL_XLICCOMPARETYPE_EQUAL,
-
19 ICALGAUGECOMPARE_LESS = ICAL_XLICCOMPARETYPE_LESS,
-
20 ICALGAUGECOMPARE_LESSEQUAL = ICAL_XLICCOMPARETYPE_LESSEQUAL,
-
21 ICALGAUGECOMPARE_GREATER = ICAL_XLICCOMPARETYPE_GREATER,
-
22 ICALGAUGECOMPARE_GREATEREQUAL = ICAL_XLICCOMPARETYPE_GREATEREQUAL,
-
23 ICALGAUGECOMPARE_NOTEQUAL = ICAL_XLICCOMPARETYPE_NOTEQUAL,
-
24 ICALGAUGECOMPARE_REGEX = ICAL_XLICCOMPARETYPE_REGEX,
-
25 ICALGAUGECOMPARE_ISNULL = ICAL_XLICCOMPARETYPE_ISNULL,
-
26 ICALGAUGECOMPARE_ISNOTNULL = ICAL_XLICCOMPARETYPE_ISNOTNULL,
-
27 ICALGAUGECOMPARE_NONE = 0
-
28} icalgaugecompare;
-
29
-
30typedef enum icalgaugelogic
-
31{
-
32 ICALGAUGELOGIC_NONE,
-
33 ICALGAUGELOGIC_AND,
-
34 ICALGAUGELOGIC_OR
-
35} icalgaugelogic;
-
36
-
37struct icalgauge_where
-
38{
-
39 icalgaugelogic logic;
-
40 icalcomponent_kind comp;
-
41 icalproperty_kind prop;
-
42 icalgaugecompare compare;
-
43 char *value;
-
44};
-
45
-
46struct icalgauge_impl
-
47{
-
48 pvl_list select;
-
49 pvl_list from;
-
50 pvl_list where;
-
51 int expand;
-
52};
-
53
-
54#endif
+
1 /*======================================================================
+
2  FILE: icalgaugeimpl.h
+
3  CREATOR: eric 09 Aug 2000
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALGAUGEIMPL_H
+
20 #define ICALGAUGEIMPL_H
+
21 
+
22 #include "icalcomponent.h"
+
23 
+
24 typedef enum icalgaugecompare
+
25 {
+
26  ICALGAUGECOMPARE_EQUAL = ICAL_XLICCOMPARETYPE_EQUAL,
+
27  ICALGAUGECOMPARE_LESS = ICAL_XLICCOMPARETYPE_LESS,
+
28  ICALGAUGECOMPARE_LESSEQUAL = ICAL_XLICCOMPARETYPE_LESSEQUAL,
+
29  ICALGAUGECOMPARE_GREATER = ICAL_XLICCOMPARETYPE_GREATER,
+
30  ICALGAUGECOMPARE_GREATEREQUAL = ICAL_XLICCOMPARETYPE_GREATEREQUAL,
+
31  ICALGAUGECOMPARE_NOTEQUAL = ICAL_XLICCOMPARETYPE_NOTEQUAL,
+
32  ICALGAUGECOMPARE_REGEX = ICAL_XLICCOMPARETYPE_REGEX,
+
33  ICALGAUGECOMPARE_ISNULL = ICAL_XLICCOMPARETYPE_ISNULL,
+
34  ICALGAUGECOMPARE_ISNOTNULL = ICAL_XLICCOMPARETYPE_ISNOTNULL,
+
35  ICALGAUGECOMPARE_NONE = 0
+
36 } icalgaugecompare;
+
37 
+
38 typedef enum icalgaugelogic
+
39 {
+
40  ICALGAUGELOGIC_NONE,
+
41  ICALGAUGELOGIC_AND,
+
42  ICALGAUGELOGIC_OR
+
43 } icalgaugelogic;
+
44 
+
45 struct icalgauge_where
+
46 {
+
47  icalgaugelogic logic;
+
48  icalcomponent_kind comp;
+
49  icalproperty_kind prop;
+
50  icalgaugecompare compare;
+
51  char *value;
+
52 };
+
53 
+
54 struct icalgauge_impl
+
55 {
+
56  pvl_list select;
+
57  pvl_list from;
+
58  pvl_list where;
+
59  int expand;
+
60 };
+
61 
+
62 #endif
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-
icalgauge_impl::where
pvl_list where
Definition: icalgaugeimpl.h:50
-
icalgauge_impl::from
pvl_list from
Definition: icalgaugeimpl.h:49
-
icalgauge_impl::select
pvl_list select
Definition: icalgaugeimpl.h:48
-
icalgauge_where
Definition: icalgaugeimpl.h:38
-
pvl_list_t
Definition: pvl.c:59
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
+
icalgauge_impl::where
pvl_list where
Definition: icalgaugeimpl.h:58
+
icalgauge_impl::from
pvl_list from
Definition: icalgaugeimpl.h:57
+
icalgauge_impl::select
pvl_list select
Definition: icalgaugeimpl.h:56
+
icalgauge_where
Definition: icalgaugeimpl.h:46
+
pvl_list_t
Definition: pvl.c:65
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icallangbind_8h_source.html b/apidocs/icallangbind_8h_source.html index d9c46f3c..fdfb56c2 100644 --- a/apidocs/icallangbind_8h_source.html +++ b/apidocs/icallangbind_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icallangbind.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icallangbind.h
+
+
icallangbind.h
-
1/*======================================================================
-
2 FILE: icallangbind.h
-
3 CREATOR: eric 25 jan 2001
-
4
-
5 SPDX-FileCopyrightText: 1999 Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALLANGBIND_H
-
12#define ICALLANGBIND_H
-
13
-
14#include "libical_ical_export.h"
-
15#include "icalcomponent.h"
-
16#include "icalproperty.h"
-
17
-
18LIBICAL_ICAL_EXPORT int *icallangbind_new_array(int size);
-
19
-
20LIBICAL_ICAL_EXPORT void icallangbind_free_array(int *array);
-
21
-
22LIBICAL_ICAL_EXPORT int icallangbind_access_array(int *array, int index);
-
23
-
24LIBICAL_ICAL_EXPORT icalproperty *icallangbind_get_first_property(icalcomponent *c,
-
25 const char *prop);
-
26
-
27LIBICAL_ICAL_EXPORT icalproperty *icallangbind_get_next_property(icalcomponent *c,
-
28 const char *prop);
-
29
-
30LIBICAL_ICAL_EXPORT icalcomponent *icallangbind_get_first_component(icalcomponent *c,
-
31 const char *comp);
-
32
-
33LIBICAL_ICAL_EXPORT icalcomponent *icallangbind_get_next_component(icalcomponent *c,
-
34 const char *comp);
-
35
-
36LIBICAL_ICAL_EXPORT icalparameter *icallangbind_get_first_parameter(icalproperty *prop);
-
37
-
38LIBICAL_ICAL_EXPORT icalparameter *icallangbind_get_next_parameter(icalproperty *prop);
-
39
-
40LIBICAL_ICAL_EXPORT const char *icallangbind_property_eval_string(icalproperty *prop,
-
41 const char *sep);
-
42
-
43LIBICAL_ICAL_EXPORT char *icallangbind_property_eval_string_r(icalproperty *prop,
-
44 const char *sep);
-
45
-
46LIBICAL_ICAL_EXPORT int icallangbind_string_to_open_flag(const char *str);
-
47
-
48LIBICAL_ICAL_EXPORT const char *icallangbind_quote_as_ical(const char *str);
-
49
-
50LIBICAL_ICAL_EXPORT char *icallangbind_quote_as_ical_r(const char *str);
-
51
-
52#endif
+
1 /*======================================================================
+
2  FILE: icallangbind.h
+
3  CREATOR: eric 25 jan 2001
+
4 
+
5  (C) COPYRIGHT 1999 Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALLANGBIND_H
+
20 #define ICALLANGBIND_H
+
21 
+
22 #include "libical_ical_export.h"
+
23 #include "icalcomponent.h"
+
24 #include "icalproperty.h"
+
25 
+
26 LIBICAL_ICAL_EXPORT int *icallangbind_new_array(int size);
+
27 
+
28 LIBICAL_ICAL_EXPORT void icallangbind_free_array(int *array);
+
29 
+
30 LIBICAL_ICAL_EXPORT int icallangbind_access_array(int *array, int index);
+
31 
+
32 LIBICAL_ICAL_EXPORT icalproperty *icallangbind_get_first_property(icalcomponent *c,
+
33  const char *prop);
+
34 
+
35 LIBICAL_ICAL_EXPORT icalproperty *icallangbind_get_next_property(icalcomponent *c,
+
36  const char *prop);
+
37 
+
38 LIBICAL_ICAL_EXPORT icalcomponent *icallangbind_get_first_component(icalcomponent *c,
+
39  const char *comp);
+
40 
+
41 LIBICAL_ICAL_EXPORT icalcomponent *icallangbind_get_next_component(icalcomponent *c,
+
42  const char *comp);
+
43 
+
44 LIBICAL_ICAL_EXPORT icalparameter *icallangbind_get_first_parameter(icalproperty *prop);
+
45 
+
46 LIBICAL_ICAL_EXPORT icalparameter *icallangbind_get_next_parameter(icalproperty *prop);
+
47 
+
48 LIBICAL_ICAL_EXPORT const char *icallangbind_property_eval_string(icalproperty *prop,
+
49  const char *sep);
+
50 
+
51 LIBICAL_ICAL_EXPORT char *icallangbind_property_eval_string_r(icalproperty *prop,
+
52  const char *sep);
+
53 
+
54 LIBICAL_ICAL_EXPORT int icallangbind_string_to_open_flag(const char *str);
+
55 
+
56 LIBICAL_ICAL_EXPORT const char *icallangbind_quote_as_ical(const char *str);
+
57 
+
58 LIBICAL_ICAL_EXPORT char *icallangbind_quote_as_ical_r(const char *str);
+
59 
+
60 #endif
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalmemory_8h.html b/apidocs/icalmemory_8h.html index 1135cce4..cbfb7cb3 100644 --- a/apidocs/icalmemory_8h.html +++ b/apidocs/icalmemory_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalmemory.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-Typedefs | Functions
-
icalmemory.h File Reference
+
+
icalmemory.h File Reference
@@ -78,19 +78,7 @@ $(function() {

Go to the source code of this file.

- - - - - - - -

-Typedefs

-typedef void(* icalmemory_free_f) (void *)
 
-typedef void *(* icalmemory_malloc_f) (size_t)
 
-typedef void *(* icalmemory_realloc_f) (void *, size_t)
 
- @@ -107,35 +95,29 @@ Functions - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +

+

Functions

void icalmemory_add_tmp_buffer (void *buf)
 Adds an externally allocated buffer to the ring. More...
void icalmemory_free_ring (void)
 Frees all memory used in the ring. More...
 
void icalmemory_get_mem_alloc_funcs (icalmemory_malloc_f *f_malloc, icalmemory_realloc_f *f_realloc, icalmemory_free_f *f_free)
 Returns the functions used for memory management. More...
 
void * icalmemory_new_buffer (size_t size)
 Creates new buffer with the specified size. More...
 
void * icalmemory_resize_buffer (void *buf, size_t size)
 Resizes a buffer created with icalmemory_new_buffer(). More...
 
void icalmemory_set_mem_alloc_funcs (icalmemory_malloc_f f_malloc, icalmemory_realloc_f f_realloc, icalmemory_free_f f_free)
 Configures the functions to use for memory management. More...
 
char * icalmemory_strdup (const char *s)
 Creates a duplicate of a string. More...
 
void * icalmemory_tmp_buffer (size_t size)
 Creates a new temporary buffer on the ring and returns it. More...
 
char * icalmemory_tmp_copy (const char *str)
 Creates a copy of the given string, stored on the ring buffer, and returns it. More...
 
void * icalmemory_new_buffer (size_t size)
 Creates new buffer with the specified size. More...
 
void * icalmemory_resize_buffer (void *buf, size_t size)
 Resizes a buffer created with icalmemory_new_buffer(). More...
 
char * icalmemory_strdup (const char *s)
 Creates a duplicate of a string. More...
 
void * icalmemory_tmp_buffer (size_t size)
 Creates a new temporary buffer on the ring and returns it. More...
 
char * icalmemory_tmp_copy (const char *str)
 Creates a copy of the given string, stored on the ring buffer, and returns it. More...
 

Detailed Description

-

Common memory management routines.

-

libical often passes strings back to the caller. To make these interfaces simple, I did not want the caller to have to pass in a memory buffer, but having libical pass out newly allocated memory makes it difficult to de-allocate the memory.

-

The ring buffer in this scheme makes it possible for libical to pass out references to memory which the caller does not own, and be able to de-allocate the memory later. The ring allows libical to have several buffers active simultaneously, which is handy when creating string representations of components. Methods for working with these temporary buffers are marked with icalmemory_tmp_*().

-

Other memory management routines include wrappers around the system management routines like icalmemory_new_buffer() and icalmemory_free_buffer() as well as routines to work with strings, like icalmemory_append_string().

+

Common memory management routines.

+

libical often passes strings back to the caller. To make these interfaces simple, I did not want the caller to have to pass in a memory buffer, but having libical pass out newly allocated memory makes it difficult to de-allocate the memory.

+

The ring buffer in this scheme makes it possible for libical to pass out references to memory which the caller does not own, and be able to de-allocate the memory later. The ring allows libical to have several buffers active simultaneously, which is handy when creating string representations of components. Methods for working with these temporary buffers are marked with icalmemory_tmp_*().

+

Other memory management routines include wrappers around the system management routines like icalmemory_new_buffer() and icalmemory_free_buffer() as well as routines to work with strings, like icalmemory_append_string().

Function Documentation

- +

◆ icalmemory_add_tmp_buffer()

@@ -158,18 +140,18 @@ Functions -

Adds an externally allocated buffer to the ring. This ensures that libical will free() the buffer automatically, either after BUFFER_RING_SIZE other buffers have been created or added, or after icalmemory_free_ring() has been called. Note that freeing the buffers is done using the icalmemory_free_buffer() function, which by default is a wrapper around stdlib's free() function. However, if the memory management functions are customized by the user, the user must make sure to only pass in buffers that have been allocated in a compatible manner.

+

Adds an externally allocated buffer to the ring. This ensures that libical will free() the buffer automatically, either after BUFFER_RING_SIZE other buffers have been created or added, or after icalmemory_free_ring() has been called.

Error handling
No error is raised if buf is NULL.
Ownership
After adding buf to the ring, it becomes owned by icalmemory and must not be free()d manually anymore, it leads to a double-free() when icalmemory reclaims the memory.
Usage
char *buf = calloc(256, sizeof(char));
-
icalmemory_add_tmp_buffer(buf);
-
icalmemory_add_tmp_buffer
void icalmemory_add_tmp_buffer(void *buf)
Adds an externally allocated buffer to the ring.
Definition: icalmemory.c:167
+
icalmemory_add_tmp_buffer(buf);
+
icalmemory_add_tmp_buffer
void icalmemory_add_tmp_buffer(void *buf)
Adds an externally allocated buffer to the ring.
Definition: icalmemory.c:182
- +

◆ icalmemory_append_char()

@@ -217,32 +199,32 @@ Functions -
Warning
This method may not be used for temporary buffers (buffers allocated with icalmemory_tmp_buffer() and related functions)!
+
Warning
This method may not be used for temporary buffers (buffers allocated with icalmemory_tmp_buffer() and related functions)!
Error handling
Sets icalerrno to ICAL_BADARG_ERROR if buf, *buf, pos, * pos, or buf_size NULL.

This method will copy the character ch and a ‘’\0'` character after it to the buffer buf starting at position pos, reallocing buf if it is too small. buf_size is the size of buf and will be changed if buf is reallocated. pos will point to the new terminating ‘’\0'` character buf.

Example
// creates a new buffer
int buffer_len = 15;
-
char *buffer = icalmemory_new_buffer(buffer_len);
+
char *buffer = icalmemory_new_buffer(buffer_len);
strcpy(buffer, "My number is: ");
// append a char to the buffer
int buffer_end = strlen(buffer);
char *buffer_end_pos = buffer[buffer_str_end];
-
icalmemory_append_char(&buffer, &buffer_end_pos, &buffer_len, '7');
+
icalmemory_append_char(&buffer, &buffer_end_pos, &buffer_len, '7');
// print string
printf("%s\n", buffer);
// release memory
-
icalmemory_free_buffer(buffer);
-
icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition: icalmemory.c:359
-
icalmemory_new_buffer
void * icalmemory_new_buffer(size_t size)
Creates new buffer with the specified size.
Definition: icalmemory.c:319
-
icalmemory_append_char
void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch)
Appends a character to a buffer.
Definition: icalmemory.c:411
+
icalmemory_free_buffer(buffer);
+
icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition: icalmemory.c:287
+
icalmemory_new_buffer
void * icalmemory_new_buffer(size_t size)
Creates new buffer with the specified size.
Definition: icalmemory.c:261
+
icalmemory_append_char
void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch)
Appends a character to a buffer.
Definition: icalmemory.c:330
- +

◆ icalmemory_append_string()

@@ -290,30 +272,30 @@ Functions -
Warning
This method may not be used for temporary buffers (buffers allocated with icalmemory_tmp_buffer() and related functions)!
+
Warning
This method may not be used for temporary buffers (buffers allocated with icalmemory_tmp_buffer() and related functions)!
Error handling
Sets icalerrno to ICAL_BADARG_ERROR if buf, *buf, pos, * pos, buf_size or string are NULL.

This method will copy the string string to the buffer buf starting at position pos, reallocing buf if it is too small. buf_size is the size of buf and will be changed if buf is reallocated. pos will point to the last byte of the new string in buf, usually a ‘’\0'`

Example
// creates a new buffer
int buffer_len = 15;
-
char *buffer = icalmemory_new_buffer(buffer_len);
+
char *buffer = icalmemory_new_buffer(buffer_len);
strcpy(buffer, "My name is: ");
// append a string to the buffer
int buffer_end = strlen(buffer);
char *buffer_end_pos = buffer[buffer_str_end];
-
icalmemory_append_string(&buffer, &buffer_end_pos, &buffer_len, "John Doe");
+
icalmemory_append_string(&buffer, &buffer_end_pos, &buffer_len, "John Doe");
// print string
printf("%s\n", buffer);
// release memory
-
icalmemory_free_buffer(buffer);
-
icalmemory_append_string
void icalmemory_append_string(char **buf, char **pos, size_t *buf_size, const char *string)
Appends a string to a buffer.
Definition: icalmemory.c:369
+
icalmemory_free_buffer(buffer);
+
icalmemory_append_string
void icalmemory_append_string(char **buf, char **pos, size_t *buf_size, const char *string)
Appends a string to a buffer.
Definition: icalmemory.c:292
- +

◆ icalmemory_free_buffer()

@@ -336,13 +318,12 @@ Functions -
See also
icalmemory_new_buffer()
-

Releases the memory of the buffer.

-

By default this function delegates to stdlib's free() but the used function can be configured via icalmemory_set_mem_alloc_funcs().

+
See also
icalmemory_new_buffer()
+

Releases the memory of the buffer.

- +

◆ icalmemory_free_ring()

@@ -359,72 +340,27 @@ Functions

Frees all memory used in the ring.

-

Frees all memory used in the ring. Depending on if HAVE_PTHREAD is set or not, the ring buffer is allocated on a per-thread basis, meaning that if all rings are to be released, it must be called once in every thread.

-
Usage
void *buf = icalmemory_tmp_buffer(256);
+

Frees all memory used in the ring. Depending on if HAVE_PTHREAD is set or not, the ring buffer is allocated on a per-thread basis, meaning that if all rings are to be released, it must be called once in every thread.

+
Usage
void *buf = icalmemory_tmp_buffer(256);
// use buf
// release buf and all other memory in the ring buffer
-
icalmemory_free_ring();
-
icalmemory_free_ring
void icalmemory_free_ring(void)
Frees all memory used in the ring.
Definition: icalmemory.c:215
-
icalmemory_tmp_buffer
void * icalmemory_tmp_buffer(size_t size)
Creates a new temporary buffer on the ring and returns it.
Definition: icalmemory.c:193
+
icalmemory_free_ring();
+
icalmemory_free_ring
void icalmemory_free_ring(void)
Frees all memory used in the ring.
Definition: icalmemory.c:227
+
icalmemory_tmp_buffer
void * icalmemory_tmp_buffer(size_t size)
Creates a new temporary buffer on the ring and returns it.
Definition: icalmemory.c:205
- -

◆ icalmemory_get_mem_alloc_funcs()

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
void icalmemory_get_mem_alloc_funcs (icalmemory_malloc_f * f_malloc,
icalmemory_realloc_f * f_realloc,
icalmemory_free_f * f_free 
)
-
- -

Returns the functions used for memory management.

-
Parameters
- - - - -
f_mallocA pointer to the function to use for memory allocation.
f_reallocA pointer to the function to use for memory reallocation.
f_freeA pointer to the function to use for memory deallocation.
-
-
-

Retrieves the functions used by the library for memory management.

Since
3.1.0
- -
-
- -

◆ icalmemory_new_buffer()

+ +

◆ icalmemory_new_buffer()

- + @@ -443,29 +379,28 @@ Functions
Returns
A pointer to the newly-created buffer.
See also
icalmemory_free_buffer()
Error handling
If there is a problem allocating memory, it sets icalerrno to ICAL_NEWFAILED_ERROR and returns NULL.
-
Ownership
Buffers created with this method are owned by the caller. They must be released with the icalmemory_free_buffer() method.
+
Ownership
Buffers created with this method are owned by the caller. The must be released with the appropriate icalmemory_free_buffer() method.

This creates a new (non-temporary) buffer of the specified size. All buffers returned by this method are zeroed-out.

-

By default this function delegates to stdlib's malloc() but the used function can be changed via icalmemory_set_mem_alloc_funcs().

Usage
// create buffer
-
char *buffer = icalmemory_new_buffer(50);
+
char *buffer = icalmemory_new_buffer(50);
// fill buffer
strcpy(buffer, "some data");
// release buffer
-
icalmemory_free_buffer(buffer);
+
icalmemory_free_buffer(buffer);
- -

◆ icalmemory_resize_buffer()

+ +

◆ icalmemory_resize_buffer()

void * icalmemory_new_buffer void* icalmemory_new_buffer ( size_t  size)
- + @@ -484,7 +419,7 @@ Functions
void * icalmemory_resize_buffer void* icalmemory_resize_buffer ( void *  buf,
-

Resizes a buffer created with icalmemory_new_buffer().

+

Resizes a buffer created with icalmemory_new_buffer().

Parameters
@@ -493,84 +428,37 @@ Functions
Returns
The new, resized buffer.
-
See also
icalmemory_new_buffer()
-
Warning
This method may not be used for temporary buffers (buffers allocated with icalmemory_tmp_buffer() and related functions)!
+
See also
icalmemory_new_buffer()
+
Warning
This method may not be used for temporary buffers (buffers allocated with icalmemory_tmp_buffer() and related functions)!
Error handling
If there is a problem while reallocating the buffer, the method sets icalerrno to ICAL_NEWFAILED_ERROR and returns NULL.
Ownership
The returned buffer is owned by the caller and needs to be released with the appropriate icalmemory_free_buffer() method. The old buffer, buf, can not be used anymore after calling this method.
-

By default this function delegates to stdlib's realloc() but the used function can be configured via icalmemory_set_mem_alloc_funcs().

Usage
// create new buffer
-
char *buffer = icalmemory_new_buffer(10);
+
char *buffer = icalmemory_new_buffer(10);
// fill buffer
strcpy(buffer, "some data");
// expand buffer
-
buffer = icalmemory_resize_buffer(buffer, 20);
+
buffer = icalmemory_resize_buffer(buffer, 20);
// fill with more data
strcpy(buffer, "a lot more data");
// release
-
icalmemory_free_buffer(buffer);
-
icalmemory_resize_buffer
void * icalmemory_resize_buffer(void *buf, size_t size)
Resizes a buffer created with icalmemory_new_buffer().
Definition: icalmemory.c:340
+
icalmemory_free_buffer(buffer);
+
icalmemory_resize_buffer
void * icalmemory_resize_buffer(void *buf, size_t size)
Resizes a buffer created with icalmemory_new_buffer().
Definition: icalmemory.c:275
- -

◆ icalmemory_set_mem_alloc_funcs()

- -
-
-
bufThe buffer to be resized.
- - - - - - - - - - - - - - - - - - - - - - - -
void icalmemory_set_mem_alloc_funcs (icalmemory_malloc_f f_malloc,
icalmemory_realloc_f f_realloc,
icalmemory_free_f f_free 
)
-
- -

Configures the functions to use for memory management.

-
Parameters
- - - - -
f_mallocThe function to use for memory allocation.
f_reallocThe function to use for memory reallocation.
f_freeThe function to use for memory deallocation.
-
-
-

This function configures the library to use the specified functions for memory management. By default the standard system memory management functions malloc(), realloc() and free() are used.

-

Note: The memory management functions configured via this functions are used throughout the core libical component but not within other components like libicalvcal.

Since
3.1.0
- -
-
- -

◆ icalmemory_strdup()

+ +

◆ icalmemory_strdup()

- + @@ -588,25 +476,25 @@ Functions
Returns
A pointer to a string containing the same data as s
Error handling
The string s must not be NULL, otherwise depending on the libc used, it might lead to undefined behaviour (read: segfaults).
-
Ownership
The returned string is owned by the caller and needs to be released with the icalmemory_free_buffer() method.
-

Replaces strdup(). The function uses icalmemory_new_buffer() for memory allocation. It also helps trapping calls to strdup() and solves the problem that in -ansi, gcc on Red Hat claims that strdup() is undeclared.

+
Ownership
The returned string is owned by the caller and needs to be released with the appropriate free() method.
+

A wrapper around strdup(). Partly to trap calls to strdup(), partly because in -ansi, gcc on Red Hat claims that strdup() is undeclared.

Usage
const char *my_str = "LibIcal";
-
char *dup = icalmemory_strdup(my_str);
+
char *dup = icalmemory_strdup(my_str);
printf("%s\n", dup);
-
icalmemory_free_buffer(dup);
-
icalmemory_strdup
char * icalmemory_strdup(const char *s)
Creates a duplicate of a string.
Definition: icalmemory.c:249
+
free(dup);
+
icalmemory_strdup
char * icalmemory_strdup(const char *s)
Creates a duplicate of a string.
Definition: icalmemory.c:251
- -

◆ icalmemory_tmp_buffer()

+ +

◆ icalmemory_tmp_buffer()

char * icalmemory_strdup char* icalmemory_strdup ( const char *  s)
- + @@ -626,7 +514,7 @@ Functions

Creates a temporary buffer on the ring. Regardless of what size you specify, the buffer will always be at least MIN_BUFFER_SIZE big, and it will be zeroed out.

Error handling
If there is a problem allocating memory for the buffer, it sets icalerrno to ICAL_NEWFAILED_ERROR and returns NULL.
Ownership
The returned buffer is owned by icalmemory. It must not be freed by the caller and the returned memory will be automatically reclaimed as more items are added to the ring buffer.
-
Usage
char *str = icalmemory_tmp_buffer(256);
+
Usage
char *str = icalmemory_tmp_buffer(256);
strcpy(str, "some data");
// use str
@@ -634,14 +522,14 @@ Functions
- -

◆ icalmemory_tmp_copy()

+ +

◆ icalmemory_tmp_copy()

void * icalmemory_tmp_buffer void* icalmemory_tmp_buffer ( size_t  size)
- + @@ -661,8 +549,8 @@ Functions
Error handling
The passed string str must not be NULL, otherwise a segfault might ensue, since the routine calls strlen() on it.
Ownership
The returned string is owned by icalmemory. It must not be freed by the caller, and it will be automatically reclaimed as more items are added to the buffer.
Usage
const char *str = "Example string";
-
char *tmp_copy = icalmemory_tmp_copy(str);
-
icalmemory_tmp_copy
char * icalmemory_tmp_copy(const char *str)
Creates a copy of the given string, stored on the ring buffer, and returns it.
Definition: icalmemory.c:232
+
char *tmp_copy = icalmemory_tmp_copy(str);
+
icalmemory_tmp_copy
char * icalmemory_tmp_copy(const char *str)
Creates a copy of the given string, stored on the ring buffer, and returns it.
Definition: icalmemory.c:242
@@ -670,7 +558,7 @@ Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalmemory_8h_source.html b/apidocs/icalmemory_8h_source.html index 54224720..b9bcb0be 100644 --- a/apidocs/icalmemory_8h_source.html +++ b/apidocs/icalmemory_8h_source.html @@ -2,8 +2,8 @@ - - + +Libical API Documentation: icalmemory.h Source File @@ -19,9 +19,10 @@
char * icalmemory_tmp_copy char* icalmemory_tmp_copy ( const char *  str)
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalmemory.h
+
+
icalmemory.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalmemory.h
-
3 CREATOR: eric 30 June 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Initial Developer of the Original Code is Eric Busboom
-
10======================================================================*/
-
11
-
12#ifndef ICALMEMORY_H
-
13#define ICALMEMORY_H
-
14
-
36#include "libical_ical_export.h"
-
37
-
64LIBICAL_ICAL_EXPORT void *icalmemory_tmp_buffer(size_t size);
-
65
-
88LIBICAL_ICAL_EXPORT char *icalmemory_tmp_copy(const char *str);
-
89
-
118LIBICAL_ICAL_EXPORT void icalmemory_add_tmp_buffer(void *buf);
-
119
-
137LIBICAL_ICAL_EXPORT void icalmemory_free_ring(void);
-
138
-
139typedef void *(*icalmemory_malloc_f)(size_t);
-
140typedef void *(*icalmemory_realloc_f)(void *, size_t);
-
141typedef void (*icalmemory_free_f)(void *);
-
142
-
159LIBICAL_ICAL_EXPORT void icalmemory_set_mem_alloc_funcs(icalmemory_malloc_f f_malloc,
-
160 icalmemory_realloc_f f_realloc,
-
161 icalmemory_free_f f_free);
-
162
-
173LIBICAL_ICAL_EXPORT void icalmemory_get_mem_alloc_funcs(icalmemory_malloc_f *f_malloc,
-
174 icalmemory_realloc_f *f_realloc, icalmemory_free_f *f_free);
-
175
-
208LIBICAL_ICAL_EXPORT void *icalmemory_new_buffer(size_t size);
-
209
-
249LIBICAL_ICAL_EXPORT void *icalmemory_resize_buffer(void *buf, size_t size);
-
250
-
261LIBICAL_ICAL_EXPORT void icalmemory_free_buffer(void *buf);
-
262
-
263/* THESE ROUTINES CAN NOT BE USED ON TMP BUFFERS. Only use them on
-
264 normally allocated memory, or on buffers created from
-
265 icalmemory_new_buffer, never with buffers created by
-
266 icalmemory_tmp_buffer. If icalmemory_append_string has to resize a
-
267 buffer on the ring, the ring will loose track of it an you will
-
268 have memory problems. */
-
269
-
308LIBICAL_ICAL_EXPORT void icalmemory_append_string(char **buf, char **pos, size_t *buf_size,
-
309 const char *string);
-
310
-
350LIBICAL_ICAL_EXPORT void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch);
-
351
-
378LIBICAL_ICAL_EXPORT char *icalmemory_strdup(const char *s);
-
379
-
380#endif /* !ICALMEMORY_H */
-
icalmemory_free_ring
void icalmemory_free_ring(void)
Frees all memory used in the ring.
Definition: icalmemory.c:215
-
icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition: icalmemory.c:359
-
icalmemory_strdup
char * icalmemory_strdup(const char *s)
Creates a duplicate of a string.
Definition: icalmemory.c:249
-
icalmemory_append_string
void icalmemory_append_string(char **buf, char **pos, size_t *buf_size, const char *string)
Appends a string to a buffer.
Definition: icalmemory.c:369
-
icalmemory_resize_buffer
void * icalmemory_resize_buffer(void *buf, size_t size)
Resizes a buffer created with icalmemory_new_buffer().
Definition: icalmemory.c:340
-
icalmemory_new_buffer
void * icalmemory_new_buffer(size_t size)
Creates new buffer with the specified size.
Definition: icalmemory.c:319
-
icalmemory_tmp_copy
char * icalmemory_tmp_copy(const char *str)
Creates a copy of the given string, stored on the ring buffer, and returns it.
Definition: icalmemory.c:232
-
icalmemory_append_char
void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch)
Appends a character to a buffer.
Definition: icalmemory.c:411
-
icalmemory_get_mem_alloc_funcs
void icalmemory_get_mem_alloc_funcs(icalmemory_malloc_f *f_malloc, icalmemory_realloc_f *f_realloc, icalmemory_free_f *f_free)
Returns the functions used for memory management.
Definition: icalmemory.c:300
-
icalmemory_add_tmp_buffer
void icalmemory_add_tmp_buffer(void *buf)
Adds an externally allocated buffer to the ring.
Definition: icalmemory.c:167
-
icalmemory_set_mem_alloc_funcs
void icalmemory_set_mem_alloc_funcs(icalmemory_malloc_f f_malloc, icalmemory_realloc_f f_realloc, icalmemory_free_f f_free)
Configures the functions to use for memory management.
Definition: icalmemory.c:291
-
icalmemory_tmp_buffer
void * icalmemory_tmp_buffer(size_t size)
Creates a new temporary buffer on the ring and returns it.
Definition: icalmemory.c:193
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalmemory.h
+
3  CREATOR: eric 30 June 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Initial Developer of the Original Code is Eric Busboom
+
19 ======================================================================*/
+
20 
+
21 #ifndef ICALMEMORY_H
+
22 #define ICALMEMORY_H
+
23 
+
45 #include "libical_ical_export.h"
+
46 
+
73 LIBICAL_ICAL_EXPORT void *icalmemory_tmp_buffer(size_t size);
+
74 
+
97 LIBICAL_ICAL_EXPORT char *icalmemory_tmp_copy(const char *str);
+
98 
+
123 LIBICAL_ICAL_EXPORT void icalmemory_add_tmp_buffer(void *buf);
+
124 
+
142 LIBICAL_ICAL_EXPORT void icalmemory_free_ring(void);
+
143 
+
144 /* Non-tmp buffers must be freed. These are mostly wrappers around
+
145  * malloc, etc, but are used so the caller can change the memory
+
146  * allocators in a future version of the library */
+
147 
+
177 LIBICAL_ICAL_EXPORT void *icalmemory_new_buffer(size_t size);
+
178 
+
215 LIBICAL_ICAL_EXPORT void *icalmemory_resize_buffer(void *buf, size_t size);
+
216 
+
224 LIBICAL_ICAL_EXPORT void icalmemory_free_buffer(void *buf);
+
225 
+
226 /* THESE ROUTINES CAN NOT BE USED ON TMP BUFFERS. Only use them on
+
227  normally allocated memory, or on buffers created from
+
228  icalmemory_new_buffer, never with buffers created by
+
229  icalmemory_tmp_buffer. If icalmemory_append_string has to resize a
+
230  buffer on the ring, the ring will loose track of it an you will
+
231  have memory problems. */
+
232 
+
271 LIBICAL_ICAL_EXPORT void icalmemory_append_string(char **buf, char **pos, size_t *buf_size,
+
272  const char *string);
+
273 
+
313 LIBICAL_ICAL_EXPORT void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch);
+
314 
+
339 LIBICAL_ICAL_EXPORT char *icalmemory_strdup(const char *s);
+
340 
+
341 #endif /* !ICALMEMORY_H */
+
icalmemory_free_ring
void icalmemory_free_ring(void)
Frees all memory used in the ring.
Definition: icalmemory.c:227
+
icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition: icalmemory.c:287
+
icalmemory_tmp_copy
char * icalmemory_tmp_copy(const char *str)
Creates a copy of the given string, stored on the ring buffer, and returns it.
Definition: icalmemory.c:242
+
icalmemory_new_buffer
void * icalmemory_new_buffer(size_t size)
Creates new buffer with the specified size.
Definition: icalmemory.c:261
+
icalmemory_resize_buffer
void * icalmemory_resize_buffer(void *buf, size_t size)
Resizes a buffer created with icalmemory_new_buffer().
Definition: icalmemory.c:275
+
icalmemory_append_string
void icalmemory_append_string(char **buf, char **pos, size_t *buf_size, const char *string)
Appends a string to a buffer.
Definition: icalmemory.c:292
+
icalmemory_tmp_buffer
void * icalmemory_tmp_buffer(size_t size)
Creates a new temporary buffer on the ring and returns it.
Definition: icalmemory.c:205
+
icalmemory_append_char
void icalmemory_append_char(char **buf, char **pos, size_t *buf_size, char ch)
Appends a character to a buffer.
Definition: icalmemory.c:330
+
icalmemory_add_tmp_buffer
void icalmemory_add_tmp_buffer(void *buf)
Adds an externally allocated buffer to the ring.
Definition: icalmemory.c:182
+
icalmemory_strdup
char * icalmemory_strdup(const char *s)
Creates a duplicate of a string.
Definition: icalmemory.c:251
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalmessage_8h_source.html b/apidocs/icalmessage_8h_source.html index 35a383c1..aeffc0ed 100644 --- a/apidocs/icalmessage_8h_source.html +++ b/apidocs/icalmessage_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalmessage.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalmessage.h
+
+
icalmessage.h
-
1/*======================================================================
-
2 FILE: icalmessage.h
-
3 CREATOR: eric 07 Nov 2000
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 =========================================================================*/
-
10
-
11#ifndef ICALMESSAGE_H
-
12#define ICALMESSAGE_H
-
13
-
14#include "libical_icalss_export.h"
-
15#include "icalcomponent.h"
-
16
-
17LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_accept_reply(icalcomponent *c,
-
18 const char *user,
-
19 const char *msg);
-
20
-
21LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_decline_reply(icalcomponent *c,
-
22 const char *user,
-
23 const char *msg);
-
24
-
25/* New is modified version of old */
-
26LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_counterpropose_reply(icalcomponent *oldc,
-
27 icalcomponent *newc,
-
28 const char *user,
-
29 const char *msg);
-
30
-
31LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_delegate_reply(icalcomponent *c,
-
32 const char *user,
-
33 const char *delegatee,
-
34 const char *msg);
-
35
-
36LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_error_reply(icalcomponent *c,
-
37 const char *user,
-
38 const char *msg,
-
39 const char *debug,
-
40 icalrequeststatus rs);
-
41
-
42#endif /* ICALMESSAGE_H */
+
1 /*======================================================================
+
2  FILE: icalmessage.h
+
3  CREATOR: eric 07 Nov 2000
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17  =========================================================================*/
+
18 
+
19 #ifndef ICALMESSAGE_H
+
20 #define ICALMESSAGE_H
+
21 
+
22 #include "libical_icalss_export.h"
+
23 #include "icalcomponent.h"
+
24 
+
25 LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_accept_reply(icalcomponent *c,
+
26  const char *user,
+
27  const char *msg);
+
28 
+
29 LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_decline_reply(icalcomponent *c,
+
30  const char *user,
+
31  const char *msg);
+
32 
+
33 /* New is modified version of old */
+
34 LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_counterpropose_reply(icalcomponent *oldc,
+
35  icalcomponent *newc,
+
36  const char *user,
+
37  const char *msg);
+
38 
+
39 LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_delegate_reply(icalcomponent *c,
+
40  const char *user,
+
41  const char *delegatee,
+
42  const char *msg);
+
43 
+
44 LIBICAL_ICALSS_EXPORT icalcomponent *icalmessage_new_error_reply(icalcomponent *c,
+
45  const char *user,
+
46  const char *msg,
+
47  const char *debug,
+
48  icalrequeststatus rs);
+
49 
+
50 #endif /* ICALMESSAGE_H */
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalmime_8h_source.html b/apidocs/icalmime_8h_source.html index 14ef7e81..a6789cfd 100644 --- a/apidocs/icalmime_8h_source.html +++ b/apidocs/icalmime_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalmime.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalmime.h
+
+
icalmime.h
-
1/*======================================================================
-
2 FILE: icalmime.h
-
3 CREATOR: eric 26 July 2000
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALMIME_H
-
12#define ICALMIME_H
-
13
-
14#include "libical_ical_export.h"
-
15#include "icalcomponent.h"
-
16
-
17LIBICAL_ICAL_EXPORT icalcomponent *icalmime_parse(char *(*line_gen_func) (char *s,
-
18 size_t size,
-
19 void *d), void *data);
-
20
-
21#endif /* !ICALMIME_H */
+
1 /*======================================================================
+
2  FILE: icalmime.h
+
3  CREATOR: eric 26 July 2000
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALMIME_H
+
20 #define ICALMIME_H
+
21 
+
22 #include "libical_ical_export.h"
+
23 #include "icalcomponent.h"
+
24 
+
25 LIBICAL_ICAL_EXPORT icalcomponent *icalmime_parse(char *(*line_gen_func) (char *s,
+
26  size_t size,
+
27  void *d), void *data);
+
28 
+
29 #endif /* !ICALMIME_H */
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalparameter_8h.html b/apidocs/icalparameter_8h.html index 5a1d7752..58e21379 100644 --- a/apidocs/icalparameter_8h.html +++ b/apidocs/icalparameter_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparameter.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Functions
-
icalparameter.h File Reference
+
+
icalparameter.h File Reference

Go to the source code of this file.

- - - - - - - - - - + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + @@ -110,21 +108,21 @@ Functions - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + @@ -142,16 +140,16 @@ Functions

+

Functions

char * icalparameter_as_ical_string (icalparameter *parameter)
 Converts icalparameter into a string representation. More...
 
char * icalparameter_as_ical_string_r (icalparameter *parameter)
 Converts icalparameter into an string representation according to RFC5445/RFC6868. More...
 
icalparameter * icalparameter_clone (const icalparameter *p)
 Creates new icalparameter as a clone of the given one. More...
 
char * icalparameter_as_ical_string (icalparameter *parameter)
 Converts icalparameter into a string representation. More...
 
char * icalparameter_as_ical_string_r (icalparameter *parameter)
 Converts icalparameter into an string representation according to RFC5445/RFC6868. More...
 
void icalparameter_free (icalparameter *parameter)
 Frees an icalparameter object. More...
 
const char * icalparameter_get_iana_name (icalparameter *param)
 Returns the IANA name of param. More...
 
const char * icalparameter_get_iana_value (icalparameter *param)
 Returns the IANA value of param. More...
 
const char * icalparameter_get_xname (icalparameter *param)
 Returns the X-name of param. More...
 
const char * icalparameter_get_xvalue (icalparameter *param)
 Returns the X-value of param. More...
 
const char * icalparameter_get_iana_name (icalparameter *param)
 Returns the IANA name of param. More...
 
const char * icalparameter_get_iana_value (icalparameter *param)
 Returns the IANA value of param. More...
 
const char * icalparameter_get_xname (icalparameter *param)
 Returns the X-name of param. More...
 
const char * icalparameter_get_xvalue (icalparameter *param)
 Returns the X-value of param. More...
 
int icalparameter_has_same_name (icalparameter *param1, icalparameter *param2)
 Determines if two parameters have the same name. More...
 
int icalparameter_kind_is_valid (const icalparameter_kind kind)
 Checks the validity of a icalparameter_kind. More...
 
const char * icalparameter_kind_to_string (icalparameter_kind kind)
 Returns a string representing the given icalparameter_kind. More...
 
icalparameter * icalparameter_new (icalparameter_kind kind)
 Creates new icalparameter object. More...
 
icalparameter * icalparameter_new_clone (icalparameter *p))
 Creates new icalparameter as a clone of the given one. More...
 
icalparameter * icalparameter_new_from_string (const char *value)
 Creates new icalparameter object from string. More...
 
icalparameter * icalparameter_new_from_value_string (icalparameter_kind kind, const char *value)
 Creates new icalparameter of a given kind with a given value. More...
 
const char * icalparameter_kind_to_string (icalparameter_kind kind)
 Returns a string representing the given icalparameter_kind. More...
 
icalparameter * icalparameter_new (icalparameter_kind kind)
 Creates new icalparameter object. More...
 
icalparameter * icalparameter_new_clone (icalparameter *p)
 Creates new icalparameter as a clone of the given one. More...
 
icalparameter * icalparameter_new_from_string (const char *value)
 Creates new icalparameter object from string. More...
 
icalparameter * icalparameter_new_from_value_string (icalparameter_kind kind, const char *value)
 Creates new icalparameter of a given kind with a given value. More...
 
void icalparameter_set_iana_name (icalparameter *param, const char *v)
 Sets the IANA name of param to v. More...
 
 

Detailed Description

-

Functions to work with ical parameter objects, which represent parameters to property objects.

+

Functions to work with ical parameter objects, which represent parameters to property objects.

Function Documentation

- -

◆ icalparameter_as_ical_string()

+ +

◆ icalparameter_as_ical_string()

- + @@ -168,31 +166,31 @@ Functions
Returns
A string representing the parameter according to RFC5445/RFC6868.
-
See also
icalparameter_as_ical_string_r()
+
See also
icalparameter_as_ical_string_r()
Error handling
If there is any error, the method returns NULL. Furthermore, if parameter is NULL, it also sets icalerrno to ICAL_BADARG_ERROR. If it doesn't recognize the kind of the parameter, it sets icalerrno it ICAL_BADARG_ERROR. If the parameter is otherwise malformed, it sets icalerrno to ICAL_MALFORMEDDATA_ERROR.
-
Ownership
Strings returned by this method are owned by libical, they must not be freed and they may be reclaimed with the next call into the library. A version of this function, which returns strings that are not owned by libical, is icalparameter_as_ical_string_r().
-
Usage
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
+
Ownership
Strings returned by this method are owned by libical, they must not be freed and they may be reclaimed with the next call into the library. A version of this function, which returns strings that are not owned by libical, is icalparameter_as_ical_string_r().
+
Usage
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
if(param) {
-
printf("%s\n", icalparameter_as_ical_string(param));
+
printf("%s\n", icalparameter_as_ical_string(param));
}
-
icalparameter_free(param);
-
icalparameter_new_from_string
icalparameter * icalparameter_new_from_string(const char *value)
Creates new icalparameter object from string.
Definition: icalparameter.c:115
-
icalparameter_free
void icalparameter_free(icalparameter *parameter)
Frees an icalparameter object.
Definition: icalparameter.c:51
-
icalparameter_as_ical_string
char * icalparameter_as_ical_string(icalparameter *parameter)
Converts icalparameter into a string representation.
Definition: icalparameter.c:164
+
icalparameter_free(param);
+
icalparameter_new_from_string
icalparameter * icalparameter_new_from_string(const char *value)
Creates new icalparameter object from string.
Definition: icalparameter.c:119
+
icalparameter_free
void icalparameter_free(icalparameter *parameter)
Frees an icalparameter object.
Definition: icalparameter.c:60
+
icalparameter_as_ical_string
char * icalparameter_as_ical_string(icalparameter *parameter)
Converts icalparameter into a string representation.
Definition: icalparameter.c:168
- -

◆ icalparameter_as_ical_string_r()

+ +

◆ icalparameter_as_ical_string_r()

char * icalparameter_as_ical_string char* icalparameter_as_ical_string ( icalparameter *  parameter)
- + @@ -209,68 +207,23 @@ Functions
Returns
A string representing the parameter
-
See also
icalparameter_as_ical_string()
+
See also
icalparameter_as_ical_string()
Error handling
If there is any error, the method returns NULL. Furthermore, if parameter is NULL, it also sets icalerrno to ICAL_BADARG_ERROR. If it doesn't recognize the kind of the parameter, it sets icalerrno to ICAL_BADARG_ERROR. If the parameter is otherwise malformed, it sets icalerrno to ICAL_MALFORMEDDATA_ERROR.
-
Ownership
Strings returned by this method are owned by the caller, thus they need to be manually icalmemory_free_buffer()d after use. A version of this function which returns strings that do not need to be freed manually is icalparameter_as_ical_string().
-
Usage
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
+
Ownership
Strings returned by this method are owned by the caller, thus they need to be manually free()d after use. A version of this function which returns strings that do not need to be freed manually is icalparameter_as_ical_string().
+
Usage
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
if(param) {
-
char *str = icalparameter_as_ical_string(param);
+
char *str = icalparameter_as_ical_string(param);
printf("%s\n", str);
-
icalmemory_free_buffer(str);
-
}
-
-
icalparameter_free(param);
-
icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition: icalmemory.c:359
-
- -
- - -

◆ icalparameter_clone()

- -
-
-
char * icalparameter_as_ical_string_r char* icalparameter_as_ical_string_r ( icalparameter *  parameter)
- - - - - - - -
icalparameter * icalparameter_clone (const icalparameter * p)
-
- -

Creates new icalparameter as a clone of the given one.

-
Parameters
- - -
pThe existing, non-NULL parameter to clone.
-
-
-
Returns
An icalparameter that is a clone of the given one.
-
Error handling
If p is NULL, it returns NULL and sets icalerrno to ICAL_BADARG_ERROR. If there was an internal error cloning the data, it returns NULL without reporting any error in icalerrno.
-
Ownership
Objects created by this method are owned by the caller and must be released with the icalparameter_free() method.
-
Usage
// create an icalparameter
-
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
-
-
// clone the parameter
-
icalparameter *clone = icalparameter_clone(param);
-
-
if(clone) {
-
// use clone ...
+
free(str);
}
-
// release parameters
-
icalparameter_free(param);
-
icalparameter_free(clone);
+
icalparameter_free(param);
-
Since
3.1.0
- +

◆ icalparameter_free()

@@ -293,28 +246,28 @@ Functions -

This method needs to be used on all parameter objects returned from any of the _new() methods including icalparameter_new(), icalparameter_new_from_string() and icalparameter_new_from_value_string() and on cloned parameter objects returned by icalparameter_clone() when these object are not needed anymore and to be released.

-
Usage
icalparameter *param = icalparameter_new();
+

This method needs to be used on all parameter objects returned from any of the _new() methods including icalparameter_new(), icalparameter_new_clone(), icalparameter_new_from_string() and icalparameter_new_from_value_string(), when they are not needed anymore and to be released.

+
Usage
icalparameter *param = icalparameter_new();
if(param) {
// use param...
}
// after use, release it
-
icalparameter_free(param);
-
icalparameter_new
icalparameter * icalparameter_new(icalparameter_kind kind)
Creates new icalparameter object.
Definition: icalparameter.c:44
+
icalparameter_free(param);
+
icalparameter_new
icalparameter * icalparameter_new(icalparameter_kind kind)
Creates new icalparameter object.
Definition: icalparameter.c:53
- -

◆ icalparameter_get_iana_name()

+ +

◆ icalparameter_get_iana_name()

- + @@ -335,29 +288,29 @@ Functions
Error handling
Returns NULL and sets icalerrno to ICAL_BADARG_ERROR when a NULL is passed instead of an icalparameter.
Ownership
The string that is returned stays owned by libical and must not be freed by the caller.
Usage
// creates new parameter
-
icalparameter *param = icalparameter_new();
+
icalparameter *param = icalparameter_new();
// sets iana name
-
icalparameter_set_iana_name(param, "X-TEST");
+
icalparameter_set_iana_name(param, "X-TEST");
// compare iana name
-
assert(0 == strcmp(icalparameter_get_iana_name(param), "X-TEST"));
+
assert(0 == strcmp(icalparameter_get_iana_name(param), "X-TEST"));
-
icalparameter_free(param);
-
icalparameter_set_iana_name
void icalparameter_set_iana_name(icalparameter *param, const char *v)
Sets the IANA name of param to v.
Definition: icalparameter.c:396
-
icalparameter_get_iana_name
const char * icalparameter_get_iana_name(icalparameter *param)
Returns the IANA name of param.
Definition: icalparameter.c:401
+
icalparameter_free(param);
+
icalparameter_get_iana_name
const char * icalparameter_get_iana_name(icalparameter *param)
Returns the IANA name of param.
Definition: icalparameter.c:405
+
icalparameter_set_iana_name
void icalparameter_set_iana_name(icalparameter *param, const char *v)
Sets the IANA name of param to v.
Definition: icalparameter.c:400
- -

◆ icalparameter_get_iana_value()

+ +

◆ icalparameter_get_iana_value()

const char * icalparameter_get_iana_name const char* icalparameter_get_iana_name ( icalparameter *  param)
- + @@ -378,30 +331,30 @@ Functions
Error handling
Returns NULL and sets icalerrno to ICAL_BADARG_ERROR when a NULL is passed instead of an icalparameter.
Ownership
The string that is returned stays owned by libical and must not be freed by the caller.
Usage
// create new parameter
-
icalparameter *param = icalparameter_new_from_string("ROLE=ATTENDEE");
+
icalparameter *param = icalparameter_new_from_string("ROLE=ATTENDEE");
// set role to chair
-
icalparameter_set_iana_value(param, "CHAIR");
+
icalparameter_set_iana_value(param, "CHAIR");
// check that it worked
-
assert(0 == strcmp(icalparameter_get_iana_value(param), "SUCCESS"));
+
assert(0 == strcmp(icalparameter_get_iana_value(param), "SUCCESS"));
// release memory
-
icalparameter_free(param);
-
icalparameter_get_iana_value
const char * icalparameter_get_iana_value(icalparameter *param)
Returns the IANA value of param.
Definition: icalparameter.c:391
-
icalparameter_set_iana_value
void icalparameter_set_iana_value(icalparameter *param, const char *v)
Sets the IANA value of param to v.
Definition: icalparameter.c:386
+
icalparameter_free(param);
+
icalparameter_set_iana_value
void icalparameter_set_iana_value(icalparameter *param, const char *v)
Sets the IANA value of param to v.
Definition: icalparameter.c:390
+
icalparameter_get_iana_value
const char * icalparameter_get_iana_value(icalparameter *param)
Returns the IANA value of param.
Definition: icalparameter.c:395
- -

◆ icalparameter_get_xname()

+ +

◆ icalparameter_get_xname()

const char * icalparameter_get_iana_value const char* icalparameter_get_iana_value ( icalparameter *  param)
- + @@ -422,29 +375,29 @@ Functions
Error handling
Returns NULL and sets icalerrno to ICAL_BADARG_ERROR when a NULL is passed instead of an icalparameter.
Ownership
The string that is returned stays owned by libical and must not be freed by the caller.
Usage
// creates new parameter
-
icalparameter *param = icalparameter_new();
+
icalparameter *param = icalparameter_new();
// sets xname
-
icalparameter_set_xname(param, "X-TEST");
+
icalparameter_set_xname(param, "X-TEST");
// compare xname
-
assert(0 == strcmp(icalparameter_get_xname(param), "X-TEST"));
+
assert(0 == strcmp(icalparameter_get_xname(param), "X-TEST"));
-
icalparameter_free(param);
-
icalparameter_get_xname
const char * icalparameter_get_xname(icalparameter *param)
Returns the X-name of param.
Definition: icalparameter.c:356
-
icalparameter_set_xname
void icalparameter_set_xname(icalparameter *param, const char *v)
Sets the X-name of param to v.
Definition: icalparameter.c:340
+
icalparameter_free(param);
+
icalparameter_get_xname
const char * icalparameter_get_xname(icalparameter *param)
Returns the X-name of param.
Definition: icalparameter.c:360
+
icalparameter_set_xname
void icalparameter_set_xname(icalparameter *param, const char *v)
Sets the X-name of param to v.
Definition: icalparameter.c:344
- -

◆ icalparameter_get_xvalue()

+ +

◆ icalparameter_get_xvalue()

const char * icalparameter_get_xname const char* icalparameter_get_xname ( icalparameter *  param)
- + @@ -465,23 +418,23 @@ Functions
Error handling
Returns NULL and sets icalerrno to ICAL_BADARG_ERROR when a NULL is passed instead of an icalparameter.
Ownership
The string that is returned stays owned by libical and must not be freed by the caller.
Usage
// create new parameter
-
icalparameter *param = icalparameter_new_from_string("X-TEST=FAIL");
+
icalparameter *param = icalparameter_new_from_string("X-TEST=FAIL");
// set test to success
-
icalparameter_set_xvalue(param, "SUCCESS");
+
icalparameter_set_xvalue(param, "SUCCESS");
// check that it worked
-
assert(0 == strcmp(icalparameter_get_xvalue(param), "SUCCESS"));
+
assert(0 == strcmp(icalparameter_get_xvalue(param), "SUCCESS"));
// release memory
-
icalparameter_free(param);
-
icalparameter_get_xvalue
const char * icalparameter_get_xvalue(icalparameter *param)
Returns the X-value of param.
Definition: icalparameter.c:379
-
icalparameter_set_xvalue
void icalparameter_set_xvalue(icalparameter *param, const char *v)
Sets the X-value of param to v.
Definition: icalparameter.c:363
+
icalparameter_free(param);
+
icalparameter_get_xvalue
const char * icalparameter_get_xvalue(icalparameter *param)
Returns the X-value of param.
Definition: icalparameter.c:383
+
icalparameter_set_xvalue
void icalparameter_set_xvalue(icalparameter *param, const char *v)
Sets the X-value of param to v.
Definition: icalparameter.c:367
- +

◆ icalparameter_has_same_name()

@@ -519,21 +472,21 @@ Functions
Error handling
If either of param1 or param2 are NULL, it returns 0 and sets icalerrno to ICAL_BADARG_ERROR.
Ownership
Does not take ownership of either icalparameter.
Example
// create two parameters
-
icalparameter *param1 = icalparameter_new_from_string("ROLE=CHAIR");
-
icalparameter *param2 = icalparameter_new_from_string("EMAIL=mailto@example.com");
+
icalparameter *param1 = icalparameter_new_from_string("ROLE=CHAIR");
+
icalparameter *param2 = icalparameter_new_from_string("EMAIL=mailto@example.com");
// compare parameter names for equality
-
assert(icalparameter_has_same_name(param1, param2) == 0);
+
assert(icalparameter_has_same_name(param1, param2) == 0);
// release memory
-
icalparameter_free(param1);
-
icalparameter_free(param2);
-
icalparameter_has_same_name
int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2)
Determines if two parameters have the same name.
Definition: icalparameter.c:420
+
icalparameter_free(param1);
+
icalparameter_free(param2);
+
icalparameter_has_same_name
int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2)
Determines if two parameters have the same name.
Definition: icalparameter.c:424
- +

◆ icalparameter_isa()

@@ -548,7 +501,7 @@ Functions
const char * icalparameter_get_xvalue const char* icalparameter_get_xvalue ( icalparameter *  param)
-

Returns the icalparameter_kind of parameter.

+

Returns the icalparameter_kind of parameter.

Parameters
@@ -557,19 +510,19 @@ Functions
Returns
The icalparameter_kind of the parameter

Error handling Returns ICAL_NO_PARAMETER when passed NULL.

-

Usage

// create parameter
-
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
+

Usage

// create parameter
+
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
// check what type of parameter this is
-
assert(icalparameter_isa(param) == ICAL_ROLE_PARAMETER);
+
assert(icalparameter_isa(param) == ICAL_ROLE_PARAMETER);
// release memory
-
icalparameter_free(param);
-
icalparameter_isa
icalparameter_kind icalparameter_isa(icalparameter *parameter)
Definition: icalparameter.c:316
+
icalparameter_free(param);
+
icalparameter_isa
icalparameter_kind icalparameter_isa(icalparameter *parameter)
Definition: icalparameter.c:320
- +

◆ icalparameter_isa_parameter()

@@ -584,7 +537,7 @@ Functions
parameterThe icalparameter whose kind to determine
-

Determines if the given param is an icalparameter

Parameters
+

Determines if the given param is an icalparameter

Parameters
paramThe libical-originated object to check
@@ -593,19 +546,19 @@ Functions
Returns
1 if the object is an icalparameter, 0 otherwise.
Note
This function expects to be given an object originating from libical - if this function is passed anything that is not from libical, its behavior is undefined.

Error handling When given a NULL object, it returns 0.

-

Usage

// create parameter
-
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
+

Usage

// create parameter
+
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
// check if it's a parameter
-
assert(icalparameter_isa_parameter(param));
+
assert(icalparameter_isa_parameter(param));
// release memory
-
icalparameter_free(param);
-
icalparameter_isa_parameter
int icalparameter_isa_parameter(void *param)
Definition: icalparameter.c:325
+
icalparameter_free(param);
+
icalparameter_isa_parameter
int icalparameter_isa_parameter(void *param)
Definition: icalparameter.c:329
- +

◆ icalparameter_kind_is_valid()

@@ -629,21 +582,21 @@ Functions
Returns
1 if kind is valid, 0 otherwise
-
Usage
assert(icalparameter_kind_is_valid(ICAL_ROLE_PARAMETER));
+
Usage
assert(icalparameter_kind_is_valid(ICAL_ROLE_PARAMETER));
icalparameter_kind_is_valid
int icalparameter_kind_is_valid(const icalparameter_kind kind)
Checks the validity of a icalparameter_kind.
Since
3.0.4
- -

◆ icalparameter_kind_to_string()

+ +

◆ icalparameter_kind_to_string()

- + @@ -662,22 +615,22 @@ Functions
Returns
A string representing kind
Error handling
When passed a non-existing icalparameter_kind, it returns NULL.
Ownership
The string that is returned by this function is owned by libical and must not be freed by the caller.
-
Usage
assert(0 == strcmp(icalparameter_kind_to_string(ICAL_ROLE_PARAMETER), "ROLE"));
-
assert(0 == strcmp(icalparameter_kind_to_string(ICAL_EMAIL_PARAMETER), "EMAIL));
+
Usage
assert(0 == strcmp(icalparameter_kind_to_string(ICAL_ROLE_PARAMETER), "ROLE"));
+
assert(0 == strcmp(icalparameter_kind_to_string(ICAL_EMAIL_PARAMETER), "EMAIL));
assert(0 == strcmp(icalparameter_kind_to_string(ICAL_ID_PARAMETER), "ID"));
-
icalparameter_kind_to_string
const char * icalparameter_kind_to_string(icalparameter_kind kind)
Returns a string representing the given icalparameter_kind.
+
icalparameter_kind_to_string
const char * icalparameter_kind_to_string(icalparameter_kind kind)
Returns a string representing the given icalparameter_kind.
- -

◆ icalparameter_new()

+ +

◆ icalparameter_new()

const char * icalparameter_kind_to_string const char* icalparameter_kind_to_string ( icalparameter_kind  kind)
- + @@ -697,26 +650,26 @@ Functions
Error handling
If there was an internal error regarding memory allocation, it returns NULL and sets icalerrno to ICAL_NEWFAILED_ERROR.
Ownership
Objects created by this method are owned by the caller and must be released with the icalparameter_free() method.
Usage
// create new parameter
-
icalparameter *parameter = icalparameter_new();
+
icalparameter *parameter = icalparameter_new();
if(parameter) {
// use parameter ...
}
// release parameter
-
icalparameter_free(parameter);
+
icalparameter_free(parameter);
- -

◆ icalparameter_new_clone()

+ +

◆ icalparameter_new_clone()

icalparameter * icalparameter_new icalparameter* icalparameter_new ( icalparameter_kind  kind)
- + @@ -739,7 +692,7 @@ Functions
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
// clone the parameter
-
icalparameter *clone = icalparameter_clone(param);
+
icalparameter *clone = icalparameter_new_clone(param);
if(clone) {
// use clone ...
@@ -749,19 +702,17 @@ Functions
icalparameter_free(param);
icalparameter_free(clone);
-
Since
3.1.0
-
Deprecated:
Use icalparameter_clone() instead
- -

◆ icalparameter_new_from_string()

+ +

◆ icalparameter_new_from_string()

icalparameter * icalparameter_new_clone icalparameter* icalparameter_new_clone ( icalparameter *  p)
- + @@ -780,25 +731,25 @@ Functions
Returns
An icalparameter that corresponds to the given string.
Error handling
If there was an internal error copying data, it returns NULL and sets icalerrno to ICAL_NEWFAILED_ERROR. If value was NULL, it returns NULL and sets icalerrno to ICAL_BADARG_ERROR. If value was malformed, it returns NULL and sets icalerrno to ICAL_MALFORMEDDATA_ERROR.
Ownership
Objects created by this method are owned by the caller and must be released with the icalparameter_free() method.
-
Usage
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
+
Usage
icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
if(param) {
// use param ...
}
-
icalparameter_free(param);
+
icalparameter_free(param);
- -

◆ icalparameter_new_from_value_string()

+ +

◆ icalparameter_new_from_value_string()

icalparameter * icalparameter_new_from_string icalparameter* icalparameter_new_from_string ( const char *  value)
- + @@ -830,20 +781,20 @@ Functions
Ownership
Objects created by this method are owned by the caller and must be released with the icalparameter_free() method.
Example
// create new parameter
icalparameter *param;
-
param = icalparameter_new_from_value_string(ICAL_ROLE_PARAMETER, "CHAIR");
+
param = icalparameter_new_from_value_string(ICAL_ROLE_PARAMETER, "CHAIR");
// check parameter
-
assert(0 == strcmp(icalparameter_get_iana_name(param), "ROLE"));
-
assert(0 == strcmp(icalparameter_get_iana_value(param), "CHAIR"));
+
assert(0 == strcmp(icalparameter_get_iana_name(param), "ROLE"));
+
assert(0 == strcmp(icalparameter_get_iana_value(param), "CHAIR"));
// release memory
-
icalparameter_free(param);
-
icalparameter_new_from_value_string
icalparameter * icalparameter_new_from_value_string(icalparameter_kind kind, const char *value)
Creates new icalparameter of a given kind with a given value.
+
icalparameter_free(param);
+
icalparameter_new_from_value_string
icalparameter * icalparameter_new_from_value_string(icalparameter_kind kind, const char *value)
Creates new icalparameter of a given kind with a given value.
- +

◆ icalparameter_set_iana_name()

@@ -877,24 +828,24 @@ Functions
icalparameter * icalparameter_new_from_value_string icalparameter* icalparameter_new_from_value_string ( icalparameter_kind  kind,
-
See also
icalparameter_get_iana_name()
+
See also
icalparameter_get_iana_name()
Error handling
If either param or v are NULL, it sets :calerrno to ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets errno to ENOMEM.
Ownership
The passed string v stays in the ownership of the caller - libical creates a copy of it.
Usage
// creates new parameter
-
icalparameter *param = icalparameter_new();
+
icalparameter *param = icalparameter_new();
// sets iana name
-
icalparameter_set_iana_name(param, "ROLE");
+
icalparameter_set_iana_name(param, "ROLE");
// compare iana name
-
assert(0 == strcmp(icalparameter_get_iana_name(param), "X-TEST"));
+
assert(0 == strcmp(icalparameter_get_iana_name(param), "X-TEST"));
-
icalparameter_free(param);
+
icalparameter_free(param);
- +

◆ icalparameter_set_iana_value()

@@ -928,25 +879,25 @@ Functions -
See also
icalparameter_get_iana_value()
+
See also
icalparameter_get_iana_value()
Error handling
If either param or v are NULL, it sets icalerrno to ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets errno to ENOMEM.
Ownership
The passed string v stays in the ownership of the caller - libical creates a copy of it.
Usage
// create new parameter
-
icalparameter *param = icalparameter_new_from_string("ROLE=ATTENDEE");
+
icalparameter *param = icalparameter_new_from_string("ROLE=ATTENDEE");
// set role to chair
-
icalparameter_set_iana_value(param, "CHAIR");
+
icalparameter_set_iana_value(param, "CHAIR");
// check that it worked
-
assert(0 == strcmp(icalparameter_get_iana_value(param), "SUCCESS"));
+
assert(0 == strcmp(icalparameter_get_iana_value(param), "SUCCESS"));
// release memory
-
icalparameter_free(param);
+
icalparameter_free(param);
- +

◆ icalparameter_set_xname()

@@ -980,24 +931,24 @@ Functions -
See also
icalparameter_get_xname()
+
See also
icalparameter_get_xname()
Error handling
If either param or v are NULL, it sets icalerrno to ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets errno to ENOMEM.
Ownership
The passed string v stays in the ownership of the caller - libical creates a copy of it.
Usage
// creates new parameter
-
icalparameter *param = icalparameter_new();
+
icalparameter *param = icalparameter_new();
// sets xname
-
icalparameter_set_xname(param, "X-TEST");
+
icalparameter_set_xname(param, "X-TEST");
// compare xname
-
assert(0 == strcmp(icalparameter_get_xname(param), "X-TEST"));
+
assert(0 == strcmp(icalparameter_get_xname(param), "X-TEST"));
-
icalparameter_free(param);
+
icalparameter_free(param);
- +

◆ icalparameter_set_xvalue()

@@ -1031,25 +982,25 @@ Functions -
See also
icalparameter_get_xvalue()
+
See also
icalparameter_get_xvalue()
Error handling
If either param or v are NULL, it sets icalerrno to ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets errno to ENOMEM.
Ownership
The passed string v stays in the ownership of the caller - libical creates a copy of it.
Usage
// create new parameter
-
icalparameter *param = icalparameter_new_from_string("X-TEST=FAIL");
+
icalparameter *param = icalparameter_new_from_string("X-TEST=FAIL");
// set test to success
-
icalparameter_set_xvalue(param, "SUCCESS");
+
icalparameter_set_xvalue(param, "SUCCESS");
// check that it worked
-
assert(0 == strcmp(icalparameter_get_xvalue(param), "SUCCESS"));
+
assert(0 == strcmp(icalparameter_get_xvalue(param), "SUCCESS"));
// release memory
-
icalparameter_free(param);
+
icalparameter_free(param);
- +

◆ icalparameter_string_to_kind()

@@ -1075,9 +1026,9 @@ Functions
Returns
An icalparameter_kind
Error handling
Returns ICAL_NO_PARAMETER if string is NULL. If it can't find the parameter, depending on the ical_get_unknown_token_handling_setting(), it returns either ICAL_NO_PARAMETER or ICAL_IANA_PARAMETER.
Ownership
Does not take ownership of string.
-
Usage
assert(icalparameter_string_to_kind("ROLE") == ICAL_ROLE_PARAMETER);
-
assert(icalparameter_string_to_kind("EMAIL") == ICAL_EMAIL_PARAMETER);
-
assert(icalparameter_string_to_kind("ID") == ICAL_ID_PARAMETER);
+
Usage
assert(icalparameter_string_to_kind("ROLE") == ICAL_ROLE_PARAMETER);
+
assert(icalparameter_string_to_kind("EMAIL") == ICAL_EMAIL_PARAMETER);
+
assert(icalparameter_string_to_kind("ID") == ICAL_ID_PARAMETER);
icalparameter_string_to_kind
icalparameter_kind icalparameter_string_to_kind(const char *string)
Returns the icalparameter_kind for a given string.
@@ -1086,7 +1037,7 @@ Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalparameter_8h_source.html b/apidocs/icalparameter_8h_source.html index 60848354..2b6b54e4 100644 --- a/apidocs/icalparameter_8h_source.html +++ b/apidocs/icalparameter_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparameter.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalparameter.h
+
+
icalparameter.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalparam.h
-
3 CREATOR: eric 20 March 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
18#ifndef ICALPARAMETER_H
-
19#define ICALPARAMETER_H
-
20
-
21#include "libical_deprecated.h"
-
22#include "libical_ical_export.h"
-
23#include "icalderivedparameter.h"
-
24
-
25/* Declared in icalderivedparameter.h */
-
26/*typedef struct icalparameter_impl icalparameter;*/
-
27
-
55LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind);
-
56
-
89LIBICAL_ICAL_EXPORT icalparameter *icalparameter_clone(const icalparameter *p);
-
90
-
95LIBICAL_ICAL_EXPORT LIBICAL_DEPRECATED(icalparameter *icalparameter_new_clone(icalparameter *p));
-
96
-
123LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_string(const char *value);
-
124
-
152LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_value_string(icalparameter_kind kind,
-
153 const char *value);
-
154
-
177LIBICAL_ICAL_EXPORT void icalparameter_free(icalparameter *parameter);
-
178
-
209LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string(icalparameter *parameter);
-
210
-
243LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string_r(icalparameter *parameter);
-
244
-
266LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_isa(icalparameter *parameter);
-
267
-
291LIBICAL_ICAL_EXPORT int icalparameter_isa_parameter(void *param);
-
292
-
293/* Access the name of an X parameter */
-
294
-
323LIBICAL_ICAL_EXPORT void icalparameter_set_xname(icalparameter *param, const char *v);
-
324
-
353LIBICAL_ICAL_EXPORT const char *icalparameter_get_xname(icalparameter *param);
-
354
-
384LIBICAL_ICAL_EXPORT void icalparameter_set_xvalue(icalparameter *param, const char *v);
-
385
-
415LIBICAL_ICAL_EXPORT const char *icalparameter_get_xvalue(icalparameter *param);
-
416
-
417/* Access the name of an IANA parameter */
-
418
-
447LIBICAL_ICAL_EXPORT void icalparameter_set_iana_name(icalparameter *param, const char *v);
-
448
-
477LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_name(icalparameter *param);
-
478
-
508LIBICAL_ICAL_EXPORT void icalparameter_set_iana_value(icalparameter *param, const char *v);
-
509
-
539LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_value(icalparameter *param);
-
540
-
568LIBICAL_ICAL_EXPORT int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2);
-
569
-
570/* Convert enumerations */
-
571
-
591LIBICAL_ICAL_EXPORT const char *icalparameter_kind_to_string(icalparameter_kind kind);
-
592
-
614LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_string_to_kind(const char *string);
-
615
-
627LIBICAL_ICAL_EXPORT int icalparameter_kind_is_valid(const icalparameter_kind kind);
-
628
-
629#endif
-
icalparameter_isa
icalparameter_kind icalparameter_isa(icalparameter *parameter)
Definition: icalparameter.c:316
-
icalparameter_get_xvalue
const char * icalparameter_get_xvalue(icalparameter *param)
Returns the X-value of param.
Definition: icalparameter.c:379
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalparam.h
+
3  CREATOR: eric 20 March 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
26 #ifndef ICALPARAMETER_H
+
27 #define ICALPARAMETER_H
+
28 
+
29 #include "libical_ical_export.h"
+
30 #include "icalderivedparameter.h"
+
31 
+
32 /* Declared in icalderivedparameter.h */
+
33 /*typedef struct icalparameter_impl icalparameter;*/
+
34 
+
62 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind);
+
63 
+
95 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_clone(icalparameter *p);
+
96 
+
123 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_string(const char *value);
+
124 
+
152 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_value_string(icalparameter_kind kind,
+
153  const char *value);
+
154 
+
176 LIBICAL_ICAL_EXPORT void icalparameter_free(icalparameter *parameter);
+
177 
+
208 LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string(icalparameter *parameter);
+
209 
+
242 LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string_r(icalparameter *parameter);
+
243 
+
265 LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_isa(icalparameter *parameter);
+
266 
+
290 LIBICAL_ICAL_EXPORT int icalparameter_isa_parameter(void *param);
+
291 
+
292 /* Access the name of an X parameter */
+
293 
+
322 LIBICAL_ICAL_EXPORT void icalparameter_set_xname(icalparameter *param, const char *v);
+
323 
+
352 LIBICAL_ICAL_EXPORT const char *icalparameter_get_xname(icalparameter *param);
+
353 
+
383 LIBICAL_ICAL_EXPORT void icalparameter_set_xvalue(icalparameter *param, const char *v);
+
384 
+
414 LIBICAL_ICAL_EXPORT const char *icalparameter_get_xvalue(icalparameter *param);
+
415 
+
416 /* Access the name of an IANA parameter */
+
417 
+
446 LIBICAL_ICAL_EXPORT void icalparameter_set_iana_name(icalparameter *param, const char *v);
+
447 
+
476 LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_name(icalparameter *param);
+
477 
+
507 LIBICAL_ICAL_EXPORT void icalparameter_set_iana_value(icalparameter *param, const char *v);
+
508 
+
538 LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_value(icalparameter *param);
+
539 
+
567 LIBICAL_ICAL_EXPORT int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2);
+
568 
+
569 /* Convert enumerations */
+
570 
+
590 LIBICAL_ICAL_EXPORT const char *icalparameter_kind_to_string(icalparameter_kind kind);
+
591 
+
613 LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_string_to_kind(const char *string);
+
614 
+
626 LIBICAL_ICAL_EXPORT int icalparameter_kind_is_valid(const icalparameter_kind kind);
+
627 
+
628 #endif
+
icalparameter_isa
icalparameter_kind icalparameter_isa(icalparameter *parameter)
Definition: icalparameter.c:320
+
icalparameter_get_xname
const char * icalparameter_get_xname(icalparameter *param)
Returns the X-name of param.
Definition: icalparameter.c:360
icalparameter_kind_is_valid
int icalparameter_kind_is_valid(const icalparameter_kind kind)
Checks the validity of a icalparameter_kind.
-
icalparameter_new
icalparameter * icalparameter_new(icalparameter_kind kind)
Creates new icalparameter object.
Definition: icalparameter.c:44
-
icalparameter_get_xname
const char * icalparameter_get_xname(icalparameter *param)
Returns the X-name of param.
Definition: icalparameter.c:356
-
icalparameter_set_xname
void icalparameter_set_xname(icalparameter *param, const char *v)
Sets the X-name of param to v.
Definition: icalparameter.c:340
+
icalparameter_new
icalparameter * icalparameter_new(icalparameter_kind kind)
Creates new icalparameter object.
Definition: icalparameter.c:53
+
icalparameter_set_xname
void icalparameter_set_xname(icalparameter *param, const char *v)
Sets the X-name of param to v.
Definition: icalparameter.c:344
icalparameter_string_to_kind
icalparameter_kind icalparameter_string_to_kind(const char *string)
Returns the icalparameter_kind for a given string.
-
icalparameter_kind_to_string
const char * icalparameter_kind_to_string(icalparameter_kind kind)
Returns a string representing the given icalparameter_kind.
-
icalparameter_clone
icalparameter * icalparameter_clone(const icalparameter *p)
Creates new icalparameter as a clone of the given one.
Definition: icalparameter.c:75
-
icalparameter_new_clone
icalparameter * icalparameter_new_clone(icalparameter *p))
Creates new icalparameter as a clone of the given one.
Definition: icalparameter.c:110
-
icalparameter_get_iana_value
const char * icalparameter_get_iana_value(icalparameter *param)
Returns the IANA value of param.
Definition: icalparameter.c:391
-
icalparameter_isa_parameter
int icalparameter_isa_parameter(void *param)
Definition: icalparameter.c:325
-
icalparameter_new_from_string
icalparameter * icalparameter_new_from_string(const char *value)
Creates new icalparameter object from string.
Definition: icalparameter.c:115
-
icalparameter_set_iana_name
void icalparameter_set_iana_name(icalparameter *param, const char *v)
Sets the IANA name of param to v.
Definition: icalparameter.c:396
-
icalparameter_set_xvalue
void icalparameter_set_xvalue(icalparameter *param, const char *v)
Sets the X-value of param to v.
Definition: icalparameter.c:363
-
icalparameter_free
void icalparameter_free(icalparameter *parameter)
Frees an icalparameter object.
Definition: icalparameter.c:51
-
icalparameter_get_iana_name
const char * icalparameter_get_iana_name(icalparameter *param)
Returns the IANA name of param.
Definition: icalparameter.c:401
-
icalparameter_as_ical_string
char * icalparameter_as_ical_string(icalparameter *parameter)
Converts icalparameter into a string representation.
Definition: icalparameter.c:164
-
icalparameter_new_from_value_string
icalparameter * icalparameter_new_from_value_string(icalparameter_kind kind, const char *value)
Creates new icalparameter of a given kind with a given value.
-
icalparameter_has_same_name
int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2)
Determines if two parameters have the same name.
Definition: icalparameter.c:420
-
icalparameter_set_iana_value
void icalparameter_set_iana_value(icalparameter *param, const char *v)
Sets the IANA value of param to v.
Definition: icalparameter.c:386
-
icalparameter_as_ical_string_r
char * icalparameter_as_ical_string_r(icalparameter *parameter)
Converts icalparameter into an string representation according to RFC5445/RFC6868.
Definition: icalparameter.c:264
+
icalparameter_new_clone
icalparameter * icalparameter_new_clone(icalparameter *p)
Creates new icalparameter as a clone of the given one.
Definition: icalparameter.c:84
+
icalparameter_new_from_value_string
icalparameter * icalparameter_new_from_value_string(icalparameter_kind kind, const char *value)
Creates new icalparameter of a given kind with a given value.
+
icalparameter_new_from_string
icalparameter * icalparameter_new_from_string(const char *value)
Creates new icalparameter object from string.
Definition: icalparameter.c:119
+
icalparameter_isa_parameter
int icalparameter_isa_parameter(void *param)
Definition: icalparameter.c:329
+
icalparameter_get_xvalue
const char * icalparameter_get_xvalue(icalparameter *param)
Returns the X-value of param.
Definition: icalparameter.c:383
+
icalparameter_get_iana_name
const char * icalparameter_get_iana_name(icalparameter *param)
Returns the IANA name of param.
Definition: icalparameter.c:405
+
icalparameter_set_iana_name
void icalparameter_set_iana_name(icalparameter *param, const char *v)
Sets the IANA name of param to v.
Definition: icalparameter.c:400
+
icalparameter_set_xvalue
void icalparameter_set_xvalue(icalparameter *param, const char *v)
Sets the X-value of param to v.
Definition: icalparameter.c:367
+
icalparameter_free
void icalparameter_free(icalparameter *parameter)
Frees an icalparameter object.
Definition: icalparameter.c:60
+
icalparameter_as_ical_string
char * icalparameter_as_ical_string(icalparameter *parameter)
Converts icalparameter into a string representation.
Definition: icalparameter.c:168
+
icalparameter_has_same_name
int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2)
Determines if two parameters have the same name.
Definition: icalparameter.c:424
+
icalparameter_set_iana_value
void icalparameter_set_iana_value(icalparameter *param, const char *v)
Sets the IANA value of param to v.
Definition: icalparameter.c:390
+
icalparameter_as_ical_string_r
char * icalparameter_as_ical_string_r(icalparameter *parameter)
Converts icalparameter into an string representation according to RFC5445/RFC6868.
Definition: icalparameter.c:268
+
icalparameter_kind_to_string
const char * icalparameter_kind_to_string(icalparameter_kind kind)
Returns a string representing the given icalparameter_kind.
+
icalparameter_get_iana_value
const char * icalparameter_get_iana_value(icalparameter *param)
Returns the IANA value of param.
Definition: icalparameter.c:395
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalparameter__cxx_8h.html b/apidocs/icalparameter__cxx_8h.html index a7d6d1d7..fdbb8b2a 100644 --- a/apidocs/icalparameter__cxx_8h.html +++ b/apidocs/icalparameter__cxx_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparameter_cxx.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures
-
icalparameter_cxx.h File Reference
+
+
icalparameter_cxx.h File Reference
@@ -77,20 +78,23 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

class  LibICal::ICalParameter
 

Detailed Description

-

Definition of C++ Wrapper for icalparameter.c.

+

Definition of C++ Wrapper for icalparameter.c.

Author
fnguyen (12/10/01)
-

SPDX-FileCopyrightText: 2001, Critical Path

-

SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0

+

(C) COPYRIGHT 2001, Critical Path

+

This library is free software; you can redistribute it and/or modify it under the terms of either:

+

The LGPL as published by the Free Software Foundation, version 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html

+

Or:

+

The Mozilla Public License Version 2.0. You may obtain a copy of the License at https://www.mozilla.org/MPL/

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalparameter__cxx_8h_source.html b/apidocs/icalparameter__cxx_8h_source.html index 43675765..7bbe3156 100644 --- a/apidocs/icalparameter__cxx_8h_source.html +++ b/apidocs/icalparameter__cxx_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparameter_cxx.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalparameter_cxx.h
+
+
icalparameter_cxx.h
-Go to the documentation of this file.
1
-
12#ifndef ICALPARAMETER_CXX_H
-
13#define ICALPARAMETER_CXX_H
-
14
-
15#include "libical_ical_export.h"
-
16#include "icptrholder_cxx.h"
-
17
-
18extern "C"
-
19{
-
20#include "icalerror.h"
-
21#include "icalparameter.h"
-
22}
-
23
-
24#include <string>
-
25
-
26namespace LibICal
-
27{
-
28
-
29class LIBICAL_ICAL_EXPORT ICalParameter
-
30{
-
31public:
-
32 ICalParameter();
-
33 ICalParameter(const ICalParameter &);
-
34 ICalParameter &operator=(const ICalParameter &);
-
35 ~ICalParameter();
-
36
-
37 explicit ICalParameter(icalparameter *v);
-
38
-
39 // Create from string of form "PARAMNAME=VALUE"
-
40 explicit ICalParameter(const std::string &str);
-
41
-
42 // Create from just the value, the part after the "="
-
43 explicit ICalParameter(const icalparameter_kind &kind);
-
44 ICalParameter(const icalparameter_kind &kind, const std::string &str);
-
45
-
46 operator icalparameter *()
-
47 {
-
48 return imp;
-
49 }
-
50
-
51 void detach();
-
52
-
53public:
-
54 std::string as_ical_string();
-
55 bool is_valid();
-
56 icalparameter_kind isa();
-
57 int isa_parameter(void *param);
-
58
-
59public:
-
60 /* Access the name of an X parameter */
-
61 static void set_xname(ICalParameter &param, const std::string &v);
-
62 static std::string get_xname(ICalParameter &param);
-
63 static void set_xvalue(ICalParameter &param, const std::string &v);
-
64 static std::string get_xvalue(ICalParameter &param);
-
65
-
66 /* Convert enumerations */
-
67 static std::string kind_to_string(const icalparameter_kind &kind);
-
68 static icalparameter_kind string_to_kind(const std::string &str);
-
69
-
70public:
-
71 /* DELEGATED-FROM */
-
72 std::string get_delegatedfrom() const;
-
73 void set_delegatedfrom(const std::string &v);
-
74
-
75 /* RELATED */
-
76 icalparameter_related get_related() const;
-
77 void set_related(const icalparameter_related &v);
-
78
-
79 /* SENT-BY */
-
80 std::string get_sentby() const;
-
81 void set_sentby(const std::string &v);
-
82
-
83 /* LANGUAGE */
-
84 std::string get_language() const;
-
85 void set_language(const std::string &v);
-
86
-
87 /* RELTYPE */
-
88 icalparameter_reltype get_reltype() const;
-
89 void set_reltype(const icalparameter_reltype &v);
-
90
-
91 /* ENCODING */
-
92 icalparameter_encoding get_encoding() const;
-
93 void set_encoding(const icalparameter_encoding &v);
-
94
-
95 /* ALTREP */
-
96 std::string get_altrep() const;
-
97 void set_altrep(const std::string &v);
-
98
-
99 /* FMTTYPE */
-
100 std::string get_fmttype() const;
-
101 void set_fmttype(const std::string &v);
-
102
-
103 /* FBTYPE */
-
104 icalparameter_fbtype get_fbtype() const;
-
105 void set_fbtype(const icalparameter_fbtype &v);
-
106
-
107 /* RSVP */
-
108 icalparameter_rsvp get_rsvp() const;
-
109 void set_rsvp(const icalparameter_rsvp &v);
-
110
-
111 /* RANGE */
-
112 icalparameter_range get_range() const;
-
113 void set_range(const icalparameter_range &v);
-
114
-
115 /* DELEGATED-TO */
-
116 std::string get_delegatedto() const;
-
117 void set_delegatedto(const std::string &v);
-
118
-
119 /* CN */
-
120 std::string get_cn() const;
-
121 void set_cn(const std::string &v);
-
122
-
123 /* ROLE */
-
124 icalparameter_role get_role() const;
-
125 void set_role(const icalparameter_role &v);
-
126
-
127 /* X-LIC-COMPARETYPE */
-
128 icalparameter_xliccomparetype get_xliccomparetype() const;
-
129 void set_xliccomparetype(const icalparameter_xliccomparetype &v);
-
130
-
131 /* PARTSTAT */
-
132 icalparameter_partstat get_partstat() const;
-
133 void set_partstat(const icalparameter_partstat &v);
-
134
-
135 /* X-LIC-ERRORTYPE */
-
136 icalparameter_xlicerrortype get_xlicerrortype() const;
-
137 void set_xlicerrortype(const icalparameter_xlicerrortype &v);
-
138
-
139 /* MEMBER */
-
140 std::string get_member() const;
-
141 void set_member(const std::string &v);
-
142
-
143 /* X */
-
144 std::string get_x() const;
-
145 void set_x(const std::string &v);
-
146
-
147 /* CUTYPE */
-
148 icalparameter_cutype get_cutype() const;
-
149 void set_cutype(const icalparameter_cutype &v);
-
150
-
151 /* TZID */
-
152 std::string get_tzid() const;
-
153 void set_tzid(const std::string &v);
-
154
-
155 /* VALUE */
-
156 icalparameter_value get_value() const;
-
157 void set_value(const icalparameter_value &v);
-
158
-
159 /* DIR */
-
160 std::string get_dir() const;
-
161 void set_dir(const std::string &v);
-
162
-
163private:
-
164 icalparameter *imp;
-
165};
-
166
-
167} // namespace LibICal
-
168
-
169#endif
-
LibICal::ICalParameter
Definition: icalparameter_cxx.h:30
+Go to the documentation of this file.
1 
+
20 #ifndef ICALPARAMETER_CXX_H
+
21 #define ICALPARAMETER_CXX_H
+
22 
+
23 #include "libical_ical_export.h"
+
24 #include "icptrholder_cxx.h"
+
25 
+
26 extern "C"
+
27 {
+
28 #include "icalerror.h"
+
29 #include "icalparameter.h"
+
30 }
+
31 
+
32 #include <string>
+
33 
+
34 namespace LibICal
+
35 {
+
36 
+
37 class LIBICAL_ICAL_EXPORT ICalParameter
+
38 {
+
39 public:
+
40  ICalParameter();
+
41  ICalParameter(const ICalParameter &);
+
42  ICalParameter &operator=(const ICalParameter &);
+
43  ~ICalParameter();
+
44 
+
45  explicit ICalParameter(icalparameter *v);
+
46 
+
47  // Create from string of form "PARAMNAME=VALUE"
+
48  explicit ICalParameter(const std::string &str);
+
49 
+
50  // Create from just the value, the part after the "="
+
51  explicit ICalParameter(const icalparameter_kind &kind);
+
52  ICalParameter(const icalparameter_kind &kind, const std::string &str);
+
53 
+
54  operator icalparameter *()
+
55  {
+
56  return imp;
+
57  }
+
58 
+
59  void detach();
+
60 
+
61 public:
+
62  std::string as_ical_string();
+
63  bool is_valid();
+
64  icalparameter_kind isa();
+
65  int isa_parameter(void *param);
+
66 
+
67 public:
+
68  /* Access the name of an X parameter */
+
69  static void set_xname(ICalParameter &param, const std::string &v);
+
70  static std::string get_xname(ICalParameter &param);
+
71  static void set_xvalue(ICalParameter &param, const std::string &v);
+
72  static std::string get_xvalue(ICalParameter &param);
+
73 
+
74  /* Convert enumerations */
+
75  static std::string kind_to_string(const icalparameter_kind &kind);
+
76  static icalparameter_kind string_to_kind(const std::string &str);
+
77 
+
78 public:
+
79  /* DELEGATED-FROM */
+
80  std::string get_delegatedfrom() const;
+
81  void set_delegatedfrom(const std::string &v);
+
82 
+
83  /* RELATED */
+
84  icalparameter_related get_related() const;
+
85  void set_related(const icalparameter_related &v);
+
86 
+
87  /* SENT-BY */
+
88  std::string get_sentby() const;
+
89  void set_sentby(const std::string &v);
+
90 
+
91  /* LANGUAGE */
+
92  std::string get_language() const;
+
93  void set_language(const std::string &v);
+
94 
+
95  /* RELTYPE */
+
96  icalparameter_reltype get_reltype() const;
+
97  void set_reltype(const icalparameter_reltype &v);
+
98 
+
99  /* ENCODING */
+
100  icalparameter_encoding get_encoding() const;
+
101  void set_encoding(const icalparameter_encoding &v);
+
102 
+
103  /* ALTREP */
+
104  std::string get_altrep() const;
+
105  void set_altrep(const std::string &v);
+
106 
+
107  /* FMTTYPE */
+
108  std::string get_fmttype() const;
+
109  void set_fmttype(const std::string &v);
+
110 
+
111  /* FBTYPE */
+
112  icalparameter_fbtype get_fbtype() const;
+
113  void set_fbtype(const icalparameter_fbtype &v);
+
114 
+
115  /* RSVP */
+
116  icalparameter_rsvp get_rsvp() const;
+
117  void set_rsvp(const icalparameter_rsvp &v);
+
118 
+
119  /* RANGE */
+
120  icalparameter_range get_range() const;
+
121  void set_range(const icalparameter_range &v);
+
122 
+
123  /* DELEGATED-TO */
+
124  std::string get_delegatedto() const;
+
125  void set_delegatedto(const std::string &v);
+
126 
+
127  /* CN */
+
128  std::string get_cn() const;
+
129  void set_cn(const std::string &v);
+
130 
+
131  /* ROLE */
+
132  icalparameter_role get_role() const;
+
133  void set_role(const icalparameter_role &v);
+
134 
+
135  /* X-LIC-COMPARETYPE */
+
136  icalparameter_xliccomparetype get_xliccomparetype() const;
+
137  void set_xliccomparetype(const icalparameter_xliccomparetype &v);
+
138 
+
139  /* PARTSTAT */
+
140  icalparameter_partstat get_partstat() const;
+
141  void set_partstat(const icalparameter_partstat &v);
+
142 
+
143  /* X-LIC-ERRORTYPE */
+
144  icalparameter_xlicerrortype get_xlicerrortype() const;
+
145  void set_xlicerrortype(const icalparameter_xlicerrortype &v);
+
146 
+
147  /* MEMBER */
+
148  std::string get_member() const;
+
149  void set_member(const std::string &v);
+
150 
+
151  /* X */
+
152  std::string get_x() const;
+
153  void set_x(const std::string &v);
+
154 
+
155  /* CUTYPE */
+
156  icalparameter_cutype get_cutype() const;
+
157  void set_cutype(const icalparameter_cutype &v);
+
158 
+
159  /* TZID */
+
160  std::string get_tzid() const;
+
161  void set_tzid(const std::string &v);
+
162 
+
163  /* VALUE */
+
164  icalparameter_value get_value() const;
+
165  void set_value(const icalparameter_value &v);
+
166 
+
167  /* DIR */
+
168  std::string get_dir() const;
+
169  void set_dir(const std::string &v);
+
170 
+
171 private:
+
172  icalparameter *imp;
+
173 };
+
174 
+
175 } // namespace LibICal
+
176 
+
177 #endif
+
LibICal::ICalParameter
Definition: icalparameter_cxx.h:38
icalerror.h
Error handling for libical.
icptrholder_cxx.h
C++ template classes for managing C++ pointers returned by VComponent::get_..._component,...
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalparameterimpl_8h_source.html b/apidocs/icalparameterimpl_8h_source.html index a3e03988..a8418289 100644 --- a/apidocs/icalparameterimpl_8h_source.html +++ b/apidocs/icalparameterimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparameterimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalparameterimpl.h
+
+
icalparameterimpl.h
-
1/*======================================================================
-
2 FILE: icalparameterimpl.h
-
3 CREATOR: eric 09 May 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The original code is icalderivedparameters.{c,h}
-
10
-
11 Contributions from:
-
12 Graham Davison (g.m.davison@computer.org)
-
13======================================================================*/
-
14
-
15#ifndef ICALPARAMETERIMPL_H
-
16#define ICALPARAMETERIMPL_H
-
17
-
18#include "icalproperty.h"
-
19
-
20struct icalparameter_impl
-
21{
-
22 icalparameter_kind kind;
-
23 char id[5];
-
24 int size;
-
25 const char *string;
-
26 const char *x_name;
-
27 icalproperty *parent;
-
28
-
29 int data;
-
30};
-
31
-
32#endif /*ICALPARAMETER_IMPL */
+
1 /*======================================================================
+
2  FILE: icalparameterimpl.h
+
3  CREATOR: eric 09 May 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The original code is icalderivedparameters.{c,h}
+
19 
+
20  Contributions from:
+
21  Graham Davison (g.m.davison@computer.org)
+
22 ======================================================================*/
+
23 
+
24 #ifndef ICALPARAMETERIMPL_H
+
25 #define ICALPARAMETERIMPL_H
+
26 
+
27 #include "icalproperty.h"
+
28 
+
29 struct icalparameter_impl
+
30 {
+
31  icalparameter_kind kind;
+
32  char id[5];
+
33  int size;
+
34  const char *string;
+
35  const char *x_name;
+
36  icalproperty *parent;
+
37 
+
38  int data;
+
39 };
+
40 
+
41 #endif /*ICALPARAMETER_IMPL */
-
icalparameter_impl
Definition: icalparameterimpl.h:21
+
icalparameter_impl
Definition: icalparameterimpl.h:30
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalparser_8h.html b/apidocs/icalparser_8h.html index e7d517a8..7ad4b182 100644 --- a/apidocs/icalparser_8h.html +++ b/apidocs/icalparser_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparser.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Typedefs | Enumerations | Functions
-
icalparser.h File Reference
+
+
icalparser.h File Reference
@@ -79,18 +80,18 @@ $(function() {

Go to the source code of this file.

- - - - +

+

Typedefs

typedef struct icalparser_impl icalparser
 
+
typedef char *(* icalparser_line_gen_func) (char *s, size_t size, void *d)
 
+
 
typedef enum icalparser_state icalparser_state
 
-

+

Enumerations

enum  icalparser_state {
  ICALPARSER_ERROR @@ -104,45 +105,45 @@ Enumerations
 Represents the current state of the parser. More...
 
- - - - - - - + + + + + + - - - + + + - - - - - - - - - + + + + + + + + + - - +

+

Functions

icalcomponent * icalparser_add_line (icalparser *parser, char *str)
 Adds a single line to be parsed by the icalparser. More...
 
icalcomponent * icalparser_clean (icalparser *parser)
 Cleans out an icalparser and returns whatever it has parsed so far. More...
 
icalcomponent * icalparser_add_line (icalparser *parser, char *str)
 Adds a single line to be parsed by the icalparser. More...
 
icalcomponent * icalparser_clean (icalparser *parser)
 Cleans out an icalparser and returns whatever it has parsed so far. More...
 
void icalparser_free (icalparser *parser)
 Frees an icalparser object. More...
 
char * icalparser_get_line (icalparser *parser, icalparser_line_gen_func line_gen_func)
 Given a line generator function, returns a single iCal content line. More...
 
char * icalparser_get_line (icalparser *parser, icalparser_line_gen_func line_gen_func)
 Given a line generator function, returns a single iCal content line. More...
 
icalparser_state icalparser_get_state (icalparser *parser)
 Returns current state of the icalparser. More...
 
icalparser * icalparser_new (void)
 Creates a new icalparser. More...
 
icalcomponent * icalparser_parse (icalparser *parser, icalparser_line_gen_func line_gen_func)
 Message oriented parsing. More...
 
icalcomponent * icalparser_parse_string (const char *str)
 Parses a string and returns the parsed icalcomponent. More...
 
icalparser * icalparser_new (void)
 Creates a new icalparser. More...
 
icalcomponent * icalparser_parse (icalparser *parser, icalparser_line_gen_func line_gen_func)
 Message oriented parsing. More...
 
icalcomponent * icalparser_parse_string (const char *str)
 Parses a string and returns the parsed icalcomponent. More...
 
void icalparser_set_gen_data (icalparser *parser, void *data)
 Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'. More...
 
+
char * icalparser_string_line_generator (char *out, size_t buf_size, void *d)
 
 

Detailed Description

-

Line-oriented parsing.

-

This file provides methods to parse iCalendar-formatted data into the structures provided by this library.

-
Usage
Create a new parser via icalparser_new_parser(), then add lines one at a time with icalparser_add_line(). icalparser_add_line() will return non-zero when it has finished with a component.
+

Line-oriented parsing.

+

This file provides methods to parse iCalendar-formatted data into the structures provided by this library.

+
Usage
Create a new parser via icalparser_new_parser(), then add lines one at a time with icalparser_add_line(). icalparser_add_line() will return non-zero when it has finished with a component.

Typedef Documentation

- +

◆ icalparser

@@ -153,12 +154,12 @@ char * icalparser_string_l
-

Implementation of the icalparser struct, which holds the state for the current parsing operation.

+

Implementation of the icalparser struct, which holds the state for the current parsing operation.

Enumeration Type Documentation

- +

◆ icalparser_state

@@ -172,29 +173,29 @@ char * icalparser_string_l

Represents the current state of the parser.

- - - - -
Enumerator
ICALPARSER_ERROR 

An error occurred while parsing.

+
Enumerator
ICALPARSER_ERROR 

An error occurred while parsing.

ICALPARSER_SUCCESS 

Parsing was successful.

+
ICALPARSER_SUCCESS 

Parsing was successful.

ICALPARSER_BEGIN_COMP 

Currently parsing the begin of a component.

+
ICALPARSER_BEGIN_COMP 

Currently parsing the begin of a component.

ICALPARSER_END_COMP 

Currently parsing the end of the component.

+
ICALPARSER_END_COMP 

Currently parsing the end of the component.

ICALPARSER_IN_PROGRESS 

Parsing is currently in progress.

+
ICALPARSER_IN_PROGRESS 

Parsing is currently in progress.

Function Documentation

- -

◆ icalparser_add_line()

+ +

◆ icalparser_add_line()

- + @@ -222,7 +223,7 @@ char * 
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalperiod_8h_source.html b/apidocs/icalperiod_8h_source.html index 29d4dda7..509909c2 100644 --- a/apidocs/icalperiod_8h_source.html +++ b/apidocs/icalperiod_8h_source.html @@ -2,8 +2,8 @@ - - + +Libical API Documentation: icalperiod.h Source File @@ -19,9 +19,10 @@
icalcomponent * icalparser_add_line icalcomponent* icalparser_add_line ( icalparser *  parser, icalparser_string_l
Returns
When this was the last line of the component to be parsed, it returns the icalcomponent, otherwise it returns NULL.
-
See also
icalparser_parse()
+
See also
icalparser_parse()
Error handling
  • If parser is NULL, it returns NULL and sets icalerrno to ICAL_BADARG_ERROR.
  • If line is empty, if returns NULL
    • @@ -240,19 +241,19 @@ char * 
icalparser_string_l
{
char* line;
FILE* stream;
-
icalcomponent *component;
+
icalcomponent *component;
-
icalparser *parser = icalparser_new();
+
icalparser *parser = icalparser_new();
stream = fopen(argv[1],"r");
-
icalparser_set_gen_data(parser, stream);
+
icalparser_set_gen_data(parser, stream);
do{
// get a single content line
-
line = icalparser_get_line(parser, read_stream);
+
line = icalparser_get_line(parser, read_stream);
// add that line to the parser
-
c = icalparser_add_line(parser,line);
+
c = icalparser_add_line(parser,line);
// once we parsed a component, print it
if (c != 0) {
@@ -261,27 +262,27 @@ char * 		icalparser_string_l
}
} while (line != 0);
-
icalparser_free(parser);
+
icalparser_free(parser);
}
-
icalparser_free
void icalparser_free(icalparser *parser)
Frees an icalparser object.
Definition: icalparser.c:104
-
icalparser_new
icalparser * icalparser_new(void)
Creates a new icalparser.
Definition: icalparser.c:81
-
icalparser_add_line
icalcomponent * icalparser_add_line(icalparser *parser, char *str)
Adds a single line to be parsed by the icalparser.
Definition: icalparser.c:682
-
icalparser_set_gen_data
void icalparser_set_gen_data(icalparser *parser, void *data)
Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.
Definition: icalparser.c:121
-
icalparser_get_line
char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)
Given a line generator function, returns a single iCal content line.
Definition: icalparser.c:467
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalparser_impl
Definition: icalparser.c:32
+
icalparser_add_line
icalcomponent * icalparser_add_line(icalparser *parser, char *str)
Adds a single line to be parsed by the icalparser.
Definition: icalparser.c:691
+
icalparser_free
void icalparser_free(icalparser *parser)
Frees an icalparser object.
Definition: icalparser.c:121
+
icalparser_get_line
char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)
Given a line generator function, returns a single iCal content line.
Definition: icalparser.c:480
+
icalparser_new
icalparser * icalparser_new(void)
Creates a new icalparser.
Definition: icalparser.c:99
+
icalparser_set_gen_data
void icalparser_set_gen_data(icalparser *parser, void *data)
Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.
Definition: icalparser.c:138
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalparser_impl
Definition: icalparser.c:51
- -

◆ icalparser_clean()

+ +

◆ icalparser_clean()

- + @@ -304,7 +305,7 @@ char * 
icalcomponent * icalparser_clean icalcomponent* icalparser_clean ( icalparser *  parser)icalparser_string_l - +

◆ icalparser_free()

@@ -327,23 +328,23 @@ char * 
icalparser_string_l
-
Example
icalparser *parser = icalparser_new();
+
Example
icalparser *parser = icalparser_new();
// use parser ...
-
icalparser_free(parser);
+
icalparser_free(parser);
- -

◆ icalparser_get_line()

+ +

◆ icalparser_get_line()

- + @@ -375,7 +376,7 @@ char * 
Returns
1 if p is a valid period, 0 otherwise
Usage
// creates null period
-
struct icalperiodtype period = icalperiodtype_null_period();
+
struct icalperiodtype period = icalperiodtype_null_period();
// a null period isn't a valid period
-
assert(icalperiodtype_is_valid_period(period) == 0);
-
icalperiodtype_is_valid_period
int icalperiodtype_is_valid_period(struct icalperiodtype p)
Definition: icalperiod.c:145
+
assert(icalperiodtype_is_valid_period(period) == 0);
+
icalperiodtype_is_valid_period
int icalperiodtype_is_valid_period(struct icalperiodtype p)
Definition: icalperiod.c:154
- +

◆ icalperiodtype_null_period()

@@ -335,16 +336,16 @@ Functions
char * icalparser_get_line char* icalparser_get_line ( icalparser *  parser, icalparser_string_l - +

◆ icalparser_get_state()

@@ -399,30 +400,30 @@ char * 
icalparser_string_l
Returns
The current state of the icalparser, as an icalparser_state
-
Example
icalparser *parser = icalparser_new();
+
Example
icalparser *parser = icalparser_new();
// use icalparser...
-
if(icalparser_get_state(parser) == ICALPARSER_ERROR) {
+
if(icalparser_get_state(parser) == ICALPARSER_ERROR) {
// handle error
} else {
// ...
}
-
icalparser_get_state
icalparser_state icalparser_get_state(icalparser *parser)
Returns current state of the icalparser.
Definition: icalparser.c:1238
-
ICALPARSER_ERROR
@ ICALPARSER_ERROR
Definition: icalparser.h:49
+
icalparser_get_state
icalparser_state icalparser_get_state(icalparser *parser)
Returns current state of the icalparser.
Definition: icalparser.c:1243
+
ICALPARSER_ERROR
@ ICALPARSER_ERROR
Definition: icalparser.h:58

icalparser_free(parser);

- -

◆ icalparser_new()

+ +

◆ icalparser_new()

- + @@ -436,24 +437,24 @@ char * 
Returns
1 if p is a null period, 0 otherwise
See also
icalperiodtype_null_period()
Usage
// creates null period
-
struct icalperiodtype period = icalperiodtype_null_period();
+
struct icalperiodtype period = icalperiodtype_null_period();
// checks if it's a null period
-
assert(icalperiodtype_is_null_period(period));
-
icalperiodtype_null_period
struct icalperiodtype icalperiodtype_null_period(void)
Definition: icalperiod.c:124
-
icalperiodtype_is_null_period
int icalperiodtype_is_null_period(struct icalperiodtype p)
Definition: icalperiod.c:135
+
assert(icalperiodtype_is_null_period(period));
+
icalperiodtype_null_period
struct icalperiodtype icalperiodtype_null_period(void)
Definition: icalperiod.c:133
+
icalperiodtype_is_null_period
int icalperiodtype_is_null_period(struct icalperiodtype p)
Definition: icalperiod.c:144
- +

◆ icalperiodtype_is_valid_period()

@@ -303,7 +304,7 @@ Functions
icalparser * icalparser_new icalparser* icalparser_new ( void  )icalparser_string_l
Error handling
On error, it returns NULL and sets icalerrno to ICAL_NEWFAILED_ERROR.
Ownership
All icalparser objects created with this function need to be freed using the icalparser_free() function.
Usage
// create new parser
-
icalparser *parser = icalparser_new();
+
icalparser *parser = icalparser_new();
// do something with it...
// free parser
-
icalparser_free(parser);
+
icalparser_free(parser);
- -

◆ icalparser_parse()

+ +

◆ icalparser_parse()

- + @@ -481,7 +482,7 @@ char * 

Function Documentation

- -

◆ icalperiodtype_as_ical_string()

+ +

◆ icalperiodtype_as_ical_string()

icalcomponent * icalparser_parse icalcomponent* icalparser_parse ( icalparser *  parser, icalparser_string_l
Returns
The parsed icalcomponent
-
See also
icalparser_parse_string()
+
See also
icalparser_parse_string()

Reads an icalcomponent using the supplied line_gen_func, returning the parsed component (or NULL on error).

Error handling
icalparser_string_l
{
char* line;
FILE* stream;
-
icalcomponent *component;
+
icalcomponent *component;
-
icalparser *parser = icalparser_new();
+
icalparser *parser = icalparser_new();
stream = fopen(argv[1],"r");
-
icalparser_set_gen_data(parser, stream);
+
icalparser_set_gen_data(parser, stream);
// use the parse method to parse the input data
-
component = icalparser_parse(parser, read_stream);
+
component = icalparser_parse(parser, read_stream);
// once we parsed a component, print it
printf("%s", icalcomponent_as_ical_string(c));
icalcomponent_free(c);
-
icalparser_free(parser);
+
icalparser_free(parser);
}
-
icalparser_parse
icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)
Message oriented parsing.
Definition: icalparser.c:622
+
icalparser_parse
icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)
Message oriented parsing.
Definition: icalparser.c:629
- -

◆ icalparser_parse_string()

+ +

◆ icalparser_parse_string()

- + @@ -550,21 +551,21 @@ char * 
icalcomponent * icalparser_parse_string icalcomponent* icalparser_parse_string ( const char *  str)icalparser_string_l
Example
char *ical_string;
// parse ical_string
-
icalcomponent *component = icalparser_parse_string(ical_string);
+
icalcomponent *component = icalparser_parse_string(ical_string);
-
if(!icalerrno || component == NULL) {
+
if(!icalerrno || component == NULL) {
// use component ...
}
// release component
icalcomponent_free(component);
-
icalerrno
#define icalerrno
Access the current icalerrno value.
Definition: icalerror.h:135
-
icalparser_parse_string
icalcomponent * icalparser_parse_string(const char *str)
Parses a string and returns the parsed icalcomponent.
Definition: icalparser.c:1336
+
icalerrno
#define icalerrno
Access the current icalerrno value.
Definition: icalerror.h:144
+
icalparser_parse_string
icalcomponent * icalparser_parse_string(const char *str)
Parses a string and returns the parsed icalcomponent.
Definition: icalparser.c:1341
- +

◆ icalparser_set_gen_data()

@@ -598,14 +599,14 @@ char * 
icalparser_string_l
-

If you use any of the icalparser_parser() or icalparser_get_line() functions, the line_gen_func that they expect has a third void* d argument. This function sets what will be passed to your line_gen_function as such argument.

+

If you use any of the icalparser_parser() or icalparser_get_line() functions, the line_gen_func that they expect has a third void *d argument. This function sets what will be passed to your line_gen_function as such argument.

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalparser_8h_source.html b/apidocs/icalparser_8h_source.html index 6e0a173b..7d70c081 100644 --- a/apidocs/icalparser_8h_source.html +++ b/apidocs/icalparser_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparser.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalparser.h
+
+
icalparser.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalparser.h
-
3 CREATOR: eric 20 April 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The original code is icalparser.h
-
10======================================================================*/
-
11
-
12#ifndef ICALPARSER_H
-
13#define ICALPARSER_H
-
14
-
15#include "libical_ical_export.h"
-
16#include "icalcomponent.h"
-
17
-
39typedef struct icalparser_impl icalparser;
-
40
-
46typedef enum icalparser_state
-
47{
-
49 ICALPARSER_ERROR,
-
50
-
52 ICALPARSER_SUCCESS,
-
53
-
55 ICALPARSER_BEGIN_COMP,
-
56
-
58 ICALPARSER_END_COMP,
-
59
-
61 ICALPARSER_IN_PROGRESS
-
62} icalparser_state;
-
63
-
64typedef char *(*icalparser_line_gen_func) (char *s, size_t size, void *d);
-
65
-
89LIBICAL_ICAL_EXPORT icalparser *icalparser_new(void);
-
90
-
150LIBICAL_ICAL_EXPORT icalcomponent *icalparser_add_line(icalparser *parser, char *str);
-
151
-
171LIBICAL_ICAL_EXPORT icalcomponent *icalparser_clean(icalparser *parser);
-
172
-
193LIBICAL_ICAL_EXPORT icalparser_state icalparser_get_state(icalparser *parser);
-
194
-
208LIBICAL_ICAL_EXPORT void icalparser_free(icalparser *parser);
-
209
-
262LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse(icalparser *parser,
-
263 icalparser_line_gen_func line_gen_func);
-
264
-
275LIBICAL_ICAL_EXPORT void icalparser_set_gen_data(icalparser *parser, void *data);
-
276
-
304LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse_string(const char *str);
-
305
-
306/***********************************************************************
-
307 * Parser support functions
-
308 ***********************************************************************/
-
309
-
324LIBICAL_ICAL_EXPORT char *icalparser_get_line(icalparser *parser,
-
325 icalparser_line_gen_func line_gen_func);
-
326
-
327LIBICAL_ICAL_EXPORT char *icalparser_string_line_generator(char *out, size_t buf_size, void *d);
-
328
-
329#endif /* !ICALPARSE_H */
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalparser.h
+
3  CREATOR: eric 20 April 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The original code is icalparser.h
+
19 ======================================================================*/
+
20 
+
21 #ifndef ICALPARSER_H
+
22 #define ICALPARSER_H
+
23 
+
24 #include "libical_ical_export.h"
+
25 #include "icalcomponent.h"
+
26 
+
48 typedef struct icalparser_impl icalparser;
+
49 
+
55 typedef enum icalparser_state
+
56 {
+
58  ICALPARSER_ERROR,
+
59 
+
61  ICALPARSER_SUCCESS,
+
62 
+
64  ICALPARSER_BEGIN_COMP,
+
65 
+
67  ICALPARSER_END_COMP,
+
68 
+
70  ICALPARSER_IN_PROGRESS
+
71 } icalparser_state;
+
72 
+
73 typedef char *(*icalparser_line_gen_func) (char *s, size_t size, void *d);
+
74 
+
98 LIBICAL_ICAL_EXPORT icalparser *icalparser_new(void);
+
99 
+
159 LIBICAL_ICAL_EXPORT icalcomponent *icalparser_add_line(icalparser *parser, char *str);
+
160 
+
180 LIBICAL_ICAL_EXPORT icalcomponent *icalparser_clean(icalparser *parser);
+
181 
+
202 LIBICAL_ICAL_EXPORT icalparser_state icalparser_get_state(icalparser *parser);
+
203 
+
217 LIBICAL_ICAL_EXPORT void icalparser_free(icalparser *parser);
+
218 
+
271 LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse(icalparser *parser,
+
272  icalparser_line_gen_func line_gen_func);
+
273 
+
284 LIBICAL_ICAL_EXPORT void icalparser_set_gen_data(icalparser *parser, void *data);
+
285 
+
313 LIBICAL_ICAL_EXPORT icalcomponent *icalparser_parse_string(const char *str);
+
314 
+
315 /***********************************************************************
+
316  * Parser support functions
+
317  ***********************************************************************/
+
318 
+
333 LIBICAL_ICAL_EXPORT char *icalparser_get_line(icalparser *parser,
+
334  icalparser_line_gen_func line_gen_func);
+
335 
+
336 LIBICAL_ICAL_EXPORT char *icalparser_string_line_generator(char *out, size_t buf_size, void *d);
+
337 
+
338 #endif /* !ICALPARSE_H */
-
icalparser_parse
icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)
Message oriented parsing.
Definition: icalparser.c:622
-
icalparser_free
void icalparser_free(icalparser *parser)
Frees an icalparser object.
Definition: icalparser.c:104
-
icalparser_parse_string
icalcomponent * icalparser_parse_string(const char *str)
Parses a string and returns the parsed icalcomponent.
Definition: icalparser.c:1336
-
icalparser_new
icalparser * icalparser_new(void)
Creates a new icalparser.
Definition: icalparser.c:81
-
icalparser_add_line
icalcomponent * icalparser_add_line(icalparser *parser, char *str)
Adds a single line to be parsed by the icalparser.
Definition: icalparser.c:682
-
icalparser_get_state
icalparser_state icalparser_get_state(icalparser *parser)
Returns current state of the icalparser.
Definition: icalparser.c:1238
-
icalparser_clean
icalcomponent * icalparser_clean(icalparser *parser)
Cleans out an icalparser and returns whatever it has parsed so far.
Definition: icalparser.c:1243
-
icalparser_set_gen_data
void icalparser_set_gen_data(icalparser *parser, void *data)
Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.
Definition: icalparser.c:121
-
icalparser_get_line
char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)
Given a line generator function, returns a single iCal content line.
Definition: icalparser.c:467
-
icalparser_state
icalparser_state
Represents the current state of the parser.
Definition: icalparser.h:47
-
ICALPARSER_BEGIN_COMP
@ ICALPARSER_BEGIN_COMP
Definition: icalparser.h:55
-
ICALPARSER_SUCCESS
@ ICALPARSER_SUCCESS
Definition: icalparser.h:52
-
ICALPARSER_END_COMP
@ ICALPARSER_END_COMP
Definition: icalparser.h:58
-
ICALPARSER_IN_PROGRESS
@ ICALPARSER_IN_PROGRESS
Definition: icalparser.h:61
-
ICALPARSER_ERROR
@ ICALPARSER_ERROR
Definition: icalparser.h:49
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalparser_impl
Definition: icalparser.c:32
+
icalparser_add_line
icalcomponent * icalparser_add_line(icalparser *parser, char *str)
Adds a single line to be parsed by the icalparser.
Definition: icalparser.c:691
+
icalparser_free
void icalparser_free(icalparser *parser)
Frees an icalparser object.
Definition: icalparser.c:121
+
icalparser_get_line
char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)
Given a line generator function, returns a single iCal content line.
Definition: icalparser.c:480
+
icalparser_new
icalparser * icalparser_new(void)
Creates a new icalparser.
Definition: icalparser.c:99
+
icalparser_parse_string
icalcomponent * icalparser_parse_string(const char *str)
Parses a string and returns the parsed icalcomponent.
Definition: icalparser.c:1341
+
icalparser_get_state
icalparser_state icalparser_get_state(icalparser *parser)
Returns current state of the icalparser.
Definition: icalparser.c:1243
+
icalparser_clean
icalcomponent * icalparser_clean(icalparser *parser)
Cleans out an icalparser and returns whatever it has parsed so far.
Definition: icalparser.c:1248
+
icalparser_parse
icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)
Message oriented parsing.
Definition: icalparser.c:629
+
icalparser_set_gen_data
void icalparser_set_gen_data(icalparser *parser, void *data)
Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.
Definition: icalparser.c:138
+
icalparser_state
icalparser_state
Represents the current state of the parser.
Definition: icalparser.h:56
+
ICALPARSER_BEGIN_COMP
@ ICALPARSER_BEGIN_COMP
Definition: icalparser.h:64
+
ICALPARSER_SUCCESS
@ ICALPARSER_SUCCESS
Definition: icalparser.h:61
+
ICALPARSER_END_COMP
@ ICALPARSER_END_COMP
Definition: icalparser.h:67
+
ICALPARSER_IN_PROGRESS
@ ICALPARSER_IN_PROGRESS
Definition: icalparser.h:70
+
ICALPARSER_ERROR
@ ICALPARSER_ERROR
Definition: icalparser.h:58
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalparser_impl
Definition: icalparser.c:51
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalperiod_8h.html b/apidocs/icalperiod_8h.html index a93c3089..814b73e7 100644 --- a/apidocs/icalperiod_8h.html +++ b/apidocs/icalperiod_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalperiod.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures | Macros | Functions
-
icalperiod.h File Reference
+
+
icalperiod.h File Reference
@@ -79,25 +80,25 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

struct  icalperiodtype
 Struct to represent a period in time. More...
 
- - +

+

Macros

#define ICALPERIODTYPE_INITIALIZER
#define ICALPERIODTYPE_INITIALIZER
 
- - - - - - - + + + + + + @@ -109,9 +110,9 @@ Functions

+

Functions

const char * icalperiodtype_as_ical_string (struct icalperiodtype p)
 Converts an icalperiodtype into an iCal-formatted string. More...
 
char * icalperiodtype_as_ical_string_r (struct icalperiodtype p)
 Converts an icalperiodtype into an iCal-formatted string. More...
 
const char * icalperiodtype_as_ical_string (struct icalperiodtype p)
 Converts an icalperiodtype into an iCal-formatted string. More...
 
char * icalperiodtype_as_ical_string_r (struct icalperiodtype p)
 Converts an icalperiodtype into an iCal-formatted string. More...
 
struct icalperiodtype icalperiodtype_from_string (const char *str)
 Constructs a new icalperiodtype from str. More...
 
 

Detailed Description

-

Functions for working with iCal periods (of time).

+

Functions for working with iCal periods (of time).

Macro Definition Documentation

- +

◆ ICALPERIODTYPE_INITIALIZER

@@ -131,14 +132,14 @@ Functions
- + @@ -155,30 +156,30 @@ Functions
Returns
A string representing the iCal-formatted period
-
See also
icalperiodtype_as_ical_string_r()
+
See also
icalperiodtype_as_ical_string_r()
Error handling
Sets icalerrno to ICAL_ALLOCATION_ERROR if there was an internal error allocating memory.
Ownership
The string returned by this method is owned by libical and must not be free() by the caller.
Example
// create icalperiodtype
const char *period_string = "20170606T090000/20170607T090000";
-
struct icalperiodtype period = icalperiodtype_from_string(period_string);
+
struct icalperiodtype period = icalperiodtype_from_string(period_string);
// print period in iCal format
-
printf("%s\n", icalperiodtype_as_ical_string(period));
-
icalperiodtype_as_ical_string
const char * icalperiodtype_as_ical_string(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:85
-
icalperiodtype_from_string
struct icalperiodtype icalperiodtype_from_string(const char *str)
Constructs a new icalperiodtype from str.
Definition: icalperiod.c:21
-
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:29
+
printf("%s\n", icalperiodtype_as_ical_string(period));
+
icalperiodtype_from_string
struct icalperiodtype icalperiodtype_from_string(const char *str)
Constructs a new icalperiodtype from str.
Definition: icalperiod.c:30
+
icalperiodtype_as_ical_string
const char * icalperiodtype_as_ical_string(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:94
+
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:38
- -

◆ icalperiodtype_as_ical_string_r()

+ +

◆ icalperiodtype_as_ical_string_r()

const char * icalperiodtype_as_ical_string const char* icalperiodtype_as_ical_string ( struct icalperiodtype  p)
- + @@ -195,24 +196,24 @@ Functions
Returns
A string representing the iCal-formatted period
-
See also
icalperiodtype_as_ical_string()
+
See also
icalperiodtype_as_ical_string()
Error handling
Sets icalerrno to ICAL_ALLOCATION_ERROR if there was an internal error allocating memory.
Ownership
The string returned by this method is owned by the caller and must be released with the appropriate function after use.
Example
// create icalperiodtype
const char *period_string = "20170606T090000/20170607T090000";
-
struct icalperiodtype period = icalperiodtype_from_string(period_string);
+
struct icalperiodtype period = icalperiodtype_from_string(period_string);
// print period in iCal format
-
const char *period_string_gen = icalperiodtype_as_ical_string_r(period);
+
const char *period_string_gen = icalperiodtype_as_ical_string_r(period);
printf("%s\n", period_string_gen);
-
icalmemory_free_buffer(period_string_gen);
-
icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition: icalmemory.c:359
-
icalperiodtype_as_ical_string_r
char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:94
+
icalmemory_free_buffer(period_string_gen);
+
icalmemory_free_buffer
void icalmemory_free_buffer(void *buf)
Releases a buffer.
Definition: icalmemory.c:287
+
icalperiodtype_as_ical_string_r
char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:103
- +

◆ icalperiodtype_from_string()

@@ -246,15 +247,15 @@ Functions

The format for the times is the same as those used by icaltime_from_string(), and the format for the duration is the same as that used by icaldurationtype_from_string().

Usage
// create icalperiodtype
const char *period_string = "20170606T090000/20170607T090000";
-
struct icalperiodtype period = icalperiodtype_from_string(period_string);
+
struct icalperiodtype period = icalperiodtype_from_string(period_string);
// print period in iCal format
-
printf("%s\n", icalperiodtype_as_ical_string(period));
+
printf("%s\n", icalperiodtype_as_ical_string(period));
- +

◆ icalperiodtype_is_null_period()

@@ -269,7 +270,7 @@ Functions
char * icalperiodtype_as_ical_string_r char* icalperiodtype_as_ical_string_r ( struct icalperiodtype  p)
-

Checks if a given icalperiodtype is a null period.

Parameters
+

Checks if a given icalperiodtype is a null period.

Parameters
pThe time period to check
@@ -278,17 +279,17 @@ Functions
-

Checks if a given icalperiodtype is a valid period.

Parameters
+

Checks if a given icalperiodtype is a valid period.

Parameters
pThe time period to check
@@ -311,16 +312,16 @@ Functions
-

Creates a null period icalperiodtype.

Returns
An icalperiodtype representing a null period
+

Creates a null period icalperiodtype.

Returns
An icalperiodtype representing a null period
See also
icalperiodtype_is_null_period()
Usage
// creates null period
-
struct icalperiodtype period = icalperiodtype_null_period();
+
struct icalperiodtype period = icalperiodtype_null_period();
// verifies start, end and length
-
assert(icaltime_is_null_time(period.start));
-
assert(icaltime_is_null_time(period.end));
+
assert(icaltime_is_null_time(period.start));
+
assert(icaltime_is_null_time(period.end));
assert(icaldurationtype_is_null_duratino(period.duration));
-
icaltime_is_null_time
int icaltime_is_null_time(const struct icaltimetype t)
Returns true if the time is null.
Definition: icaltime.c:593
+
icaltime_is_null_time
int icaltime_is_null_time(const struct icaltimetype t)
Returns true if the time is null.
Definition: icaltime.c:617
@@ -352,7 +353,7 @@ Functions
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalperiod.h
+
+
icalperiod.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalperiod.h
-
3 CREATOR: eric 26 Jan 2001
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
13#ifndef ICALPERIOD_H
-
14#define ICALPERIOD_H
-
15
-
21#include "libical_ical_export.h"
-
22#include "icalduration.h"
-
23#include "icaltime.h"
-
24
-
28struct icalperiodtype
-
29{
-
30 struct icaltimetype start;
-
31 struct icaltimetype end;
-
32 struct icaldurationtype duration;
-
33};
-
34
-
35#define ICALPERIODTYPE_INITIALIZER { \
-
36 ICALTIMETYPE_INITIALIZER, \
-
37 ICALTIMETYPE_INITIALIZER, \
-
38 ICALDURATIONTYPE_INITIALIZER \
-
39}
-
40
-
72LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_from_string(const char *str);
-
73
-
98LIBICAL_ICAL_EXPORT const char *icalperiodtype_as_ical_string(struct icalperiodtype p);
-
99
-
126LIBICAL_ICAL_EXPORT char *icalperiodtype_as_ical_string_r(struct icalperiodtype p);
-
127
-
144LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void);
-
145
-
161LIBICAL_ICAL_EXPORT int icalperiodtype_is_null_period(struct icalperiodtype p);
-
162
-
177LIBICAL_ICAL_EXPORT int icalperiodtype_is_valid_period(struct icalperiodtype p);
-
178
-
179#endif /* !ICALTIME_H */
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalperiod.h
+
3  CREATOR: eric 26 Jan 2001
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
22 #ifndef ICALPERIOD_H
+
23 #define ICALPERIOD_H
+
24 
+
30 #include "libical_ical_export.h"
+
31 #include "icalduration.h"
+
32 #include "icaltime.h"
+
33 
+
37 struct icalperiodtype
+
38 {
+
39  struct icaltimetype start;
+
40  struct icaltimetype end;
+
41  struct icaldurationtype duration;
+
42 };
+
43 
+
44 #define ICALPERIODTYPE_INITIALIZER { \
+
45  ICALTIMETYPE_INITIALIZER, \
+
46  ICALTIMETYPE_INITIALIZER, \
+
47  ICALDURATIONTYPE_INITIALIZER \
+
48 }
+
49 
+
81 LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_from_string(const char *str);
+
82 
+
107 LIBICAL_ICAL_EXPORT const char *icalperiodtype_as_ical_string(struct icalperiodtype p);
+
108 
+
135 LIBICAL_ICAL_EXPORT char *icalperiodtype_as_ical_string_r(struct icalperiodtype p);
+
136 
+
153 LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void);
+
154 
+
170 LIBICAL_ICAL_EXPORT int icalperiodtype_is_null_period(struct icalperiodtype p);
+
171 
+
186 LIBICAL_ICAL_EXPORT int icalperiodtype_is_valid_period(struct icalperiodtype p);
+
187 
+
188 #endif /* !ICALTIME_H */
icalduration.h
Methods for working with durations in iCal.
-
icalperiodtype_as_ical_string
const char * icalperiodtype_as_ical_string(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:85
-
icalperiodtype_as_ical_string_r
char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:94
-
icalperiodtype_null_period
struct icalperiodtype icalperiodtype_null_period(void)
Definition: icalperiod.c:124
-
icalperiodtype_from_string
struct icalperiodtype icalperiodtype_from_string(const char *str)
Constructs a new icalperiodtype from str.
Definition: icalperiod.c:21
-
icalperiodtype_is_null_period
int icalperiodtype_is_null_period(struct icalperiodtype p)
Definition: icalperiod.c:135
-
icalperiodtype_is_valid_period
int icalperiodtype_is_valid_period(struct icalperiodtype p)
Definition: icalperiod.c:145
+
icalperiodtype_null_period
struct icalperiodtype icalperiodtype_null_period(void)
Definition: icalperiod.c:133
+
icalperiodtype_from_string
struct icalperiodtype icalperiodtype_from_string(const char *str)
Constructs a new icalperiodtype from str.
Definition: icalperiod.c:30
+
icalperiodtype_as_ical_string_r
char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:103
+
icalperiodtype_as_ical_string
const char * icalperiodtype_as_ical_string(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:94
+
icalperiodtype_is_null_period
int icalperiodtype_is_null_period(struct icalperiodtype p)
Definition: icalperiod.c:144
+
icalperiodtype_is_valid_period
int icalperiodtype_is_valid_period(struct icalperiodtype p)
Definition: icalperiod.c:154
icaltime.h
struct icaltimetype is a pseudo-object that abstracts time handling.
-
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:28
-
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:29
-
icaltimetype
Definition: icaltime.h:97
+
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
+
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:38
+
icaltimetype
Definition: icaltime.h:105
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalproperty_8h.html b/apidocs/icalproperty_8h.html index 99af85e5..884eafa6 100644 --- a/apidocs/icalproperty_8h.html +++ b/apidocs/icalproperty_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalproperty.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Functions
-
icalproperty.h File Reference
+
+
icalproperty.h File Reference

Go to the source code of this file.

- - - + + - - - - - - + - - - - - + - - - - + - - + - - - + - - + - - + - - - - + + + - - + - - + - - + - - + - - + - - - - - + - - - + - - - - - + + + - - + - + @@ -185,50 +183,50 @@ icalproperty *  - - - - - - - - + - - - - - + +

+

Functions

icalproperty * icalparameter_get_parent (icalparameter *param)
 
icalproperty * icalparameter_get_parent (icalparameter *param)
 
void icalparameter_set_parent (icalparameter *param, icalproperty *property)
 
+
icalvalue_kind icalparameter_value_to_value_kind (icalparameter_value value)
 
+
void icalproperty_add_parameter (icalproperty *prop, icalparameter *parameter)
 
+
void icalproperty_add_parameters (struct icalproperty_impl *prop, va_list args)
 
+
const char * icalproperty_as_ical_string (icalproperty *prop)
 
+
 
char * icalproperty_as_ical_string_r (icalproperty *prop)
 
icalproperty * icalproperty_clone (const icalproperty *prop)
 Deeply clones an icalproperty. More...
 
+
 
int icalproperty_count_parameters (const icalproperty *prop)
 
+
int icalproperty_enum_belongs_to_property (icalproperty_kind kind, int e)
 
+
const char * icalproperty_enum_to_string (int e)
 
+
 
char * icalproperty_enum_to_string_r (int e)
 
+
 
void icalproperty_free (icalproperty *prop)
 
+
icalparameter * icalproperty_get_first_parameter (icalproperty *prop, icalparameter_kind kind)
 
+
 
icalparameter * icalproperty_get_next_parameter (icalproperty *prop, icalparameter_kind kind)
 
+
 
const char * icalproperty_get_parameter_as_string (icalproperty *prop, const char *name)
 
+
 
char * icalproperty_get_parameter_as_string_r (icalproperty *prop, const char *name)
 
const char * icalproperty_get_property_name (const icalproperty *prop)
 
+
 
const char * icalproperty_get_property_name (const icalproperty *prop)
 
char * icalproperty_get_property_name_r (const icalproperty *prop)
 
+
 
icalvalue * icalproperty_get_value (const icalproperty *prop)
 
+
 
const char * icalproperty_get_value_as_string (const icalproperty *prop)
 
+
 
char * icalproperty_get_value_as_string_r (const icalproperty *prop)
 
+
 
const char * icalproperty_get_x_name (icalproperty *prop)
 
+
 
icalproperty_kind icalproperty_isa (icalproperty *property)
 
+
int icalproperty_isa_property (void *property)
 
+
int icalproperty_kind_and_string_to_enum (const int kind, const char *str)
 
int icalproperty_kind_is_valid (const icalproperty_kind kind)
 
+
const char * icalproperty_kind_to_string (icalproperty_kind kind)
 
+
 
icalvalue_kind icalproperty_kind_to_value_kind (icalproperty_kind kind)
 
+
const char * icalproperty_method_to_string (icalproperty_method method)
 
+
 
icalproperty * icalproperty_new (icalproperty_kind kind)
 
icalproperty * icalproperty_new_clone (icalproperty *prop))
 Deeply clones an icalproperty. More...
 
+
 
+icalproperty * icalproperty_new_clone (icalproperty *prop)
 
icalproperty * icalproperty_new_from_string (const char *str)
 
+
 
icalproperty * icalproperty_new_impl (icalproperty_kind kind)
 
 
void icalproperty_normalize (icalproperty *prop)
 
void icalproperty_remove_parameter_by_kind (icalproperty *prop, icalparameter_kind kind)
icalpropert
void icalproperty_remove_parameter_by_ref (icalproperty *prop, icalparameter *param)
 Removes the specified parameter reference from the property. More...
 
+
void icalproperty_set_parameter (icalproperty *prop, icalparameter *parameter)
 
+
void icalproperty_set_parameter_from_string (icalproperty *prop, const char *name, const char *value)
 
+
void icalproperty_set_value (icalproperty *prop, icalvalue *value)
 
+
void icalproperty_set_value_from_string (icalproperty *prop, const char *value, const char *kind)
 
+
void icalproperty_set_x_name (icalproperty *prop, const char *name)
 
+
const char * icalproperty_status_to_string (icalproperty_status)
 
+
 
icalproperty_kind icalproperty_string_to_kind (const char *string)
 
+
icalproperty_method icalproperty_string_to_method (const char *str)
 
+
icalproperty_status icalproperty_string_to_status (const char *string)
 
+
icalproperty_kind icalproperty_value_kind_to_kind (icalvalue_kind kind)
 
icalproperty * icalvalue_get_parent (icalvalue *value)
 
icalproperty * icalvalue_get_parent (icalvalue *value)
 
void icalvalue_set_parent (icalvalue *value, icalproperty *property)
 

Function Documentation

- -

◆ icalparameter_get_parent()

+ +

◆ icalparameter_get_parent()

- + @@ -236,11 +234,11 @@ icalproperty_kind 
icalproperty * icalparameter_get_parent icalproperty* icalparameter_get_parent ( icalparameter *  param)icalprop
-

Returns the parent icalproperty for the specified icalparameter.

Since
3.0
+

Returns the parent icalproperty for the specified icalparameter.

Since
3.0
- +

◆ icalparameter_set_parent()

@@ -265,39 +263,18 @@ icalproperty_kind icalprop
-

Sets the parent icalproperty for the specified icalparameter.

Since
3.0
- -
-
- -

◆ icalproperty_clone()

- -
-
- - - - - - - - -
icalproperty * icalproperty_clone (const icalproperty * prop)
-
- -

Deeply clones an icalproperty.

-

Returns a pointer to the memory for the newly cloned icalproperty.

Since
3.1.0
+

Sets the parent icalproperty for the specified icalparameter.

Since
3.0
- -

◆ icalproperty_get_property_name()

+ +

◆ icalproperty_get_property_name()

- + @@ -305,11 +282,11 @@ icalproperty_kind 
const char * icalproperty_get_property_name const char* icalproperty_get_property_name ( const icalproperty *  prop)icalprop
-

Returns the name of the property – the type name converted to a string, or the value of _get_x_name if the type is and X property

+

Returns the name of the property – the type name converted to a string, or the value of _get_x_name if the type is and X property

- +

◆ icalproperty_kind_is_valid()

@@ -324,33 +301,11 @@ icalproperty_kind icalprop
-

Check validity of a specific icalproperty_kind

- -
-
- -

◆ icalproperty_new_clone()

- -
-
- - - - - - - - -
icalproperty * icalproperty_new_clone (icalproperty * prop)
-
- -

Deeply clones an icalproperty.

-

Returns a pointer to the memory for the newly cloned icalproperty.

Since
3.1.0
-
Deprecated:
use icalproperty_clone() instead
+

Check validity of a specific icalproperty_kind

- +

◆ icalproperty_normalize()

@@ -365,11 +320,11 @@ icalproperty_kind icalprop
-

Normalizes (reorders and sorts the parameters) the specified icalproperty.

Since
3.0
+

Normalizes (reorders and sorts the parameters) the specified icalproperty.

Since
3.0
- +

◆ icalproperty_remove_parameter_by_kind()

@@ -407,7 +362,7 @@ icalproperty_kind icalprop
- +

◆ icalproperty_remove_parameter_by_name()

@@ -442,11 +397,11 @@ icalproperty_kind icalprop

This function removes parameters with the given name. The name corresponds to either a built-in name (TZID, etc.) or the name of an extended parameter (X-FOO)

-

See icalproperty_remove_parameter_by_kind() and icalproperty_remove_parameter_by_ref() for alternate ways of removing parameters

+

See icalproperty_remove_parameter_by_kind() and icalproperty_remove_parameter_by_ref() for alternate ways of removing parameters

- +

◆ icalproperty_remove_parameter_by_ref()

@@ -484,14 +439,14 @@ icalproperty_kind icalprop
- -

◆ icalvalue_get_parent()

+ +

◆ icalvalue_get_parent()

- + @@ -499,11 +454,11 @@ icalproperty_kind 
icalproperty * icalvalue_get_parent icalproperty* icalvalue_get_parent ( icalvalue *  value)icalprop
-

Returns the parent icalproperty for the specified icalvalue.

Since
3.0
+

Returns the parent icalproperty for the specified icalvalue.

Since
3.0
- +

◆ icalvalue_set_parent()

@@ -528,14 +483,14 @@ icalproperty_kind icalprop
-

Sets the parent icalproperty for the specified icalvalue.

+

Sets the parent icalproperty for the specified icalvalue.

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalproperty_8h_source.html b/apidocs/icalproperty_8h_source.html index 33ab6daa..556f6f9c 100644 --- a/apidocs/icalproperty_8h_source.html +++ b/apidocs/icalproperty_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalproperty.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalproperty.h
+
+
icalproperty.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalproperty.h
-
3 CREATOR: eric 20 March 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALPROPERTY_H
-
12#define ICALPROPERTY_H
-
13
-
14#include "libical_deprecated.h"
-
15#include "libical_ical_export.h"
-
16#include "icalderivedproperty.h" /* To get icalproperty_kind enumerations */
-
17
-
18#include <stdarg.h> /* for va_... */
-
19
-
22LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new(icalproperty_kind kind);
-
23
-
24LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_impl(icalproperty_kind kind);
-
25
-
31LIBICAL_ICAL_EXPORT icalproperty *icalproperty_clone(const icalproperty *prop);
-
32
-
33LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_from_string(const char *str);
-
34
-
35LIBICAL_ICAL_EXPORT const char *icalproperty_as_ical_string(icalproperty *prop);
-
36
-
37LIBICAL_ICAL_EXPORT char *icalproperty_as_ical_string_r(icalproperty *prop);
-
38
-
39LIBICAL_ICAL_EXPORT void icalproperty_free(icalproperty *prop);
-
40
-
41LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_isa(icalproperty *property);
-
42
-
43LIBICAL_ICAL_EXPORT int icalproperty_isa_property(void *property);
-
44
-
45LIBICAL_ICAL_EXPORT void icalproperty_add_parameters(struct icalproperty_impl *prop, va_list args);
-
46
-
47LIBICAL_ICAL_EXPORT void icalproperty_add_parameter(icalproperty *prop, icalparameter *parameter);
-
48
-
49LIBICAL_ICAL_EXPORT void icalproperty_set_parameter(icalproperty *prop, icalparameter *parameter);
-
50
-
51LIBICAL_ICAL_EXPORT void icalproperty_set_parameter_from_string(icalproperty *prop,
-
52 const char *name,
-
53 const char *value);
-
54LIBICAL_ICAL_EXPORT const char *icalproperty_get_parameter_as_string(icalproperty *prop,
-
55 const char *name);
-
56
-
57LIBICAL_ICAL_EXPORT char *icalproperty_get_parameter_as_string_r(icalproperty *prop,
-
58 const char *name);
-
59
-
69LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_kind(icalproperty *prop,
-
70 icalparameter_kind kind);
-
71
-
85LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_name(icalproperty *prop,
-
86 const char *name);
-
87
-
96LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_ref(icalproperty *prop,
-
97 icalparameter *param);
-
98
-
99LIBICAL_ICAL_EXPORT int icalproperty_count_parameters(const icalproperty *prop);
-
100
-
101/* Iterate through the parameters */
-
102LIBICAL_ICAL_EXPORT icalparameter *icalproperty_get_first_parameter(icalproperty *prop,
-
103 icalparameter_kind kind);
-
104LIBICAL_ICAL_EXPORT icalparameter *icalproperty_get_next_parameter(icalproperty *prop,
-
105 icalparameter_kind kind);
-
106/* Access the value of the property */
-
107LIBICAL_ICAL_EXPORT void icalproperty_set_value(icalproperty *prop, icalvalue *value);
-
108LIBICAL_ICAL_EXPORT void icalproperty_set_value_from_string(icalproperty *prop, const char *value,
-
109 const char *kind);
-
110
-
111LIBICAL_ICAL_EXPORT icalvalue *icalproperty_get_value(const icalproperty *prop);
-
112LIBICAL_ICAL_EXPORT const char *icalproperty_get_value_as_string(const icalproperty *prop);
-
113LIBICAL_ICAL_EXPORT char *icalproperty_get_value_as_string_r(const icalproperty *prop);
-
114
-
118LIBICAL_ICAL_EXPORT void icalvalue_set_parent(icalvalue *value, icalproperty *property);
-
119
-
124LIBICAL_ICAL_EXPORT icalproperty *icalvalue_get_parent(icalvalue *value);
-
125
-
126/* Deal with X properties */
-
127
-
128LIBICAL_ICAL_EXPORT void icalproperty_set_x_name(icalproperty *prop, const char *name);
-
129LIBICAL_ICAL_EXPORT const char *icalproperty_get_x_name(icalproperty *prop);
-
130
-
135LIBICAL_ICAL_EXPORT const char *icalproperty_get_property_name(const icalproperty *prop);
-
136LIBICAL_ICAL_EXPORT char *icalproperty_get_property_name_r(const icalproperty *prop);
-
137
-
138LIBICAL_ICAL_EXPORT icalvalue_kind icalparameter_value_to_value_kind(icalparameter_value value);
-
139
-
144LIBICAL_ICAL_EXPORT void icalparameter_set_parent(icalparameter *param, icalproperty *property);
-
145
-
150LIBICAL_ICAL_EXPORT icalproperty *icalparameter_get_parent(icalparameter *param);
-
151
-
152/* Convert kinds to string and get default value type */
-
153LIBICAL_ICAL_EXPORT icalvalue_kind icalproperty_kind_to_value_kind(icalproperty_kind kind);
-
154LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_value_kind_to_kind(icalvalue_kind kind);
-
155LIBICAL_ICAL_EXPORT const char *icalproperty_kind_to_string(icalproperty_kind kind);
-
156LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_string_to_kind(const char *string);
-
157
-
159LIBICAL_ICAL_EXPORT int icalproperty_kind_is_valid(const icalproperty_kind kind);
-
160
-
161LIBICAL_ICAL_EXPORT icalproperty_method icalproperty_string_to_method(const char *str);
-
162LIBICAL_ICAL_EXPORT const char *icalproperty_method_to_string(icalproperty_method method);
-
163
-
164LIBICAL_ICAL_EXPORT const char *icalproperty_enum_to_string(int e);
-
165LIBICAL_ICAL_EXPORT char *icalproperty_enum_to_string_r(int e);
-
166LIBICAL_ICAL_EXPORT int icalproperty_kind_and_string_to_enum(const int kind, const char *str);
-
167
-
168LIBICAL_ICAL_EXPORT const char *icalproperty_status_to_string(icalproperty_status);
-
169LIBICAL_ICAL_EXPORT icalproperty_status icalproperty_string_to_status(const char *string);
-
170
-
171LIBICAL_ICAL_EXPORT int icalproperty_enum_belongs_to_property(icalproperty_kind kind, int e);
-
172
-
177LIBICAL_ICAL_EXPORT void icalproperty_normalize(icalproperty *prop);
-
178
-
183LIBICAL_ICAL_EXPORT LIBICAL_DEPRECATED(icalproperty *icalproperty_new_clone(icalproperty *prop));
-
184
-
185#endif /*ICALPROPERTY_H */
-
icalproperty_clone
icalproperty * icalproperty_clone(const icalproperty *prop)
Deeply clones an icalproperty.
Definition: icalproperty.c:85
-
icalproperty_remove_parameter_by_ref
void icalproperty_remove_parameter_by_ref(icalproperty *prop, icalparameter *param)
Removes the specified parameter reference from the property.
Definition: icalproperty.c:670
-
icalproperty_remove_parameter_by_name
void icalproperty_remove_parameter_by_name(icalproperty *prop, const char *name)
Removes all parameters with the specified name.
Definition: icalproperty.c:641
-
icalproperty_remove_parameter_by_kind
void icalproperty_remove_parameter_by_kind(icalproperty *prop, icalparameter_kind kind)
Removes all parameters with the specified kind.
Definition: icalproperty.c:624
-
icalproperty_get_property_name
const char * icalproperty_get_property_name(const icalproperty *prop)
Definition: icalproperty.c:863
-
icalproperty_new_clone
icalproperty * icalproperty_new_clone(icalproperty *prop))
Deeply clones an icalproperty.
Definition: icalproperty.c:124
-
icalproperty_normalize
void icalproperty_normalize(icalproperty *prop)
Definition: icalproperty.c:925
-
icalvalue_set_parent
void icalvalue_set_parent(icalvalue *value, icalproperty *property)
Definition: icalvalue.c:1467
-
icalparameter_get_parent
icalproperty * icalparameter_get_parent(icalparameter *param)
Definition: icalparameter.c:413
-
icalvalue_get_parent
icalproperty * icalvalue_get_parent(icalvalue *value)
Definition: icalvalue.c:1474
-
icalparameter_set_parent
void icalparameter_set_parent(icalparameter *param, icalproperty *property)
Definition: icalparameter.c:406
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalproperty.h
+
3  CREATOR: eric 20 March 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALPROPERTY_H
+
20 #define ICALPROPERTY_H
+
21 
+
22 #include "libical_ical_export.h"
+
23 #include "icalderivedproperty.h" /* To get icalproperty_kind enumerations */
+
24 
+
25 #include <stdarg.h> /* for va_... */
+
26 
+
29 LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new(icalproperty_kind kind);
+
30 
+
31 LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_impl(icalproperty_kind kind);
+
32 
+
33 LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_clone(icalproperty *prop);
+
34 
+
35 LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_from_string(const char *str);
+
36 
+
37 LIBICAL_ICAL_EXPORT const char *icalproperty_as_ical_string(icalproperty *prop);
+
38 
+
39 LIBICAL_ICAL_EXPORT char *icalproperty_as_ical_string_r(icalproperty *prop);
+
40 
+
41 LIBICAL_ICAL_EXPORT void icalproperty_free(icalproperty *prop);
+
42 
+
43 LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_isa(icalproperty *property);
+
44 
+
45 LIBICAL_ICAL_EXPORT int icalproperty_isa_property(void *property);
+
46 
+
47 LIBICAL_ICAL_EXPORT void icalproperty_add_parameters(struct icalproperty_impl *prop, va_list args);
+
48 
+
49 LIBICAL_ICAL_EXPORT void icalproperty_add_parameter(icalproperty *prop, icalparameter *parameter);
+
50 
+
51 LIBICAL_ICAL_EXPORT void icalproperty_set_parameter(icalproperty *prop, icalparameter *parameter);
+
52 
+
53 LIBICAL_ICAL_EXPORT void icalproperty_set_parameter_from_string(icalproperty *prop,
+
54  const char *name,
+
55  const char *value);
+
56 LIBICAL_ICAL_EXPORT const char *icalproperty_get_parameter_as_string(icalproperty *prop,
+
57  const char *name);
+
58 
+
59 LIBICAL_ICAL_EXPORT char *icalproperty_get_parameter_as_string_r(icalproperty *prop,
+
60  const char *name);
+
61 
+
71 LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_kind(icalproperty *prop,
+
72  icalparameter_kind kind);
+
73 
+
87 LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_name(icalproperty *prop,
+
88  const char *name);
+
89 
+
98 LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_ref(icalproperty *prop,
+
99  icalparameter *param);
+
100 
+
101 LIBICAL_ICAL_EXPORT int icalproperty_count_parameters(const icalproperty *prop);
+
102 
+
103 /* Iterate through the parameters */
+
104 LIBICAL_ICAL_EXPORT icalparameter *icalproperty_get_first_parameter(icalproperty *prop,
+
105  icalparameter_kind kind);
+
106 LIBICAL_ICAL_EXPORT icalparameter *icalproperty_get_next_parameter(icalproperty *prop,
+
107  icalparameter_kind kind);
+
108 /* Access the value of the property */
+
109 LIBICAL_ICAL_EXPORT void icalproperty_set_value(icalproperty *prop, icalvalue *value);
+
110 LIBICAL_ICAL_EXPORT void icalproperty_set_value_from_string(icalproperty *prop, const char *value,
+
111  const char *kind);
+
112 
+
113 LIBICAL_ICAL_EXPORT icalvalue *icalproperty_get_value(const icalproperty *prop);
+
114 LIBICAL_ICAL_EXPORT const char *icalproperty_get_value_as_string(const icalproperty *prop);
+
115 LIBICAL_ICAL_EXPORT char *icalproperty_get_value_as_string_r(const icalproperty *prop);
+
116 
+
120 LIBICAL_ICAL_EXPORT void icalvalue_set_parent(icalvalue *value, icalproperty *property);
+
121 
+
126 LIBICAL_ICAL_EXPORT icalproperty *icalvalue_get_parent(icalvalue *value);
+
127 
+
128 /* Deal with X properties */
+
129 
+
130 LIBICAL_ICAL_EXPORT void icalproperty_set_x_name(icalproperty *prop, const char *name);
+
131 LIBICAL_ICAL_EXPORT const char *icalproperty_get_x_name(icalproperty *prop);
+
132 
+
137 LIBICAL_ICAL_EXPORT const char *icalproperty_get_property_name(const icalproperty *prop);
+
138 LIBICAL_ICAL_EXPORT char *icalproperty_get_property_name_r(const icalproperty *prop);
+
139 
+
140 LIBICAL_ICAL_EXPORT icalvalue_kind icalparameter_value_to_value_kind(icalparameter_value value);
+
141 
+
146 LIBICAL_ICAL_EXPORT void icalparameter_set_parent(icalparameter *param, icalproperty *property);
+
147 
+
152 LIBICAL_ICAL_EXPORT icalproperty *icalparameter_get_parent(icalparameter *param);
+
153 
+
154 /* Convert kinds to string and get default value type */
+
155 LIBICAL_ICAL_EXPORT icalvalue_kind icalproperty_kind_to_value_kind(icalproperty_kind kind);
+
156 LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_value_kind_to_kind(icalvalue_kind kind);
+
157 LIBICAL_ICAL_EXPORT const char *icalproperty_kind_to_string(icalproperty_kind kind);
+
158 LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_string_to_kind(const char *string);
+
159 
+
161 LIBICAL_ICAL_EXPORT int icalproperty_kind_is_valid(const icalproperty_kind kind);
+
162 
+
163 LIBICAL_ICAL_EXPORT icalproperty_method icalproperty_string_to_method(const char *str);
+
164 LIBICAL_ICAL_EXPORT const char *icalproperty_method_to_string(icalproperty_method method);
+
165 
+
166 LIBICAL_ICAL_EXPORT const char *icalproperty_enum_to_string(int e);
+
167 LIBICAL_ICAL_EXPORT char *icalproperty_enum_to_string_r(int e);
+
168 LIBICAL_ICAL_EXPORT int icalproperty_kind_and_string_to_enum(const int kind, const char *str);
+
169 
+
170 LIBICAL_ICAL_EXPORT const char *icalproperty_status_to_string(icalproperty_status);
+
171 LIBICAL_ICAL_EXPORT icalproperty_status icalproperty_string_to_status(const char *string);
+
172 
+
173 LIBICAL_ICAL_EXPORT int icalproperty_enum_belongs_to_property(icalproperty_kind kind, int e);
+
174 
+
179 LIBICAL_ICAL_EXPORT void icalproperty_normalize(icalproperty *prop);
+
180 
+
181 #endif /*ICALPROPERTY_H */
+
icalparameter_get_parent
icalproperty * icalparameter_get_parent(icalparameter *param)
Definition: icalparameter.c:417
+
icalproperty_get_property_name
const char * icalproperty_get_property_name(const icalproperty *prop)
Definition: icalproperty.c:867
+
icalproperty_remove_parameter_by_ref
void icalproperty_remove_parameter_by_ref(icalproperty *prop, icalparameter *param)
Removes the specified parameter reference from the property.
Definition: icalproperty.c:674
+
icalproperty_remove_parameter_by_name
void icalproperty_remove_parameter_by_name(icalproperty *prop, const char *name)
Removes all parameters with the specified name.
Definition: icalproperty.c:645
+
icalproperty_remove_parameter_by_kind
void icalproperty_remove_parameter_by_kind(icalproperty *prop, icalparameter_kind kind)
Removes all parameters with the specified kind.
Definition: icalproperty.c:628
+
icalproperty_normalize
void icalproperty_normalize(icalproperty *prop)
Definition: icalproperty.c:929
+
icalvalue_set_parent
void icalvalue_set_parent(icalvalue *value, icalproperty *property)
Definition: icalvalue.c:1471
+
icalvalue_get_parent
icalproperty * icalvalue_get_parent(icalvalue *value)
Definition: icalvalue.c:1478
+
icalparameter_set_parent
void icalparameter_set_parent(icalparameter *param, icalproperty *property)
Definition: icalparameter.c:410
icalproperty_kind_is_valid
int icalproperty_kind_is_valid(const icalproperty_kind kind)
-
icalproperty_impl
Definition: icalproperty.c:28
+
icalproperty_impl
Definition: icalproperty.c:37
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalproperty__cxx_8h.html b/apidocs/icalproperty__cxx_8h.html index 9c4ce88e..f0422b32 100644 --- a/apidocs/icalproperty__cxx_8h.html +++ b/apidocs/icalproperty__cxx_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalproperty_cxx.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
icalproperty_cxx.h File Reference
+
+
icalproperty_cxx.h File Reference
@@ -78,26 +79,29 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

class  LibICal::ICalProperty
 
- -

+

Typedefs

+
typedef ICPointerHolder< LibICal::ICalProperty > ICalPropertyTmpPtr
 

Detailed Description

-

Definition of C++ Wrapper for icalproperty.c.

+

Definition of C++ Wrapper for icalproperty.c.

Author
fnguyen (12/10/01)
-

SPDX-FileCopyrightText: 2001, Critical Path

-

SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0

+

(C) COPYRIGHT 2001, Critical Path

+

This library is free software; you can redistribute it and/or modify it under the terms of either:

+

The LGPL as published by the Free Software Foundation, version 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html

+

Or:

+

The Mozilla Public License Version 2.0. You may obtain a copy of the License at https://www.mozilla.org/MPL/

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalproperty__cxx_8h_source.html b/apidocs/icalproperty__cxx_8h_source.html index 7ee65367..ef54a6a7 100644 --- a/apidocs/icalproperty__cxx_8h_source.html +++ b/apidocs/icalproperty__cxx_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalproperty_cxx.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalproperty_cxx.h
+
+
icalproperty_cxx.h
-Go to the documentation of this file.
1
-
12#ifndef ICALPROPERTY_CXX_H
-
13#define ICALPROPERTY_CXX_H
-
14
-
15#include "libical_ical_export.h"
-
16#include "icptrholder_cxx.h"
-
17
-
18extern "C"
-
19{
-
20#include "icalerror.h"
-
21#include "icalproperty.h"
-
22}
-
23
-
24#include <string>
-
25
-
26namespace LibICal
-
27{
-
28
-
29class ICalParameter;
-
30class ICalValue;
-
31
-
32class LIBICAL_ICAL_EXPORT ICalProperty
-
33{
-
34public:
-
35 ICalProperty();
-
36 ICalProperty(const ICalProperty &);
-
37 ICalProperty &operator=(const ICalProperty &);
-
38 ~ICalProperty();
-
39
-
40 explicit ICalProperty(icalproperty *v);
-
41 explicit ICalProperty(std::string str);
-
42 explicit ICalProperty(icalproperty_kind kind);
-
43 ICalProperty(icalproperty_kind kind, std::string str);
-
44
-
45 operator icalproperty *()
-
46 {
-
47 return imp;
-
48 }
-
49 int operator==(ICalProperty &rhs);
-
50
-
51 void detach();
-
52
-
53public:
-
54 std::string as_ical_string();
-
55 icalproperty_kind isa();
-
56 int isa_property(void *property);
-
57
-
58 void add_parameter(ICalParameter &parameter);
-
59 void set_parameter(ICalParameter &parameter);
-
60 void set_parameter_from_string(const std::string &name, const std::string &val);
-
61 std::string get_parameter_as_string(const std::string &name);
-
62 void remove_parameter_by_kind(const icalparameter_kind &kind);
-
63 int count_parameters();
-
64
-
66 ICalParameter *get_first_parameter(const icalparameter_kind &kind);
-
67 ICalParameter *get_next_parameter(const icalparameter_kind &kind);
-
68
-
70 void set_value(const ICalValue &val);
-
71 void set_value_from_string(const std::string &val, const std::string &kind);
-
72
-
73 ICalValue *get_value();
-
74 std::string get_value_as_string();
-
75
-
80 std::string get_name() const;
-
81
-
82public:
-
83 /* Deal with X properties */
-
84 static void set_x_name(ICalProperty &prop, const std::string &name);
-
85 static std::string get_x_name(ICalProperty &prop);
-
86
-
87 static icalvalue_kind value_to_value_kind(const icalparameter_value &val);
-
88
-
89 /* Convert kinds to string and get default value type */
-
90 static icalvalue_kind kind_to_value_kind(const icalproperty_kind &kind);
-
91 static icalproperty_kind value_kind_to_kind(const icalvalue_kind &kind);
-
92 static std::string kind_to_string(const icalproperty_kind &kind);
-
93 static icalproperty_kind string_to_kind(const std::string &str);
-
94
-
95 static icalproperty_method string_to_method(const std::string &str);
-
96 static std::string method_to_string(const icalproperty_method &method);
-
97
-
98 static std::string enum_to_string(const int &e);
-
99 static int kind_and_string_to_enum(const icalproperty_kind &kind, const std::string &str);
-
100
-
101 static std::string status_to_string(const icalproperty_status &status);
-
102 static icalproperty_status string_to_status(const std::string &str);
-
103
-
104 static int enum_belongs_to_property(const icalproperty_kind &kind, const int &e);
-
105
-
106public:
-
107 /* ACTION */
-
108 void set_action(const enum icalproperty_action &val);
-
109 enum icalproperty_action get_action();
-
110
-
111 /* ATTACH */
-
112 void set_attach(icalattach *val);
-
113 icalattach *get_attach() const;
-
114
-
115 /* ATTENDEE */
-
116 void set_attendee(const std::string &val);
-
117 std::string get_attendee() const;
-
118
-
119 /* CALSCALE */
-
120 void set_calscale(const std::string &val);
-
121 std::string get_calscale() const;
-
122
-
123 /* CATEGORIES */
-
124 void set_categories(const std::string &val);
-
125 std::string get_categories() const;
-
126
-
127 /* CLASS */
-
128 void set_class(const enum icalproperty_class &val);
-
129 enum icalproperty_class get_class() const;
-
130
-
131 /* COMMENT */
-
132 void set_comment(const std::string &val);
-
133 std::string get_comment() const;
-
134
-
135 /* COMPLETED */
-
136 void set_completed(const struct icaltimetype &val);
-
137 struct icaltimetype get_completed() const;
-
138
-
139 /* CONTACT */
-
140 void set_contact(const std::string &val);
-
141 std::string get_contact() const;
-
142
-
143 /* CREATED */
-
144 void set_created(const struct icaltimetype &val);
-
145 struct icaltimetype get_created() const;
-
146
-
147 /* DESCRIPTION */
-
148 void set_description(const std::string &val);
-
149 std::string get_description() const;
-
150
-
151 /* DTEND */
-
152 void set_dtend(const struct icaltimetype &val);
-
153 struct icaltimetype get_dtend() const;
-
154
-
155 /* DTSTAMP */
-
156 void set_dtstamp(const struct icaltimetype &val);
-
157 struct icaltimetype get_dtstamp() const;
-
158
-
159 /* DTSTART */
-
160 void set_dtstart(const struct icaltimetype &val);
-
161 struct icaltimetype get_dtstart() const;
-
162
-
163 /* DUE */
-
164 void set_due(const struct icaltimetype &val);
-
165 struct icaltimetype get_due() const;
-
166
-
167 /* DURATION */
-
168 void set_duration(const struct icaldurationtype &val);
-
169 struct icaldurationtype get_duration() const;
-
170
-
171 /* EXDATE */
-
172 void set_exdate(const struct icaltimetype &val);
-
173 struct icaltimetype get_exdate() const;
-
174
-
175 /* EXPAND */
-
176 void set_expand(const int &val);
-
177 int get_expand() const;
-
178
-
179 /* EXRULE */
-
180 void set_exrule(const struct icalrecurrencetype &val);
-
181 struct icalrecurrencetype get_exrule() const;
-
182
-
183 /* FREEBUSY */
-
184 void set_freebusy(const struct icalperiodtype &val);
-
185 struct icalperiodtype get_freebusy() const;
-
186
-
187 /* GEO */
-
188 void set_geo(const struct icalgeotype &val);
-
189 struct icalgeotype get_geo() const;
-
190
-
191 /* GRANT */
-
192 void set_grant(const std::string &val);
-
193 std::string get_grant() const;
-
194
-
195 /* LAST-MODIFIED */
-
196 void set_lastmodified(const struct icaltimetype &val);
-
197 struct icaltimetype get_lastmodified() const;
-
198
-
199 /* LOCATION */
-
200 void set_location(const std::string &val);
-
201 std::string get_location() const;
-
202
-
203 /* MAXRESULTS */
-
204 void set_maxresults(const int &val);
-
205 int get_maxresults() const;
-
206
-
207 /* MAXRESULTSSIZE */
-
208 void set_maxresultsize(const int &val);
-
209 int get_maxresultsize() const;
-
210
-
211 /* METHOD */
-
212 void set_method(const enum icalproperty_method &val);
-
213 enum icalproperty_method get_method() const;
-
214
-
215 /* OWNER */
-
216 void set_owner(const std::string &val);
-
217 std::string get_owner() const;
-
218
-
219 /* ORGANIZER */
-
220 void set_organizer(const std::string &val);
-
221 std::string get_organizer() const;
-
222
-
223 /* PERCENT-COMPLETE */
-
224 void set_percentcomplete(const int &val);
-
225 int get_percentcomplete() const;
-
226
-
227 /* PRIORITY */
-
228 void set_priority(const int &val);
-
229 int get_priority() const;
-
230
-
231 /* PRODID */
-
232 void set_prodid(const std::string &val);
-
233 std::string get_prodid() const;
-
234
-
235 /* QUERY */
-
236 void set_query(const std::string &val);
-
237 std::string get_query() const;
-
238
-
239 /* QUERYNAME */
-
240 void set_queryname(const std::string &val);
-
241 std::string get_queryname() const;
-
242
-
243 /* RDATE */
-
244 void set_rdate(const struct icaldatetimeperiodtype &val);
-
245 struct icaldatetimeperiodtype get_rdate() const;
-
246
-
247 /* RECURRENCE-ID */
-
248 void set_recurrenceid(const struct icaltimetype &val);
-
249 struct icaltimetype get_recurrenceid() const;
-
250
-
251 /* RELATED-TO */
-
252 void set_relatedto(const std::string &val);
-
253 std::string get_relatedto() const;
-
254
-
255 /* RELCALID */
-
256 void set_relcalid(const std::string &val);
-
257 std::string get_relcalid() const;
-
258
-
259 /* REPEAT */
-
260 void set_repeat(const int &val);
-
261 int get_repeat() const;
-
262
-
263 /* REQUEST-STATUS */
-
264 void set_requeststatus(const std::string &val);
-
265 std::string get_requeststatus() const;
-
266
-
267 /* RESOURCES */
-
268 void set_resources(const std::string &val);
-
269 std::string get_resources() const;
-
270
-
271 /* RRULE */
-
272 void set_rrule(const struct icalrecurrencetype &val);
-
273 struct icalrecurrencetype get_rrule() const;
-
274
-
275 /* SCOPE */
-
276 void set_scope(const std::string &val);
-
277 std::string get_scope() const;
-
278
-
279 /* SEQUENCE */
-
280 void set_sequence(const int &val);
-
281 int get_sequence() const;
-
282
-
283 /* STATUS */
-
284 void set_status(const enum icalproperty_status &val);
-
285 enum icalproperty_status get_status() const;
-
286
-
287 /* SUMMARY */
-
288 void set_summary(const std::string &val);
-
289 std::string get_summary() const;
-
290
-
291 /* TARGET */
-
292 void set_target(const std::string &val);
-
293 std::string get_target() const;
-
294
-
295 /* TRANSP */
-
296 void set_transp(const enum icalproperty_transp &val);
-
297 enum icalproperty_transp get_transp() const;
-
298
-
299 /* TRIGGER */
-
300 void set_trigger(const struct icaltriggertype &val);
-
301 struct icaltriggertype get_trigger() const;
-
302
-
303 /* TZID */
-
304 void set_tzid(const std::string &val);
-
305 std::string get_tzid() const;
-
306
-
307 /* TZNAME */
-
308 void set_tzname(const std::string &val);
-
309 std::string get_tzname() const;
-
310
-
311 /* TZOFFSETFROM */
-
312 void set_tzoffsetfrom(const int &val);
-
313 int get_tzoffsetfrom() const;
-
314
-
315 /* TZOFFSETTO */
-
316 void set_tzoffsetto(const int &val);
-
317 int get_tzoffsetto() const;
-
318
-
319 /* TZURL */
-
320 void set_tzurl(const std::string &val);
-
321 std::string get_tzurl() const;
-
322
-
323 /* UID */
-
324 void set_uid(const std::string &val);
-
325 std::string get_uid() const;
-
326
-
327 /* URL */
-
328 void set_url(const std::string &val);
-
329 std::string get_url() const;
-
330
-
331 /* VERSION */
-
332 void set_version(const std::string &val);
-
333 std::string get_version() const;
-
334
-
335 /* X */
-
336 void set_x(const std::string &val);
-
337 std::string get_x() const;
-
338
-
339 /* X-LIC-CLUSTERCOUNT */
-
340 void set_xlicclustercount(const std::string &val);
-
341 std::string get_xlicclustercount() const;
-
342
-
343 /* X-LIC-ERROR */
-
344 void set_xlicerror(const std::string &val);
-
345 std::string get_xlicerror() const;
-
346
-
347 /* X-LIC-MIMECHARSET */
-
348 void set_xlicmimecharset(const std::string &val);
-
349 std::string get_xlicmimecharset() const;
-
350
-
351 /* X-LIC-MIMECID */
-
352 void set_xlicmimecid(const std::string &val);
-
353 std::string get_xlicmimecid() const;
-
354
-
355 /* X-LIC-MIMECONTENTTYPE */
-
356 void set_xlicmimecontenttype(const std::string &val);
-
357 std::string get_xlicmimecontenttype() const;
-
358
-
359 /* X-LIC-MIMEENCODING */
-
360 void set_xlicmimeencoding(const std::string &val);
-
361 std::string get_xlicmimeencoding() const;
-
362
-
363 /* X-LIC-MIMEFILENAME */
-
364 void set_xlicmimefilename(const std::string &val);
-
365 std::string get_xlicmimefilename() const;
-
366
-
367 /* X-LIC-MIMEOPTINFO */
-
368 void set_xlicmimeoptinfo(const std::string &val);
-
369 std::string get_xlicmimeoptinfo() const;
-
370
-
371private:
-
372 icalproperty *imp;
-
374};
-
375
-
376} // namespace LibICal
-
377
-
378typedef ICPointerHolder < LibICal::ICalProperty > ICalPropertyTmpPtr;
-
379
-
380#endif /* ICalProperty_H */
-
ICPointerHolder
Definition: icptrholder_cxx.h:40
-
LibICal::ICalParameter
Definition: icalparameter_cxx.h:30
-
LibICal::ICalProperty
Definition: icalproperty_cxx.h:33
-
LibICal::ICalProperty::get_first_parameter
ICalParameter * get_first_parameter(const icalparameter_kind &kind)
+Go to the documentation of this file.
1 
+
20 #ifndef ICALPROPERTY_CXX_H
+
21 #define ICALPROPERTY_CXX_H
+
22 
+
23 #include "libical_ical_export.h"
+
24 #include "icptrholder_cxx.h"
+
25 
+
26 extern "C"
+
27 {
+
28 #include "icalerror.h"
+
29 #include "icalproperty.h"
+
30 }
+
31 
+
32 #include <string>
+
33 
+
34 namespace LibICal
+
35 {
+
36 
+
37 class ICalParameter;
+
38 class ICalValue;
+
39 
+
40 class LIBICAL_ICAL_EXPORT ICalProperty
+
41 {
+
42 public:
+
43  ICalProperty();
+
44  ICalProperty(const ICalProperty &);
+
45  ICalProperty &operator=(const ICalProperty &);
+
46  ~ICalProperty();
+
47 
+
48  explicit ICalProperty(icalproperty *v);
+
49  explicit ICalProperty(std::string str);
+
50  explicit ICalProperty(icalproperty_kind kind);
+
51  ICalProperty(icalproperty_kind kind, std::string str);
+
52 
+
53  operator icalproperty *()
+
54  {
+
55  return imp;
+
56  }
+
57  int operator==(ICalProperty &rhs);
+
58 
+
59  void detach();
+
60 
+
61 public:
+
62  std::string as_ical_string();
+
63  icalproperty_kind isa();
+
64  int isa_property(void *property);
+
65 
+
66  void add_parameter(ICalParameter &parameter);
+
67  void set_parameter(ICalParameter &parameter);
+
68  void set_parameter_from_string(const std::string &name, const std::string &val);
+
69  std::string get_parameter_as_string(const std::string &name);
+
70  void remove_parameter_by_kind(const icalparameter_kind &kind);
+
71  int count_parameters();
+
72 
+
74  ICalParameter *get_first_parameter(const icalparameter_kind &kind);
+
75  ICalParameter *get_next_parameter(const icalparameter_kind &kind);
+
76 
+
78  void set_value(const ICalValue &val);
+
79  void set_value_from_string(const std::string &val, const std::string &kind);
+
80 
+
81  ICalValue *get_value();
+
82  std::string get_value_as_string();
+
83 
+
88  std::string get_name() const;
+
89 
+
90 public:
+
91  /* Deal with X properties */
+
92  static void set_x_name(ICalProperty &prop, const std::string &name);
+
93  static std::string get_x_name(ICalProperty &prop);
+
94 
+
95  static icalvalue_kind value_to_value_kind(const icalparameter_value &val);
+
96 
+
97  /* Convert kinds to string and get default value type */
+
98  static icalvalue_kind kind_to_value_kind(const icalproperty_kind &kind);
+
99  static icalproperty_kind value_kind_to_kind(const icalvalue_kind &kind);
+
100  static std::string kind_to_string(const icalproperty_kind &kind);
+
101  static icalproperty_kind string_to_kind(const std::string &str);
+
102 
+
103  static icalproperty_method string_to_method(const std::string &str);
+
104  static std::string method_to_string(const icalproperty_method &method);
+
105 
+
106  static std::string enum_to_string(const int &e);
+
107  static int kind_and_string_to_enum(const icalproperty_kind &kind, const std::string &str);
+
108 
+
109  static std::string status_to_string(const icalproperty_status &status);
+
110  static icalproperty_status string_to_status(const std::string &str);
+
111 
+
112  static int enum_belongs_to_property(const icalproperty_kind &kind, const int &e);
+
113 
+
114 public:
+
115  /* ACTION */
+
116  void set_action(const enum icalproperty_action &val);
+
117  enum icalproperty_action get_action();
+
118 
+
119  /* ATTACH */
+
120  void set_attach(icalattach *val);
+
121  icalattach *get_attach() const;
+
122 
+
123  /* ATTENDEE */
+
124  void set_attendee(const std::string &val);
+
125  std::string get_attendee() const;
+
126 
+
127  /* CALSCALE */
+
128  void set_calscale(const std::string &val);
+
129  std::string get_calscale() const;
+
130 
+
131  /* CATEGORIES */
+
132  void set_categories(const std::string &val);
+
133  std::string get_categories() const;
+
134 
+
135  /* CLASS */
+
136  void set_class(const enum icalproperty_class &val);
+
137  enum icalproperty_class get_class() const;
+
138 
+
139  /* COMMENT */
+
140  void set_comment(const std::string &val);
+
141  std::string get_comment() const;
+
142 
+
143  /* COMPLETED */
+
144  void set_completed(const struct icaltimetype &val);
+
145  struct icaltimetype get_completed() const;
+
146 
+
147  /* CONTACT */
+
148  void set_contact(const std::string &val);
+
149  std::string get_contact() const;
+
150 
+
151  /* CREATED */
+
152  void set_created(const struct icaltimetype &val);
+
153  struct icaltimetype get_created() const;
+
154 
+
155  /* DESCRIPTION */
+
156  void set_description(const std::string &val);
+
157  std::string get_description() const;
+
158 
+
159  /* DTEND */
+
160  void set_dtend(const struct icaltimetype &val);
+
161  struct icaltimetype get_dtend() const;
+
162 
+
163  /* DTSTAMP */
+
164  void set_dtstamp(const struct icaltimetype &val);
+
165  struct icaltimetype get_dtstamp() const;
+
166 
+
167  /* DTSTART */
+
168  void set_dtstart(const struct icaltimetype &val);
+
169  struct icaltimetype get_dtstart() const;
+
170 
+
171  /* DUE */
+
172  void set_due(const struct icaltimetype &val);
+
173  struct icaltimetype get_due() const;
+
174 
+
175  /* DURATION */
+
176  void set_duration(const struct icaldurationtype &val);
+
177  struct icaldurationtype get_duration() const;
+
178 
+
179  /* EXDATE */
+
180  void set_exdate(const struct icaltimetype &val);
+
181  struct icaltimetype get_exdate() const;
+
182 
+
183  /* EXPAND */
+
184  void set_expand(const int &val);
+
185  int get_expand() const;
+
186 
+
187  /* EXRULE */
+
188  void set_exrule(const struct icalrecurrencetype &val);
+
189  struct icalrecurrencetype get_exrule() const;
+
190 
+
191  /* FREEBUSY */
+
192  void set_freebusy(const struct icalperiodtype &val);
+
193  struct icalperiodtype get_freebusy() const;
+
194 
+
195  /* GEO */
+
196  void set_geo(const struct icalgeotype &val);
+
197  struct icalgeotype get_geo() const;
+
198 
+
199  /* GRANT */
+
200  void set_grant(const std::string &val);
+
201  std::string get_grant() const;
+
202 
+
203  /* LAST-MODIFIED */
+
204  void set_lastmodified(const struct icaltimetype &val);
+
205  struct icaltimetype get_lastmodified() const;
+
206 
+
207  /* LOCATION */
+
208  void set_location(const std::string &val);
+
209  std::string get_location() const;
+
210 
+
211  /* MAXRESULTS */
+
212  void set_maxresults(const int &val);
+
213  int get_maxresults() const;
+
214 
+
215  /* MAXRESULTSSIZE */
+
216  void set_maxresultsize(const int &val);
+
217  int get_maxresultsize() const;
+
218 
+
219  /* METHOD */
+
220  void set_method(const enum icalproperty_method &val);
+
221  enum icalproperty_method get_method() const;
+
222 
+
223  /* OWNER */
+
224  void set_owner(const std::string &val);
+
225  std::string get_owner() const;
+
226 
+
227  /* ORGANIZER */
+
228  void set_organizer(const std::string &val);
+
229  std::string get_organizer() const;
+
230 
+
231  /* PERCENT-COMPLETE */
+
232  void set_percentcomplete(const int &val);
+
233  int get_percentcomplete() const;
+
234 
+
235  /* PRIORITY */
+
236  void set_priority(const int &val);
+
237  int get_priority() const;
+
238 
+
239  /* PRODID */
+
240  void set_prodid(const std::string &val);
+
241  std::string get_prodid() const;
+
242 
+
243  /* QUERY */
+
244  void set_query(const std::string &val);
+
245  std::string get_query() const;
+
246 
+
247  /* QUERYNAME */
+
248  void set_queryname(const std::string &val);
+
249  std::string get_queryname() const;
+
250 
+
251  /* RDATE */
+
252  void set_rdate(const struct icaldatetimeperiodtype &val);
+
253  struct icaldatetimeperiodtype get_rdate() const;
+
254 
+
255  /* RECURRENCE-ID */
+
256  void set_recurrenceid(const struct icaltimetype &val);
+
257  struct icaltimetype get_recurrenceid() const;
+
258 
+
259  /* RELATED-TO */
+
260  void set_relatedto(const std::string &val);
+
261  std::string get_relatedto() const;
+
262 
+
263  /* RELCALID */
+
264  void set_relcalid(const std::string &val);
+
265  std::string get_relcalid() const;
+
266 
+
267  /* REPEAT */
+
268  void set_repeat(const int &val);
+
269  int get_repeat() const;
+
270 
+
271  /* REQUEST-STATUS */
+
272  void set_requeststatus(const std::string &val);
+
273  std::string get_requeststatus() const;
+
274 
+
275  /* RESOURCES */
+
276  void set_resources(const std::string &val);
+
277  std::string get_resources() const;
+
278 
+
279  /* RRULE */
+
280  void set_rrule(const struct icalrecurrencetype &val);
+
281  struct icalrecurrencetype get_rrule() const;
+
282 
+
283  /* SCOPE */
+
284  void set_scope(const std::string &val);
+
285  std::string get_scope() const;
+
286 
+
287  /* SEQUENCE */
+
288  void set_sequence(const int &val);
+
289  int get_sequence() const;
+
290 
+
291  /* STATUS */
+
292  void set_status(const enum icalproperty_status &val);
+
293  enum icalproperty_status get_status() const;
+
294 
+
295  /* SUMMARY */
+
296  void set_summary(const std::string &val);
+
297  std::string get_summary() const;
+
298 
+
299  /* TARGET */
+
300  void set_target(const std::string &val);
+
301  std::string get_target() const;
+
302 
+
303  /* TRANSP */
+
304  void set_transp(const enum icalproperty_transp &val);
+
305  enum icalproperty_transp get_transp() const;
+
306 
+
307  /* TRIGGER */
+
308  void set_trigger(const struct icaltriggertype &val);
+
309  struct icaltriggertype get_trigger() const;
+
310 
+
311  /* TZID */
+
312  void set_tzid(const std::string &val);
+
313  std::string get_tzid() const;
+
314 
+
315  /* TZNAME */
+
316  void set_tzname(const std::string &val);
+
317  std::string get_tzname() const;
+
318 
+
319  /* TZOFFSETFROM */
+
320  void set_tzoffsetfrom(const int &val);
+
321  int get_tzoffsetfrom() const;
+
322 
+
323  /* TZOFFSETTO */
+
324  void set_tzoffsetto(const int &val);
+
325  int get_tzoffsetto() const;
+
326 
+
327  /* TZURL */
+
328  void set_tzurl(const std::string &val);
+
329  std::string get_tzurl() const;
+
330 
+
331  /* UID */
+
332  void set_uid(const std::string &val);
+
333  std::string get_uid() const;
+
334 
+
335  /* URL */
+
336  void set_url(const std::string &val);
+
337  std::string get_url() const;
+
338 
+
339  /* VERSION */
+
340  void set_version(const std::string &val);
+
341  std::string get_version() const;
+
342 
+
343  /* X */
+
344  void set_x(const std::string &val);
+
345  std::string get_x() const;
+
346 
+
347  /* X-LIC-CLUSTERCOUNT */
+
348  void set_xlicclustercount(const std::string &val);
+
349  std::string get_xlicclustercount() const;
+
350 
+
351  /* X-LIC-ERROR */
+
352  void set_xlicerror(const std::string &val);
+
353  std::string get_xlicerror() const;
+
354 
+
355  /* X-LIC-MIMECHARSET */
+
356  void set_xlicmimecharset(const std::string &val);
+
357  std::string get_xlicmimecharset() const;
+
358 
+
359  /* X-LIC-MIMECID */
+
360  void set_xlicmimecid(const std::string &val);
+
361  std::string get_xlicmimecid() const;
+
362 
+
363  /* X-LIC-MIMECONTENTTYPE */
+
364  void set_xlicmimecontenttype(const std::string &val);
+
365  std::string get_xlicmimecontenttype() const;
+
366 
+
367  /* X-LIC-MIMEENCODING */
+
368  void set_xlicmimeencoding(const std::string &val);
+
369  std::string get_xlicmimeencoding() const;
+
370 
+
371  /* X-LIC-MIMEFILENAME */
+
372  void set_xlicmimefilename(const std::string &val);
+
373  std::string get_xlicmimefilename() const;
+
374 
+
375  /* X-LIC-MIMEOPTINFO */
+
376  void set_xlicmimeoptinfo(const std::string &val);
+
377  std::string get_xlicmimeoptinfo() const;
+
378 
+
379 private:
+
380  icalproperty *imp;
+
382 };
+
383 
+
384 } // namespace LibICal
+
385 
+
386 typedef ICPointerHolder < LibICal::ICalProperty > ICalPropertyTmpPtr;
+
387 
+
388 #endif /* ICalProperty_H */
+
ICPointerHolder
Definition: icptrholder_cxx.h:48
+
LibICal::ICalParameter
Definition: icalparameter_cxx.h:38
+
LibICal::ICalProperty
Definition: icalproperty_cxx.h:41
+
LibICal::ICalProperty::get_first_parameter
ICalParameter * get_first_parameter(const icalparameter_kind &kind)
LibICal::ICalProperty::get_name
std::string get_name() const
LibICal::ICalProperty::set_value
void set_value(const ICalValue &val)
-
LibICal::ICalValue
Definition: icalvalue_cxx.h:28
+
LibICal::ICalValue
Definition: icalvalue_cxx.h:36
icalerror.h
Error handling for libical.
icptrholder_cxx.h
C++ template classes for managing C++ pointers returned by VComponent::get_..._component,...
-
icalattach_impl
Definition: icalattachimpl.h:18
-
icaldatetimeperiodtype
Definition: icaltypes.h:20
-
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:28
-
icalgeotype
Definition: icaltypes.h:27
-
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:29
-
icalrecurrencetype
Definition: icalrecur.h:144
-
icaltimetype
Definition: icaltime.h:97
-
icaltriggertype
Definition: icaltypes.h:33
+
icalattach_impl
Definition: icalattachimpl.h:26
+
icaldatetimeperiodtype
Definition: icaltypes.h:28
+
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
+
icalgeotype
Definition: icaltypes.h:34
+
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:38
+
icalrecurrencetype
Definition: icalrecur.h:152
+
icaltimetype
Definition: icaltime.h:105
+
icaltriggertype
Definition: icaltypes.h:40
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalproperty__p_8h_source.html b/apidocs/icalproperty__p_8h_source.html index 2a7cac62..9994bd33 100644 --- a/apidocs/icalproperty__p_8h_source.html +++ b/apidocs/icalproperty__p_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalproperty_p.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalproperty_p.h
+
+
icalproperty_p.h
-
1/*======================================================================
-
2 FILE: icalproperty_p.h
-
3
-
4 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
5
-
6 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
7
-
8======================================================================*/
-
9
-
10#ifndef ICALPROPERTY_P_H
-
11#define ICALPROPERTY_P_H
-
12
-
13#include "icalproperty.h"
-
14#include "icalcomponent.h"
-
15
-
16/* Check validity and attributes of icalproperty_kind and icalvalue_kind pair */
-
17LIBICAL_ICAL_NO_EXPORT int icalproperty_value_kind_is_valid(icalproperty_kind pkind,
-
18 icalvalue_kind vkind);
-
19LIBICAL_ICAL_NO_EXPORT int icalproperty_value_kind_is_multivalued(icalproperty_kind pkind,
-
20 icalvalue_kind *vkind);
-
21LIBICAL_ICAL_NO_EXPORT int icalproperty_value_kind_is_default(icalproperty_kind pkind,
-
22 icalvalue_kind vkind);
-
23
-
24#endif /* ICALPROPERTY_P_H */
+
1 /*======================================================================
+
2  FILE: icalproperty_p.h
+
3 
+
4  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
5 
+
6  This library is free software; you can redistribute it and/or modify
+
7  it under the terms of either:
+
8 
+
9  The LGPL as published by the Free Software Foundation, version
+
10  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
11 
+
12  Or:
+
13 
+
14  The Mozilla Public License Version 2.0. You may obtain a copy of
+
15  the License at https://www.mozilla.org/MPL/
+
16 ======================================================================*/
+
17 
+
18 #ifndef ICALPROPERTY_P_H
+
19 #define ICALPROPERTY_P_H
+
20 
+
21 #include "icalproperty.h"
+
22 #include "icalcomponent.h"
+
23 
+
24 /* Check validity and attributes of icalproperty_kind and icalvalue_kind pair */
+
25 LIBICAL_ICAL_NO_EXPORT int icalproperty_value_kind_is_valid(icalproperty_kind pkind,
+
26  icalvalue_kind vkind);
+
27 LIBICAL_ICAL_NO_EXPORT int icalproperty_value_kind_is_multivalued(icalproperty_kind pkind,
+
28  icalvalue_kind *vkind);
+
29 LIBICAL_ICAL_NO_EXPORT int icalproperty_value_kind_is_default(icalproperty_kind pkind,
+
30  icalvalue_kind vkind);
+
31 
+
32 #endif /* ICALPROPERTY_P_H */
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalrecur_8h.html b/apidocs/icalrecur_8h.html index 639de8d3..c09f6a08 100644 --- a/apidocs/icalrecur_8h.html +++ b/apidocs/icalrecur_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalrecur.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Typedefs | Enumerations | Functions
-
icalrecur.h File Reference
+
+
icalrecur.h File Reference
@@ -81,71 +82,64 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

struct  icalrecurrencetype
 
- - - - - - - - - - +

+

Macros

+
#define ICAL_BY_DAY_SIZE   7*(ICAL_BY_WEEKNO_SIZE-1)+1 /* 1 to N */
 
+
#define ICAL_BY_HOUR_SIZE   25 /* 0 to 23 */
 
+
#define ICAL_BY_MINUTE_SIZE   61 /* 0 to 59 */
 
+
#define ICAL_BY_MONTH_SIZE   14 /* 1 to 13 */
 
+
#define ICAL_BY_MONTHDAY_SIZE   32 /* 1 to 31 */
 
#define ICAL_BY_SECOND_SIZE   62 /* 0 to 60 */
 
+
#define ICAL_BY_SETPOS_SIZE   ICAL_BY_YEARDAY_SIZE /* 1 to N */
 
+
#define ICAL_BY_WEEKNO_SIZE   56 /* 1 to 55 */
 
+
#define ICAL_BY_YEARDAY_SIZE   386 /* 1 to 385 */
 
#define ICALRECURRENCETYPE_INITIALIZER
#define ICALRECURRENCETYPE_INITIALIZER
 
- - - - - - -

+

Typedefs

-typedef enum ical_invalid_rrule_handling ical_invalid_rrule_handling
 
+
typedef struct icalrecur_iterator_impl icalrecur_iterator
 
+
typedef enum icalrecurrencetype_frequency icalrecurrencetype_frequency
 
+
typedef enum icalrecurrencetype_skip icalrecurrencetype_skip
 
+
typedef enum icalrecurrencetype_weekday icalrecurrencetype_weekday
 
- - - - -
} - - }

+

Enumerations

enum  ical_invalid_rrule_handling { ICAL_RRULE_TREAT_AS_ERROR = 0 -, ICAL_RRULE_IGNORE_INVALID = 1 - }
 
enum  icalrecurrence_array_max_values { ICAL_RECURRENCE_ARRAY_MAX = 0x7f7f +
enum  icalrecurrence_array_max_values { ICAL_RECURRENCE_ARRAY_MAX = 0x7f7f , ICAL_RECURRENCE_ARRAY_MAX_BYTE = 0x7f }
 
enum  icalrecurrencetype_frequency {
+
enum  icalrecurrencetype_frequency {
  ICAL_SECONDLY_RECURRENCE = 0 , ICAL_MINUTELY_RECURRENCE = 1 , ICAL_HOURLY_RECURRENCE = 2 @@ -158,13 +152,13 @@ Enumerations
 
enum  icalrecurrencetype_skip { ICAL_SKIP_BACKWARD = 0 +
enum  icalrecurrencetype_skip { ICAL_SKIP_BACKWARD = 0 , ICAL_SKIP_FORWARD , ICAL_SKIP_OMIT , ICAL_SKIP_UNDEFINED }
 
enum  icalrecurrencetype_weekday {
+
enum  icalrecurrencetype_weekday {
  ICAL_NO_WEEKDAY , ICAL_SUNDAY_WEEKDAY , ICAL_MONDAY_WEEKDAY @@ -178,56 +172,44 @@ Enumerations
 
- - - - - - - - - + + + - + - - + + - - - - - - - - - + - - - - - + - - + - - + @@ -236,58 +218,55 @@ void  - - - - - + - - - - +

+

Functions

-ical_invalid_rrule_handling ical_get_invalid_rrule_handling_setting (void)
 
-void ical_set_invalid_rrule_handling_setting (ical_invalid_rrule_handling newSetting)
 
int icalrecur_expand_recurrence (const char *rule, icaltime_t start, int count, icaltime_t *array)
 Fills an array with the 'count' number of occurrences generated by the rrule. More...
 
+
int icalrecur_expand_recurrence (const char *rule, time_t start, int count, time_t *array)
 Fills an array with the 'count' number of occurrences generated by the rrule. More...
 
const char * icalrecur_freq_to_string (icalrecurrencetype_frequency kind)
 
 
void icalrecur_iterator_free (icalrecur_iterator *)
 
icalrecur_iterator * icalrecur_iterator_new (struct icalrecurrencetype rule, struct icaltimetype dtstart)
 
icalrecur_iterator * icalrecur_iterator_new (struct icalrecurrencetype rule, struct icaltimetype dtstart)
 
struct icaltimetype icalrecur_iterator_next (icalrecur_iterator *)
 
struct icaltimetype icalrecur_iterator_prev (icalrecur_iterator *)
 
int icalrecur_iterator_set_end (icalrecur_iterator *impl, struct icaltimetype end)
 
int icalrecur_iterator_set_range (icalrecur_iterator *impl, struct icaltimetype from, struct icaltimetype to)
 
int icalrecur_iterator_set_start (icalrecur_iterator *impl, struct icaltimetype start)
 
+
const char * icalrecur_skip_to_string (icalrecurrencetype_skip kind)
 
+
 
icalrecurrencetype_frequency icalrecur_string_to_freq (const char *str)
 
+
icalrecurrencetype_skip icalrecur_string_to_skip (const char *str)
 
+
icalrecurrencetype_weekday icalrecur_string_to_weekday (const char *str)
 
+
const char * icalrecur_weekday_to_string (icalrecurrencetype_weekday kind)
 
+
 
char * icalrecurrencetype_as_string (struct icalrecurrencetype *recur)
 
+
 
char * icalrecurrencetype_as_string_r (struct icalrecurrencetype *recur)
 
+
 
void icalrecurrencetype_clear (struct icalrecurrencetype *r)
 
enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week (short day)
icalrecurrencetype_cl
int icalrecurrencetype_day_position (short day)
 Decodes a day to a position of the weekday. More...
 
short icalrecurrencetype_encode_day (enum icalrecurrencetype_weekday weekday, int position)
 
short icalrecurrencetype_encode_month (int month, int is_leap)
 
struct icalrecurrencetype icalrecurrencetype_from_string (const char *str)
 
int icalrecurrencetype_month_is_leap (short month)
+int icalrecurrencetype_month_is_leap (short month)
 
+
int icalrecurrencetype_month_month (short month)
 
+
int icalrecurrencetype_rscale_is_supported (void)
 
+
icalarray * icalrecurrencetype_rscale_supported_calendars (void)
 
 

Detailed Description

-

Routines for dealing with recurring time.

-

How to use:

-

1) Get a rule and a start time from a component

+

Routines for dealing with recurring time.

+

How to use:

+

1) Get a rule and a start time from a component

icalproperty rrule;
-
struct icalrecurrencetype recur;
-
struct icaltimetype dtstart;
+
struct icalrecurrencetype recur;
+
struct icaltimetype dtstart;
rrule = icalcomponent_get_first_property(comp,ICAL_RRULE_PROPERTY);
recur = icalproperty_get_rrule(rrule);
start = icalproperty_get_dtstart(dtstart);
-
icalrecurrencetype
Definition: icalrecur.h:144
-
icaltimetype
Definition: icaltime.h:97
-

Or, just make them up:

-
recur = icalrecurrencetype_from_string("FREQ=YEARLY;BYDAY=SU,WE");
-
dtstart = icaltime_from_string("19970101T123000")
-
icalrecurrencetype_from_string
struct icalrecurrencetype icalrecurrencetype_from_string(const char *str)
Definition: icalrecur.c:634
-
icaltime_from_string
struct icaltimetype icaltime_from_string(const char *str)
Constructor.
Definition: icaltime.c:330
-

2) Create an iterator

-
icalrecur_iterator *ritr;
-
ritr = icalrecur_iterator_new(recur,start);
-
icalrecur_iterator_new
icalrecur_iterator * icalrecur_iterator_new(struct icalrecurrencetype rule, struct icaltimetype dtstart)
Definition: icalrecur.c:1931
-
icalrecur_iterator_impl
Definition: icalrecur.c:933
-

3) Iterator over the occurrences

-
struct icaltimetype next;
-
while (next = icalrecur_iterator_next(ritr)
-
&& !icaltime_is_null_time(next){
+
icalrecurrencetype
Definition: icalrecur.h:152
+
icaltimetype
Definition: icaltime.h:105
+

Or, just make them up:

+
recur = icalrecurrencetype_from_string("FREQ=YEARLY;BYDAY=SU,WE");
+
dtstart = icaltime_from_string("19970101T123000")
+
icalrecurrencetype_from_string
struct icalrecurrencetype icalrecurrencetype_from_string(const char *str)
Definition: icalrecur.c:555
+
icaltime_from_string
struct icaltimetype icaltime_from_string(const char *str)
Constructor.
Definition: icaltime.c:345
+

2) Create an iterator

+
icalrecur_iterator *ritr;
+
ritr = icalrecur_iterator_new(recur,start);
+
icalrecur_iterator_new
icalrecur_iterator * icalrecur_iterator_new(struct icalrecurrencetype rule, struct icaltimetype dtstart)
Definition: icalrecur.c:1952
+
icalrecur_iterator_impl
Definition: icalrecur.c:925
+

3) Iterator over the occurrences

+
struct icaltimetype next;
+
while (next = icalrecur_iterator_next(ritr)
+
&& !icaltime_is_null_time(next){
Do something with next
}
-
icalrecur_iterator_next
struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *)
Definition: icalrecur.c:3150
-
icaltime_is_null_time
int icaltime_is_null_time(const struct icaltimetype t)
Returns true if the time is null.
Definition: icaltime.c:593
-

Note that the time returned by icalrecur_iterator_next is in whatever timezone that dtstart is in.

+
icalrecur_iterator_next
struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *)
Definition: icalrecur.c:2933
+
icaltime_is_null_time
int icaltime_is_null_time(const struct icaltimetype t)
Returns true if the time is null.
Definition: icaltime.c:617
+

Note that the time returned by icalrecur_iterator_next is in whatever timezone that dtstart is in.

Macro Definition Documentation

- +

◆ ICAL_BY_SECOND_SIZE

@@ -298,11 +277,11 @@ int icalrecurrencetype_rsc
-

Recurrence type routines

+

Recurrence type routines

- +

◆ ICALRECURRENCETYPE_INITIALIZER

@@ -335,8 +314,8 @@ int icalrecurrencetype_rsc

Function Documentation

- -

◆ icalrecur_expand_recurrence()

+ +

◆ icalrecur_expand_recurrence()

@@ -350,7 +329,7 @@ int icalrecurrencetype_rsc - icaltime_t  + time_t  start, @@ -362,7 +341,7 @@ int icalrecurrencetype_rsc - icaltime_t *  + time_t *  array  @@ -374,12 +353,12 @@ int icalrecurrencetype_rsc

Fills an array with the 'count' number of occurrences generated by the rrule.

-

Specifically, this fills array up with at most 'count' icaltime_t values, each representing an occurrence time in seconds past the POSIX epoch.

-

Note that the times are returned in UTC, but the times are calculated in local time. You will have to convert the results back into local time before using them.

+

Specifically, this fills array up with at most 'count' time_t values, each representing an occurrence time in seconds past the POSIX epoch.

+

Note that the times are returned in UTC, but the times are calculated in local time. You will have to convert the results back into local time before using them.

- +

◆ icalrecur_iterator_free()

@@ -394,18 +373,18 @@ int icalrecurrencetype_rsc
-

Frees the iterator.

+

Frees the iterator.

- -

◆ icalrecur_iterator_new()

+ +

◆ icalrecur_iterator_new()

- + @@ -423,11 +402,11 @@ int 
icalrecur_iterator * icalrecur_iterator_new icalrecur_iterator* icalrecur_iterator_new ( struct icalrecurrencetype  rule, icalrecurrencetype_rsc
-

Creates a new recurrence rule iterator, starting at DTSTART.

+

Creates a new recurrence rule iterator, starting at DTSTART.

- +

◆ icalrecur_iterator_next()

@@ -442,98 +421,11 @@ int icalrecurrencetype_rsc
-

Gets the next occurrence from an iterator.

- -
-
- -

◆ icalrecur_iterator_prev()

- -
-
- - - - - - - - -
struct icaltimetype icalrecur_iterator_prev (icalrecur_iterator * impl)
-
-

Gets the previous occurrence from an iterator.

Since
3.1
- -
-
- -

◆ icalrecur_iterator_set_end()

- -
-
- - - - - - - - - - - - - - - - - - -
int icalrecur_iterator_set_end (icalrecur_iterator * impl,
struct icaltimetype end 
)
-
-

Set the date-time at which the iterator will stop at the latest. Values equal to or greater than end will not be returned by the iterator.

- -
-
- -

◆ icalrecur_iterator_set_range()

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
int icalrecur_iterator_set_range (icalrecur_iterator * impl,
struct icaltimetype from,
struct icaltimetype to 
)
-
-

Sets the date-times over which the iterator will run, where from is a value between DTSTART and UNTIL.

-

If to is null time, the forward iterator will return values up to and including UNTIL (if present), otherwise up to the year 2582.

-

if to is non-null time and later than from, the forward iterator will return values up to and including 'to'.

-

If to is non-null time and earlier than from, the reverse iterator will be set to start at from and will return values down to and including to.

-

NOTE: CAN NOT be used with RRULEs that contain COUNT.

Since
3.1
+

Gets the next occurrence from an iterator.

- +

◆ icalrecur_iterator_set_start()

@@ -558,12 +450,12 @@ int icalrecurrencetype_rsc
-

Sets the date-time at which the iterator will start, where start is a value between DTSTART and UNTIL.

-

NOTE: CAN NOT be used with RRULEs that contain COUNT.

Since
3.0
+

Sets the date-time at which the iterator will start, where start is a value between DTSTART and UNTIL.

+

NOTE: CAN NOT be used with RRULEs that contain COUNT.

Since
3.0
- +

◆ icalrecurrencetype_day_day_of_week()

@@ -582,12 +474,11 @@ int icalrecurrencetype_rsc

Decodes a day to a weekday.

Returns
The decoded day of the week. 1 is Monday, 2 is Tuesday, etc. A position of 0 means 'any' or 'every'.

The 'day' element of icalrecurrencetype_weekday is encoded to allow representation of both the day of the week ( Monday, Tuesday), but also the Nth day of the week ( First tuesday of the month, last thursday of the year) These routines decode the day values.

-

The day's position in the period ( Nth-ness) and the numerical value of the day are encoded together as: pos*7 + dow.

-

A position of 0 means 'any' or 'every'.

+

The day's position in the period ( Nth-ness) and the numerical value of the day are encoded together as: pos*7 + dow.

- +

◆ icalrecurrencetype_day_position()

@@ -608,65 +499,7 @@ int icalrecurrencetype_rsc
- -

◆ icalrecurrencetype_encode_day()

- -
-
- - - - - - - - - - - - - - - - - - -
short icalrecurrencetype_encode_day (enum icalrecurrencetype_weekday weekday,
int position 
)
-
-

Encodes the weekday and position into a form, which can be stored to icalrecurrencetype::by_day array. Use icalrecurrencetype_day_day_of_week() and icalrecurrencetype_day_position() to split the encoded value back into the parts.

Since
3.1
- -
-
- -

◆ icalrecurrencetype_encode_month()

- -
-
- - - - - - - - - - - - - - - - - - -
short icalrecurrencetype_encode_month (int month,
int is_leap 
)
-
-

Encodes the month and the is_leap into a form, which can be stored to icalrecurrencetype::by_month array. Use icalrecurrencetype_month_is_leap() and icalrecurrencetype_month_month() to split the encoded value back into the parts

Since
3.1
- -
-
- +

◆ icalrecurrencetype_from_string()

@@ -681,34 +514,14 @@ int icalrecurrencetype_rsc
-

Convert between strings and recurrencetype structures.

- -
- - -

◆ icalrecurrencetype_month_is_leap()

- -
-
- - - - - - - - -
int icalrecurrencetype_month_is_leap (short month)
-
-

The month element of the by_month array is encoded to allow representation of the "L" leap suffix (RFC 7529). These routines decode the month values.

-

The "L" suffix is encoded by setting a high-order bit.

+

Convert between strings and recurrencetype structures.

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalrecur_8h_source.html b/apidocs/icalrecur_8h_source.html index e6c9b3d9..57f1e998 100644 --- a/apidocs/icalrecur_8h_source.html +++ b/apidocs/icalrecur_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalrecur.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalrecur.h
+
+
icalrecur.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalrecur.h
-
3 CREATOR: eric 20 March 2000
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9========================================================================*/
-
10
-
58#ifndef ICALRECUR_H
-
59#define ICALRECUR_H
-
60
-
61#include "libical_ical_export.h"
-
62#include "icalarray.h"
-
63#include "icaltime.h"
-
64
-
65/*
-
66 * Recurrence enumerations
-
67 */
-
68
-
69typedef enum icalrecurrencetype_frequency
-
70{
-
71 /* These enums are used to index an array, so don't change the
-
72 order or the integers */
-
73
-
74 ICAL_SECONDLY_RECURRENCE = 0,
-
75 ICAL_MINUTELY_RECURRENCE = 1,
-
76 ICAL_HOURLY_RECURRENCE = 2,
-
77 ICAL_DAILY_RECURRENCE = 3,
-
78 ICAL_WEEKLY_RECURRENCE = 4,
-
79 ICAL_MONTHLY_RECURRENCE = 5,
-
80 ICAL_YEARLY_RECURRENCE = 6,
-
81 ICAL_NO_RECURRENCE = 7
-
82} icalrecurrencetype_frequency;
-
83
-
84typedef enum icalrecurrencetype_weekday
-
85{
-
86 ICAL_NO_WEEKDAY,
-
87 ICAL_SUNDAY_WEEKDAY,
-
88 ICAL_MONDAY_WEEKDAY,
-
89 ICAL_TUESDAY_WEEKDAY,
-
90 ICAL_WEDNESDAY_WEEKDAY,
-
91 ICAL_THURSDAY_WEEKDAY,
-
92 ICAL_FRIDAY_WEEKDAY,
-
93 ICAL_SATURDAY_WEEKDAY
-
94} icalrecurrencetype_weekday;
-
95
-
96typedef enum icalrecurrencetype_skip
-
97{
-
98 ICAL_SKIP_BACKWARD = 0,
-
99 ICAL_SKIP_FORWARD,
-
100 ICAL_SKIP_OMIT,
-
101 ICAL_SKIP_UNDEFINED
-
102} icalrecurrencetype_skip;
-
103
-
104enum icalrecurrence_array_max_values
-
105{
-
106 ICAL_RECURRENCE_ARRAY_MAX = 0x7f7f,
-
107 ICAL_RECURRENCE_ARRAY_MAX_BYTE = 0x7f
-
108};
-
109
-
110/*
-
111 * Recurrence enumerations conversion routines.
-
112 */
-
113
-
114LIBICAL_ICAL_EXPORT icalrecurrencetype_frequency icalrecur_string_to_freq(const char *str);
-
115LIBICAL_ICAL_EXPORT const char *icalrecur_freq_to_string(icalrecurrencetype_frequency kind);
-
116
-
117LIBICAL_ICAL_EXPORT icalrecurrencetype_skip icalrecur_string_to_skip(const char *str);
-
118LIBICAL_ICAL_EXPORT const char *icalrecur_skip_to_string(icalrecurrencetype_skip kind);
-
119
-
120LIBICAL_ICAL_EXPORT const char *icalrecur_weekday_to_string(icalrecurrencetype_weekday kind);
-
121LIBICAL_ICAL_EXPORT icalrecurrencetype_weekday icalrecur_string_to_weekday(const char *str);
-
122
-
127/* See RFC 5545 Section 3.3.10, RECUR Value, and RFC 7529
-
128 * for an explanation of the values and fields in struct icalrecurrencetype.
-
129 *
-
130 * The maximums below are based on lunisolar leap years (13 months)
-
131 */
-
132#define ICAL_BY_SECOND_SIZE 62 /* 0 to 60 */
-
133#define ICAL_BY_MINUTE_SIZE 61 /* 0 to 59 */
-
134#define ICAL_BY_HOUR_SIZE 25 /* 0 to 23 */
-
135#define ICAL_BY_MONTH_SIZE 14 /* 1 to 13 */
-
136#define ICAL_BY_MONTHDAY_SIZE 32 /* 1 to 31 */
-
137#define ICAL_BY_WEEKNO_SIZE 56 /* 1 to 55 */
-
138#define ICAL_BY_YEARDAY_SIZE 386 /* 1 to 385 */
-
139#define ICAL_BY_SETPOS_SIZE ICAL_BY_YEARDAY_SIZE /* 1 to N */
-
140#define ICAL_BY_DAY_SIZE 7*(ICAL_BY_WEEKNO_SIZE-1)+1 /* 1 to N */
-
141
-
143struct icalrecurrencetype
-
144{
-
145 icalrecurrencetype_frequency freq;
-
146
-
147 /* until and count are mutually exclusive. */
-
148 struct icaltimetype until;
-
149 int count;
-
150
-
151 short interval;
-
152
-
153 icalrecurrencetype_weekday week_start;
-
154
-
155 /* The BY* parameters can each take a list of values. Here I
-
156 * assume that the list of values will not be larger than the
-
157 * range of the value -- that is, the client will not name a
-
158 * value more than once.
-
159
-
160 * Each of the lists is terminated with the value
-
161 * ICAL_RECURRENCE_ARRAY_MAX unless the list is full.
-
162 */
-
163
-
164 short by_second[ICAL_BY_SECOND_SIZE];
-
165 short by_minute[ICAL_BY_MINUTE_SIZE];
-
166 short by_hour[ICAL_BY_HOUR_SIZE];
-
167 short by_day[ICAL_BY_DAY_SIZE];
-
177 short by_month_day[ICAL_BY_MONTHDAY_SIZE];
-
178 short by_year_day[ICAL_BY_YEARDAY_SIZE];
-
179 short by_week_no[ICAL_BY_WEEKNO_SIZE];
-
180 short by_month[ICAL_BY_MONTH_SIZE];
-
188 short by_set_pos[ICAL_BY_SETPOS_SIZE];
-
189
-
190 /* For RSCALE extension (RFC 7529) */
-
191 char *rscale;
-
192 icalrecurrencetype_skip skip;
-
193};
-
194
-
195#define ICALRECURRENCETYPE_INITIALIZER { \
-
196 ICAL_NO_RECURRENCE, /* freq */ \
-
197 ICALTIMETYPE_INITIALIZER, /* until */ \
-
198 0, /* count */ \
-
199 1, /* interval */ \
-
200 ICAL_MONDAY_WEEKDAY, /* week_start */ \
-
201 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_second */ \
-
202 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_minute */ \
-
203 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_hour */ \
-
204 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_day */ \
-
205 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_month_day */ \
-
206 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_year_day */ \
-
207 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_week_no */ \
-
208 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_month */ \
-
209 { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_set_pos */ \
-
210 NULL, /* rscale */ \
-
211 ICAL_SKIP_OMIT /* skip */ \
-
212}
-
213
-
214LIBICAL_ICAL_EXPORT int icalrecurrencetype_rscale_is_supported(void);
-
215
-
216LIBICAL_ICAL_EXPORT icalarray *icalrecurrencetype_rscale_supported_calendars(void);
-
217
-
218LIBICAL_ICAL_EXPORT void icalrecurrencetype_clear(struct icalrecurrencetype *r);
-
219
-
220/*
-
221 * Routines to decode the day values of the by_day array
-
222 */
-
223
-
239LIBICAL_ICAL_EXPORT enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week(short day);
-
240
-
247LIBICAL_ICAL_EXPORT int icalrecurrencetype_day_position(short day);
-
248
-
254LIBICAL_ICAL_EXPORT short icalrecurrencetype_encode_day(enum icalrecurrencetype_weekday weekday,
-
255 int position);
-
256
-
257/*
-
258 * Routines to decode the 'month' element of the by_month array
-
259 */
-
260
-
268LIBICAL_ICAL_EXPORT int icalrecurrencetype_month_is_leap(short month);
-
269
-
270LIBICAL_ICAL_EXPORT int icalrecurrencetype_month_month(short month);
-
271
-
277LIBICAL_ICAL_EXPORT short icalrecurrencetype_encode_month(int month, int is_leap);
-
278
-
279/*
-
280 * Recurrence rule parser
-
281 */
-
282
-
284LIBICAL_ICAL_EXPORT struct icalrecurrencetype icalrecurrencetype_from_string(const char *str);
-
285
-
286LIBICAL_ICAL_EXPORT char *icalrecurrencetype_as_string(struct icalrecurrencetype *recur);
-
287
-
288LIBICAL_ICAL_EXPORT char *icalrecurrencetype_as_string_r(struct icalrecurrencetype *recur);
-
289
-
290/*
-
291 * Recurrence iteration routines
-
292 */
-
293
-
294typedef struct icalrecur_iterator_impl icalrecur_iterator;
-
295
-
297LIBICAL_ICAL_EXPORT icalrecur_iterator *icalrecur_iterator_new(struct icalrecurrencetype rule,
-
298 struct icaltimetype dtstart);
-
299
-
307LIBICAL_ICAL_EXPORT int icalrecur_iterator_set_start(icalrecur_iterator *impl,
-
308 struct icaltimetype start);
-
309
-
313LIBICAL_ICAL_EXPORT int icalrecur_iterator_set_end(icalrecur_iterator *impl,
-
314 struct icaltimetype end);
-
315
-
333LIBICAL_ICAL_EXPORT int icalrecur_iterator_set_range(icalrecur_iterator *impl,
-
334 struct icaltimetype from,
-
335 struct icaltimetype to);
-
336
-
340LIBICAL_ICAL_EXPORT struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *);
-
341
-
346LIBICAL_ICAL_EXPORT struct icaltimetype icalrecur_iterator_prev(icalrecur_iterator *);
-
347
-
349LIBICAL_ICAL_EXPORT void icalrecur_iterator_free(icalrecur_iterator *);
-
350
-
361LIBICAL_ICAL_EXPORT int icalrecur_expand_recurrence(const char *rule, icaltime_t start,
-
362 int count, icaltime_t *array);
-
363
-
364/* ical_invalid_rrule_handling :
-
365 * How should the ICAL library handle RRULEs with invalid BYxxx part combos?
-
366 */
-
367typedef enum ical_invalid_rrule_handling
-
368{
-
369 ICAL_RRULE_TREAT_AS_ERROR = 0,
-
370 ICAL_RRULE_IGNORE_INVALID = 1
-
371} ical_invalid_rrule_handling;
-
372
-
373LIBICAL_ICAL_EXPORT ical_invalid_rrule_handling ical_get_invalid_rrule_handling_setting(void);
-
374
-
375LIBICAL_ICAL_EXPORT void ical_set_invalid_rrule_handling_setting(
-
376 ical_invalid_rrule_handling newSetting);
-
377
-
378#endif /* ICALRECUR_H */
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalrecur.h
+
3  CREATOR: eric 20 March 2000
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ========================================================================*/
+
18 
+
66 #ifndef ICALRECUR_H
+
67 #define ICALRECUR_H
+
68 
+
69 #include "libical_ical_export.h"
+
70 #include "icalarray.h"
+
71 #include "icaltime.h"
+
72 
+
73 /*
+
74  * Recurrence enumerations
+
75  */
+
76 
+
77 typedef enum icalrecurrencetype_frequency
+
78 {
+
79  /* These enums are used to index an array, so don't change the
+
80  order or the integers */
+
81 
+
82  ICAL_SECONDLY_RECURRENCE = 0,
+
83  ICAL_MINUTELY_RECURRENCE = 1,
+
84  ICAL_HOURLY_RECURRENCE = 2,
+
85  ICAL_DAILY_RECURRENCE = 3,
+
86  ICAL_WEEKLY_RECURRENCE = 4,
+
87  ICAL_MONTHLY_RECURRENCE = 5,
+
88  ICAL_YEARLY_RECURRENCE = 6,
+
89  ICAL_NO_RECURRENCE = 7
+
90 } icalrecurrencetype_frequency;
+
91 
+
92 typedef enum icalrecurrencetype_weekday
+
93 {
+
94  ICAL_NO_WEEKDAY,
+
95  ICAL_SUNDAY_WEEKDAY,
+
96  ICAL_MONDAY_WEEKDAY,
+
97  ICAL_TUESDAY_WEEKDAY,
+
98  ICAL_WEDNESDAY_WEEKDAY,
+
99  ICAL_THURSDAY_WEEKDAY,
+
100  ICAL_FRIDAY_WEEKDAY,
+
101  ICAL_SATURDAY_WEEKDAY
+
102 } icalrecurrencetype_weekday;
+
103 
+
104 typedef enum icalrecurrencetype_skip
+
105 {
+
106  ICAL_SKIP_BACKWARD = 0,
+
107  ICAL_SKIP_FORWARD,
+
108  ICAL_SKIP_OMIT,
+
109  ICAL_SKIP_UNDEFINED
+
110 } icalrecurrencetype_skip;
+
111 
+
112 enum icalrecurrence_array_max_values
+
113 {
+
114  ICAL_RECURRENCE_ARRAY_MAX = 0x7f7f,
+
115  ICAL_RECURRENCE_ARRAY_MAX_BYTE = 0x7f
+
116 };
+
117 
+
118 /*
+
119  * Recurrence enumerations conversion routines.
+
120  */
+
121 
+
122 LIBICAL_ICAL_EXPORT icalrecurrencetype_frequency icalrecur_string_to_freq(const char *str);
+
123 LIBICAL_ICAL_EXPORT const char *icalrecur_freq_to_string(icalrecurrencetype_frequency kind);
+
124 
+
125 LIBICAL_ICAL_EXPORT icalrecurrencetype_skip icalrecur_string_to_skip(const char *str);
+
126 LIBICAL_ICAL_EXPORT const char *icalrecur_skip_to_string(icalrecurrencetype_skip kind);
+
127 
+
128 LIBICAL_ICAL_EXPORT const char *icalrecur_weekday_to_string(icalrecurrencetype_weekday kind);
+
129 LIBICAL_ICAL_EXPORT icalrecurrencetype_weekday icalrecur_string_to_weekday(const char *str);
+
130 
+
135 /* See RFC 5545 Section 3.3.10, RECUR Value, and RFC 7529
+
136  * for an explanation of the values and fields in struct icalrecurrencetype.
+
137  *
+
138  * The maximums below are based on lunisolar leap years (13 months)
+
139  */
+
140 #define ICAL_BY_SECOND_SIZE 62 /* 0 to 60 */
+
141 #define ICAL_BY_MINUTE_SIZE 61 /* 0 to 59 */
+
142 #define ICAL_BY_HOUR_SIZE 25 /* 0 to 23 */
+
143 #define ICAL_BY_MONTH_SIZE 14 /* 1 to 13 */
+
144 #define ICAL_BY_MONTHDAY_SIZE 32 /* 1 to 31 */
+
145 #define ICAL_BY_WEEKNO_SIZE 56 /* 1 to 55 */
+
146 #define ICAL_BY_YEARDAY_SIZE 386 /* 1 to 385 */
+
147 #define ICAL_BY_SETPOS_SIZE ICAL_BY_YEARDAY_SIZE /* 1 to N */
+
148 #define ICAL_BY_DAY_SIZE 7*(ICAL_BY_WEEKNO_SIZE-1)+1 /* 1 to N */
+
149 
+
151 struct icalrecurrencetype
+
152 {
+
153  icalrecurrencetype_frequency freq;
+
154 
+
155  /* until and count are mutually exclusive. */
+
156  struct icaltimetype until;
+
157  int count;
+
158 
+
159  short interval;
+
160 
+
161  icalrecurrencetype_weekday week_start;
+
162 
+
163  /* The BY* parameters can each take a list of values. Here I
+
164  * assume that the list of values will not be larger than the
+
165  * range of the value -- that is, the client will not name a
+
166  * value more than once.
+
167 
+
168  * Each of the lists is terminated with the value
+
169  * ICAL_RECURRENCE_ARRAY_MAX unless the list is full.
+
170  */
+
171 
+
172  short by_second[ICAL_BY_SECOND_SIZE];
+
173  short by_minute[ICAL_BY_MINUTE_SIZE];
+
174  short by_hour[ICAL_BY_HOUR_SIZE];
+
175  short by_day[ICAL_BY_DAY_SIZE];
+
185  short by_month_day[ICAL_BY_MONTHDAY_SIZE];
+
186  short by_year_day[ICAL_BY_YEARDAY_SIZE];
+
187  short by_week_no[ICAL_BY_WEEKNO_SIZE];
+
188  short by_month[ICAL_BY_MONTH_SIZE];
+
196  short by_set_pos[ICAL_BY_SETPOS_SIZE];
+
197 
+
198  /* For RSCALE extension (RFC 7529) */
+
199  char *rscale;
+
200  icalrecurrencetype_skip skip;
+
201 };
+
202 
+
203 #define ICALRECURRENCETYPE_INITIALIZER { \
+
204  ICAL_NO_RECURRENCE, /* freq */ \
+
205  ICALTIMETYPE_INITIALIZER, /* until */ \
+
206  0, /* count */ \
+
207  1, /* interval */ \
+
208  ICAL_MONDAY_WEEKDAY, /* week_start */ \
+
209  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_second */ \
+
210  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_minute */ \
+
211  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_hour */ \
+
212  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_day */ \
+
213  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_month_day */ \
+
214  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_year_day */ \
+
215  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_week_no */ \
+
216  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_month */ \
+
217  { ICAL_RECURRENCE_ARRAY_MAX_BYTE }, /* by_set_pos */ \
+
218  NULL, /* rscale */ \
+
219  ICAL_SKIP_OMIT /* skip */ \
+
220 }
+
221 
+
222 LIBICAL_ICAL_EXPORT int icalrecurrencetype_rscale_is_supported(void);
+
223 
+
224 LIBICAL_ICAL_EXPORT icalarray *icalrecurrencetype_rscale_supported_calendars(void);
+
225 
+
226 LIBICAL_ICAL_EXPORT void icalrecurrencetype_clear(struct icalrecurrencetype *r);
+
227 
+
228 /*
+
229  * Routines to decode the day values of the by_day array
+
230  */
+
231 
+
245 LIBICAL_ICAL_EXPORT enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week(short day);
+
246 
+
253 LIBICAL_ICAL_EXPORT int icalrecurrencetype_day_position(short day);
+
254 
+
255 /*
+
256  * Routines to decode the 'month' element of the by_month array
+
257  */
+
258 
+
259 LIBICAL_ICAL_EXPORT int icalrecurrencetype_month_is_leap(short month);
+
260 
+
261 LIBICAL_ICAL_EXPORT int icalrecurrencetype_month_month(short month);
+
262 
+
263 /*
+
264  * Recurrence rule parser
+
265  */
+
266 
+
268 LIBICAL_ICAL_EXPORT struct icalrecurrencetype icalrecurrencetype_from_string(const char *str);
+
269 
+
270 LIBICAL_ICAL_EXPORT char *icalrecurrencetype_as_string(struct icalrecurrencetype *recur);
+
271 
+
272 LIBICAL_ICAL_EXPORT char *icalrecurrencetype_as_string_r(struct icalrecurrencetype *recur);
+
273 
+
274 /*
+
275  * Recurrence iteration routines
+
276  */
+
277 
+
278 typedef struct icalrecur_iterator_impl icalrecur_iterator;
+
279 
+
281 LIBICAL_ICAL_EXPORT icalrecur_iterator *icalrecur_iterator_new(struct icalrecurrencetype rule,
+
282  struct icaltimetype dtstart);
+
283 
+
291 LIBICAL_ICAL_EXPORT int icalrecur_iterator_set_start(icalrecur_iterator *impl,
+
292  struct icaltimetype start);
+
293 
+
295 LIBICAL_ICAL_EXPORT struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *);
+
296 
+
298 LIBICAL_ICAL_EXPORT void icalrecur_iterator_free(icalrecur_iterator *);
+
299 
+
310 LIBICAL_ICAL_EXPORT int icalrecur_expand_recurrence(const char *rule, time_t start,
+
311  int count, time_t *array);
+
312 
+
313 #endif
icalarray.h
An array of arbitrarily-sized elements which grows dynamically as elements are added.
-
icalrecurrencetype_from_string
struct icalrecurrencetype icalrecurrencetype_from_string(const char *str)
Definition: icalrecur.c:634
-
icalrecur_iterator_free
void icalrecur_iterator_free(icalrecur_iterator *)
Definition: icalrecur.c:2051
-
icalrecurrencetype_encode_day
short icalrecurrencetype_encode_day(enum icalrecurrencetype_weekday weekday, int position)
Definition: icalrecur.c:3587
-
icalrecur_iterator_next
struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *)
Definition: icalrecur.c:3150
-
icalrecur_iterator_new
icalrecur_iterator * icalrecur_iterator_new(struct icalrecurrencetype rule, struct icaltimetype dtstart)
Definition: icalrecur.c:1931
-
icalrecurrencetype_month_is_leap
int icalrecurrencetype_month_is_leap(short month)
Definition: icalrecur.c:3592
-
icalrecur_expand_recurrence
int icalrecur_expand_recurrence(const char *rule, icaltime_t start, int count, icaltime_t *array)
Fills an array with the 'count' number of occurrences generated by the rrule.
Definition: icalrecur.c:3607
-
icalrecurrencetype_day_day_of_week
enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week(short day)
Decodes a day to a weekday.
Definition: icalrecur.c:3571
-
icalrecur_iterator_prev
struct icaltimetype icalrecur_iterator_prev(icalrecur_iterator *)
Definition: icalrecur.c:3226
-
icalrecurrencetype_day_position
int icalrecurrencetype_day_position(short day)
Decodes a day to a position of the weekday.
Definition: icalrecur.c:3576
-
icalrecurrencetype_encode_month
short icalrecurrencetype_encode_month(int month, int is_leap)
Definition: icalrecur.c:3602
-
icalrecur_iterator_set_start
int icalrecur_iterator_set_start(icalrecur_iterator *impl, struct icaltimetype start)
Definition: icalrecur.c:3461
-
icalrecur_iterator_set_end
int icalrecur_iterator_set_end(icalrecur_iterator *impl, struct icaltimetype end)
Definition: icalrecur.c:3487
-
ICAL_BY_SECOND_SIZE
#define ICAL_BY_SECOND_SIZE
Definition: icalrecur.h:132
-
icalrecur_iterator_set_range
int icalrecur_iterator_set_range(icalrecur_iterator *impl, struct icaltimetype from, struct icaltimetype to)
Definition: icalrecur.c:3498
+
icalrecur_expand_recurrence
int icalrecur_expand_recurrence(const char *rule, time_t start, int count, time_t *array)
Fills an array with the 'count' number of occurrences generated by the rrule.
Definition: icalrecur.c:3244
+
icalrecurrencetype_from_string
struct icalrecurrencetype icalrecurrencetype_from_string(const char *str)
Definition: icalrecur.c:555
+
icalrecur_iterator_free
void icalrecur_iterator_free(icalrecur_iterator *)
Definition: icalrecur.c:2065
+
icalrecur_iterator_next
struct icaltimetype icalrecur_iterator_next(icalrecur_iterator *)
Definition: icalrecur.c:2933
+
icalrecur_iterator_new
icalrecur_iterator * icalrecur_iterator_new(struct icalrecurrencetype rule, struct icaltimetype dtstart)
Definition: icalrecur.c:1952
+
icalrecurrencetype_day_day_of_week
enum icalrecurrencetype_weekday icalrecurrencetype_day_day_of_week(short day)
Decodes a day to a weekday.
Definition: icalrecur.c:3210
+
icalrecurrencetype_day_position
int icalrecurrencetype_day_position(short day)
Decodes a day to a position of the weekday.
Definition: icalrecur.c:3215
+
icalrecur_iterator_set_start
int icalrecur_iterator_set_start(icalrecur_iterator *impl, struct icaltimetype start)
Definition: icalrecur.c:3168
+
ICAL_BY_SECOND_SIZE
#define ICAL_BY_SECOND_SIZE
Definition: icalrecur.h:140
icaltime.h
struct icaltimetype is a pseudo-object that abstracts time handling.
-
_icalarray
Definition: icalarray.h:30
-
icalrecur_iterator_impl
Definition: icalrecur.c:933
-
icalrecurrencetype
Definition: icalrecur.h:144
-
icalrecurrencetype::by_day
short by_day[7 *(56 -1)+1]
Encoded value.
Definition: icalrecur.h:167
-
icalrecurrencetype::by_month
short by_month[14]
Encoded value.
Definition: icalrecur.h:180
-
icaltimetype
Definition: icaltime.h:97
-
icaltimetype::month
int month
Definition: icaltime.h:99
+
_icalarray
Definition: icalarray.h:36
+
icalrecur_iterator_impl
Definition: icalrecur.c:925
+
icalrecurrencetype
Definition: icalrecur.h:152
+
icalrecurrencetype::by_day
short by_day[7 *(56 -1)+1]
Encoded value.
Definition: icalrecur.h:175
+
icalrecurrencetype::by_month
short by_month[14]
Encoded value.
Definition: icalrecur.h:188
+
icaltimetype
Definition: icaltime.h:105
+
icaltimetype::month
int month
Definition: icaltime.h:107
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalrestriction_8h.html b/apidocs/icalrestriction_8h.html index 454a645d..20501ac8 100644 --- a/apidocs/icalrestriction_8h.html +++ b/apidocs/icalrestriction_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalrestriction.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Typedefs | Enumerations | Functions
-
icalrestriction.h File Reference
+
+
icalrestriction.h File Reference
@@ -79,13 +80,13 @@ $(function() {

Go to the source code of this file.

-

+

Typedefs

typedef enum icalrestriction_kind icalrestriction_kind
 The kinds of icalrestrictions there are. More...
 
-

+

Enumerations

enum  icalrestriction_kind {
  ICAL_RESTRICTION_NONE = 0 @@ -104,7 +105,7 @@ Enumerations
 The kinds of icalrestrictions there are. More...
 
- @@ -114,9 +115,9 @@ Functions

+

Functions

int icalrestriction_check (icalcomponent *comp)
 Checks if a given VCALENDAR meets all the restrictions imposed by the standard. More...
 

Detailed Description

-

Functions to check if an icalcomponent meets the restrictions imposed by the standard.

+

Functions to check if an icalcomponent meets the restrictions imposed by the standard.

Typedef Documentation

- +

◆ icalrestriction_kind

@@ -129,12 +130,12 @@ Functions

The kinds of icalrestrictions there are.

-

These must stay in this order for icalrestriction_compare to work

+

These must stay in this order for icalrestriction_compare to work

Enumeration Type Documentation

- +

◆ icalrestriction_kind

@@ -147,32 +148,32 @@ Functions

The kinds of icalrestrictions there are.

-

These must stay in this order for icalrestriction_compare to work

+

These must stay in this order for icalrestriction_compare to work

- - - - - - - - -
Enumerator
ICAL_RESTRICTION_NONE 

No restriction.

+
Enumerator
ICAL_RESTRICTION_NONE 

No restriction.

ICAL_RESTRICTION_ZERO 

Zero.

+
ICAL_RESTRICTION_ZERO 

Zero.

ICAL_RESTRICTION_ONE 

One.

+
ICAL_RESTRICTION_ONE 

One.

ICAL_RESTRICTION_ZEROPLUS 

Zero or more.

+
ICAL_RESTRICTION_ZEROPLUS 

Zero or more.

ICAL_RESTRICTION_ONEPLUS 

One or more.

+
ICAL_RESTRICTION_ONEPLUS 

One or more.

ICAL_RESTRICTION_ZEROORONE 

Zero or one.

+
ICAL_RESTRICTION_ZEROORONE 

Zero or one.

ICAL_RESTRICTION_ONEEXCLUSIVE 

Zero or one, exclusive with another property.

+
ICAL_RESTRICTION_ONEEXCLUSIVE 

Zero or one, exclusive with another property.

ICAL_RESTRICTION_ONEMUTUAL 

Zero or one, mutual with another property.

+
ICAL_RESTRICTION_ONEMUTUAL 

Zero or one, mutual with another property.

ICAL_RESTRICTION_UNKNOWN 

Unknown.

+
ICAL_RESTRICTION_UNKNOWN 

Unknown.

Function Documentation

- +

◆ icalrestriction_check()

@@ -197,17 +198,17 @@ Functions
Returns
1 if the restrictions are met, 0 if not
Error handling
Returns 0 and sets icalerrno if NULL is passed as comp, or if the component is not a VCALENDAR.
-
Example
icalcomponent *component = // ...
+
Example
icalcomponent *component = // ...
// check component
-
assert(icalrestriction_check(component) == true);
+
assert(icalrestriction_check(component) == true);
icalrestriction_check
int icalrestriction_check(icalcomponent *comp)
Checks if a given VCALENDAR meets all the restrictions imposed by the standard.
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
- +

◆ icalrestriction_compare()

@@ -242,8 +243,8 @@ Functions
Returns
1 if the restriction is met, 0 if not
-
Example
assert(icalrestriction_compare(ICALRESTRICTION_ONEPLUS, 5) == true);
-
assert(icalrestriction_compare(ICALRESTRICTION_NONE, 3) == false);
+
Example
assert(icalrestriction_compare(ICALRESTRICTION_ONEPLUS, 5) == true);
+
assert(icalrestriction_compare(ICALRESTRICTION_NONE, 3) == false);
icalrestriction_compare
int icalrestriction_compare(icalrestriction_kind restr, int count)
Checks if the given count is in accordance with the given restriction, restr.
@@ -252,7 +253,7 @@ Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalrestriction_8h_source.html b/apidocs/icalrestriction_8h_source.html index b95f8275..6e6e92a4 100644 --- a/apidocs/icalrestriction_8h_source.html +++ b/apidocs/icalrestriction_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalrestriction.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalrestriction.h
+
+
icalrestriction.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalrestriction.h
-
3 CREATOR: eric 24 April 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The original code is icalrestriction.h
-
10
-
11 Contributions from:
-
12 Graham Davison (g.m.davison@computer.org)
-
13======================================================================*/
-
14
-
15#ifndef ICALRESTRICTION_H
-
16#define ICALRESTRICTION_H
-
17
-
24#include "libical_ical_export.h"
-
25#include "icalcomponent.h"
-
26#include "icalproperty.h"
-
27
-
33typedef enum icalrestriction_kind
-
34{
-
36 ICAL_RESTRICTION_NONE = 0, /* 0 */
-
37
-
39 ICAL_RESTRICTION_ZERO, /* 1 */
-
40
-
42 ICAL_RESTRICTION_ONE, /* 2 */
-
43
-
45 ICAL_RESTRICTION_ZEROPLUS, /* 3 */
-
46
-
48 ICAL_RESTRICTION_ONEPLUS, /* 4 */
-
49
-
51 ICAL_RESTRICTION_ZEROORONE, /* 5 */
-
52
-
54 ICAL_RESTRICTION_ONEEXCLUSIVE, /* 6 */
-
55
-
57 ICAL_RESTRICTION_ONEMUTUAL, /* 7 */
-
58
-
60 ICAL_RESTRICTION_UNKNOWN /* 8 */
-
61} icalrestriction_kind;
-
62
-
76LIBICAL_ICAL_EXPORT int icalrestriction_compare(icalrestriction_kind restr, int count);
-
77
-
96LIBICAL_ICAL_EXPORT int icalrestriction_check(icalcomponent *comp);
-
97
-
98#endif /* !ICALRESTRICTION_H */
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalrestriction.h
+
3  CREATOR: eric 24 April 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The original code is icalrestriction.h
+
19 
+
20  Contributions from:
+
21  Graham Davison (g.m.davison@computer.org)
+
22 ======================================================================*/
+
23 
+
24 #ifndef ICALRESTRICTION_H
+
25 #define ICALRESTRICTION_H
+
26 
+
33 #include "libical_ical_export.h"
+
34 #include "icalcomponent.h"
+
35 #include "icalproperty.h"
+
36 
+
42 typedef enum icalrestriction_kind
+
43 {
+
45  ICAL_RESTRICTION_NONE = 0, /* 0 */
+
46 
+
48  ICAL_RESTRICTION_ZERO, /* 1 */
+
49 
+
51  ICAL_RESTRICTION_ONE, /* 2 */
+
52 
+
54  ICAL_RESTRICTION_ZEROPLUS, /* 3 */
+
55 
+
57  ICAL_RESTRICTION_ONEPLUS, /* 4 */
+
58 
+
60  ICAL_RESTRICTION_ZEROORONE, /* 5 */
+
61 
+
63  ICAL_RESTRICTION_ONEEXCLUSIVE, /* 6 */
+
64 
+
66  ICAL_RESTRICTION_ONEMUTUAL, /* 7 */
+
67 
+
69  ICAL_RESTRICTION_UNKNOWN /* 8 */
+
70 } icalrestriction_kind;
+
71 
+
85 LIBICAL_ICAL_EXPORT int icalrestriction_compare(icalrestriction_kind restr, int count);
+
86 
+
105 LIBICAL_ICAL_EXPORT int icalrestriction_check(icalcomponent *comp);
+
106 
+
107 #endif /* !ICALRESTRICTION_H */
icalrestriction_check
int icalrestriction_check(icalcomponent *comp)
Checks if a given VCALENDAR meets all the restrictions imposed by the standard.
-
icalrestriction_kind
icalrestriction_kind
The kinds of icalrestrictions there are.
Definition: icalrestriction.h:34
-
ICAL_RESTRICTION_ZEROPLUS
@ ICAL_RESTRICTION_ZEROPLUS
Definition: icalrestriction.h:45
-
ICAL_RESTRICTION_UNKNOWN
@ ICAL_RESTRICTION_UNKNOWN
Definition: icalrestriction.h:60
-
ICAL_RESTRICTION_ONE
@ ICAL_RESTRICTION_ONE
Definition: icalrestriction.h:42
-
ICAL_RESTRICTION_ONEEXCLUSIVE
@ ICAL_RESTRICTION_ONEEXCLUSIVE
Definition: icalrestriction.h:54
-
ICAL_RESTRICTION_ONEPLUS
@ ICAL_RESTRICTION_ONEPLUS
Definition: icalrestriction.h:48
-
ICAL_RESTRICTION_NONE
@ ICAL_RESTRICTION_NONE
Definition: icalrestriction.h:36
-
ICAL_RESTRICTION_ZEROORONE
@ ICAL_RESTRICTION_ZEROORONE
Definition: icalrestriction.h:51
-
ICAL_RESTRICTION_ONEMUTUAL
@ ICAL_RESTRICTION_ONEMUTUAL
Definition: icalrestriction.h:57
-
ICAL_RESTRICTION_ZERO
@ ICAL_RESTRICTION_ZERO
Definition: icalrestriction.h:39
+
icalrestriction_kind
icalrestriction_kind
The kinds of icalrestrictions there are.
Definition: icalrestriction.h:43
+
ICAL_RESTRICTION_ZEROPLUS
@ ICAL_RESTRICTION_ZEROPLUS
Definition: icalrestriction.h:54
+
ICAL_RESTRICTION_UNKNOWN
@ ICAL_RESTRICTION_UNKNOWN
Definition: icalrestriction.h:69
+
ICAL_RESTRICTION_ONE
@ ICAL_RESTRICTION_ONE
Definition: icalrestriction.h:51
+
ICAL_RESTRICTION_ONEEXCLUSIVE
@ ICAL_RESTRICTION_ONEEXCLUSIVE
Definition: icalrestriction.h:63
+
ICAL_RESTRICTION_ONEPLUS
@ ICAL_RESTRICTION_ONEPLUS
Definition: icalrestriction.h:57
+
ICAL_RESTRICTION_NONE
@ ICAL_RESTRICTION_NONE
Definition: icalrestriction.h:45
+
ICAL_RESTRICTION_ZEROORONE
@ ICAL_RESTRICTION_ZEROORONE
Definition: icalrestriction.h:60
+
ICAL_RESTRICTION_ONEMUTUAL
@ ICAL_RESTRICTION_ONEMUTUAL
Definition: icalrestriction.h:66
+
ICAL_RESTRICTION_ZERO
@ ICAL_RESTRICTION_ZERO
Definition: icalrestriction.h:48
icalrestriction_compare
int icalrestriction_compare(icalrestriction_kind restr, int count)
Checks if the given count is in accordance with the given restriction, restr.
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalset_8h.html b/apidocs/icalset_8h.html index 62d916b2..aef75d46 100644 --- a/apidocs/icalset_8h.html +++ b/apidocs/icalset_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalset.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Enumerations | Functions | Variables
-
icalset.h File Reference
+
+
icalset.h File Reference

Go to the source code of this file.

-

+

Data Structures

struct  icalset_impl
 
struct  icalsetiter
 
- - - -

+

Typedefs

+
typedef struct icalset_impl icalset
 
+
typedef enum icalset_kind icalset_kind
 
+
typedef struct icalsetiter icalsetiter
 
- -

+

Enumerations

enum  icalset_kind { ICAL_FILE_SET +
enum  icalset_kind { ICAL_FILE_SET , ICAL_DIR_SET , ICAL_BDB_SET }
 
- - - - - - - + + - + - - - + + - - + - - + - - - - + + + - - + - - + - - + - - + - - + + - - - - - - + + + - - - - + + + - +

+

Functions

+
icalerrorenum icalset_add_component (icalset *set, icalcomponent *comp)
 
+
icalsetiter icalset_begin_component (icalset *set, icalcomponent_kind kind, icalgauge *gauge, const char *tzid)
 
icalerrorenum icalset_commit (icalset *set)
 
+
int icalset_count_components (icalset *set, icalcomponent_kind kind)
 
icalcomponent * icalset_fetch (icalset *set, const char *uid)
 
+
icalcomponent * icalset_fetch (icalset *set, const char *uid)
 
icalcomponent * icalset_fetch_match (icalset *set, icalcomponent *c)
 
 
void icalset_free (icalset *set)
 
icalcomponent * icalset_get_current_component (icalset *set)
 
+
icalcomponent * icalset_get_current_component (icalset *set)
 
icalcomponent * icalset_get_first_component (icalset *set)
 
+
 
icalcomponent * icalset_get_next_component (icalset *set)
 
+
 
int icalset_has_uid (icalset *set, const char *uid)
 
void icalset_mark (icalset *set)
 
icalerrorenum icalset_modify (icalset *set, icalcomponent *oldc, icalcomponent *newc)
 
icalset * icalset_new (icalset_kind kind, const char *dsn, void *options)
 Generic icalset constructor. More...
 
+
icalset * icalset_new (icalset_kind kind, const char *dsn, void *options)
 Generic icalset constructor. More...
 
icalset * icalset_new_dir (const char *path)
 
+
 
icalset * icalset_new_file (const char *path)
 
+
 
icalset * icalset_new_file_reader (const char *path)
 
+
 
icalset * icalset_new_file_writer (const char *path)
 
+
 
const char * icalset_path (icalset *set)
 
-int icalset_register_class (icalset *set)
 
+int icalset_register_class (icalset *set)
 Registers a new derived class.
 
+
icalerrorenum icalset_remove_component (icalset *set, icalcomponent *comp)
 
icalerrorenum icalset_select (icalset *set, icalgauge *gauge)
 
+
icalcomponent * icalsetiter_deref (icalsetiter *i)
 
icalcomponent * icalsetiter_next (icalsetiter *i)
 
+
 
icalcomponent * icalsetiter_next (icalsetiter *i)
 
icalcomponent * icalsetiter_prior (icalsetiter *i)
 
icalcomponent * icalsetiter_to_next (icalset *set, icalsetiter *i)
 
+
 
icalcomponent * icalsetiter_to_next (icalset *set, icalsetiter *i)
 
icalcomponent * icalsetiter_to_prior (icalset *set, icalsetiter *i)
 
 
- @@ -189,9 +190,9 @@ Variables

Detailed Description

Author
eric 28 November 1999

Icalset is the "base class" for representations of a collection of iCal components. Derived classes (actually delegatees) include:

-

icalfileset Store components in a single file icaldirset Store components in multiple files in a directory icalbdbset Store components in a Berkeley DB File icalheapset Store components on the heap icalmysqlset Store components in a mysql database.

+

icalfileset Store components in a single file icaldirset Store components in multiple files in a directory icalbdbset Store components in a Berkeley DB File icalheapset Store components on the heap icalmysqlset Store components in a mysql database.

Function Documentation

- +

◆ icalset_commit()

@@ -206,18 +207,18 @@ Variables

+

Variables

icalsetiter icalsetiter_null
 
-

Writes changes to disk immediately

+

Writes changes to disk immediately

- -

◆ icalset_fetch()

+ +

◆ icalset_fetch()

- + @@ -235,11 +236,11 @@ Variables
icalcomponent * icalset_fetch icalcomponent* icalset_fetch ( icalset *  set,
-

Gets a component by uid

+

Gets a component by uid

- +

◆ icalset_free()

@@ -254,18 +255,18 @@ Variables
-

Frees the memory associated with this icalset automatically calls the implementation specific free routine

+

Frees the memory associated with this icalset automatically calls the implementation specific free routine

- -

◆ icalset_get_current_component()

+ +

◆ icalset_get_current_component()

- + @@ -273,11 +274,11 @@ Variables
icalcomponent * icalset_get_current_component icalcomponent* icalset_get_current_component ( icalset *  set)
-

Iterates through the components. If a gauge has been defined, these will skip over components that do not pass the gauge

+

Iterates through the components. If a gauge has been defined, these will skip over components that do not pass the gauge

- +

◆ icalset_mark()

@@ -292,11 +293,11 @@ Variables
-

Marks the cluster as changed, so it will be written to disk when it is freed.

+

Marks the cluster as changed, so it will be written to disk when it is freed.

- +

◆ icalset_modify()

@@ -327,18 +328,18 @@ Variables
-

Modifies components according to the MODIFY method of CAP. Works on the currently selected components.

+

Modifies components according to the MODIFY method of CAP. Works on the currently selected components.

- -

◆ icalset_new()

+ +

◆ icalset_new()

- + @@ -374,12 +375,12 @@ Variables
Returns
A valid icalset reference or NULL if error.

This creates any of the icalset types available.

-

unimplemented

-

call the implementation specific initializer

+

unimplemented

+

call the implementation specific initializer

- +

◆ icalset_select()

@@ -404,18 +405,18 @@ Variables
icalset * icalset_new icalset* icalset_new ( icalset_kind  kind,
-

Restricts the component returned by icalset_first, _next to those that pass the gauge.

+

Restricts the component returned by icalset_first, _next to those that pass the gauge.

- -

◆ icalsetiter_next()

+ +

◆ icalsetiter_next()

- + @@ -423,18 +424,18 @@ Variables
icalcomponent * icalsetiter_next icalcomponent* icalsetiter_next ( icalsetiter *  i)
-

Default _next, _prior, _deref for subclasses that use single cluster

+

Default _next, _prior, _deref for subclasses that use single cluster

- -

◆ icalsetiter_to_next()

+ +

◆ icalsetiter_to_next()

- + @@ -452,12 +453,12 @@ Variables
icalcomponent * icalsetiter_to_next icalcomponent* icalsetiter_to_next ( icalset *  set,
-

for subclasses that use multiple clusters that require specialized cluster traversal

+

for subclasses that use multiple clusters that require specialized cluster traversal

Variable Documentation

- +

◆ icalsetiter_null

@@ -476,14 +477,14 @@ Variables
-

External Iterator with gauge - for thread safety

+

External Iterator with gauge - for thread safety

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalset_8h_source.html b/apidocs/icalset_8h_source.html index 01fefda3..44b27b77 100644 --- a/apidocs/icalset_8h_source.html +++ b/apidocs/icalset_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalset.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalset.h
+
+
icalset.h
-Go to the documentation of this file.
1
-
15/*
-
16
-
17 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
18
-
19 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
20
-
21 The Original Code is eric. The Initial Developer of the Original
-
22 Code is Eric Busboom
-
23======================================================================*/
-
24
-
25#ifndef ICALSET_H
-
26#define ICALSET_H
-
27
-
28#include "libical_icalss_export.h"
-
29#include "icalgauge.h"
-
30#include "icalcomponent.h"
-
31#include "icalerror.h"
-
32
-
33typedef struct icalset_impl icalset;
-
34
-
35typedef enum icalset_kind
-
36{
-
37 ICAL_FILE_SET,
-
38 ICAL_DIR_SET,
-
39 ICAL_BDB_SET
-
40} icalset_kind;
-
41
-
42typedef struct icalsetiter
-
43{
-
44 icalcompiter iter; /* icalcomponent_kind, pvl_elem iter */
-
45 icalgauge *gauge;
-
46 icalrecur_iterator *ritr; /*the last iterator */
-
47 icalcomponent *last_component; /*the pending recurring component to be processed */
-
48 const char *tzid; /* the calendar's timezone id */
-
49} icalsetiter;
-
50
-
51struct icalset_impl
-
52{
-
53 icalset_kind kind;
-
54 size_t size;
-
55 char *dsn;
-
56 icalset *(*init) (icalset *set, const char *dsn, void *options);
-
57 void (*free) (icalset *set);
-
58 const char *(*path) (icalset *set);
-
59 void (*mark) (icalset *set);
-
60 icalerrorenum(*commit) (icalset *set);
-
61 icalerrorenum(*add_component) (icalset *set, icalcomponent *comp);
-
62 icalerrorenum(*remove_component) (icalset *set, icalcomponent *comp);
-
63 int (*count_components) (icalset *set, icalcomponent_kind kind);
-
64 icalerrorenum(*select) (icalset *set, icalgauge *gauge);
-
65 void (*clear) (icalset *set);
-
66 icalcomponent *(*fetch) (icalset *set, icalcomponent_kind kind, const char *uid);
-
67 icalcomponent *(*fetch_match) (icalset *set, icalcomponent *comp);
-
68 int (*has_uid) (icalset *set, const char *uid);
-
69 icalerrorenum(*modify) (icalset *set, icalcomponent *old, icalcomponent *newc);
-
70 icalcomponent *(*get_current_component) (icalset *set);
-
71 icalcomponent *(*get_first_component) (icalset *set);
-
72 icalcomponent *(*get_next_component) (icalset *set);
-
73 icalsetiter(*icalset_begin_component) (icalset *set,
-
74 icalcomponent_kind kind, icalgauge *gauge,
-
75 const char *tzid);
-
76 icalcomponent *(*icalsetiter_to_next) (icalset *set, icalsetiter *i);
-
77 icalcomponent *(*icalsetiter_to_prior) (icalset *set, icalsetiter *i);
-
78};
-
79
-
81LIBICAL_ICALSS_EXPORT int icalset_register_class(icalset *set);
-
82
-
94LIBICAL_ICALSS_EXPORT icalset *icalset_new(icalset_kind kind, const char *dsn, void *options);
-
95
-
96LIBICAL_ICALSS_EXPORT icalset *icalset_new_file(const char *path);
-
97
-
98LIBICAL_ICALSS_EXPORT icalset *icalset_new_file_reader(const char *path);
-
99
-
100LIBICAL_ICALSS_EXPORT icalset *icalset_new_file_writer(const char *path);
-
101
-
102LIBICAL_ICALSS_EXPORT icalset *icalset_new_dir(const char *path);
-
103
-
108LIBICAL_ICALSS_EXPORT void icalset_free(icalset *set);
-
109
-
110LIBICAL_ICALSS_EXPORT const char *icalset_path(icalset *set);
-
111
-
114LIBICAL_ICALSS_EXPORT void icalset_mark(icalset *set);
-
115
-
117LIBICAL_ICALSS_EXPORT icalerrorenum icalset_commit(icalset *set);
-
118
-
119LIBICAL_ICALSS_EXPORT icalerrorenum icalset_add_component(icalset *set, icalcomponent *comp);
-
120
-
121LIBICAL_ICALSS_EXPORT icalerrorenum icalset_remove_component(icalset *set, icalcomponent *comp);
-
122
-
123LIBICAL_ICALSS_EXPORT int icalset_count_components(icalset *set, icalcomponent_kind kind);
-
124
-
127LIBICAL_ICALSS_EXPORT icalerrorenum icalset_select(icalset *set, icalgauge *gauge);
-
128
-
130LIBICAL_ICALSS_EXPORT icalcomponent *icalset_fetch(icalset *set, const char *uid);
-
131
-
132LIBICAL_ICALSS_EXPORT int icalset_has_uid(icalset *set, const char *uid);
-
133
-
134LIBICAL_ICALSS_EXPORT icalcomponent *icalset_fetch_match(icalset *set, icalcomponent *c);
-
135
-
138LIBICAL_ICALSS_EXPORT icalerrorenum icalset_modify(icalset *set,
-
139 icalcomponent *oldc, icalcomponent *newc);
-
140
-
144LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_current_component(icalset *set);
-
145
-
146LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_first_component(icalset *set);
-
147
-
148LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_next_component(icalset *set);
-
149
-
151LIBICAL_ICALSS_EXPORT extern icalsetiter icalsetiter_null;
-
152
-
153LIBICAL_ICALSS_EXPORT icalsetiter icalset_begin_component(icalset *set,
-
154 icalcomponent_kind kind,
-
155 icalgauge *gauge, const char *tzid);
-
156
-
158LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_next(icalsetiter *i);
-
159
-
160LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_prior(icalsetiter *i);
-
161
-
162LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_deref(icalsetiter *i);
-
163
-
165LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_to_next(icalset *set, icalsetiter *i);
-
166
-
167LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_to_prior(icalset *set, icalsetiter *i);
-
168
-
169#endif /* !ICALSET_H */
+Go to the documentation of this file.
1 
+
15 /*
+
16 
+
17  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
18 
+
19  This library is free software; you can redistribute it and/or modify
+
20  it under the terms of either:
+
21 
+
22  The LGPL as published by the Free Software Foundation, version
+
23  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
24 
+
25  Or:
+
26 
+
27  The Mozilla Public License Version 2.0. You may obtain a copy of
+
28  the License at https://www.mozilla.org/MPL/
+
29 
+
30  The Original Code is eric. The Initial Developer of the Original
+
31  Code is Eric Busboom
+
32 ======================================================================*/
+
33 
+
34 #ifndef ICALSET_H
+
35 #define ICALSET_H
+
36 
+
37 #include "libical_icalss_export.h"
+
38 #include "icalgauge.h"
+
39 #include "icalcomponent.h"
+
40 #include "icalerror.h"
+
41 
+
42 typedef struct icalset_impl icalset;
+
43 
+
44 typedef enum icalset_kind
+
45 {
+
46  ICAL_FILE_SET,
+
47  ICAL_DIR_SET,
+
48  ICAL_BDB_SET
+
49 } icalset_kind;
+
50 
+
51 typedef struct icalsetiter
+
52 {
+
53  icalcompiter iter; /* icalcomponent_kind, pvl_elem iter */
+
54  icalgauge *gauge;
+
55  icalrecur_iterator *ritr; /*the last iterator */
+
56  icalcomponent *last_component; /*the pending recurring component to be processed */
+
57  const char *tzid; /* the calendar's timezone id */
+
58 } icalsetiter;
+
59 
+
60 struct icalset_impl
+
61 {
+
62  icalset_kind kind;
+
63  size_t size;
+
64  char *dsn;
+
65  icalset *(*init) (icalset *set, const char *dsn, void *options);
+
66  void (*free) (icalset *set);
+
67  const char *(*path) (icalset *set);
+
68  void (*mark) (icalset *set);
+
69  icalerrorenum(*commit) (icalset *set);
+
70  icalerrorenum(*add_component) (icalset *set, icalcomponent *comp);
+
71  icalerrorenum(*remove_component) (icalset *set, icalcomponent *comp);
+
72  int (*count_components) (icalset *set, icalcomponent_kind kind);
+
73  icalerrorenum(*select) (icalset *set, icalgauge *gauge);
+
74  void (*clear) (icalset *set);
+
75  icalcomponent *(*fetch) (icalset *set, icalcomponent_kind kind, const char *uid);
+
76  icalcomponent *(*fetch_match) (icalset *set, icalcomponent *comp);
+
77  int (*has_uid) (icalset *set, const char *uid);
+
78  icalerrorenum(*modify) (icalset *set, icalcomponent *old, icalcomponent *newc);
+
79  icalcomponent *(*get_current_component) (icalset *set);
+
80  icalcomponent *(*get_first_component) (icalset *set);
+
81  icalcomponent *(*get_next_component) (icalset *set);
+
82  icalsetiter(*icalset_begin_component) (icalset *set,
+
83  icalcomponent_kind kind, icalgauge *gauge,
+
84  const char *tzid);
+
85  icalcomponent *(*icalsetiter_to_next) (icalset *set, icalsetiter *i);
+
86  icalcomponent *(*icalsetiter_to_prior) (icalset *set, icalsetiter *i);
+
87 };
+
88 
+
90 LIBICAL_ICALSS_EXPORT int icalset_register_class(icalset *set);
+
91 
+
103 LIBICAL_ICALSS_EXPORT icalset *icalset_new(icalset_kind kind, const char *dsn, void *options);
+
104 
+
105 LIBICAL_ICALSS_EXPORT icalset *icalset_new_file(const char *path);
+
106 
+
107 LIBICAL_ICALSS_EXPORT icalset *icalset_new_file_reader(const char *path);
+
108 
+
109 LIBICAL_ICALSS_EXPORT icalset *icalset_new_file_writer(const char *path);
+
110 
+
111 LIBICAL_ICALSS_EXPORT icalset *icalset_new_dir(const char *path);
+
112 
+
117 LIBICAL_ICALSS_EXPORT void icalset_free(icalset *set);
+
118 
+
119 LIBICAL_ICALSS_EXPORT const char *icalset_path(icalset *set);
+
120 
+
123 LIBICAL_ICALSS_EXPORT void icalset_mark(icalset *set);
+
124 
+
126 LIBICAL_ICALSS_EXPORT icalerrorenum icalset_commit(icalset *set);
+
127 
+
128 LIBICAL_ICALSS_EXPORT icalerrorenum icalset_add_component(icalset *set, icalcomponent *comp);
+
129 
+
130 LIBICAL_ICALSS_EXPORT icalerrorenum icalset_remove_component(icalset *set, icalcomponent *comp);
+
131 
+
132 LIBICAL_ICALSS_EXPORT int icalset_count_components(icalset *set, icalcomponent_kind kind);
+
133 
+
136 LIBICAL_ICALSS_EXPORT icalerrorenum icalset_select(icalset *set, icalgauge *gauge);
+
137 
+
139 LIBICAL_ICALSS_EXPORT icalcomponent *icalset_fetch(icalset *set, const char *uid);
+
140 
+
141 LIBICAL_ICALSS_EXPORT int icalset_has_uid(icalset *set, const char *uid);
+
142 
+
143 LIBICAL_ICALSS_EXPORT icalcomponent *icalset_fetch_match(icalset *set, icalcomponent *c);
+
144 
+
147 LIBICAL_ICALSS_EXPORT icalerrorenum icalset_modify(icalset *set,
+
148  icalcomponent *oldc, icalcomponent *newc);
+
149 
+
153 LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_current_component(icalset *set);
+
154 
+
155 LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_first_component(icalset *set);
+
156 
+
157 LIBICAL_ICALSS_EXPORT icalcomponent *icalset_get_next_component(icalset *set);
+
158 
+
160 LIBICAL_ICALSS_EXPORT extern icalsetiter icalsetiter_null;
+
161 
+
162 LIBICAL_ICALSS_EXPORT icalsetiter icalset_begin_component(icalset *set,
+
163  icalcomponent_kind kind,
+
164  icalgauge *gauge, const char *tzid);
+
165 
+
167 LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_next(icalsetiter *i);
+
168 
+
169 LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_prior(icalsetiter *i);
+
170 
+
171 LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_deref(icalsetiter *i);
+
172 
+
174 LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_to_next(icalset *set, icalsetiter *i);
+
175 
+
176 LIBICAL_ICALSS_EXPORT icalcomponent *icalsetiter_to_prior(icalset *set, icalsetiter *i);
+
177 
+
178 #endif /* !ICALSET_H */
icalerror.h
Error handling for libical.
-
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:67
+
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:76
icalgauge.h
Routines implementing a filter for ical components.
-
icalset_select
icalerrorenum icalset_select(icalset *set, icalgauge *gauge)
Definition: icalset.c:405
-
icalset_free
void icalset_free(icalset *set)
Definition: icalset.c:362
-
icalset_commit
icalerrorenum icalset_commit(icalset *set)
Definition: icalset.c:385
-
icalset_mark
void icalset_mark(icalset *set)
Definition: icalset.c:380
-
icalsetiter_next
icalcomponent * icalsetiter_next(icalsetiter *i)
Definition: icalset.c:459
+
icalset_new
icalset * icalset_new(icalset_kind kind, const char *dsn, void *options)
Generic icalset constructor.
Definition: icalset.c:240
+
icalset_select
icalerrorenum icalset_select(icalset *set, icalgauge *gauge)
Definition: icalset.c:414
+
icalset_free
void icalset_free(icalset *set)
Definition: icalset.c:371
+
icalset_commit
icalerrorenum icalset_commit(icalset *set)
Definition: icalset.c:394
+
icalset_mark
void icalset_mark(icalset *set)
Definition: icalset.c:389
icalset_register_class
int icalset_register_class(icalset *set)
Registers a new derived class.
-
icalset_get_current_component
icalcomponent * icalset_get_current_component(icalset *set)
Definition: icalset.c:435
-
icalsetiter_to_next
icalcomponent * icalsetiter_to_next(icalset *set, icalsetiter *i)
Definition: icalset.c:498
-
icalsetiter_null
icalsetiter icalsetiter_null
Definition: icalset.c:450
-
icalset_fetch
icalcomponent * icalset_fetch(icalset *set, const char *uid)
Definition: icalset.c:415
-
icalset_new
icalset * icalset_new(icalset_kind kind, const char *dsn, void *options)
Generic icalset constructor.
Definition: icalset.c:231
-
icalset_modify
icalerrorenum icalset_modify(icalset *set, icalcomponent *oldc, icalcomponent *newc)
Definition: icalset.c:430
-
icalcompiter
Definition: icalcomponent.h:29
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-
icalrecur_iterator_impl
Definition: icalrecur.c:933
-
icalset_impl
Definition: icalset.h:52
-
icalsetiter
Definition: icalset.h:43
+
icalset_fetch
icalcomponent * icalset_fetch(icalset *set, const char *uid)
Definition: icalset.c:424
+
icalsetiter_to_next
icalcomponent * icalsetiter_to_next(icalset *set, icalsetiter *i)
Definition: icalset.c:507
+
icalsetiter_null
icalsetiter icalsetiter_null
Definition: icalset.c:459
+
icalset_get_current_component
icalcomponent * icalset_get_current_component(icalset *set)
Definition: icalset.c:444
+
icalsetiter_next
icalcomponent * icalsetiter_next(icalsetiter *i)
Definition: icalset.c:468
+
icalset_modify
icalerrorenum icalset_modify(icalset *set, icalcomponent *oldc, icalcomponent *newc)
Definition: icalset.c:439
+
icalcompiter
Definition: icalcomponent.h:36
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalgauge_impl
Definition: icalgaugeimpl.h:55
+
icalrecur_iterator_impl
Definition: icalrecur.c:925
+
icalset_impl
Definition: icalset.h:61
+
icalsetiter
Definition: icalset.h:52
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalspanlist_8h.html b/apidocs/icalspanlist_8h.html index 6aebc897..8a208652 100644 --- a/apidocs/icalspanlist_8h.html +++ b/apidocs/icalspanlist_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalspanlist.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
icalspanlist.h File Reference
+
+
icalspanlist.h File Reference
@@ -78,47 +79,47 @@ $(function() {

Go to the source code of this file.

- -

+

Typedefs

+
typedef struct icalspanlist_impl icalspanlist
 
- - - - - - - + + + + + + - - - - - - + + + + + +

+

Functions

int * icalspanlist_as_freebusy_matrix (icalspanlist *span, int delta_t)
 Returns an hour-by-hour array of free/busy times over a given period. More...
 
icalcomponent * icalspanlist_as_vfreebusy (icalspanlist *sl, const char *organizer, const char *attendee)
 Returns a VFREEBUSY component for a spanlist. More...
 
int * icalspanlist_as_freebusy_matrix (icalspanlist *span, int delta_t)
 Returns an hour-by-hour array of free/busy times over a given period. More...
 
icalcomponent * icalspanlist_as_vfreebusy (icalspanlist *sl, const char *organizer, const char *attendee)
 Returns a VFREEBUSY component for a spanlist. More...
 
void icalspanlist_dump (icalspanlist *sl)
 (Debug) print out spanlist to STDOUT. More...
 
void icalspanlist_free (icalspanlist *sl)
 Destructor. More...
 
icalspanlist * icalspanlist_from_vfreebusy (icalcomponent *comp)
 Constructs an icalspanlist from a VFREEBUSY component. More...
 
icalspanlist * icalspanlist_new (icalset *set, struct icaltimetype start, struct icaltimetype end)
 Makes a free list from a set of VEVENT components. More...
 
icalspanlist * icalspanlist_from_vfreebusy (icalcomponent *comp)
 Constructs an icalspanlist from a VFREEBUSY component. More...
 
icalspanlist * icalspanlist_new (icalset *set, struct icaltimetype start, struct icaltimetype end)
 Makes a free list from a set of VEVENT components. More...
 
struct icalperiodtype icalspanlist_next_free_time (icalspanlist *sl, struct icaltimetype t)
 Finds the next free time span in a spanlist. More...
 

Detailed Description

-

Code that supports collections of free/busy spans of time.

+

Code that supports collections of free/busy spans of time.

Function Documentation

- -

◆ icalspanlist_as_freebusy_matrix()

+ +

◆ icalspanlist_as_freebusy_matrix()

- + @@ -147,18 +148,18 @@ Functions
Returns
A pointer to an array of integers containing the number of busy events in each delta_t time period. The final entry contains the value -1.

This calculation is somewhat tricky. This is due to the fact that the time range contains the start time, but does not contain the end time. To perform a proper calculation we subtract one second off the end times to get a true containing time.

-

Also note that if you supplying a spanlist that does not start or end on a time boundary divisible by delta_t you may get results that are not quite what you expect.

+

Also note that if you supplying a spanlist that does not start or end on a time boundary divisible by delta_t you may get results that are not quite what you expect.

- -

◆ icalspanlist_as_vfreebusy()

+ +

◆ icalspanlist_as_vfreebusy()

int * icalspanlist_as_freebusy_matrix int* icalspanlist_as_freebusy_matrix ( icalspanlist *  span,
- + @@ -186,7 +187,7 @@ Functions

Returns a VFREEBUSY component for a spanlist.

Parameters
icalcomponent * icalspanlist_as_vfreebusy icalcomponent* icalspanlist_as_vfreebusy ( icalspanlist *  sl,
- +
slA valid icalspanlist, from icalspanlist_new()
slA valid icalspanlist, from icalspanlist_new()
organizerThe organizer specified as "MAILTO:user@domain"
attendeeThe attendee specified as "MAILTO:user@domain"
@@ -197,7 +198,7 @@ Functions
- +

◆ icalspanlist_dump()

@@ -223,7 +224,7 @@ Functions
- +

◆ icalspanlist_free()

@@ -250,14 +251,14 @@ Functions
- -

◆ icalspanlist_from_vfreebusy()

+ +

◆ icalspanlist_from_vfreebusy()

- + @@ -267,7 +268,7 @@ Functions

Constructs an icalspanlist from a VFREEBUSY component.

-

Constructs an icalspanlist from the VFREEBUSY component of an icalcomponent.

+

Constructs an icalspanlist from the VFREEBUSY component of an icalcomponent.

Parameters
icalspanlist * icalspanlist_from_vfreebusy icalspanlist* icalspanlist_from_vfreebusy ( icalcomponent *  comp)
@@ -278,14 +279,14 @@ Functions - -

◆ icalspanlist_new()

+ +

◆ icalspanlist_new()

compA valid icalcomponent.
- + @@ -324,7 +325,7 @@ Functions - +

◆ icalspanlist_next_free_time()

@@ -365,7 +366,7 @@ Functions
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalspanlist_8h_source.html b/apidocs/icalspanlist_8h_source.html index 5735a0bb..a75f061e 100644 --- a/apidocs/icalspanlist_8h_source.html +++ b/apidocs/icalspanlist_8h_source.html @@ -2,8 +2,8 @@ - - + +Libical API Documentation: icalspanlist.h Source File @@ -19,9 +19,10 @@
icalspanlist * icalspanlist_new icalspanlist* icalspanlist_new ( icalset *  set,
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalspanlist.h
+
+
icalspanlist.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalspanlist.h
-
3 CREATOR: eric 21 Aug 2000
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9=========================================================================*/
-
10#ifndef ICALSPANLIST_H
-
11#define ICALSPANLIST_H
-
12
-
13#include "libical_icalss_export.h"
-
14#include "icalset.h"
-
15
-
20typedef struct icalspanlist_impl icalspanlist;
-
21
-
34LIBICAL_ICALSS_EXPORT icalspanlist *icalspanlist_new(icalset *set,
-
35 struct icaltimetype start,
-
36 struct icaltimetype end);
-
37
-
43LIBICAL_ICALSS_EXPORT void icalspanlist_free(icalspanlist *sl);
-
44
-
53LIBICAL_ICALSS_EXPORT struct icalperiodtype icalspanlist_next_free_time(icalspanlist *sl,
-
54 struct icaltimetype t);
-
55
-
59LIBICAL_ICALSS_EXPORT void icalspanlist_dump(icalspanlist *sl);
-
60
-
75LIBICAL_ICALSS_EXPORT icalcomponent *icalspanlist_as_vfreebusy(icalspanlist *sl,
-
76 const char *organizer,
-
77 const char *attendee);
-
78
-
98LIBICAL_ICALSS_EXPORT int *icalspanlist_as_freebusy_matrix(icalspanlist *span, int delta_t);
-
99
-
109LIBICAL_ICALSS_EXPORT icalspanlist *icalspanlist_from_vfreebusy(icalcomponent *comp);
-
110
-
111#endif
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalspanlist.h
+
3  CREATOR: eric 21 Aug 2000
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 =========================================================================*/
+
18 #ifndef ICALSPANLIST_H
+
19 #define ICALSPANLIST_H
+
20 
+
21 #include "libical_icalss_export.h"
+
22 #include "icalset.h"
+
23 
+
28 typedef struct icalspanlist_impl icalspanlist;
+
29 
+
42 LIBICAL_ICALSS_EXPORT icalspanlist *icalspanlist_new(icalset *set,
+
43  struct icaltimetype start,
+
44  struct icaltimetype end);
+
45 
+
51 LIBICAL_ICALSS_EXPORT void icalspanlist_free(icalspanlist *sl);
+
52 
+
61 LIBICAL_ICALSS_EXPORT struct icalperiodtype icalspanlist_next_free_time(icalspanlist *sl,
+
62  struct icaltimetype t);
+
63 
+
67 LIBICAL_ICALSS_EXPORT void icalspanlist_dump(icalspanlist *sl);
+
68 
+
83 LIBICAL_ICALSS_EXPORT icalcomponent *icalspanlist_as_vfreebusy(icalspanlist *sl,
+
84  const char *organizer,
+
85  const char *attendee);
+
86 
+
106 LIBICAL_ICALSS_EXPORT int *icalspanlist_as_freebusy_matrix(icalspanlist *span, int delta_t);
+
107 
+
117 LIBICAL_ICALSS_EXPORT icalspanlist *icalspanlist_from_vfreebusy(icalcomponent *comp);
+
118 
+
119 #endif
-
icalspanlist_dump
void icalspanlist_dump(icalspanlist *sl)
(Debug) print out spanlist to STDOUT.
Definition: icalspanlist.c:202
-
icalspanlist_as_freebusy_matrix
int * icalspanlist_as_freebusy_matrix(icalspanlist *span, int delta_t)
Returns an hour-by-hour array of free/busy times over a given period.
Definition: icalspanlist.c:282
-
icalspanlist_from_vfreebusy
icalspanlist * icalspanlist_from_vfreebusy(icalcomponent *comp)
Constructs an icalspanlist from a VFREEBUSY component.
Definition: icalspanlist.c:394
-
icalspanlist_free
void icalspanlist_free(icalspanlist *sl)
Destructor.
Definition: icalspanlist.c:184
-
icalspanlist_new
icalspanlist * icalspanlist_new(icalset *set, struct icaltimetype start, struct icaltimetype end)
Makes a free list from a set of VEVENT components.
Definition: icalspanlist.c:82
-
icalspanlist_as_vfreebusy
icalcomponent * icalspanlist_as_vfreebusy(icalspanlist *sl, const char *organizer, const char *attendee)
Returns a VFREEBUSY component for a spanlist.
Definition: icalspanlist.c:343
-
icalspanlist_next_free_time
struct icalperiodtype icalspanlist_next_free_time(icalspanlist *sl, struct icaltimetype t)
Finds the next free time span in a spanlist.
Definition: icalspanlist.c:218
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:29
-
icalset_impl
Definition: icalset.h:52
-
icalspanlist_impl
Definition: icalspanlist.c:21
-
icalspanlist_impl::start
struct icaltimetype start
Definition: icalspanlist.c:23
-
icalspanlist_impl::end
struct icaltimetype end
Definition: icalspanlist.c:24
-
icaltimetype
Definition: icaltime.h:97
+
icalspanlist_as_vfreebusy
icalcomponent * icalspanlist_as_vfreebusy(icalspanlist *sl, const char *organizer, const char *attendee)
Returns a VFREEBUSY component for a spanlist.
Definition: icalspanlist.c:351
+
icalspanlist_dump
void icalspanlist_dump(icalspanlist *sl)
(Debug) print out spanlist to STDOUT.
Definition: icalspanlist.c:210
+
icalspanlist_from_vfreebusy
icalspanlist * icalspanlist_from_vfreebusy(icalcomponent *comp)
Constructs an icalspanlist from a VFREEBUSY component.
Definition: icalspanlist.c:402
+
icalspanlist_as_freebusy_matrix
int * icalspanlist_as_freebusy_matrix(icalspanlist *span, int delta_t)
Returns an hour-by-hour array of free/busy times over a given period.
Definition: icalspanlist.c:290
+
icalspanlist_free
void icalspanlist_free(icalspanlist *sl)
Destructor.
Definition: icalspanlist.c:192
+
icalspanlist_new
icalspanlist * icalspanlist_new(icalset *set, struct icaltimetype start, struct icaltimetype end)
Makes a free list from a set of VEVENT components.
Definition: icalspanlist.c:90
+
icalspanlist_next_free_time
struct icalperiodtype icalspanlist_next_free_time(icalspanlist *sl, struct icaltimetype t)
Finds the next free time span in a spanlist.
Definition: icalspanlist.c:226
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:38
+
icalset_impl
Definition: icalset.h:61
+
icalspanlist_impl
Definition: icalspanlist.c:29
+
icalspanlist_impl::start
struct icaltimetype start
Definition: icalspanlist.c:31
+
icalspanlist_impl::end
struct icaltimetype end
Definition: icalspanlist.c:32
+
icaltimetype
Definition: icaltime.h:105
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalspanlist__cxx_8h.html b/apidocs/icalspanlist__cxx_8h.html index 8cd0f0d3..696c9f5b 100644 --- a/apidocs/icalspanlist__cxx_8h.html +++ b/apidocs/icalspanlist__cxx_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalspanlist_cxx.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures
-
icalspanlist_cxx.h File Reference
+
+
icalspanlist_cxx.h File Reference
@@ -77,20 +78,23 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

class  LibICal::ICalSpanList
 

Detailed Description

-

C++ class wrapping the icalspanlist data structure.

+

C++ class wrapping the icalspanlist data structure.

Author
Critical Path
-

SPDX-FileCopyrightText: 2001, Critical Path

-

SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0

+

(C) COPYRIGHT 2001, Critical Path

+

This library is free software; you can redistribute it and/or modify it under the terms of either:

+

The LGPL as published by the Free Software Foundation, version 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html

+

Or:

+

The Mozilla Public License Version 2.0. You may obtain a copy of the License at https://www.mozilla.org/MPL/

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalspanlist__cxx_8h_source.html b/apidocs/icalspanlist__cxx_8h_source.html index 2635b80a..878bb6e1 100644 --- a/apidocs/icalspanlist__cxx_8h_source.html +++ b/apidocs/icalspanlist__cxx_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalspanlist_cxx.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalspanlist_cxx.h
+
+
icalspanlist_cxx.h
-Go to the documentation of this file.
1
-
11#ifndef ICALSPANLIST_CXX_H
-
12#define ICALSPANLIST_CXX_H
-
13
-
14#include "libical_icalss_export.h"
-
15
-
16extern "C"
-
17{
-
18#include "icalcomponent.h"
-
19#include "icalspanlist.h"
-
20#include "icaltime.h"
-
21}
-
22
-
23#include <vector>
-
24
-
25namespace LibICal
-
26{
-
27
-
28class VComponent;
-
29
-
37class LIBICAL_ICALSS_EXPORT ICalSpanList
-
38{
-
39public:
-
40 ICalSpanList();
-
41 ICalSpanList(const ICalSpanList &v);
-
42
-
44 ICalSpanList(icalset *set, icaltimetype start, icaltimetype end);
-
45
-
47 explicit ICalSpanList(icalcomponent *comp);
-
48
-
50 explicit ICalSpanList(VComponent &comp);
-
51
-
53 ~ICalSpanList();
-
54
-
56 VComponent *get_vfreebusy(const char *organizer, const char *attendee);
-
57
-
58 ICalSpanList &operator=(const ICalSpanList &);
-
59
-
61 operator icalspanlist *()
-
62 {
-
63 return data;
-
64 }
-
65
-
67 std::vector < int >as_vector(int delta_t);
-
68
-
70 void dump();
-
71
-
72private:
-
73 icalspanlist *data;
-
74};
-
75
-
76} // namespace LibICal;
-
77
-
78#endif
-
LibICal::ICalSpanList
Definition: icalspanlist_cxx.h:38
+Go to the documentation of this file.
1 
+
20 #ifndef ICALSPANLIST_CXX_H
+
21 #define ICALSPANLIST_CXX_H
+
22 
+
23 #include "libical_icalss_export.h"
+
24 
+
25 extern "C"
+
26 {
+
27 #include "icalcomponent.h"
+
28 #include "icalspanlist.h"
+
29 #include "icaltime.h"
+
30 }
+
31 
+
32 #include <vector>
+
33 
+
34 namespace LibICal
+
35 {
+
36 
+
37 class VComponent;
+
38 
+
46 class LIBICAL_ICALSS_EXPORT ICalSpanList
+
47 {
+
48 public:
+
49  ICalSpanList();
+
50  ICalSpanList(const ICalSpanList &v);
+
51 
+
53  ICalSpanList(icalset *set, icaltimetype start, icaltimetype end);
+
54 
+
56  explicit ICalSpanList(icalcomponent *comp);
+
57 
+
59  explicit ICalSpanList(VComponent &comp);
+
60 
+
62  ~ICalSpanList();
+
63 
+
65  VComponent *get_vfreebusy(const char *organizer, const char *attendee);
+
66 
+
67  ICalSpanList &operator=(const ICalSpanList &);
+
68 
+
70  operator icalspanlist *()
+
71  {
+
72  return data;
+
73  }
+
74 
+
76  std::vector < int >as_vector(int delta_t);
+
77 
+
79  void dump();
+
80 
+
81 private:
+
82  icalspanlist *data;
+
83 };
+
84 
+
85 } // namespace LibICal;
+
86 
+
87 #endif
+
LibICal::ICalSpanList
Definition: icalspanlist_cxx.h:47
LibICal::ICalSpanList::ICalSpanList
ICalSpanList(icalset *set, icaltimetype start, icaltimetype end)
LibICal::ICalSpanList::ICalSpanList
ICalSpanList(icalcomponent *comp)
LibICal::ICalSpanList::ICalSpanList
ICalSpanList(VComponent &comp)
-
LibICal::ICalSpanList::get_vfreebusy
VComponent * get_vfreebusy(const char *organizer, const char *attendee)
LibICal::ICalSpanList::as_vector
std::vector< int > as_vector(int delta_t)
+
LibICal::ICalSpanList::get_vfreebusy
VComponent * get_vfreebusy(const char *organizer, const char *attendee)
-
LibICal::VComponent
A class wrapping the libical icalcomponent functions.
Definition: vcomponent_cxx.h:40
+
LibICal::VComponent
A class wrapping the libical icalcomponent functions.
Definition: vcomponent_cxx.h:48
icalspanlist.h
Code that supports collections of free/busy spans of time.
icaltime.h
struct icaltimetype is a pseudo-object that abstracts time handling.
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icalset_impl
Definition: icalset.h:52
-
icalspanlist_impl
Definition: icalspanlist.c:21
-
icaltimetype
Definition: icaltime.h:97
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icalset_impl
Definition: icalset.h:61
+
icalspanlist_impl
Definition: icalspanlist.c:29
+
icaltimetype
Definition: icaltime.h:105
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalssyacc_8h_source.html b/apidocs/icalssyacc_8h_source.html index 4380f0a5..52f91f5d 100644 --- a/apidocs/icalssyacc_8h_source.html +++ b/apidocs/icalssyacc_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalssyacc.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalssyacc.h
+
+
icalssyacc.h
-
1/* A Bison parser, made by GNU Bison 2.3. */
-
2
-
3/* Skeleton interface for Bison's Yacc-like parsers in C
-
4
-
5 SPDX-FileCopyrightText: 1984, 1989, 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
-
6 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
7
-
8 This program is free software; you can redistribute it and/or modify
-
9 it under the terms of the GNU General Public License as published by
-
10 the Free Software Foundation; either version 2, or (at your option)
-
11 any later version.
-
12
-
13 This program is distributed in the hope that it will be useful,
-
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
-
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-
16 GNU General Public License for more details.
-
17
-
18 You should have received a copy of the GNU General Public License
-
19 along with this program; if not, write to the Free Software
-
20 Foundation, Inc., 51 Franklin Street, Fifth Floor,
-
21 Boston, MA 02110-1301, USA. */
-
22
-
23/* As a special exception, you may create a larger work that contains
-
24 part or all of the Bison parser skeleton and distribute that work
-
25 under terms of your choice, so long as that work isn't itself a
-
26 parser generator using the skeleton or a modified version thereof
-
27 as a parser skeleton. Alternatively, if you modify or redistribute
-
28 the parser skeleton itself, you may (at your option) remove this
-
29 special exception, which will cause the skeleton and the resulting
-
30 Bison output files to be licensed under the GNU General Public
-
31 License without this special exception.
-
32
-
33 This special exception was added by the Free Software Foundation in
-
34 version 2.2 of Bison. */
-
35
-
36/* Tokens. */
-
37#ifndef YYTOKENTYPE
-
38# define YYTOKENTYPE
-
39 /* Put the tokens into the symbol table, so that GDB and other debuggers
-
40 know about them. */
-
41 enum yytokentype {
-
42 STRING = 258,
-
43 SELECT = 259,
-
44 FROM = 260,
-
45 WHERE = 261,
-
46 COMMA = 262,
-
47 QUOTE = 263,
-
48 EQUALS = 264,
-
49 NOTEQUALS = 265,
-
50 LESS = 266,
-
51 GREATER = 267,
-
52 LESSEQUALS = 268,
-
53 GREATEREQUALS = 269,
-
54 AND = 270,
-
55 OR = 271,
-
56 EOL = 272,
-
57 END = 273,
-
58 IS = 274,
-
59 NOT = 275,
-
60 SQLNULL = 276
-
61 };
-
62#endif
-
63/* Tokens. */
-
64#define STRING 258
-
65#define SELECT 259
-
66#define FROM 260
-
67#define WHERE 261
-
68#define COMMA 262
-
69#define QUOTE 263
-
70#define EQUALS 264
-
71#define NOTEQUALS 265
-
72#define LESS 266
-
73#define GREATER 267
-
74#define LESSEQUALS 268
-
75#define GREATEREQUALS 269
-
76#define AND 270
-
77#define OR 271
-
78#define EOL 272
-
79#define END 273
-
80#define IS 274
-
81#define NOT 275
-
82#define SQLNULL 276
-
83
-
84
-
85
-
86
-
87#if ! defined YYSTYPE && ! defined YYSTYPE_IS_DECLARED
-
88typedef union YYSTYPE
-
89{
-
90 char* v_string;
-
91}
-
92/* Line 1489 of yacc.c. */
-
93 YYSTYPE;
-
94# define yystype YYSTYPE /* obsolescent; will be withdrawn */
-
95# define YYSTYPE_IS_DECLARED 1
-
96# define YYSTYPE_IS_TRIVIAL 1
-
97#endif
-
98
-
99extern YYSTYPE sslval;
-
YYSTYPE
Definition: icalssyacc.c:192
+
1 /* A Bison parser, made by GNU Bison 2.3. */
+
2 
+
3 /* Skeleton interface for Bison's Yacc-like parsers in C
+
4 
+
5  Copyright (C) 1984, 1989, 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2006
+
6  Free Software Foundation, Inc.
+
7 
+
8  This program is free software; you can redistribute it and/or modify
+
9  it under the terms of the GNU General Public License as published by
+
10  the Free Software Foundation; either version 2, or (at your option)
+
11  any later version.
+
12 
+
13  This program is distributed in the hope that it will be useful,
+
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
+
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+
16  GNU General Public License for more details.
+
17 
+
18  You should have received a copy of the GNU General Public License
+
19  along with this program; if not, write to the Free Software
+
20  Foundation, Inc., 51 Franklin Street, Fifth Floor,
+
21  Boston, MA 02110-1301, USA. */
+
22 
+
23 /* As a special exception, you may create a larger work that contains
+
24  part or all of the Bison parser skeleton and distribute that work
+
25  under terms of your choice, so long as that work isn't itself a
+
26  parser generator using the skeleton or a modified version thereof
+
27  as a parser skeleton. Alternatively, if you modify or redistribute
+
28  the parser skeleton itself, you may (at your option) remove this
+
29  special exception, which will cause the skeleton and the resulting
+
30  Bison output files to be licensed under the GNU General Public
+
31  License without this special exception.
+
32 
+
33  This special exception was added by the Free Software Foundation in
+
34  version 2.2 of Bison. */
+
35 
+
36 /* Tokens. */
+
37 #ifndef YYTOKENTYPE
+
38 # define YYTOKENTYPE
+
39  /* Put the tokens into the symbol table, so that GDB and other debuggers
+
40  know about them. */
+
41  enum yytokentype {
+
42  STRING = 258,
+
43  SELECT = 259,
+
44  FROM = 260,
+
45  WHERE = 261,
+
46  COMMA = 262,
+
47  QUOTE = 263,
+
48  EQUALS = 264,
+
49  NOTEQUALS = 265,
+
50  LESS = 266,
+
51  GREATER = 267,
+
52  LESSEQUALS = 268,
+
53  GREATEREQUALS = 269,
+
54  AND = 270,
+
55  OR = 271,
+
56  EOL = 272,
+
57  END = 273,
+
58  IS = 274,
+
59  NOT = 275,
+
60  SQLNULL = 276
+
61  };
+
62 #endif
+
63 /* Tokens. */
+
64 #define STRING 258
+
65 #define SELECT 259
+
66 #define FROM 260
+
67 #define WHERE 261
+
68 #define COMMA 262
+
69 #define QUOTE 263
+
70 #define EQUALS 264
+
71 #define NOTEQUALS 265
+
72 #define LESS 266
+
73 #define GREATER 267
+
74 #define LESSEQUALS 268
+
75 #define GREATEREQUALS 269
+
76 #define AND 270
+
77 #define OR 271
+
78 #define EOL 272
+
79 #define END 273
+
80 #define IS 274
+
81 #define NOT 275
+
82 #define SQLNULL 276
+
83 
+
84 
+
85 
+
86 
+
87 #if ! defined YYSTYPE && ! defined YYSTYPE_IS_DECLARED
+
88 typedef union YYSTYPE
+
89 {
+
90  char* v_string;
+
91 }
+
92 /* Line 1489 of yacc.c. */
+
93  YYSTYPE;
+
94 # define yystype YYSTYPE /* obsolescent; will be withdrawn */
+
95 # define YYSTYPE_IS_DECLARED 1
+
96 # define YYSTYPE_IS_TRIVIAL 1
+
97 #endif
+
98 
+
99 extern YYSTYPE sslval;
+
100 
+
YYSTYPE
Definition: icalssyacc.c:198
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaltime_8h.html b/apidocs/icaltime_8h.html index b7f5c8c7..60d804cd 100644 --- a/apidocs/icaltime_8h.html +++ b/apidocs/icaltime_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltime.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
@@ -71,7 +71,8 @@ $(function() { Macros | Typedefs | Functions
-
icaltime.h File Reference
+
+
icaltime.h File Reference
@@ -80,48 +81,45 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

struct  icaltime_span
 
struct  icaltimetype
 
- - - - -

+

Macros

-#define icaltime_t   time_t
 
+
#define ICALTIMETYPE_INITIALIZER   { 0, 0, 0, 0, 0, 0, 0, 0, 0}
 
+
#define ICALTIMEZONE_DEFINED
 
- - - -

+

Typedefs

+
typedef struct icaltime_span icaltime_span
 
+
typedef struct icaltimetype icaltimetype
 
+
typedef struct _icaltimezone icaltimezone
 
- - - - - - - + + + + + + @@ -145,8 +143,8 @@ Functions - + @@ -162,22 +160,22 @@ int  - - - - - - + + + + + + - + @@ -218,56 +216,51 @@ int 

+

Functions

void icaltime_adjust (struct icaltimetype *tt, const int days, const int hours, const int minutes, const int seconds)
 Internal, shouldn't be part of the public API. More...
 
const char * icaltime_as_ical_string (const struct icaltimetype tt)
 Returns a string represention of the time, in RFC5545 format. More...
 
char * icaltime_as_ical_string_r (const struct icaltimetype tt)
 Returns a string represention of the time, in RFC5545 format. More...
 
const char * icaltime_as_ical_string (const struct icaltimetype tt)
 Returns a string representation of the time, in RFC5545 format. More...
 
char * icaltime_as_ical_string_r (const struct icaltimetype tt)
 Returns a string representation of the time, in RFC5545 format. More...
 
time_t icaltime_as_timet (const struct icaltimetype)
 
time_t icaltime_as_timet_with_zone (const struct icaltimetype tt, const icaltimezone *zone)
int icaltime_day_of_week (const struct icaltimetype t)
 Returns the day of the week of the given time. More...
 
-int icaltime_day_of_year (const struct icaltimetype t)
+int icaltime_day_of_year (const struct icaltimetype t)
 Returns the day of the year, counting from 1 (Jan 1st).
 
int icaltime_days_in_month (const int month, const int year)
icaltime_day_of_yearstruct icaltimetype icaltime_from_timet_with_zone (const time_t tm, const int is_date, const icaltimezone *zone)
 Constructor. More...
 
-const icaltimezone * icaltime_get_timezone (const struct icaltimetype t)
 Returns the timezone.
 
-const char * icaltime_get_tzid (const struct icaltimetype t)
 Returns the tzid, or NULL for a floating time.
 
+const icaltimezone * icaltime_get_timezone (const struct icaltimetype t)
 Returns the timezone.
 
+const char * icaltime_get_tzid (const struct icaltimetype t)
 Returns the tzid, or NULL for a floating time.
 
int icaltime_is_date (const struct icaltimetype t)
 Returns true if time is a DATE. More...
 
int icaltime_is_leap_year (const int year)
 Returns whether the specified year is a leap year. More...
 
-int icaltime_is_null_time (const struct icaltimetype t)
+int icaltime_is_null_time (const struct icaltimetype t)
 Returns true if the time is null.
 
int icaltime_is_utc (const struct icaltimetype t)
icaltime_is_null_time<
 

Detailed Description

-

struct icaltimetype is a pseudo-object that abstracts time handling.

-

It can represent either a DATE or a DATE-TIME (floating, UTC or in a given timezone), and it keeps track internally of its native timezone.

-

The typical usage is to call the correct constructor specifying the desired timezone. If this is not known until a later time, the correct behavior is to specify a NULL timezone and call icaltime_convert_to_zone() at a later time.

-

There are several ways to create a new icaltimetype:

+

struct icaltimetype is a pseudo-object that abstracts time handling.

+

It can represent either a DATE or a DATE-TIME (floating, UTC or in a given timezone), and it keeps track internally of its native timezone.

+

The typical usage is to call the correct constructor specifying the desired timezone. If this is not known until a later time, the correct behavior is to specify a NULL timezone and call icaltime_convert_to_zone() at a later time.

+

There are several ways to create a new icaltimetype:

-

italtimetype objects can be converted to different formats:

+

italtimetype objects can be converted to different formats:

-

Accessor methods include:

+

Accessor methods include:

-

Query methods include:

+

Query methods include:

-

Modify, compare and utility methods include:

+

Modify, compare and utility methods include:

Function Documentation

- +

◆ icaltime_adjust()

@@ -312,20 +305,20 @@ int icaltime_is_null_time<

Internal, shouldn't be part of the public API.

-

Adds or subtracts a number of days, hours, minutes and seconds.

-

Adds or subtracts a time from a icaltimetype. This time is given as a number of days, hours, minutes and seconds.

+

Adds or subtracts a number of days, hours, minutes and seconds.

+

Adds or subtracts a time from a icaltimetype. This time is given as a number of days, hours, minutes and seconds.

Note
This function is exactly the same as icaltimezone_adjust_change() except for the type of the first parameter.
- -

◆ icaltime_as_ical_string()

+ +

◆ icaltime_as_ical_string()

- + @@ -334,19 +327,19 @@ int 
const char * icaltime_as_ical_string const char* icaltime_as_ical_string ( const struct icaltimetype  tt)icaltime_is_null_time<
-

Returns a string represention of the time, in RFC5545 format.

+

Returns a string representation of the time, in RFC5545 format.

Ownership
The created string is owned by libical.
- -

◆ icaltime_as_ical_string_r()

+ +

◆ icaltime_as_ical_string_r()

- + @@ -355,12 +348,12 @@ int 
char * icaltime_as_ical_string_r char* icaltime_as_ical_string_r ( const struct icaltimetype  tt)icaltime_is_null_time<
-

Returns a string represention of the time, in RFC5545 format.

+

Returns a string representation of the time, in RFC5545 format.

Ownership
The string is owned by the caller.
- +

◆ icaltime_as_timet()

@@ -375,12 +368,13 @@ int icaltime_is_null_time<
-

Returns the time as seconds past the UNIX epoch.

-

This function probably won't do what you expect. In particular, you should only pass an icaltime in UTC, since no conversion is done. Even in that case, it's probably better to just use icaltime_as_timet_with_zone().

+

Returns the time as seconds past the UNIX epoch.

+

This function probably won't do what you expect. In particular, you should only pass an icaltime in UTC, since no conversion is done. Even in that case, it's probably better to just use icaltime_as_timet_with_zone().

+

The return value is defined for dates starting with 1902-01-01 until 10000-01-01 (excl.).

- +

◆ icaltime_as_timet_with_zone()

@@ -407,11 +401,11 @@ int icaltime_is_null_time<

Returns the time as seconds past the UNIX epoch, using the given timezone.

-

This convenience method combines a call to icaltime_convert_to_zone() with a call to icaltime_as_timet(). If the input timezone is null, no conversion is done; that is, the time is simply returned as icaltime_t in its native timezone.

+

This convenience method combines a call to icaltime_convert_to_zone() with a call to icaltime_as_timet(). If the input timezone is null, no conversion is done; that is, the time is simply returned as time_t in its native timezone.

- +

◆ icaltime_compare()

@@ -438,11 +432,11 @@ int icaltime_is_null_time<

Returns -1, 0, or 1 to indicate that a is less than b, a equals b, or a is greater than b.

-

This converts both times to the UTC timezone and compares them.

+

This converts both times to the UTC timezone and compares them.

- +

◆ icaltime_compare_date_only()

@@ -469,11 +463,11 @@ int icaltime_is_null_time<

Like icaltime_compare, but only use the date parts.

-

This converts both times to the UTC timezone and compares their date components.

+

This converts both times to the UTC timezone and compares their date components.

- +

◆ icaltime_compare_date_only_tz()

@@ -506,11 +500,11 @@ int icaltime_is_null_time<

Like icaltime_compare, but only use the date parts; accepts timezone.

-

This converts both times to the given timezone and compares their date components.

+

This converts both times to the given timezone and compares their date components.

- +

◆ icaltime_convert_to_zone()

@@ -537,14 +531,14 @@ int icaltime_is_null_time<

Converts time to a given timezone.

-

Converts a time from its native timezone to a given timezone.

-

If tt is a date, the timezone is not converted and the returned time is an exact copy of tt.

-

If it's a floating time, the returned object represents the same time relative to zone. For example, if tt represents 9:30 AM floating and zone is the GMT timezone, the returned object will represent 9:30 AM GMT.

-

Otherwise, the time will be converted to zone, and its timezone property updated to zone. For example, July 20 1969, 8:17 PM UTC would be converted to July 20 1969, 4:17 PM EDT.

+

Converts a time from its native timezone to a given timezone.

+

If tt is a date, the timezone is not converted and the returned time is an exact copy of tt.

+

If it's a floating time, the returned object represents the same time relative to zone. For example, if tt represents 9:30 AM floating and zone is the GMT timezone, the returned object will represent 9:30 AM GMT.

+

Otherwise, the time will be converted to zone, and its timezone property updated to zone. For example, July 20 1969, 8:17 PM UTC would be converted to July 20 1969, 4:17 PM EDT.

- +

◆ icaltime_current_time_with_zone()

@@ -565,7 +559,7 @@ int icaltime_is_null_time<
- +

◆ icaltime_day_of_week()

@@ -582,11 +576,11 @@ int icaltime_is_null_time<

Returns the day of the week of the given time.

-

Sunday is 1, and Saturday is 7.

+

Sunday is 1, and Saturday is 7.

- +

◆ icaltime_days_in_month()

@@ -611,11 +605,11 @@ int icaltime_is_null_time<
-

Returns the number of days in the given month.

+

Returns the number of days in the given month.

- +

◆ icaltime_days_in_year()

@@ -630,11 +624,11 @@ int icaltime_is_null_time<
-

Returns the number of days in this year.

+

Returns the number of days in this year.

- +

◆ icaltime_from_day_of_year()

@@ -661,12 +655,12 @@ int icaltime_is_null_time<

Constructor.

-

Creates a new time, given a day of year and a year.

-

Note that Jan 1 is day #1, not 0.

+

Creates a new time, given a day of year and a year.

+

Note that Jan 1 is day #1, not 0.

- +

◆ icaltime_from_string()

@@ -683,11 +677,11 @@ int icaltime_is_null_time<

Constructor.

-

Creates a time from an ISO format string.

+

Creates a time from an ISO format string.

- +

◆ icaltime_from_timet_with_zone()

@@ -729,11 +723,11 @@ int icaltime_is_null_time<

Returns a new icaltime instance, initialized to the given time, optionally using the given timezone.

-

If the caller specifies the is_date param as TRUE, the returned object is of DATE type, otherwise the input is meant to be of DATE-TIME type. If the zone is not specified (NULL zone param) the time is taken to be floating, that is, valid in any timezone. Note that, in addition to the uses specified in [RFC5545], this can be used when doing simple math on couples of times. If the zone is specified (UTC or otherwise), it's stored in the object and it's used as the native timezone for this object. This means that the caller can convert this time to a different target timezone with no need to store the source timezone.

+

If the caller specifies the is_date param as TRUE, the returned object is of DATE type, otherwise the input is meant to be of DATE-TIME type. If the zone is not specified (NULL zone param) the time is taken to be floating, that is, valid in any timezone. Note that, in addition to the uses specified in [RFC5545], this can be used when doing simple math on couples of times. If the zone is specified (UTC or otherwise), it's stored in the object and it's used as the native timezone for this object. This means that the caller can convert this time to a different target timezone with no need to store the source timezone.

- +

◆ icaltime_is_date()

@@ -750,11 +744,11 @@ int icaltime_is_null_time<

Returns true if time is a DATE.

-

The options are DATE type, which returns true, or DATE-TIME, which returns false.

+

The options are DATE type, which returns true, or DATE-TIME, which returns false.

- +

◆ icaltime_is_leap_year()

@@ -771,11 +765,11 @@ int icaltime_is_null_time<

Returns whether the specified year is a leap year.

-

Year is the normal year, e.g. 2001.

+

Year is the normal year, e.g. 2001.

- +

◆ icaltime_is_utc()

@@ -795,7 +789,7 @@ int icaltime_is_null_time<
- +

◆ icaltime_is_valid_time()

@@ -812,11 +806,11 @@ int icaltime_is_null_time<

Returns false if the time is clearly invalid, but is not null.

-

This is usually the result of creating a new time type but not clearing it, or setting one of the flags to an illegal value.

+

This is usually the result of creating a new time type but not clearing it, or setting one of the flags to an illegal value.

- +

◆ icaltime_normalize()

@@ -833,11 +827,11 @@ int icaltime_is_null_time<

Normalizes the icaltime, so all of the time components are in their normal ranges.

-

For instance, given a time with minutes=70, the minutes will be reduces to 10, and the hour incremented. This allows the caller to do arithmetic on times without worrying about overflow or underflow.

+

For instance, given a time with minutes=70, the minutes will be reduces to 10, and the hour incremented. This allows the caller to do arithmetic on times without worrying about overflow or underflow.

- +

◆ icaltime_null_date()

@@ -858,7 +852,7 @@ int icaltime_is_null_time<
- +

◆ icaltime_null_time()

@@ -879,7 +873,7 @@ int icaltime_is_null_time<
- +

◆ icaltime_set_timezone()

@@ -906,13 +900,13 @@ int icaltime_is_null_time<

Sets the timezone.

-

Forces the icaltime to be interpreted relative to another timezone. The returned time represents the same time as t, but relative to the new zone. For example, modifying July 20 1969, 8:17 PM UTC to the EDT time zone would return a time representing July 20 1969, 8:17 PM EDT.

-

If you need to do timezone conversion, applying offset adjustments, then you should use icaltime_convert_to_zone instead.

-

If t is of type DATE, its timezone is not modified and the returned time is an exact copy of t.

+

Forces the icaltime to be interpreted relative to another timezone. The returned time represents the same time as t, but relative to the new zone. For example, modifying July 20 1969, 8:17 PM UTC to the EDT time zone would return a time representing July 20 1969, 8:17 PM EDT.

+

If you need to do timezone conversion, applying offset adjustments, then you should use icaltime_convert_to_zone instead.

+

If t is of type DATE, its timezone is not modified and the returned time is an exact copy of t.

- +

◆ icaltime_span_contains()

@@ -950,7 +944,7 @@ int icaltime_is_null_time<
- +

◆ icaltime_span_new()

@@ -995,7 +989,7 @@ int icaltime_is_null_time<
- +

◆ icaltime_span_overlaps()

@@ -1031,12 +1025,12 @@ int icaltime_is_null_time<
Returns
boolean value

The result is calculated by testing if the start time of s1 is contained by the s2 span, or if the end time of s1 is contained by the s2 span.

-

Also returns true if the spans are equal.

-

Note, this will return false if the spans are adjacent.

+

Also returns true if the spans are equal.

+

Note, this will return false if the spans are adjacent.

- +

◆ icaltime_start_doy_week()

@@ -1063,12 +1057,12 @@ int icaltime_is_null_time<

Returns the day of the year for the first day of the week that the given time is within.

-

Returns the day of the year for the first day of the week .

-

This uses the first day of the week that contains the given time, which is a Sunday. It returns the day of the year for the resulting day.

+

Returns the day of the year for the first day of the week .

+

This uses the first day of the week that contains the given time, which is a Sunday. It returns the day of the year for the resulting day.

- +

◆ icaltime_today()

@@ -1089,7 +1083,7 @@ int icaltime_is_null_time<
- +

◆ icaltime_week_number()

@@ -1112,7 +1106,7 @@ int icaltime_is_null_time<
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaltime_8h_source.html b/apidocs/icaltime_8h_source.html index 9a4cd5cd..8c554bbd 100644 --- a/apidocs/icaltime_8h_source.html +++ b/apidocs/icaltime_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltime.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icaltime.h
+
+
icaltime.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icaltime.h
-
3 CREATOR: eric 02 June 2000
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 The Original Code is eric. The Initial Developer of the Original
-
10 Code is Eric Busboom
-
11======================================================================*/
-
12
-
71#ifndef ICALTIME_H
-
72#define ICALTIME_H
-
73
-
74#include "libical_ical_export.h"
-
75
-
76#include <time.h>
-
77#define icaltime_t time_t
-
78
-
79/* An opaque struct representing a timezone. We declare this here to avoid
-
80 a circular dependency. */
-
81#if !defined(ICALTIMEZONE_DEFINED)
-
82#define ICALTIMEZONE_DEFINED
-
83typedef struct _icaltimezone icaltimezone;
-
84#endif
-
85
-
87struct icaltime_span
-
88{
-
89 icaltime_t start;
-
90 icaltime_t end;
-
91 int is_busy;
-
92};
-
93
-
94typedef struct icaltime_span icaltime_span;
-
95
-
96struct icaltimetype
-
97{
-
98 int year;
-
99 int month;
-
100 int day;
-
101 int hour;
-
102 int minute;
-
103 int second;
-
104
-
105 int is_date;
-
107 int is_daylight;
-
109 const icaltimezone *zone;
-
110};
-
111
-
112typedef struct icaltimetype icaltimetype;
-
113
-
114#define ICALTIMETYPE_INITIALIZER { 0, 0, 0, 0, 0, 0, 0, 0, 0}
-
115
-
121LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_null_time(void);
-
122
-
127LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_null_date(void);
-
128
-
133LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_current_time_with_zone(const icaltimezone *zone);
-
134
-
139LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_today(void);
-
140
-
164LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_timet_with_zone(const icaltime_t tm,
-
165 const int is_date,
-
166 const icaltimezone *zone);
-
167
-
177LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_string(const char *str);
-
178
-
185LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_day_of_year(const int doy, const int year);
-
186
-
194LIBICAL_ICAL_EXPORT icaltime_t icaltime_as_timet(const struct icaltimetype);
-
195
-
204LIBICAL_ICAL_EXPORT icaltime_t icaltime_as_timet_with_zone(const struct icaltimetype tt,
-
205 const icaltimezone *zone);
-
206
-
213LIBICAL_ICAL_EXPORT const char *icaltime_as_ical_string(const struct icaltimetype tt);
-
214
-
221LIBICAL_ICAL_EXPORT char *icaltime_as_ical_string_r(const struct icaltimetype tt);
-
222
-
224LIBICAL_ICAL_EXPORT const icaltimezone *icaltime_get_timezone(const struct icaltimetype t);
-
225
-
227LIBICAL_ICAL_EXPORT const char *icaltime_get_tzid(const struct icaltimetype t);
-
228
-
243LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_set_timezone(struct icaltimetype *t,
-
244 const icaltimezone *zone);
-
245
-
249LIBICAL_ICAL_EXPORT int icaltime_day_of_year(const struct icaltimetype t);
-
250
-
255LIBICAL_ICAL_EXPORT int icaltime_day_of_week(const struct icaltimetype t);
-
256
-
265LIBICAL_ICAL_EXPORT int icaltime_start_doy_week(const struct icaltimetype t, int fdow);
-
266
-
272LIBICAL_ICAL_EXPORT int icaltime_week_number(const struct icaltimetype t);
-
273
-
275LIBICAL_ICAL_EXPORT int icaltime_is_null_time(const struct icaltimetype t);
-
276
-
283LIBICAL_ICAL_EXPORT int icaltime_is_valid_time(const struct icaltimetype t);
-
284
-
290LIBICAL_ICAL_EXPORT int icaltime_is_date(const struct icaltimetype t);
-
291
-
296LIBICAL_ICAL_EXPORT int icaltime_is_utc(const struct icaltimetype t);
-
297
-
304LIBICAL_ICAL_EXPORT int icaltime_compare(const struct icaltimetype a, const struct icaltimetype b);
-
305
-
311LIBICAL_ICAL_EXPORT int icaltime_compare_date_only(const struct icaltimetype a,
-
312 const struct icaltimetype b);
-
313
-
320LIBICAL_ICAL_EXPORT int icaltime_compare_date_only_tz(const struct icaltimetype a,
-
321 const struct icaltimetype b,
-
322 icaltimezone *tz);
-
323
-
334LIBICAL_ICAL_EXPORT void icaltime_adjust(struct icaltimetype *tt,
-
335 const int days, const int hours,
-
336 const int minutes, const int seconds);
-
337
-
347LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_normalize(const struct icaltimetype tt);
-
348
-
366LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_convert_to_zone(const struct icaltimetype tt,
-
367 icaltimezone *zone);
-
368
-
370LIBICAL_ICAL_EXPORT int icaltime_days_in_month(const int month, const int year);
-
371
-
377LIBICAL_ICAL_EXPORT int icaltime_is_leap_year(const int year);
-
378
-
380LIBICAL_ICAL_EXPORT int icaltime_days_in_year(const int year);
-
381
-
391LIBICAL_ICAL_EXPORT struct icaltime_span icaltime_span_new(struct icaltimetype dtstart,
-
392 struct icaltimetype dtend, int is_busy);
-
393
-
407LIBICAL_ICAL_EXPORT int icaltime_span_overlaps(icaltime_span *s1, icaltime_span *s2);
-
408
-
417LIBICAL_ICAL_EXPORT int icaltime_span_contains(icaltime_span *s, icaltime_span *container);
-
418
-
419#endif /* !ICALTIME_H */
-
icaltime_is_utc
int icaltime_is_utc(const struct icaltimetype t)
Returns true if the time is relative to UTC zone.
Definition: icaltime.c:588
-
icaltime_compare
int icaltime_compare(const struct icaltimetype a, const struct icaltimetype b)
Returns -1, 0, or 1 to indicate that a is less than b, a equals b, or a is greater than b.
Definition: icaltime.c:602
-
icaltime_compare_date_only
int icaltime_compare_date_only(const struct icaltimetype a, const struct icaltimetype b)
Like icaltime_compare, but only use the date parts.
Definition: icaltime.c:657
-
icaltime_span_contains
int icaltime_span_contains(icaltime_span *s, icaltime_span *container)
Returns true if the span is totally within the containing span.
Definition: icaltime.c:924
-
icaltime_from_string
struct icaltimetype icaltime_from_string(const char *str)
Constructor.
Definition: icaltime.c:330
-
icaltime_get_tzid
const char * icaltime_get_tzid(const struct icaltimetype t)
Returns the tzid, or NULL for a floating time.
Definition: icaltime.c:843
-
icaltime_from_day_of_year
struct icaltimetype icaltime_from_day_of_year(const int doy, const int year)
Constructor.
Definition: icaltime.c:511
-
icaltime_current_time_with_zone
struct icaltimetype icaltime_current_time_with_zone(const icaltimezone *zone)
Convenience constructor.
Definition: icaltime.c:212
-
icaltime_day_of_year
int icaltime_day_of_year(const struct icaltimetype t)
Returns the day of the year, counting from 1 (Jan 1st).
Definition: icaltime.c:504
-
icaltime_start_doy_week
int icaltime_start_doy_week(const struct icaltimetype t, int fdow)
Returns the day of the year for the first day of the week that the given time is within.
Definition: icaltime.c:467
-
icaltime_span_new
struct icaltime_span icaltime_span_new(struct icaltimetype dtstart, struct icaltimetype dtend, int is_busy)
Builds an icaltimespan given a start time, end time and busy value.
Definition: icaltime.c:868
-
icaltime_as_timet_with_zone
time_t icaltime_as_timet_with_zone(const struct icaltimetype tt, const icaltimezone *zone)
Returns the time as seconds past the UNIX epoch, using the given timezone.
Definition: icaltime.c:253
-
icaltime_get_timezone
const icaltimezone * icaltime_get_timezone(const struct icaltimetype t)
Returns the timezone.
Definition: icaltime.c:838
-
icaltime_week_number
int icaltime_week_number(const struct icaltimetype t)
Returns the week number for the week the given time is within.
Definition: icaltime.c:488
-
icaltime_day_of_week
int icaltime_day_of_week(const struct icaltimetype t)
Returns the day of the week of the given time.
Definition: icaltime.c:452
-
icaltime_is_date
int icaltime_is_date(const struct icaltimetype t)
Returns true if time is a DATE.
Definition: icaltime.c:583
-
icaltime_today
struct icaltimetype icaltime_today(void)
Convenience constructor.
Definition: icaltime.c:217
-
icaltime_as_timet
time_t icaltime_as_timet(const struct icaltimetype)
Definition: icaltime.c:222
-
icaltime_null_date
struct icaltimetype icaltime_null_date(void)
Constructor.
Definition: icaltime.c:555
-
icaltime_from_timet_with_zone
struct icaltimetype icaltime_from_timet_with_zone(const time_t tm, const int is_date, const icaltimezone *zone)
Constructor.
-
icaltime_span_overlaps
int icaltime_span_overlaps(icaltime_span *s1, icaltime_span *s2)
Returns true if the two spans overlap.
Definition: icaltime.c:900
-
icaltime_as_ical_string
const char * icaltime_as_ical_string(const struct icaltimetype tt)
Returns a string represention of the time, in RFC5545 format.
Definition: icaltime.c:291
-
icaltime_is_null_time
int icaltime_is_null_time(const struct icaltimetype t)
Returns true if the time is null.
Definition: icaltime.c:593
-
icaltime_days_in_month
int icaltime_days_in_month(const int month, const int year)
Definition: icaltime.c:426
-
icaltime_convert_to_zone
struct icaltimetype icaltime_convert_to_zone(const struct icaltimetype tt, icaltimezone *zone)
Converts time to a given timezone.
Definition: icaltime.c:809
-
icaltime_is_valid_time
int icaltime_is_valid_time(const struct icaltimetype t)
Returns false if the time is clearly invalid, but is not null.
Definition: icaltime.c:574
-
icaltime_compare_date_only_tz
int icaltime_compare_date_only_tz(const struct icaltimetype a, const struct icaltimetype b, icaltimezone *tz)
Like icaltime_compare, but only use the date parts; accepts timezone.
Definition: icaltime.c:687
-
icaltime_days_in_year
int icaltime_days_in_year(const int year)
Definition: icaltime.c:415
-
icaltime_is_leap_year
int icaltime_is_leap_year(const int year)
Returns whether the specified year is a leap year.
Definition: icaltime.c:406
-
icaltime_normalize
struct icaltimetype icaltime_normalize(const struct icaltimetype tt)
Normalizes the icaltime, so all of the time components are in their normal ranges.
Definition: icaltime.c:322
-
icaltime_set_timezone
struct icaltimetype icaltime_set_timezone(struct icaltimetype *t, const icaltimezone *zone)
Sets the timezone.
Definition: icaltime.c:852
-
icaltime_adjust
void icaltime_adjust(struct icaltimetype *tt, const int days, const int hours, const int minutes, const int seconds)
Internal, shouldn't be part of the public API.
Definition: icaltime.c:724
-
icaltime_null_time
struct icaltimetype icaltime_null_time(void)
Constructor.
Definition: icaltime.c:546
-
icaltime_as_ical_string_r
char * icaltime_as_ical_string_r(const struct icaltimetype tt)
Returns a string represention of the time, in RFC5545 format.
Definition: icaltime.c:300
-
_icaltimezone
Definition: icaltimezoneimpl.h:15
-
icaltime_span
Definition: icaltime.h:88
-
icaltime_span::start
time_t start
Definition: icaltime.h:89
-
icaltime_span::end
time_t end
Definition: icaltime.h:90
-
icaltime_span::is_busy
int is_busy
Definition: icaltime.h:91
-
icaltimetype
Definition: icaltime.h:97
-
icaltimetype::is_date
int is_date
Definition: icaltime.h:105
-
icaltimetype::year
int year
Definition: icaltime.h:98
-
icaltimetype::is_daylight
int is_daylight
Definition: icaltime.h:107
-
icaltimetype::zone
const icaltimezone * zone
Definition: icaltime.h:109
-
icaltimetype::month
int month
Definition: icaltime.h:99
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icaltime.h
+
3  CREATOR: eric 02 June 2000
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  The Original Code is eric. The Initial Developer of the Original
+
19  Code is Eric Busboom
+
20 ======================================================================*/
+
21 
+
80 #ifndef ICALTIME_H
+
81 #define ICALTIME_H
+
82 
+
83 #include "libical_ical_export.h"
+
84 
+
85 #include <time.h>
+
86 
+
87 /* An opaque struct representing a timezone. We declare this here to avoid
+
88  a circular dependency. */
+
89 #if !defined(ICALTIMEZONE_DEFINED)
+
90 #define ICALTIMEZONE_DEFINED
+
91 typedef struct _icaltimezone icaltimezone;
+
92 #endif
+
93 
+
95 struct icaltime_span
+
96 {
+
97  time_t start;
+
98  time_t end;
+
99  int is_busy;
+
100 };
+
101 
+
102 typedef struct icaltime_span icaltime_span;
+
103 
+
104 struct icaltimetype
+
105 {
+
106  int year;
+
107  int month;
+
108  int day;
+
109  int hour;
+
110  int minute;
+
111  int second;
+
112 
+
113  int is_date;
+
115  int is_daylight;
+
117  const icaltimezone *zone;
+
118 };
+
119 
+
120 typedef struct icaltimetype icaltimetype;
+
121 
+
122 #define ICALTIMETYPE_INITIALIZER { 0, 0, 0, 0, 0, 0, 0, 0, 0}
+
123 
+
129 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_null_time(void);
+
130 
+
135 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_null_date(void);
+
136 
+
141 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_current_time_with_zone(const icaltimezone *zone);
+
142 
+
147 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_today(void);
+
148 
+
172 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_timet_with_zone(const time_t tm,
+
173  const int is_date,
+
174  const icaltimezone *zone);
+
175 
+
185 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_string(const char *str);
+
186 
+
193 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_from_day_of_year(const int doy, const int year);
+
194 
+
204 LIBICAL_ICAL_EXPORT time_t icaltime_as_timet(const struct icaltimetype);
+
205 
+
214 LIBICAL_ICAL_EXPORT time_t icaltime_as_timet_with_zone(const struct icaltimetype tt,
+
215  const icaltimezone *zone);
+
216 
+
223 LIBICAL_ICAL_EXPORT const char *icaltime_as_ical_string(const struct icaltimetype tt);
+
224 
+
231 LIBICAL_ICAL_EXPORT char *icaltime_as_ical_string_r(const struct icaltimetype tt);
+
232 
+
234 LIBICAL_ICAL_EXPORT const icaltimezone *icaltime_get_timezone(const struct icaltimetype t);
+
235 
+
237 LIBICAL_ICAL_EXPORT const char *icaltime_get_tzid(const struct icaltimetype t);
+
238 
+
253 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_set_timezone(struct icaltimetype *t,
+
254  const icaltimezone *zone);
+
255 
+
259 LIBICAL_ICAL_EXPORT int icaltime_day_of_year(const struct icaltimetype t);
+
260 
+
265 LIBICAL_ICAL_EXPORT int icaltime_day_of_week(const struct icaltimetype t);
+
266 
+
275 LIBICAL_ICAL_EXPORT int icaltime_start_doy_week(const struct icaltimetype t, int fdow);
+
276 
+
282 LIBICAL_ICAL_EXPORT int icaltime_week_number(const struct icaltimetype t);
+
283 
+
285 LIBICAL_ICAL_EXPORT int icaltime_is_null_time(const struct icaltimetype t);
+
286 
+
293 LIBICAL_ICAL_EXPORT int icaltime_is_valid_time(const struct icaltimetype t);
+
294 
+
300 LIBICAL_ICAL_EXPORT int icaltime_is_date(const struct icaltimetype t);
+
301 
+
306 LIBICAL_ICAL_EXPORT int icaltime_is_utc(const struct icaltimetype t);
+
307 
+
314 LIBICAL_ICAL_EXPORT int icaltime_compare(const struct icaltimetype a, const struct icaltimetype b);
+
315 
+
321 LIBICAL_ICAL_EXPORT int icaltime_compare_date_only(const struct icaltimetype a,
+
322  const struct icaltimetype b);
+
323 
+
330 LIBICAL_ICAL_EXPORT int icaltime_compare_date_only_tz(const struct icaltimetype a,
+
331  const struct icaltimetype b,
+
332  icaltimezone *tz);
+
333 
+
344 LIBICAL_ICAL_EXPORT void icaltime_adjust(struct icaltimetype *tt,
+
345  const int days, const int hours,
+
346  const int minutes, const int seconds);
+
347 
+
357 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_normalize(const struct icaltimetype tt);
+
358 
+
376 LIBICAL_ICAL_EXPORT struct icaltimetype icaltime_convert_to_zone(const struct icaltimetype tt,
+
377  icaltimezone *zone);
+
378 
+
380 LIBICAL_ICAL_EXPORT int icaltime_days_in_month(const int month, const int year);
+
381 
+
387 LIBICAL_ICAL_EXPORT int icaltime_is_leap_year(const int year);
+
388 
+
390 LIBICAL_ICAL_EXPORT int icaltime_days_in_year(const int year);
+
391 
+
401 LIBICAL_ICAL_EXPORT struct icaltime_span icaltime_span_new(struct icaltimetype dtstart,
+
402  struct icaltimetype dtend, int is_busy);
+
403 
+
417 LIBICAL_ICAL_EXPORT int icaltime_span_overlaps(icaltime_span *s1, icaltime_span *s2);
+
418 
+
427 LIBICAL_ICAL_EXPORT int icaltime_span_contains(icaltime_span *s, icaltime_span *container);
+
428 
+
429 #endif /* !ICALTIME_H */
+
icaltime_is_utc
int icaltime_is_utc(const struct icaltimetype t)
Returns true if the time is relative to UTC zone.
Definition: icaltime.c:612
+
icaltime_compare
int icaltime_compare(const struct icaltimetype a, const struct icaltimetype b)
Returns -1, 0, or 1 to indicate that a is less than b, a equals b, or a is greater than b.
Definition: icaltime.c:626
+
icaltime_compare_date_only
int icaltime_compare_date_only(const struct icaltimetype a, const struct icaltimetype b)
Like icaltime_compare, but only use the date parts.
Definition: icaltime.c:681
+
icaltime_span_contains
int icaltime_span_contains(icaltime_span *s, icaltime_span *container)
Returns true if the span is totally within the containing span.
Definition: icaltime.c:948
+
icaltime_from_string
struct icaltimetype icaltime_from_string(const char *str)
Constructor.
Definition: icaltime.c:345
+
icaltime_as_ical_string_r
char * icaltime_as_ical_string_r(const struct icaltimetype tt)
Returns a string representation of the time, in RFC5545 format.
Definition: icaltime.c:315
+
icaltime_from_day_of_year
struct icaltimetype icaltime_from_day_of_year(const int doy, const int year)
Constructor.
Definition: icaltime.c:535
+
icaltime_current_time_with_zone
struct icaltimetype icaltime_current_time_with_zone(const icaltimezone *zone)
Convenience constructor.
Definition: icaltime.c:227
+
icaltime_day_of_year
int icaltime_day_of_year(const struct icaltimetype t)
Returns the day of the year, counting from 1 (Jan 1st).
Definition: icaltime.c:528
+
icaltime_start_doy_week
int icaltime_start_doy_week(const struct icaltimetype t, int fdow)
Returns the day of the year for the first day of the week that the given time is within.
Definition: icaltime.c:485
+
icaltime_span_new
struct icaltime_span icaltime_span_new(struct icaltimetype dtstart, struct icaltimetype dtend, int is_busy)
Builds an icaltimespan given a start time, end time and busy value.
Definition: icaltime.c:892
+
icaltime_as_timet_with_zone
time_t icaltime_as_timet_with_zone(const struct icaltimetype tt, const icaltimezone *zone)
Returns the time as seconds past the UNIX epoch, using the given timezone.
Definition: icaltime.c:268
+
icaltime_week_number
int icaltime_week_number(const struct icaltimetype t)
Returns the week number for the week the given time is within.
Definition: icaltime.c:509
+
icaltime_day_of_week
int icaltime_day_of_week(const struct icaltimetype t)
Returns the day of the week of the given time.
Definition: icaltime.c:467
+
icaltime_as_ical_string
const char * icaltime_as_ical_string(const struct icaltimetype tt)
Returns a string representation of the time, in RFC5545 format.
Definition: icaltime.c:306
+
icaltime_is_date
int icaltime_is_date(const struct icaltimetype t)
Returns true if time is a DATE.
Definition: icaltime.c:607
+
icaltime_get_timezone
const icaltimezone * icaltime_get_timezone(const struct icaltimetype t)
Returns the timezone.
Definition: icaltime.c:862
+
icaltime_today
struct icaltimetype icaltime_today(void)
Convenience constructor.
Definition: icaltime.c:232
+
icaltime_as_timet
time_t icaltime_as_timet(const struct icaltimetype)
Definition: icaltime.c:237
+
icaltime_null_date
struct icaltimetype icaltime_null_date(void)
Constructor.
Definition: icaltime.c:579
+
icaltime_from_timet_with_zone
struct icaltimetype icaltime_from_timet_with_zone(const time_t tm, const int is_date, const icaltimezone *zone)
Constructor.
Definition: icaltime.c:189
+
icaltime_span_overlaps
int icaltime_span_overlaps(icaltime_span *s1, icaltime_span *s2)
Returns true if the two spans overlap.
Definition: icaltime.c:924
+
icaltime_is_null_time
int icaltime_is_null_time(const struct icaltimetype t)
Returns true if the time is null.
Definition: icaltime.c:617
+
icaltime_days_in_month
int icaltime_days_in_month(const int month, const int year)
Definition: icaltime.c:441
+
icaltime_convert_to_zone
struct icaltimetype icaltime_convert_to_zone(const struct icaltimetype tt, icaltimezone *zone)
Converts time to a given timezone.
Definition: icaltime.c:833
+
icaltime_is_valid_time
int icaltime_is_valid_time(const struct icaltimetype t)
Returns false if the time is clearly invalid, but is not null.
Definition: icaltime.c:598
+
icaltime_compare_date_only_tz
int icaltime_compare_date_only_tz(const struct icaltimetype a, const struct icaltimetype b, icaltimezone *tz)
Like icaltime_compare, but only use the date parts; accepts timezone.
Definition: icaltime.c:711
+
icaltime_days_in_year
int icaltime_days_in_year(const int year)
Definition: icaltime.c:430
+
icaltime_get_tzid
const char * icaltime_get_tzid(const struct icaltimetype t)
Returns the tzid, or NULL for a floating time.
Definition: icaltime.c:867
+
icaltime_is_leap_year
int icaltime_is_leap_year(const int year)
Returns whether the specified year is a leap year.
Definition: icaltime.c:421
+
icaltime_normalize
struct icaltimetype icaltime_normalize(const struct icaltimetype tt)
Normalizes the icaltime, so all of the time components are in their normal ranges.
Definition: icaltime.c:337
+
icaltime_set_timezone
struct icaltimetype icaltime_set_timezone(struct icaltimetype *t, const icaltimezone *zone)
Sets the timezone.
Definition: icaltime.c:876
+
icaltime_adjust
void icaltime_adjust(struct icaltimetype *tt, const int days, const int hours, const int minutes, const int seconds)
Internal, shouldn't be part of the public API.
Definition: icaltime.c:748
+
icaltime_null_time
struct icaltimetype icaltime_null_time(void)
Constructor.
Definition: icaltime.c:570
+
_icaltimezone
Definition: icaltimezoneimpl.h:23
+
icaltime_span
Definition: icaltime.h:96
+
icaltime_span::start
time_t start
Definition: icaltime.h:97
+
icaltime_span::end
time_t end
Definition: icaltime.h:98
+
icaltime_span::is_busy
int is_busy
Definition: icaltime.h:99
+
icaltimetype
Definition: icaltime.h:105
+
icaltimetype::is_date
int is_date
Definition: icaltime.h:113
+
icaltimetype::year
int year
Definition: icaltime.h:106
+
icaltimetype::is_daylight
int is_daylight
Definition: icaltime.h:115
+
icaltimetype::zone
const icaltimezone * zone
Definition: icaltime.h:117
+
icaltimetype::month
int month
Definition: icaltime.h:107
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaltimezone_8h.html b/apidocs/icaltimezone_8h.html index 1a104311..35cd79fa 100644 --- a/apidocs/icaltimezone_8h.html +++ b/apidocs/icaltimezone_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltimezone.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Macros | Typedefs | Functions
-
icaltimezone.h File Reference
+
+
icaltimezone.h File Reference
@@ -79,109 +80,109 @@ $(function() {

Go to the source code of this file.

- - +

+

Typedefs

-typedef struct _icaltimezone icaltimezone
+typedef struct _icaltimezone icaltimezone
 An opaque struct representing a timezone. We declare this here to avoid a circular dependency.
 
- - - - - - + - - + - - + - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - - + + + + + + + - - - - - - + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + - @@ -189,19 +190,19 @@ void  - - - +

+

Functions

void free_zone_directory (void)
 
+
void icaltimezone_array_append_from_vtimezone (icalarray *timezones, icalcomponent *child)
 
+
void icaltimezone_array_free (icalarray *timezones)
 
+
icalarray * icaltimezone_array_new (void)
 
+
 
void icaltimezone_convert_time (struct icaltimetype *tt, icaltimezone *from_zone, icaltimezone *to_zone)
 
+
icaltimezone * icaltimezone_copy (icaltimezone *originalzone)
 
 
int icaltimezone_dump_changes (icaltimezone *zone, int max_year, FILE *fp)
 Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given. More...
 
+
void icaltimezone_expand_vtimezone (icalcomponent *comp, int end_year, icalarray *changes)
 
void icaltimezone_free (icaltimezone *zone, int free_struct)
 Frees all memory used for the icaltimezone. More...
 
-void icaltimezone_free_builtin_timezones (void)
+void icaltimezone_free_builtin_timezones (void)
 Releases builtin timezone memory.
 
-icaltimezone * icaltimezone_get_builtin_timezone (const char *location)
 Returns a single builtin timezone, given its Olson city name.
 
-icaltimezone * icaltimezone_get_builtin_timezone_from_offset (int offset, const char *tzname)
 Returns a single builtin timezone, given its offset from UTC.
 
-icaltimezone * icaltimezone_get_builtin_timezone_from_tzid (const char *tzid)
 Returns a single builtin timezone, given its TZID.
 
icalarray * icaltimezone_get_builtin_timezones (void)
 Returns an icalarray of icaltimezone structs, one for each builtin timezone. More...
 
+
+icaltimezone * icaltimezone_get_builtin_timezone (const char *location)
 Returns a single builtin timezone, given its Olson city name.
 
+icaltimezone * icaltimezone_get_builtin_timezone_from_offset (int offset, const char *tzname)
 Returns a single builtin timezone, given its offset from UTC.
 
+icaltimezone * icaltimezone_get_builtin_timezone_from_tzid (const char *tzid)
 Returns a single builtin timezone, given its TZID.
 
icalarray * icaltimezone_get_builtin_timezones (void)
 Returns an icalarray of icaltimezone structs, one for each builtin timezone. More...
 
int icaltimezone_get_builtin_tzdata (void)
 
-icalcomponent * icaltimezone_get_component (icaltimezone *zone)
 Returns the VTIMEZONE component of a timezone.
 
const char * icaltimezone_get_display_name (icaltimezone *zone)
 Returns the timezone name to display to the user. More...
 
-double icaltimezone_get_latitude (icaltimezone *zone)
+icalcomponent * icaltimezone_get_component (icaltimezone *zone)
 Returns the VTIMEZONE component of a timezone.
 
const char * icaltimezone_get_display_name (icaltimezone *zone)
 Returns the timezone name to display to the user. More...
 
+double icaltimezone_get_latitude (icaltimezone *zone)
 Returns the latitude of a builtin timezone.
 
const char * icaltimezone_get_location (icaltimezone *zone)
 
-char * icaltimezone_get_location_from_vtimezone (icalcomponent *component)
 Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE.
 
-double icaltimezone_get_longitude (icaltimezone *zone)
const char * icaltimezone_get_location (icaltimezone *zone)
 
+char * icaltimezone_get_location_from_vtimezone (icalcomponent *component)
 Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE.
 
+double icaltimezone_get_longitude (icaltimezone *zone)
 Returns the longitude of a builtin timezone.
 
const char * icaltimezone_get_tzid (icaltimezone *zone)
 
const char * icaltimezone_get_tznames (icaltimezone *zone)
 
char * icaltimezone_get_tznames_from_vtimezone (icalcomponent *component)
 Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE. More...
 
const char * icaltimezone_get_tzid (icaltimezone *zone)
 
const char * icaltimezone_get_tznames (icaltimezone *zone)
 
char * icaltimezone_get_tznames_from_vtimezone (icalcomponent *component)
 Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE. More...
 
int icaltimezone_get_utc_offset (icaltimezone *zone, struct icaltimetype *tt, int *is_daylight)
 Calculates the UTC offset of a given local time in the given timezone. More...
 
int icaltimezone_get_utc_offset_of_utc_time (icaltimezone *zone, struct icaltimetype *tt, int *is_daylight)
 Calculates the UTC offset of a given UTC time in the given timezone. More...
 
-icaltimezone * icaltimezone_get_utc_timezone (void)
 Returns the UTC timezone.
 
-icaltimezone * icaltimezone_new (void)
 Creates a new icaltimezone.
 
+
+icaltimezone * icaltimezone_get_utc_timezone (void)
 Returns the UTC timezone.
 
+icaltimezone * icaltimezone_new (void)
 Creates a new icaltimezone.
 
void icaltimezone_release_zone_tab (void)
 
+
void icaltimezone_set_builtin_tzdata (int set)
 
int icaltimezone_set_component (icaltimezone *zone, icalcomponent *comp)
icaltimezone_set_buil
 
void icaltimezone_set_tzid_prefix (const char *new_prefix)
 
+
void icaltimezone_truncate_vtimezone (icalcomponent *vtz, icaltimetype start, icaltimetype end, int ms_compatible)
 
+
const char * icaltimezone_tzid_prefix (void)
 
 
void set_zone_directory (const char *path)
 

Detailed Description

-

Timezone handling routines.

+

Timezone handling routines.

Function Documentation

- +

◆ free_zone_directory()

@@ -216,11 +217,11 @@ const char * icaltimezone_
-

Frees the memory dedicated to the zonefile directory

+

Frees the memory dedicated to the zonefile directory

- +

◆ icaltimezone_dump_changes()

@@ -253,14 +254,14 @@ const char * icaltimezone_

Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given.

-

We compare this output with the output from 'vzic –dump-changes' to make sure that we are consistent. (vzic is the Olson timezone database to VTIMEZONE converter.)

-

The output format is: 

 Zone-Name [tab] Date [tab] Time [tab] UTC-Offset
+
We compare this output with the output from 'vzic –dump-changes' to make sure that we are consistent. (vzic is the Olson timezone database to VTIMEZONE converter.)

+
The output format is: 
 Zone-Name [tab] Date [tab] Time [tab] UTC-Offset
 
 The Date and Time fields specify the time change in UTC.

-
The UTC Offset is for local (wall-clock) time. It is the amount of time to add to UTC to get local time. 

+
The UTC Offset is for local (wall-clock) time. It is the amount of time to add to UTC to get local time.
- +

◆ icaltimezone_free()

@@ -297,14 +298,14 @@ const char * icaltimezone_
- -

◆ icaltimezone_get_builtin_timezones()

+ +

◆ icaltimezone_get_builtin_timezones()

- + @@ -314,18 +315,18 @@ const char * 
icalarray * icaltimezone_get_builtin_timezones icalarray* icaltimezone_get_builtin_timezones ( void  )icaltimezone_

Returns an icalarray of icaltimezone structs, one for each builtin timezone.

-

This will load and parse the zones.tab file to get the timezone names and their coordinates. It will not load the VTIMEZONE data for any timezones.

+

This will load and parse the zones.tab file to get the timezone names and their coordinates. It will not load the VTIMEZONE data for any timezones.

- -

◆ icaltimezone_get_display_name()

+ +

◆ icaltimezone_get_display_name()

- + @@ -335,18 +336,18 @@ const char * 
const char * icaltimezone_get_display_name const char* icaltimezone_get_display_name ( icaltimezone *  zone)icaltimezone_

Returns the timezone name to display to the user.

-

We prefer to use the Olson city name, but fall back on the TZNAME, or finally the TZID. We don't want to use "" as it may be wrongly interpreted as a floating time. Do not free the returned string.

+

We prefer to use the Olson city name, but fall back on the TZNAME, or finally the TZID. We don't want to use "" as it may be wrongly interpreted as a floating time. Do not free the returned string.

- -

◆ icaltimezone_get_location()

+ +

◆ icaltimezone_get_location()

- + @@ -354,18 +355,18 @@ const char * 
const char * icaltimezone_get_location const char* icaltimezone_get_location ( icaltimezone *  zone)icaltimezone_
-

Returns the city name of a timezone.

+

Returns the city name of a timezone.

- -

◆ icaltimezone_get_tzid()

+ +

◆ icaltimezone_get_tzid()

- + @@ -373,18 +374,18 @@ const char * 
const char * icaltimezone_get_tzid const char* icaltimezone_get_tzid ( icaltimezone *  zone)icaltimezone_
-

Returns the TZID of a timezone.

+

Returns the TZID of a timezone.

- -

◆ icaltimezone_get_tznames()

+ +

◆ icaltimezone_get_tznames()

- + @@ -392,18 +393,18 @@ const char * 
const char * icaltimezone_get_tznames const char* icaltimezone_get_tznames ( icaltimezone *  zone)icaltimezone_
-

Returns the TZNAME properties used in the latest STANDARD and DAYLIGHT components. If they are the same it will return just one, e.g. "LMT". If they are different it will format them like "EST/EDT". Note that this may also return NULL.

+

Returns the TZNAME properties used in the latest STANDARD and DAYLIGHT components. If they are the same it will return just one, e.g. "LMT". If they are different it will format them like "EST/EDT". Note that this may also return NULL.

- -

◆ icaltimezone_get_tznames_from_vtimezone()

+ +

◆ icaltimezone_get_tznames_from_vtimezone()

- + @@ -413,11 +414,11 @@ const char * 
char * icaltimezone_get_tznames_from_vtimezone char* icaltimezone_get_tznames_from_vtimezone ( icalcomponent *  component)icaltimezone_

Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE.

-

If both STANDARD and DAYLIGHT components use the same TZNAME, it returns that. If they use different TZNAMEs, it formats them like "EST/EDT". The returned string should be freed by the caller.

+

If both STANDARD and DAYLIGHT components use the same TZNAME, it returns that. If they use different TZNAMEs, it formats them like "EST/EDT". The returned string should be freed by the caller.

- +

◆ icaltimezone_get_utc_offset()

@@ -450,11 +451,11 @@ const char * 
icaltimezone_

Calculates the UTC offset of a given local time in the given timezone.

-

It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.

+

It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.

- +

◆ icaltimezone_get_utc_offset_of_utc_time()

@@ -487,11 +488,11 @@ const char * 
icaltimezone_

Calculates the UTC offset of a given UTC time in the given timezone.

-

It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.

+

It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.

- +

◆ icaltimezone_set_component()

@@ -522,7 +523,7 @@ const char * 
icaltimezone_ - +

◆ icaltimezone_set_tzid_prefix()

@@ -537,11 +538,11 @@ const char * 
icaltimezone_
-

Sets the prefix to be used for tzid's generated from system tzdata. Must be globally unique (such as a domain name owned by the developer of the calling application), and begin and end with forward slashes. Do not change or de-allocate the string buffer after calling this.

+

Sets the prefix to be used for tzid's generated from system tzdata. Must be globally unique (such as a domain name owned by the developer of the calling application), and begin and end with forward slashes. Do not change or de-allocate the string buffer after calling this.

- +

◆ set_zone_directory()

@@ -556,14 +557,14 @@ const char * 
icaltimezone_
-

Sets the directory to look for the zonefiles

+

Sets the directory to look for the zonefiles

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaltimezone_8h_source.html b/apidocs/icaltimezone_8h_source.html index 52c21dd8..28a2a4f2 100644 --- a/apidocs/icaltimezone_8h_source.html +++ b/apidocs/icaltimezone_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltimezone.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icaltimezone.h
+
+
icaltimezone.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icaltimezone.h
-
3 CREATOR: Damon Chaplin 15 March 2001
-
4
-
5 SPDX-FileCopyrightText: 2001, Damon Chaplin <damon@ximian.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
15#ifndef ICALTIMEZONE_H
-
16#define ICALTIMEZONE_H
-
17
-
18#include "libical_ical_export.h"
-
19#include "icalcomponent.h"
-
20
-
21#include <stdio.h>
-
22
-
23#if !defined(ICALTIMEZONE_DEFINED)
-
24#define ICALTIMEZONE_DEFINED
-
28typedef struct _icaltimezone icaltimezone;
-
29#endif
-
30
-
31/*
-
32 * Creating/Destroying individual icaltimezones.
-
33 */
-
34
-
36LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_new(void);
-
37
-
38LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_copy(icaltimezone *originalzone);
-
39
-
44LIBICAL_ICAL_EXPORT void icaltimezone_free(icaltimezone *zone, int free_struct);
-
45
-
51LIBICAL_ICAL_EXPORT void icaltimezone_set_tzid_prefix(const char *new_prefix);
-
52
-
53/*
-
54 * Accessing timezones.
-
55 */
-
56
-
58LIBICAL_ICAL_EXPORT void icaltimezone_free_builtin_timezones(void);
-
59
-
67LIBICAL_ICAL_EXPORT icalarray *icaltimezone_get_builtin_timezones(void);
-
68
-
70LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone(const char *location);
-
71
-
73LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone_from_offset(int offset,
-
74 const char *tzname);
-
75
-
77LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone_from_tzid(const char *tzid);
-
78
-
80LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_utc_timezone(void);
-
81
-
83LIBICAL_ICAL_EXPORT const char *icaltimezone_get_tzid(icaltimezone *zone);
-
84
-
86LIBICAL_ICAL_EXPORT const char *icaltimezone_get_location(icaltimezone *zone);
-
87
-
92LIBICAL_ICAL_EXPORT const char *icaltimezone_get_tznames(icaltimezone *zone);
-
93
-
95LIBICAL_ICAL_EXPORT double icaltimezone_get_latitude(icaltimezone *zone);
-
96
-
98LIBICAL_ICAL_EXPORT double icaltimezone_get_longitude(icaltimezone *zone);
-
99
-
101LIBICAL_ICAL_EXPORT icalcomponent *icaltimezone_get_component(icaltimezone *zone);
-
102
-
108LIBICAL_ICAL_EXPORT int icaltimezone_set_component(icaltimezone *zone, icalcomponent *comp);
-
109
-
116LIBICAL_ICAL_EXPORT const char *icaltimezone_get_display_name(icaltimezone *zone);
-
117
-
118/*
-
119 * Converting times between timezones.
-
120 */
-
121
-
122LIBICAL_ICAL_EXPORT void icaltimezone_convert_time(struct icaltimetype *tt,
-
123 icaltimezone *from_zone,
-
124 icaltimezone *to_zone);
-
125
-
126/*
-
127 * Getting offsets from UTC.
-
128 */
-
129
-
137LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset(icaltimezone *zone,
-
138 struct icaltimetype *tt, int *is_daylight);
-
139
-
146LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone,
-
147 struct icaltimetype *tt,
-
148 int *is_daylight);
-
149
-
150/*
-
151 * Handling arrays of timezones. Mainly for internal use.
-
152 */
-
153LIBICAL_ICAL_EXPORT icalarray *icaltimezone_array_new(void);
-
154
-
155LIBICAL_ICAL_EXPORT void icaltimezone_array_append_from_vtimezone(icalarray *timezones,
-
156 icalcomponent *child);
-
157
-
158LIBICAL_ICAL_EXPORT void icaltimezone_array_free(icalarray *timezones);
-
159
-
160/*
-
161 * By request (issue #112) make vtimezone functions public
-
162 */
-
163LIBICAL_ICAL_EXPORT void icaltimezone_expand_vtimezone(icalcomponent *comp,
-
164 int end_year, icalarray *changes);
-
165
-
167LIBICAL_ICAL_EXPORT char *icaltimezone_get_location_from_vtimezone(icalcomponent *component);
-
168
-
175LIBICAL_ICAL_EXPORT char *icaltimezone_get_tznames_from_vtimezone(icalcomponent *component);
-
176
-
177/*
-
178 * Truncate a VTIMEZONE component to the given start and end times.
-
179 * If either time is null, then no truncation will occur at that point.
-
180 * If either time is non-null, then it MUST be specified as UTC.
-
181 * If the start time is non-null and ms_compatible is zero,
-
182 * then the DTSTART of RRULEs will be adjusted to occur after the start time.
-
183 * @since 3.0.6
-
184 */
-
185LIBICAL_ICAL_EXPORT void icaltimezone_truncate_vtimezone(icalcomponent *vtz,
-
186 icaltimetype start,
-
187 icaltimetype end,
-
188 int ms_compatible);
-
189
-
190/*
-
191 * @par Handling the default location the timezone files
-
192 */
-
193
-
195LIBICAL_ICAL_EXPORT void set_zone_directory(const char *path);
-
196
-
198LIBICAL_ICAL_EXPORT void free_zone_directory(void);
-
199
-
200LIBICAL_ICAL_EXPORT void icaltimezone_release_zone_tab(void);
-
201
-
202/*
-
203 * @par Handling whether to use builtin timezone files
-
204 */
-
205LIBICAL_ICAL_EXPORT void icaltimezone_set_builtin_tzdata(int set);
-
206
-
207LIBICAL_ICAL_EXPORT int icaltimezone_get_builtin_tzdata(void);
-
208
-
209/*
-
210 * Debugging Output.
-
211 */
-
212
-
230LIBICAL_ICAL_EXPORT int icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp);
-
231
-
232/* For the library only -- do not make visible */
-
233extern const char *icaltimezone_tzid_prefix(void);
-
234
-
235#endif /* ICALTIMEZONE_H */
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icaltimezone.h
+
3  CREATOR: Damon Chaplin 15 March 2001
+
4 
+
5  (C) COPYRIGHT 2001, Damon Chaplin <damon@ximian.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
23 #ifndef ICALTIMEZONE_H
+
24 #define ICALTIMEZONE_H
+
25 
+
26 #include "libical_ical_export.h"
+
27 #include "icalcomponent.h"
+
28 
+
29 #include <stdio.h>
+
30 
+
31 #if !defined(ICALTIMEZONE_DEFINED)
+
32 #define ICALTIMEZONE_DEFINED
+
36 typedef struct _icaltimezone icaltimezone;
+
37 #endif
+
38 
+
39 /*
+
40  * Creating/Destroying individual icaltimezones.
+
41  */
+
42 
+
44 LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_new(void);
+
45 
+
46 LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_copy(icaltimezone *originalzone);
+
47 
+
52 LIBICAL_ICAL_EXPORT void icaltimezone_free(icaltimezone *zone, int free_struct);
+
53 
+
59 LIBICAL_ICAL_EXPORT void icaltimezone_set_tzid_prefix(const char *new_prefix);
+
60 
+
61 /*
+
62  * Accessing timezones.
+
63  */
+
64 
+
66 LIBICAL_ICAL_EXPORT void icaltimezone_free_builtin_timezones(void);
+
67 
+
75 LIBICAL_ICAL_EXPORT icalarray *icaltimezone_get_builtin_timezones(void);
+
76 
+
78 LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone(const char *location);
+
79 
+
81 LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone_from_offset(int offset,
+
82  const char *tzname);
+
83 
+
85 LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_builtin_timezone_from_tzid(const char *tzid);
+
86 
+
88 LIBICAL_ICAL_EXPORT icaltimezone *icaltimezone_get_utc_timezone(void);
+
89 
+
91 LIBICAL_ICAL_EXPORT const char *icaltimezone_get_tzid(icaltimezone *zone);
+
92 
+
94 LIBICAL_ICAL_EXPORT const char *icaltimezone_get_location(icaltimezone *zone);
+
95 
+
100 LIBICAL_ICAL_EXPORT const char *icaltimezone_get_tznames(icaltimezone *zone);
+
101 
+
103 LIBICAL_ICAL_EXPORT double icaltimezone_get_latitude(icaltimezone *zone);
+
104 
+
106 LIBICAL_ICAL_EXPORT double icaltimezone_get_longitude(icaltimezone *zone);
+
107 
+
109 LIBICAL_ICAL_EXPORT icalcomponent *icaltimezone_get_component(icaltimezone *zone);
+
110 
+
116 LIBICAL_ICAL_EXPORT int icaltimezone_set_component(icaltimezone *zone, icalcomponent *comp);
+
117 
+
124 LIBICAL_ICAL_EXPORT const char *icaltimezone_get_display_name(icaltimezone *zone);
+
125 
+
126 /*
+
127  * Converting times between timezones.
+
128  */
+
129 
+
130 LIBICAL_ICAL_EXPORT void icaltimezone_convert_time(struct icaltimetype *tt,
+
131  icaltimezone *from_zone,
+
132  icaltimezone *to_zone);
+
133 
+
134 /*
+
135  * Getting offsets from UTC.
+
136  */
+
137 
+
145 LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset(icaltimezone *zone,
+
146  struct icaltimetype *tt, int *is_daylight);
+
147 
+
154 LIBICAL_ICAL_EXPORT int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone,
+
155  struct icaltimetype *tt,
+
156  int *is_daylight);
+
157 
+
158 /*
+
159  * Handling arrays of timezones. Mainly for internal use.
+
160  */
+
161 LIBICAL_ICAL_EXPORT icalarray *icaltimezone_array_new(void);
+
162 
+
163 LIBICAL_ICAL_EXPORT void icaltimezone_array_append_from_vtimezone(icalarray *timezones,
+
164  icalcomponent *child);
+
165 
+
166 LIBICAL_ICAL_EXPORT void icaltimezone_array_free(icalarray *timezones);
+
167 
+
168 /*
+
169  * By request (issue #112) make vtimezone functions public
+
170  */
+
171 LIBICAL_ICAL_EXPORT void icaltimezone_expand_vtimezone(icalcomponent *comp,
+
172  int end_year, icalarray *changes);
+
173 
+
175 LIBICAL_ICAL_EXPORT char *icaltimezone_get_location_from_vtimezone(icalcomponent *component);
+
176 
+
183 LIBICAL_ICAL_EXPORT char *icaltimezone_get_tznames_from_vtimezone(icalcomponent *component);
+
184 
+
185 /*
+
186  * Truncate a VTIMEZONE component to the given start and end times.
+
187  * If either time is null, then no truncation will occur at that point.
+
188  * If either time is non-null, then it MUST be specified as UTC.
+
189  * If the start time is non-null and ms_compatible is zero,
+
190  * then the DTSTART of RRULEs will be adjusted to occur after the start time.
+
191  * @since 3.0.6
+
192  */
+
193 LIBICAL_ICAL_EXPORT void icaltimezone_truncate_vtimezone(icalcomponent *vtz,
+
194  icaltimetype start,
+
195  icaltimetype end,
+
196  int ms_compatible);
+
197 
+
198 /*
+
199  * @par Handling the default location the timezone files
+
200  */
+
201 
+
203 LIBICAL_ICAL_EXPORT void set_zone_directory(const char *path);
+
204 
+
206 LIBICAL_ICAL_EXPORT void free_zone_directory(void);
+
207 
+
208 LIBICAL_ICAL_EXPORT void icaltimezone_release_zone_tab(void);
+
209 
+
210 /*
+
211  * @par Handling whether to use builtin timezone files
+
212  */
+
213 LIBICAL_ICAL_EXPORT void icaltimezone_set_builtin_tzdata(int set);
+
214 
+
215 LIBICAL_ICAL_EXPORT int icaltimezone_get_builtin_tzdata(void);
+
216 
+
217 /*
+
218  * Debugging Output.
+
219  */
+
220 
+
238 LIBICAL_ICAL_EXPORT int icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp);
+
239 
+
240 /* For the library only -- do not make visible */
+
241 extern const char *icaltimezone_tzid_prefix(void);
+
242 
+
243 #endif /* ICALTIMEZONE_H */
-
icaltimezone_new
icaltimezone * icaltimezone_new(void)
Creates a new icaltimezone.
Definition: icaltimezone.c:203
-
icaltimezone_set_tzid_prefix
void icaltimezone_set_tzid_prefix(const char *new_prefix)
Definition: icaltimezone.c:2163
-
icaltimezone_get_builtin_timezone_from_offset
icaltimezone * icaltimezone_get_builtin_timezone_from_offset(int offset, const char *tzname)
Returns a single builtin timezone, given its offset from UTC.
Definition: icaltimezone.c:1437
-
icaltimezone_dump_changes
int icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp)
Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year g...
Definition: icaltimezone.c:1936
-
icaltimezone_get_utc_offset
int icaltimezone_get_utc_offset(icaltimezone *zone, struct icaltimetype *tt, int *is_daylight)
Calculates the UTC offset of a given local time in the given timezone.
Definition: icaltimezone.c:810
-
icaltimezone_get_longitude
double icaltimezone_get_longitude(icaltimezone *zone)
Returns the longitude of a builtin timezone.
Definition: icaltimezone.c:1218
-
free_zone_directory
void free_zone_directory(void)
Definition: icaltimezone.c:2155
-
icaltimezone_get_location_from_vtimezone
char * icaltimezone_get_location_from_vtimezone(icalcomponent *component)
Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE.
Definition: icaltimezone.c:346
-
icaltimezone_get_tznames_from_vtimezone
char * icaltimezone_get_tznames_from_vtimezone(icalcomponent *component)
Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE.
Definition: icaltimezone.c:373
-
icaltimezone_get_component
icalcomponent * icaltimezone_get_component(icaltimezone *zone)
Returns the VTIMEZONE component of a timezone.
Definition: icaltimezone.c:1229
-
icaltimezone_free_builtin_timezones
void icaltimezone_free_builtin_timezones(void)
Releases builtin timezone memory.
Definition: icaltimezone.c:1332
-
icaltimezone_get_tznames
const char * icaltimezone_get_tznames(icaltimezone *zone)
Definition: icaltimezone.c:1196
-
icaltimezone_get_builtin_timezone
icaltimezone * icaltimezone_get_builtin_timezone(const char *location)
Returns a single builtin timezone, given its Olson city name.
Definition: icaltimezone.c:1338
-
icaltimezone_get_location
const char * icaltimezone_get_location(icaltimezone *zone)
Definition: icaltimezone.c:1185
-
icaltimezone_get_builtin_timezones
icalarray * icaltimezone_get_builtin_timezones(void)
Returns an icalarray of icaltimezone structs, one for each builtin timezone.
Definition: icaltimezone.c:1324
-
icaltimezone_get_tzid
const char * icaltimezone_get_tzid(icaltimezone *zone)
Definition: icaltimezone.c:1174
-
icaltimezone_get_utc_timezone
icaltimezone * icaltimezone_get_utc_timezone(void)
Returns the UTC timezone.
Definition: icaltimezone.c:1534
-
icaltimezone_free
void icaltimezone_free(icaltimezone *zone, int free_struct)
Frees all memory used for the icaltimezone.
Definition: icaltimezone.c:252
-
icaltimezone_get_display_name
const char * icaltimezone_get_display_name(icaltimezone *zone)
Returns the timezone name to display to the user.
Definition: icaltimezone.c:1265
-
icaltimezone_set_component
int icaltimezone_set_component(icaltimezone *zone, icalcomponent *comp)
Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, location & tzname fields.
Definition: icaltimezone.c:1240
-
icaltimezone_get_latitude
double icaltimezone_get_latitude(icaltimezone *zone)
Returns the latitude of a builtin timezone.
Definition: icaltimezone.c:1207
-
icaltimezone_get_builtin_timezone_from_tzid
icaltimezone * icaltimezone_get_builtin_timezone_from_tzid(const char *tzid)
Returns a single builtin timezone, given its TZID.
Definition: icaltimezone.c:1468
-
set_zone_directory
void set_zone_directory(const char *path)
Definition: icaltimezone.c:2144
-
icaltimezone_get_utc_offset_of_utc_time
int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone, struct icaltimetype *tt, int *is_daylight)
Calculates the UTC offset of a given UTC time in the given timezone.
Definition: icaltimezone.c:967
-
_icalarray
Definition: icalarray.h:30
-
_icaltimezone
Definition: icaltimezoneimpl.h:15
-
_icaltimezone::component
icalcomponent * component
Definition: icaltimezoneimpl.h:41
-
_icaltimezone::changes
icalarray * changes
Definition: icaltimezoneimpl.h:57
-
_icaltimezone::location
char * location
Definition: icaltimezoneimpl.h:22
-
_icaltimezone::tzid
char * tzid
Definition: icaltimezoneimpl.h:16
-
_icaltimezone::end_year
int end_year
Definition: icaltimezoneimpl.h:52
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icaltimetype
Definition: icaltime.h:97
+
icaltimezone_set_tzid_prefix
void icaltimezone_set_tzid_prefix(const char *new_prefix)
Definition: icaltimezone.c:2171
+
icaltimezone_get_component
icalcomponent * icaltimezone_get_component(icaltimezone *zone)
Returns the VTIMEZONE component of a timezone.
Definition: icaltimezone.c:1237
+
icaltimezone_dump_changes
int icaltimezone_dump_changes(icaltimezone *zone, int max_year, FILE *fp)
Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year g...
Definition: icaltimezone.c:1944
+
icaltimezone_get_utc_offset
int icaltimezone_get_utc_offset(icaltimezone *zone, struct icaltimetype *tt, int *is_daylight)
Calculates the UTC offset of a given local time in the given timezone.
Definition: icaltimezone.c:818
+
icaltimezone_get_tzid
const char * icaltimezone_get_tzid(icaltimezone *zone)
Definition: icaltimezone.c:1182
+
icaltimezone_get_longitude
double icaltimezone_get_longitude(icaltimezone *zone)
Returns the longitude of a builtin timezone.
Definition: icaltimezone.c:1226
+
icaltimezone_get_location_from_vtimezone
char * icaltimezone_get_location_from_vtimezone(icalcomponent *component)
Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE.
Definition: icaltimezone.c:354
+
free_zone_directory
void free_zone_directory(void)
Definition: icaltimezone.c:2163
+
icaltimezone_get_builtin_timezone_from_offset
icaltimezone * icaltimezone_get_builtin_timezone_from_offset(int offset, const char *tzname)
Returns a single builtin timezone, given its offset from UTC.
Definition: icaltimezone.c:1445
+
icaltimezone_free_builtin_timezones
void icaltimezone_free_builtin_timezones(void)
Releases builtin timezone memory.
Definition: icaltimezone.c:1340
+
icaltimezone_get_utc_timezone
icaltimezone * icaltimezone_get_utc_timezone(void)
Returns the UTC timezone.
Definition: icaltimezone.c:1542
+
icaltimezone_free
void icaltimezone_free(icaltimezone *zone, int free_struct)
Frees all memory used for the icaltimezone.
Definition: icaltimezone.c:260
+
icaltimezone_get_tznames
const char * icaltimezone_get_tznames(icaltimezone *zone)
Definition: icaltimezone.c:1204
+
icaltimezone_get_tznames_from_vtimezone
char * icaltimezone_get_tznames_from_vtimezone(icalcomponent *component)
Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE.
Definition: icaltimezone.c:381
+
icaltimezone_set_component
int icaltimezone_set_component(icaltimezone *zone, icalcomponent *comp)
Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, location & tzname fields.
Definition: icaltimezone.c:1248
+
icaltimezone_get_location
const char * icaltimezone_get_location(icaltimezone *zone)
Definition: icaltimezone.c:1193
+
icaltimezone_get_display_name
const char * icaltimezone_get_display_name(icaltimezone *zone)
Returns the timezone name to display to the user.
Definition: icaltimezone.c:1273
+
icaltimezone_new
icaltimezone * icaltimezone_new(void)
Creates a new icaltimezone.
Definition: icaltimezone.c:211
+
icaltimezone_get_builtin_timezones
icalarray * icaltimezone_get_builtin_timezones(void)
Returns an icalarray of icaltimezone structs, one for each builtin timezone.
Definition: icaltimezone.c:1332
+
icaltimezone_get_builtin_timezone
icaltimezone * icaltimezone_get_builtin_timezone(const char *location)
Returns a single builtin timezone, given its Olson city name.
Definition: icaltimezone.c:1346
+
icaltimezone_get_latitude
double icaltimezone_get_latitude(icaltimezone *zone)
Returns the latitude of a builtin timezone.
Definition: icaltimezone.c:1215
+
set_zone_directory
void set_zone_directory(const char *path)
Definition: icaltimezone.c:2152
+
icaltimezone_get_builtin_timezone_from_tzid
icaltimezone * icaltimezone_get_builtin_timezone_from_tzid(const char *tzid)
Returns a single builtin timezone, given its TZID.
Definition: icaltimezone.c:1476
+
icaltimezone_get_utc_offset_of_utc_time
int icaltimezone_get_utc_offset_of_utc_time(icaltimezone *zone, struct icaltimetype *tt, int *is_daylight)
Calculates the UTC offset of a given UTC time in the given timezone.
Definition: icaltimezone.c:975
+
_icalarray
Definition: icalarray.h:36
+
_icaltimezone
Definition: icaltimezoneimpl.h:23
+
_icaltimezone::component
icalcomponent * component
Definition: icaltimezoneimpl.h:49
+
_icaltimezone::changes
icalarray * changes
Definition: icaltimezoneimpl.h:65
+
_icaltimezone::location
char * location
Definition: icaltimezoneimpl.h:30
+
_icaltimezone::tzid
char * tzid
Definition: icaltimezoneimpl.h:24
+
_icaltimezone::end_year
int end_year
Definition: icaltimezoneimpl.h:60
+
icalcomponent_impl
Definition: icalcomponent.c:36
+
icaltimetype
Definition: icaltime.h:105
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaltimezoneimpl_8h_source.html b/apidocs/icaltimezoneimpl_8h_source.html index 7465ff13..2c45342c 100644 --- a/apidocs/icaltimezoneimpl_8h_source.html +++ b/apidocs/icaltimezoneimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltimezoneimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icaltimezoneimpl.h
+
+
icaltimezoneimpl.h
-
1/*======================================================================
-
2 FILE: icaltimezoneimpl.h
-
3 CREATOR: glenn 07 March 2010
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALTIMEZONEIMPL_H
-
12#define ICALTIMEZONEIMPL_H
-
13
-
14struct _icaltimezone
-
15{
-
16 char *tzid;
-
22 char *location;
-
29 char *tznames;
-
37 double latitude;
-
38 double longitude;
-
41 icalcomponent *component;
-
45 icaltimezone *builtin_timezone;
-
52 int end_year;
-
57 icalarray *changes;
-
61};
-
62
-
63#endif /*ICALTIMEZONE_IMPL */
-
_icalarray
Definition: icalarray.h:30
-
_icaltimezone
Definition: icaltimezoneimpl.h:15
-
_icaltimezone::longitude
double longitude
Definition: icaltimezoneimpl.h:38
-
_icaltimezone::builtin_timezone
icaltimezone * builtin_timezone
Definition: icaltimezoneimpl.h:45
-
_icaltimezone::component
icalcomponent * component
Definition: icaltimezoneimpl.h:41
-
_icaltimezone::tznames
char * tznames
Definition: icaltimezoneimpl.h:29
-
_icaltimezone::changes
icalarray * changes
Definition: icaltimezoneimpl.h:57
-
_icaltimezone::location
char * location
Definition: icaltimezoneimpl.h:22
-
_icaltimezone::tzid
char * tzid
Definition: icaltimezoneimpl.h:16
-
_icaltimezone::end_year
int end_year
Definition: icaltimezoneimpl.h:52
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
1 /*======================================================================
+
2  FILE: icaltimezoneimpl.h
+
3  CREATOR: glenn 07 March 2010
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALTIMEZONEIMPL_H
+
20 #define ICALTIMEZONEIMPL_H
+
21 
+
22 struct _icaltimezone
+
23 {
+
24  char *tzid;
+
30  char *location;
+
37  char *tznames;
+
45  double latitude;
+
46  double longitude;
+
49  icalcomponent *component;
+
53  icaltimezone *builtin_timezone;
+
60  int end_year;
+
65  icalarray *changes;
+
69 };
+
70 
+
71 #endif /*ICALTIMEZONE_IMPL */
+
_icalarray
Definition: icalarray.h:36
+
_icaltimezone
Definition: icaltimezoneimpl.h:23
+
_icaltimezone::longitude
double longitude
Definition: icaltimezoneimpl.h:46
+
_icaltimezone::builtin_timezone
icaltimezone * builtin_timezone
Definition: icaltimezoneimpl.h:53
+
_icaltimezone::component
icalcomponent * component
Definition: icaltimezoneimpl.h:49
+
_icaltimezone::tznames
char * tznames
Definition: icaltimezoneimpl.h:37
+
_icaltimezone::changes
icalarray * changes
Definition: icaltimezoneimpl.h:65
+
_icaltimezone::location
char * location
Definition: icaltimezoneimpl.h:30
+
_icaltimezone::tzid
char * tzid
Definition: icaltimezoneimpl.h:24
+
_icaltimezone::end_year
int end_year
Definition: icaltimezoneimpl.h:60
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaltypes_8h_source.html b/apidocs/icaltypes_8h_source.html index c9ceaa23..af382df7 100644 --- a/apidocs/icaltypes_8h_source.html +++ b/apidocs/icaltypes_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltypes.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icaltypes.h
+
+
icaltypes.h
-
1/*======================================================================
-
2 FILE: icaltypes.h
-
3 CREATOR: eric 20 March 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALTYPES_H
-
12#define ICALTYPES_H
-
13
-
14#include "libical_ical_export.h"
-
15#include "icalduration.h"
-
16#include "icalenums.h"
-
17#include "icalperiod.h"
-
18
-
19struct icaldatetimeperiodtype
-
20{
-
21 struct icaltimetype time;
-
22 struct icalperiodtype period;
-
23};
-
24
-
25#define ICAL_GEO_LEN 16
-
26struct icalgeotype
-
27{
-
28 char lat[ICAL_GEO_LEN];
-
29 char lon[ICAL_GEO_LEN];
-
30};
-
31
-
32struct icaltriggertype
-
33{
-
34 struct icaltimetype time;
-
35 struct icaldurationtype duration;
-
36};
-
37
-
38LIBICAL_ICAL_EXPORT struct icaltriggertype icaltriggertype_from_int(const int reltime);
-
39
-
40LIBICAL_ICAL_EXPORT struct icaltriggertype icaltriggertype_from_string(const char *str);
-
41
-
42LIBICAL_ICAL_EXPORT int icaltriggertype_is_null_trigger(struct icaltriggertype tr);
-
43
-
44LIBICAL_ICAL_EXPORT int icaltriggertype_is_bad_trigger(struct icaltriggertype tr);
-
45
-
46/* struct icalreqstattype. This struct contains two string pointers,
-
47but don't try to free either of them. The "desc" string is a pointer
-
48to a static table inside the library. Don't try to free it. The
-
49"debug" string is a pointer into the string that the called passed
-
50into to icalreqstattype_from_string. Don't try to free it either, and
-
51don't use it after the original string has been freed.
-
52
-
53BTW, you would get that original string from
-
54*icalproperty_get_requeststatus() or icalvalue_get_text(), when
-
55operating on the value of a request_status property. */
-
56
-
57struct icalreqstattype
-
58{
-
59 icalrequeststatus code;
-
60 const char *desc;
-
61 const char *debug;
-
62};
-
63
-
64LIBICAL_ICAL_EXPORT struct icalreqstattype icalreqstattype_from_string(const char *str);
-
65
-
66LIBICAL_ICAL_EXPORT const char *icalreqstattype_as_string(struct icalreqstattype);
-
67
-
68LIBICAL_ICAL_EXPORT char *icalreqstattype_as_string_r(struct icalreqstattype);
-
69
-
70/* ical_unknown_token_handling :
-
71 * How should the ICAL library handle components, properties and parameters with
-
72 * unknown names?
-
73 * FIXME: Currently only affects parameters. Extend to components and properties.
-
74 */
-
75typedef enum ical_unknown_token_handling
-
76{
-
77 ICAL_ASSUME_IANA_TOKEN = 1,
-
78 ICAL_DISCARD_TOKEN = 2,
-
79 ICAL_TREAT_AS_ERROR = 3
-
80} ical_unknown_token_handling;
-
81
-
82LIBICAL_ICAL_EXPORT ical_unknown_token_handling ical_get_unknown_token_handling_setting(void);
-
83
-
84LIBICAL_ICAL_EXPORT void ical_set_unknown_token_handling_setting(
-
85 ical_unknown_token_handling newSetting);
-
86
-
87#endif /* !ICALTYPES_H */
+
1 /*======================================================================
+
2  FILE: icaltypes.h
+
3  CREATOR: eric 20 March 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALTYPES_H
+
20 #define ICALTYPES_H
+
21 
+
22 #include "libical_ical_export.h"
+
23 #include "icalduration.h"
+
24 #include "icalenums.h"
+
25 #include "icalperiod.h"
+
26 
+
27 struct icaldatetimeperiodtype
+
28 {
+
29  struct icaltimetype time;
+
30  struct icalperiodtype period;
+
31 };
+
32 
+
33 struct icalgeotype
+
34 {
+
35  double lat;
+
36  double lon;
+
37 };
+
38 
+
39 struct icaltriggertype
+
40 {
+
41  struct icaltimetype time;
+
42  struct icaldurationtype duration;
+
43 };
+
44 
+
45 LIBICAL_ICAL_EXPORT struct icaltriggertype icaltriggertype_from_int(const int reltime);
+
46 
+
47 LIBICAL_ICAL_EXPORT struct icaltriggertype icaltriggertype_from_string(const char *str);
+
48 
+
49 LIBICAL_ICAL_EXPORT int icaltriggertype_is_null_trigger(struct icaltriggertype tr);
+
50 
+
51 LIBICAL_ICAL_EXPORT int icaltriggertype_is_bad_trigger(struct icaltriggertype tr);
+
52 
+
53 /* struct icalreqstattype. This struct contains two string pointers,
+
54 but don't try to free either of them. The "desc" string is a pointer
+
55 to a static table inside the library. Don't try to free it. The
+
56 "debug" string is a pointer into the string that the called passed
+
57 into to icalreqstattype_from_string. Don't try to free it either, and
+
58 don't use it after the original string has been freed.
+
59 
+
60 BTW, you would get that original string from
+
61 *icalproperty_get_requeststatus() or icalvalue_get_text(), when
+
62 operating on the value of a request_status property. */
+
63 
+
64 struct icalreqstattype
+
65 {
+
66  icalrequeststatus code;
+
67  const char *desc;
+
68  const char *debug;
+
69 };
+
70 
+
71 LIBICAL_ICAL_EXPORT struct icalreqstattype icalreqstattype_from_string(const char *str);
+
72 
+
73 LIBICAL_ICAL_EXPORT const char *icalreqstattype_as_string(struct icalreqstattype);
+
74 
+
75 LIBICAL_ICAL_EXPORT char *icalreqstattype_as_string_r(struct icalreqstattype);
+
76 
+
77 struct icaltimezonephase
+
78 {
+
79  const char *tzname;
+
80  int is_stdandard; /* 1 = standard tme, 0 = daylight savings time */
+
81  struct icaltimetype dtstart;
+
82  int offsetto;
+
83  int tzoffsetfrom;
+
84  const char *comment;
+
85  struct icaldatetimeperiodtype rdate;
+
86  const char *rrule;
+
87 };
+
88 
+
89 struct icaltimezonetype
+
90 {
+
91  const char *tzid;
+
92  struct icaltimetype last_mod;
+
93  const char *tzurl;
+
94 
+
95  /* Array of phases. The end of the array is a phase with tzname == 0 */
+
96  struct icaltimezonephase *phases;
+
97 };
+
98 
+
99 /* ical_unknown_token_handling :
+
100  * How should the ICAL library handle components, properties and parameters with
+
101  * unknown names?
+
102  * FIXME: Currently only affects parameters. Extend to components and properties.
+
103  */
+
104 typedef enum ical_unknown_token_handling
+
105 {
+
106  ICAL_ASSUME_IANA_TOKEN = 1,
+
107  ICAL_DISCARD_TOKEN = 2,
+
108  ICAL_TREAT_AS_ERROR = 3
+
109 } ical_unknown_token_handling;
+
110 
+
111 LIBICAL_ICAL_EXPORT ical_unknown_token_handling ical_get_unknown_token_handling_setting(void);
+
112 
+
113 LIBICAL_ICAL_EXPORT void ical_set_unknown_token_handling_setting(
+
114  ical_unknown_token_handling newSetting);
+
115 
+
116 #endif /* !ICALTYPES_H */
icalduration.h
Methods for working with durations in iCal.
icalperiod.h
Functions for working with iCal periods (of time).
-
icaldatetimeperiodtype
Definition: icaltypes.h:20
-
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:28
-
icalgeotype
Definition: icaltypes.h:27
-
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:29
-
icalreqstattype
Definition: icaltypes.h:58
-
icaltimetype
Definition: icaltime.h:97
-
icaltriggertype
Definition: icaltypes.h:33
+
icaldatetimeperiodtype
Definition: icaltypes.h:28
+
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
+
icalgeotype
Definition: icaltypes.h:34
+
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:38
+
icalreqstattype
Definition: icaltypes.h:65
+
icaltimetype
Definition: icaltime.h:105
+
icaltimezonephase
Definition: icaltypes.h:78
+
icaltimezonetype
Definition: icaltypes.h:90
+
icaltriggertype
Definition: icaltypes.h:40
+
rdate
Definition: icaltimezone.c:2206
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icaltz-util_8h_source.html b/apidocs/icaltz-util_8h_source.html index f7c041bf..40d6c65d 100644 --- a/apidocs/icaltz-util_8h_source.html +++ b/apidocs/icaltz-util_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltz-util.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icaltz-util.h
+
+
icaltz-util.h
-
1/*
-
2 * Authors :
-
3 * Chenthill Palanisamy <pchenthill@novell.com>
-
4 *
-
5 * SPDX-FileCopyrightText: 2007, Novell, Inc.
-
6 *
-
7 * SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8 */
-
9
-
10#ifndef ICALTZUTIL_H
-
11#define ICALTZUTIL_H
-
12
-
13#include "libical_ical_export.h"
-
14#include "icalcomponent.h"
-
15
-
16#if defined(sun) && defined(__SVR4)
-
17#define ZONES_TAB_SYSTEM_FILENAME "tab/zone_sun.tab"
-
18#else
-
19#define ZONES_TAB_SYSTEM_FILENAME "zone.tab"
-
20#endif
-
21
-
30LIBICAL_ICAL_EXPORT const char *icaltzutil_get_zone_directory(void);
-
31
-
39LIBICAL_ICAL_EXPORT void icaltzutil_set_zone_directory(const char *zonepath);
-
40
-
50LIBICAL_ICAL_NO_EXPORT icalcomponent *icaltzutil_fetch_timezone(const char *location);
-
51
-
52#endif
+
1 /*
+
2  * Authors :
+
3  * Chenthill Palanisamy <pchenthill@novell.com>
+
4  *
+
5  * Copyright 2007, Novell, Inc.
+
6  *
+
7  * This library is free software; you can redistribute it and/or modify
+
8  * it under the terms of either:
+
9  *
+
10  * The LGPL as published by the Free Software Foundation, version
+
11  * 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12  *
+
13  * Or:
+
14  *
+
15  * The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  * the License at https://www.mozilla.org/MPL/
+
17  */
+
18 
+
19 #ifndef ICALTZUTIL_H
+
20 #define ICALTZUTIL_H
+
21 
+
22 #include "libical_ical_export.h"
+
23 #include "icalcomponent.h"
+
24 
+
25 #if defined(sun) && defined(__SVR4)
+
26 #define ZONES_TAB_SYSTEM_FILENAME "tab/zone_sun.tab"
+
27 #else
+
28 #define ZONES_TAB_SYSTEM_FILENAME "zone.tab"
+
29 #endif
+
30 
+
31 LIBICAL_ICAL_EXPORT const char *icaltzutil_get_zone_directory(void);
+
32 
+
33 LIBICAL_ICAL_EXPORT icalcomponent *icaltzutil_fetch_timezone(const char *location);
+
34 
+
35 #endif
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalvalue_8h.html b/apidocs/icalvalue_8h.html index cd3c2fee..580b35f4 100644 --- a/apidocs/icalvalue_8h.html +++ b/apidocs/icalvalue_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalvalue.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */ -
icalvalue.h File Reference
+
+
icalvalue.h File Reference

Go to the source code of this file.

- - -

+

Macros

+
#define ICAL_BOOLEAN_FALSE   0
 
+
#define ICAL_BOOLEAN_TRUE   1
 
- - - - + - - - - - + - - - - - - - + - - - - - + + + - - +

+

Functions

+
const char * icalvalue_as_ical_string (const icalvalue *value)
 
+
 
char * icalvalue_as_ical_string_r (const icalvalue *value)
 
icalvalue * icalvalue_clone (const icalvalue *value)
 Deeply clones an icalvalue. More...
 
+
 
icalparameter_xliccomparetype icalvalue_compare (const icalvalue *a, const icalvalue *b)
 
int icalvalue_decode_ical_string (const char *szText, char *szDecText, int nMaxBufferLen)
 
int icalvalue_encode_ical_string (const char *szText, char *szEncText, int MaxBufferLen)
 
+
void icalvalue_free (icalvalue *value)
 
+
int icalvalue_is_valid (const icalvalue *value)
 
+
icalvalue_kind icalvalue_isa (const icalvalue *value)
 
+
int icalvalue_isa_value (void *)
 
int icalvalue_kind_is_valid (const icalvalue_kind kind)
 
+
const char * icalvalue_kind_to_string (const icalvalue_kind kind)
 
+
 
icalvalue * icalvalue_new (icalvalue_kind kind)
 
icalvalue * icalvalue_new_clone (const icalvalue *value))
 Deeply clones an icalvalue. More...
 
+
 
+icalvalue * icalvalue_new_clone (const icalvalue *value)
 
icalvalue * icalvalue_new_from_string (icalvalue_kind kind, const char *str)
 
+
 
icalvalue_kind icalvalue_string_to_kind (const char *str)
 

Function Documentation

- -

◆ icalvalue_clone()

- -
-
- - - - - - - - -
icalvalue * icalvalue_clone (const icalvalue * value)
-
- -

Deeply clones an icalvalue.

-

Returns a pointer to the memory for the newly cloned icalvalue.

Since
3.1.0
- -
-
- +

◆ icalvalue_decode_ical_string()

@@ -185,11 +162,11 @@ icalvalue_kind 
icalvalue_s
-

Extract the original character string encoded by the above function

+

Extract the original character string encoded by the above function

- +

◆ icalvalue_encode_ical_string()

@@ -220,11 +197,11 @@ icalvalue_kind icalvalue_s
-

Encode a character string in ical format, escape certain characters, etc.

+

Encode a character string in ical format, escape certain characters, etc.

- +

◆ icalvalue_kind_is_valid()

@@ -239,36 +216,14 @@ icalvalue_kind icalvalue_s
-

Check validity of a specific icalvalue_kind

- -
- - -

◆ icalvalue_new_clone()

- -
-
- - - - - - - - -
icalvalue * icalvalue_new_clone (const icalvalue * value)
-
- -

Deeply clones an icalvalue.

-

Returns a pointer to the memory for the newly cloned icalvalue.

Since
3.1.0
-
Deprecated:
Use icalvalue_clone() instead
+

Check validity of a specific icalvalue_kind

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalvalue_8h_source.html b/apidocs/icalvalue_8h_source.html index ea24bf8b..d978d8bd 100644 --- a/apidocs/icalvalue_8h_source.html +++ b/apidocs/icalvalue_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalvalue.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalvalue.h
+
+
icalvalue.h
-Go to the documentation of this file.
1/*======================================================================
-
2 FILE: icalvalue.h
-
3 CREATOR: eric 20 March 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 ======================================================================*/
-
10
-
11#ifndef ICALVALUE_H
-
12#define ICALVALUE_H
-
13
-
14#include "libical_deprecated.h"
-
15#include "libical_ical_export.h"
-
16#include "icalvalueimpl.h"
-
17
-
20#define ICAL_BOOLEAN_TRUE 1
-
21#define ICAL_BOOLEAN_FALSE 0
-
22
-
23LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new(icalvalue_kind kind);
-
24
-
30LIBICAL_ICAL_EXPORT icalvalue *icalvalue_clone(const icalvalue *value);
-
31
-
32LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new_from_string(icalvalue_kind kind, const char *str);
-
33
-
34LIBICAL_ICAL_EXPORT void icalvalue_free(icalvalue *value);
-
35
-
36LIBICAL_ICAL_EXPORT int icalvalue_is_valid(const icalvalue *value);
-
37
-
38LIBICAL_ICAL_EXPORT const char *icalvalue_as_ical_string(const icalvalue *value);
-
39
-
40LIBICAL_ICAL_EXPORT char *icalvalue_as_ical_string_r(const icalvalue *value);
-
41
-
42LIBICAL_ICAL_EXPORT icalvalue_kind icalvalue_isa(const icalvalue *value);
-
43
-
44LIBICAL_ICAL_EXPORT int icalvalue_isa_value(void *);
-
45
-
46LIBICAL_ICAL_EXPORT icalparameter_xliccomparetype icalvalue_compare(const icalvalue *a,
-
47 const icalvalue *b);
-
48
-
53LIBICAL_ICAL_EXPORT LIBICAL_DEPRECATED(icalvalue *icalvalue_new_clone(const icalvalue *value));
-
54
-
55/* Special, non autogenerated value accessors */
-
56
-
57/* Defined in icalderivedvalue.h */
-
58/* icalvalue* icalvalue_new_recur (struct icalrecurrencetype v); */
-
59/* void icalvalue_set_recur(icalvalue* value, struct icalrecurrencetype v); */
-
60/* struct icalrecurrencetype icalvalue_get_recur(const icalvalue* value); */
-
61
-
62/* icalvalue* icalvalue_new_trigger (struct icaltriggertype v); */
-
63/* void icalvalue_set_trigger(icalvalue* value, struct icaltriggertype v); */
-
64/* struct icaltriggertype icalvalue_get_trigger(const icalvalue* value); */
-
65
-
66/* icalvalue* icalvalue_new_datetimeperiod (struct icaldatetimeperiodtype v); */
-
67/* void icalvalue_set_datetimeperiod(icalvalue* value, */
-
68/* struct icaldatetimeperiodtype v); */
-
69/* struct icaldatetimeperiodtype icalvalue_get_datetimeperiod(const icalvalue* value); */
-
70
-
71/* Convert enumerations */
-
72
-
73LIBICAL_ICAL_EXPORT icalvalue_kind icalvalue_string_to_kind(const char *str);
-
74
-
75LIBICAL_ICAL_EXPORT const char *icalvalue_kind_to_string(const icalvalue_kind kind);
-
76
-
78LIBICAL_ICAL_EXPORT int icalvalue_kind_is_valid(const icalvalue_kind kind);
-
79
-
81LIBICAL_ICAL_EXPORT int icalvalue_encode_ical_string(const char *szText,
-
82 char *szEncText, int MaxBufferLen);
-
83
-
85LIBICAL_ICAL_EXPORT int icalvalue_decode_ical_string(const char *szText,
-
86 char *szDecText, int nMaxBufferLen);
-
87
-
88/* For the library only -- do not make visible */
-
90extern void print_date_to_string(char *str, const struct icaltimetype *data);
-
91extern void print_datetime_to_string(char *str, const struct icaltimetype *data);
-
93
-
94#endif /*ICALVALUE_H */
-
icalvalue_encode_ical_string
int icalvalue_encode_ical_string(const char *szText, char *szEncText, int MaxBufferLen)
Definition: icalvalue.c:1479
-
icalvalue_new_clone
icalvalue * icalvalue_new_clone(const icalvalue *value))
Deeply clones an icalvalue.
Definition: icalvalue.c:160
-
icalvalue_clone
icalvalue * icalvalue_clone(const icalvalue *value)
Deeply clones an icalvalue.
Definition: icalvalue.c:57
-
icalvalue_decode_ical_string
int icalvalue_decode_ical_string(const char *szText, char *szDecText, int nMaxBufferLen)
Definition: icalvalue.c:1510
+Go to the documentation of this file.
1 /*======================================================================
+
2  FILE: icalvalue.h
+
3  CREATOR: eric 20 March 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17  ======================================================================*/
+
18 
+
19 #ifndef ICALVALUE_H
+
20 #define ICALVALUE_H
+
21 
+
22 #include "libical_ical_export.h"
+
23 #include "icalvalueimpl.h"
+
24 
+
27 #define ICAL_BOOLEAN_TRUE 1
+
28 #define ICAL_BOOLEAN_FALSE 0
+
29 
+
30 LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new(icalvalue_kind kind);
+
31 
+
32 LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new_clone(const icalvalue *value);
+
33 
+
34 LIBICAL_ICAL_EXPORT icalvalue *icalvalue_new_from_string(icalvalue_kind kind, const char *str);
+
35 
+
36 LIBICAL_ICAL_EXPORT void icalvalue_free(icalvalue *value);
+
37 
+
38 LIBICAL_ICAL_EXPORT int icalvalue_is_valid(const icalvalue *value);
+
39 
+
40 LIBICAL_ICAL_EXPORT const char *icalvalue_as_ical_string(const icalvalue *value);
+
41 
+
42 LIBICAL_ICAL_EXPORT char *icalvalue_as_ical_string_r(const icalvalue *value);
+
43 
+
44 LIBICAL_ICAL_EXPORT icalvalue_kind icalvalue_isa(const icalvalue *value);
+
45 
+
46 LIBICAL_ICAL_EXPORT int icalvalue_isa_value(void *);
+
47 
+
48 LIBICAL_ICAL_EXPORT icalparameter_xliccomparetype icalvalue_compare(const icalvalue *a,
+
49  const icalvalue *b);
+
50 
+
51 /* Special, non autogenerated value accessors */
+
52 
+
53 /* Defined in icalderivedvalue.h */
+
54 /* icalvalue* icalvalue_new_recur (struct icalrecurrencetype v); */
+
55 /* void icalvalue_set_recur(icalvalue* value, struct icalrecurrencetype v); */
+
56 /* struct icalrecurrencetype icalvalue_get_recur(const icalvalue* value); */
+
57 
+
58 /* icalvalue* icalvalue_new_trigger (struct icaltriggertype v); */
+
59 /* void icalvalue_set_trigger(icalvalue* value, struct icaltriggertype v); */
+
60 /* struct icaltriggertype icalvalue_get_trigger(const icalvalue* value); */
+
61 
+
62 /* icalvalue* icalvalue_new_datetimeperiod (struct icaldatetimeperiodtype v); */
+
63 /* void icalvalue_set_datetimeperiod(icalvalue* value, */
+
64 /* struct icaldatetimeperiodtype v); */
+
65 /* struct icaldatetimeperiodtype icalvalue_get_datetimeperiod(const icalvalue* value); */
+
66 
+
67 /* Convert enumerations */
+
68 
+
69 LIBICAL_ICAL_EXPORT icalvalue_kind icalvalue_string_to_kind(const char *str);
+
70 
+
71 LIBICAL_ICAL_EXPORT const char *icalvalue_kind_to_string(const icalvalue_kind kind);
+
72 
+
74 LIBICAL_ICAL_EXPORT int icalvalue_kind_is_valid(const icalvalue_kind kind);
+
75 
+
77 LIBICAL_ICAL_EXPORT int icalvalue_encode_ical_string(const char *szText,
+
78  char *szEncText, int MaxBufferLen);
+
79 
+
81 LIBICAL_ICAL_EXPORT int icalvalue_decode_ical_string(const char *szText,
+
82  char *szDecText, int nMaxBufferLen);
+
83 
+
84 /* For the library only -- do not make visible */
+
86 extern void print_date_to_string(char *str, const struct icaltimetype *data);
+
87 extern void print_datetime_to_string(char *str, const struct icaltimetype *data);
+
89 
+
90 #endif /*ICALVALUE_H */
+
icalvalue_encode_ical_string
int icalvalue_encode_ical_string(const char *szText, char *szEncText, int MaxBufferLen)
Definition: icalvalue.c:1483
+
icalvalue_decode_ical_string
int icalvalue_decode_ical_string(const char *szText, char *szDecText, int nMaxBufferLen)
Definition: icalvalue.c:1514
icalvalue_kind_is_valid
int icalvalue_kind_is_valid(const icalvalue_kind kind)
-
icaltimetype
Definition: icaltime.h:97
+
icaltimetype
Definition: icaltime.h:105
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalvalue__cxx_8h_source.html b/apidocs/icalvalue__cxx_8h_source.html index 308b7cb3..5d7360ff 100644 --- a/apidocs/icalvalue__cxx_8h_source.html +++ b/apidocs/icalvalue__cxx_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalvalue_cxx.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalvalue_cxx.h
+
+
icalvalue_cxx.h
-
1/*======================================================================
-
2 FILE: icalvalue_cxx.h
-
3 CREATOR: fnguyen 12/13/01
-
4 SPDX-FileCopyrightText: 2001, Critical Path
-
5
-
6 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
7
-
8======================================================================*/
-
9
-
10#ifndef ICALVALUE_CXX_H
-
11#define ICALVALUE_CXX_H
-
12
-
13#include "libical_ical_export.h"
-
14#include "icptrholder_cxx.h"
-
15
-
16extern "C"
-
17{
-
18#include "icalerror.h"
-
19#include "icalvalue.h"
-
20}
-
21
-
22#include <string>
-
23
-
24namespace LibICal
-
25{
-
26
-
27class LIBICAL_ICAL_EXPORT ICalValue
-
28{
-
29public:
-
30 ICalValue();
-
31 ICalValue(const ICalValue &);
-
32 ICalValue &operator=(const ICalValue &);
-
33 ~ICalValue();
-
34
-
35 explicit ICalValue(icalvalue *);
-
36 explicit ICalValue(const icalvalue_kind &kind);
-
37 ICalValue(const icalvalue_kind &kind, const std::string &str);
-
38
-
39 operator icalvalue *()
-
40 {
-
41 return imp;
-
42 }
-
43
-
44 void detach();
-
45
-
46public:
-
47 std::string as_ical_string();
-
48 bool is_valid();
-
49 icalvalue_kind isa();
-
50 int isa_value(void *);
-
51
-
52 /* Special, non autogenerated value accessors */
-
53 void set_recur(const struct icalrecurrencetype &v);
-
54 struct icalrecurrencetype get_recur();
-
55
-
56 void set_trigger(const struct icaltriggertype &v);
-
57 struct icaltriggertype get_trigger();
-
58
-
59 void set_datetimeperiod(const struct icaldatetimeperiodtype &v);
-
60 struct icaldatetimeperiodtype get_datetimeperiod();
-
61
-
62public:
-
63 static icalparameter_xliccomparetype compare(ICalValue &a, ICalValue &b);
-
64
-
65 /* Convert enumerations */
-
66 static icalvalue_kind string_to_kind(const std::string &str);
-
67 std::string kind_to_string(const icalvalue_kind &kind);
-
68
-
69public:
-
70 /* BOOLEAN */
-
71 int get_boolean() const;
-
72 void set_boolean(const int &v);
-
73
-
74 /* UTC-OFFSET */
-
75 int get_utcoffset() const;
-
76 void set_utcoffset(const int &v);
-
77
-
78 /* METHOD */
-
79 enum icalproperty_method get_method() const;
-
80 void set_method(const enum icalproperty_method &v);
-
81
-
82 /* CAL-ADDRESS */
-
83 std::string get_caladdress() const;
-
84 void set_caladdress(const std::string &v);
-
85
-
86 /* PERIOD */
-
87 struct icalperiodtype get_period() const;
-
88 void set_period(const struct icalperiodtype &v);
-
89
-
90 /* STATUS */
-
91 enum icalproperty_status get_status() const;
-
92 void set_status(const enum icalproperty_status &v);
-
93
-
94 /* BINARY */
-
95 std::string get_binary() const;
-
96 void set_binary(const std::string &v);
-
97
-
98 /* TEXT */
-
99 std::string get_text() const;
-
100 void set_text(const std::string &v);
-
101
-
102 /* DURATION */
-
103 struct icaldurationtype get_duration() const;
-
104 void set_duration(const struct icaldurationtype &v);
-
105
-
106 /* INTEGER */
-
107 int get_integer() const;
-
108 void set_integer(const int &v);
-
109
-
110 /* URI */
-
111 std::string get_uri() const;
-
112 void set_uri(const std::string &v);
-
113
-
114 /* ATTACH */
-
115 icalattach *get_attach();
-
116 void set_attach(icalattach *v);
-
117
-
118 /* CLASS */
-
119 enum icalproperty_class get_class() const;
-
120 void set_class(const enum icalproperty_class &v);
-
121
-
122 /* FLOAT */
-
123 float get_float() const;
-
124 void set_float(const float &v);
-
125
-
126 /* QUERY */
-
127 std::string get_query() const;
-
128 void set_query(const std::string &v);
-
129
-
130 /* STRING */
-
131 std::string get_string() const;
-
132 void set_string(const std::string &v);
-
133
-
134 /* TRANSP */
-
135 enum icalproperty_transp get_transp() const;
-
136 void set_transp(const enum icalproperty_transp &v);
-
137
-
138 /* DATE-TIME */
-
139 struct icaltimetype get_datetime() const;
-
140 void set_datetime(const struct icaltimetype &v);
-
141
-
142 /* GEO */
-
143 struct icalgeotype get_geo() const;
-
144 void set_geo(const struct icalgeotype &v);
-
145
-
146 /* DATE */
-
147 struct icaltimetype get_date() const;
-
148 void set_date(const struct icaltimetype &v);
-
149
-
150 /* ACTION */
-
151 enum icalproperty_action get_action() const;
-
152 void set_action(const enum icalproperty_action &v);
-
153
-
154private:
-
155 icalvalue *imp;
-
156};
-
157
-
158} // namespace LibICal
-
159
-
160typedef ICPointerHolder < LibICal::ICalValue > ICalValueTmpPtr;
-
161
-
162#endif
-
ICPointerHolder
Definition: icptrholder_cxx.h:40
-
LibICal::ICalValue
Definition: icalvalue_cxx.h:28
+
1 /*======================================================================
+
2  FILE: icalvalue_cxx.h
+
3  CREATOR: fnguyen 12/13/01
+
4  (C) COPYRIGHT 2001, Critical Path
+
5 
+
6  This library is free software; you can redistribute it and/or modify
+
7  it under the terms of either:
+
8 
+
9  The LGPL as published by the Free Software Foundation, version
+
10  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
11 
+
12  Or:
+
13 
+
14  The Mozilla Public License Version 2.0. You may obtain a copy of
+
15  the License at https://www.mozilla.org/MPL/
+
16 ======================================================================*/
+
17 
+
18 #ifndef ICALVALUE_CXX_H
+
19 #define ICALVALUE_CXX_H
+
20 
+
21 #include "libical_ical_export.h"
+
22 #include "icptrholder_cxx.h"
+
23 
+
24 extern "C"
+
25 {
+
26 #include "icalerror.h"
+
27 #include "icalvalue.h"
+
28 }
+
29 
+
30 #include <string>
+
31 
+
32 namespace LibICal
+
33 {
+
34 
+
35 class LIBICAL_ICAL_EXPORT ICalValue
+
36 {
+
37 public:
+
38  ICalValue();
+
39  ICalValue(const ICalValue &);
+
40  ICalValue &operator=(const ICalValue &);
+
41  ~ICalValue();
+
42 
+
43  explicit ICalValue(icalvalue *);
+
44  explicit ICalValue(const icalvalue_kind &kind);
+
45  ICalValue(const icalvalue_kind &kind, const std::string &str);
+
46 
+
47  operator icalvalue *()
+
48  {
+
49  return imp;
+
50  }
+
51 
+
52  void detach();
+
53 
+
54 public:
+
55  std::string as_ical_string();
+
56  bool is_valid();
+
57  icalvalue_kind isa();
+
58  int isa_value(void *);
+
59 
+
60  /* Special, non autogenerated value accessors */
+
61  void set_recur(const struct icalrecurrencetype &v);
+
62  struct icalrecurrencetype get_recur();
+
63 
+
64  void set_trigger(const struct icaltriggertype &v);
+
65  struct icaltriggertype get_trigger();
+
66 
+
67  void set_datetimeperiod(const struct icaldatetimeperiodtype &v);
+
68  struct icaldatetimeperiodtype get_datetimeperiod();
+
69 
+
70 public:
+
71  static icalparameter_xliccomparetype compare(ICalValue &a, ICalValue &b);
+
72 
+
73  /* Convert enumerations */
+
74  static icalvalue_kind string_to_kind(const std::string &str);
+
75  std::string kind_to_string(const icalvalue_kind &kind);
+
76 
+
77 public:
+
78  /* BOOLEAN */
+
79  int get_boolean() const;
+
80  void set_boolean(const int &v);
+
81 
+
82  /* UTC-OFFSET */
+
83  int get_utcoffset() const;
+
84  void set_utcoffset(const int &v);
+
85 
+
86  /* METHOD */
+
87  enum icalproperty_method get_method() const;
+
88  void set_method(const enum icalproperty_method &v);
+
89 
+
90  /* CAL-ADDRESS */
+
91  std::string get_caladdress() const;
+
92  void set_caladdress(const std::string &v);
+
93 
+
94  /* PERIOD */
+
95  struct icalperiodtype get_period() const;
+
96  void set_period(const struct icalperiodtype &v);
+
97 
+
98  /* STATUS */
+
99  enum icalproperty_status get_status() const;
+
100  void set_status(const enum icalproperty_status &v);
+
101 
+
102  /* BINARY */
+
103  std::string get_binary() const;
+
104  void set_binary(const std::string &v);
+
105 
+
106  /* TEXT */
+
107  std::string get_text() const;
+
108  void set_text(const std::string &v);
+
109 
+
110  /* DURATION */
+
111  struct icaldurationtype get_duration() const;
+
112  void set_duration(const struct icaldurationtype &v);
+
113 
+
114  /* INTEGER */
+
115  int get_integer() const;
+
116  void set_integer(const int &v);
+
117 
+
118  /* URI */
+
119  std::string get_uri() const;
+
120  void set_uri(const std::string &v);
+
121 
+
122  /* ATTACH */
+
123  icalattach *get_attach();
+
124  void set_attach(icalattach *v);
+
125 
+
126  /* CLASS */
+
127  enum icalproperty_class get_class() const;
+
128  void set_class(const enum icalproperty_class &v);
+
129 
+
130  /* FLOAT */
+
131  float get_float() const;
+
132  void set_float(const float &v);
+
133 
+
134  /* QUERY */
+
135  std::string get_query() const;
+
136  void set_query(const std::string &v);
+
137 
+
138  /* STRING */
+
139  std::string get_string() const;
+
140  void set_string(const std::string &v);
+
141 
+
142  /* TRANSP */
+
143  enum icalproperty_transp get_transp() const;
+
144  void set_transp(const enum icalproperty_transp &v);
+
145 
+
146  /* DATE-TIME */
+
147  struct icaltimetype get_datetime() const;
+
148  void set_datetime(const struct icaltimetype &v);
+
149 
+
150  /* GEO */
+
151  struct icalgeotype get_geo() const;
+
152  void set_geo(const struct icalgeotype &v);
+
153 
+
154  /* DATE */
+
155  struct icaltimetype get_date() const;
+
156  void set_date(const struct icaltimetype &v);
+
157 
+
158  /* ACTION */
+
159  enum icalproperty_action get_action() const;
+
160  void set_action(const enum icalproperty_action &v);
+
161 
+
162 private:
+
163  icalvalue *imp;
+
164 };
+
165 
+
166 } // namespace LibICal
+
167 
+
168 typedef ICPointerHolder < LibICal::ICalValue > ICalValueTmpPtr;
+
169 
+
170 #endif
+
ICPointerHolder
Definition: icptrholder_cxx.h:48
+
LibICal::ICalValue
Definition: icalvalue_cxx.h:36
icalerror.h
Error handling for libical.
icptrholder_cxx.h
C++ template classes for managing C++ pointers returned by VComponent::get_..._component,...
-
icalattach_impl
Definition: icalattachimpl.h:18
-
icaldatetimeperiodtype
Definition: icaltypes.h:20
-
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:28
-
icalgeotype
Definition: icaltypes.h:27
-
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:29
-
icalrecurrencetype
Definition: icalrecur.h:144
-
icaltimetype
Definition: icaltime.h:97
-
icaltriggertype
Definition: icaltypes.h:33
+
icalattach_impl
Definition: icalattachimpl.h:26
+
icaldatetimeperiodtype
Definition: icaltypes.h:28
+
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
+
icalgeotype
Definition: icaltypes.h:34
+
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:38
+
icalrecurrencetype
Definition: icalrecur.h:152
+
icaltimetype
Definition: icaltime.h:105
+
icaltriggertype
Definition: icaltypes.h:40
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalvalueimpl_8h_source.html b/apidocs/icalvalueimpl_8h_source.html index 7ca94c86..de02d209 100644 --- a/apidocs/icalvalueimpl_8h_source.html +++ b/apidocs/icalvalueimpl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalvalueimpl.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalvalueimpl.h
+
+
icalvalueimpl.h
-
1/*======================================================================
-
2 FILE: icalvalue.c
-
3 CREATOR: eric 02 May 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 Contributions from:
-
10 Graham Davison (g.m.davison@computer.org)
-
11======================================================================*/
-
12
-
13#ifndef ICALVALUEIMPL_H
-
14#define ICALVALUEIMPL_H
-
15
-
16#include "icalproperty.h"
-
17
-
18struct icalvalue_impl
-
19{
-
20 icalvalue_kind kind; /*this is the kind that is visible from the outside */
-
21
-
22 char id[5];
-
23 int size;
-
24 icalproperty *parent;
-
25 char *x_value;
-
26
-
27 union data
-
28 {
-
29 icalattach *v_attach;
-
30 /* void *v_binary; *//* use v_attach */
-
31
-
32 const char *v_string;
-
33 /*char *v_text; */ /* use v_string */
-
34 /*char *v_caladdress; *//* use v_string */
-
35 /*char *v_query; */ /* use v_string */
-
36 /*char *v_uri; */ /* use v_string */
-
37
-
38 float v_float;
-
39
-
40 int v_int;
-
41 /*int v_boolean; */ /* use v_int */
-
42 /*int v_integer; */ /* use v_int */
-
43 /*int v_utcoffset; *//* use v_int */
-
44
-
45 struct icaldurationtype v_duration;
-
46
-
47 struct icalperiodtype v_period;
-
48 /*struct icalperiodtype v_datetimeperiod; *//* use v_time/v_period */
-
49
-
50 struct icalgeotype v_geo;
-
51
-
52 struct icaltimetype v_time;
-
53 /*struct icaltimetype v_date; */ /* use v_time */
-
54 /*struct icaltimetype v_datetime; */ /* use v_time */
-
55 /*struct icaltimetype v_datetimedate; *//* use v_time */
-
56
-
57 struct icalreqstattype v_requeststatus;
-
58
-
59 /* struct icalrecurrencetype was once included
-
60 directly ( not referenced ) in this union, but it
-
61 contributes 2000 bytes to every value, so now it is
-
62 a reference */
-
63 struct icalrecurrencetype *v_recur;
-
64
-
65 /*struct icaltriggertype v_trigger; *//* use v_time/v_duration */
-
66
-
67 int v_enum;
-
68 /* v_enum takes care of several enumerated types including:
-
69 icalproperty_method v_method;
-
70 icalproperty_status v_status;
-
71 icalproperty_action v_action;
-
72 icalproperty_class v_class;
-
73 icalproperty_transp v_transp;
-
74 icalproperty_busytype v_busytype;
-
75 icalproperty_taskmode v_taskmode;
-
76 icalproperty_pollmode v_pollmode;
-
77 icalproperty_pollcompletion v_pollcomplete;
-
78 */
-
79
-
80 } data;
-
81};
-
82
-
83#endif
+
1 /*======================================================================
+
2  FILE: icalvalue.c
+
3  CREATOR: eric 02 May 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 
+
18  Contributions from:
+
19  Graham Davison (g.m.davison@computer.org)
+
20 ======================================================================*/
+
21 
+
22 #ifndef ICALVALUEIMPL_H
+
23 #define ICALVALUEIMPL_H
+
24 
+
25 #include "icalproperty.h"
+
26 
+
27 struct icalvalue_impl
+
28 {
+
29  icalvalue_kind kind; /*this is the kind that is visible from the outside */
+
30 
+
31  char id[5];
+
32  int size;
+
33  icalproperty *parent;
+
34  char *x_value;
+
35 
+
36  union data
+
37  {
+
38  icalattach *v_attach;
+
39  /* void *v_binary; *//* use v_attach */
+
40 
+
41  const char *v_string;
+
42  /*char *v_text; */ /* use v_string */
+
43  /*char *v_caladdress; *//* use v_string */
+
44  /*char *v_query; */ /* use v_string */
+
45  /*char *v_uri; */ /* use v_string */
+
46 
+
47  float v_float;
+
48 
+
49  int v_int;
+
50  /*int v_boolean; */ /* use v_int */
+
51  /*int v_integer; */ /* use v_int */
+
52  /*int v_utcoffset; *//* use v_int */
+
53 
+
54  struct icaldurationtype v_duration;
+
55 
+
56  struct icalperiodtype v_period;
+
57  /*struct icalperiodtype v_datetimeperiod; *//* use v_time/v_period */
+
58 
+
59  struct icalgeotype v_geo;
+
60 
+
61  struct icaltimetype v_time;
+
62  /*struct icaltimetype v_date; */ /* use v_time */
+
63  /*struct icaltimetype v_datetime; */ /* use v_time */
+
64  /*struct icaltimetype v_datetimedate; *//* use v_time */
+
65 
+
66  struct icalreqstattype v_requeststatus;
+
67 
+
68  /* struct icalrecurrencetype was once included
+
69  directly ( not referenced ) in this union, but it
+
70  contributes 2000 bytes to every value, so now it is
+
71  a reference */
+
72  struct icalrecurrencetype *v_recur;
+
73 
+
74  /*struct icaltriggertype v_trigger; *//* use v_time/v_duration */
+
75 
+
76  int v_enum;
+
77  /* v_enum takes care of several enumerated types including:
+
78  icalproperty_method v_method;
+
79  icalproperty_status v_status;
+
80  icalproperty_action v_action;
+
81  icalproperty_class v_class;
+
82  icalproperty_transp v_transp;
+
83  icalproperty_busytype v_busytype;
+
84  icalproperty_taskmode v_taskmode;
+
85  icalproperty_pollmode v_pollmode;
+
86  icalproperty_pollcompletion v_pollcomplete;
+
87  */
+
88 
+
89  } data;
+
90 };
+
91 
+
92 #endif
-
icalattach_impl
Definition: icalattachimpl.h:18
-
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:28
-
icalgeotype
Definition: icaltypes.h:27
-
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:29
-
icalrecurrencetype
Definition: icalrecur.h:144
-
icalreqstattype
Definition: icaltypes.h:58
-
icaltimetype
Definition: icaltime.h:97
-
icalvalue_impl
Definition: icalvalueimpl.h:19
-
icalvalue_impl::data
Definition: icalvalueimpl.h:28
+
icalattach_impl
Definition: icalattachimpl.h:26
+
icaldurationtype
A struct representing a duration.
Definition: icalduration.h:37
+
icalgeotype
Definition: icaltypes.h:34
+
icalperiodtype
Struct to represent a period in time.
Definition: icalperiod.h:38
+
icalrecurrencetype
Definition: icalrecur.h:152
+
icalreqstattype
Definition: icaltypes.h:65
+
icaltimetype
Definition: icaltime.h:105
+
icalvalue_impl
Definition: icalvalueimpl.h:28
+
icalvalue_impl::data
Definition: icalvalueimpl.h:37
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalvcal_8h_source.html b/apidocs/icalvcal_8h_source.html index 66c3cc11..ae3e0d2a 100644 --- a/apidocs/icalvcal_8h_source.html +++ b/apidocs/icalvcal_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalvcal.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalvcal.h
+
+
icalvcal.h
-
1/*======================================================================
-
2 FILE: icalvcal.h
-
3 CREATOR: eric 25 May 00
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9======================================================================*/
-
10
-
11#ifndef ICALVCAL_H
-
12#define ICALVCAL_H
-
13
-
14#include "libical_vcal_export.h"
-
15#include "vobject.h"
-
16#include "icalcomponent.h"
-
17
-
18/* These are used as default values if the values are missing in the vCalendar
-
19 file. Gnome Calendar, for example, does not save the URL of the audio alarm,
-
20 so we have to add a value here to make a valid iCalendar object. */
-
21typedef struct _icalvcal_defaults icalvcal_defaults;
-
22struct _icalvcal_defaults
-
23{
-
24 char *alarm_audio_url;
-
25 char *alarm_audio_fmttype;
-
26 char *alarm_description;
-
27};
-
28
-
29/* Convert a vObject into an icalcomponent */
-
30
-
31LIBICAL_VCAL_EXPORT icalcomponent *icalvcal_convert(VObject *object);
-
32
-
33LIBICAL_VCAL_EXPORT icalcomponent *icalvcal_convert_with_defaults(VObject *object,
-
34 icalvcal_defaults * defaults);
-
35
-
36#endif /* !ICALVCAL_H */
+
1 /*======================================================================
+
2  FILE: icalvcal.h
+
3  CREATOR: eric 25 May 00
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17 ======================================================================*/
+
18 
+
19 #ifndef ICALVCAL_H
+
20 #define ICALVCAL_H
+
21 
+
22 #include "libical_vcal_export.h"
+
23 #include "vobject.h"
+
24 #include "icalcomponent.h"
+
25 
+
26 /* These are used as default values if the values are missing in the vCalendar
+
27  file. Gnome Calendar, for example, does not save the URL of the audio alarm,
+
28  so we have to add a value here to make a valid iCalendar object. */
+
29 typedef struct _icalvcal_defaults icalvcal_defaults;
+
30 struct _icalvcal_defaults
+
31 {
+
32  char *alarm_audio_url;
+
33  char *alarm_audio_fmttype;
+
34  char *alarm_description;
+
35 };
+
36 
+
37 /* Convert a vObject into an icalcomponent */
+
38 
+
39 LIBICAL_VCAL_EXPORT icalcomponent *icalvcal_convert(VObject *object);
+
40 
+
41 LIBICAL_VCAL_EXPORT icalcomponent *icalvcal_convert_with_defaults(VObject *object,
+
42  icalvcal_defaults * defaults);
+
43 
+
44 #endif /* !ICALVCAL_H */
-
VObject
Definition: vobject.c:43
-
_icalvcal_defaults
Definition: icalvcal.h:23
-
icalcomponent_impl
Definition: icalcomponent.c:28
+
VObject
Definition: vobject.c:69
+
_icalvcal_defaults
Definition: icalvcal.h:31
+
icalcomponent_impl
Definition: icalcomponent.c:36
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icalversion_8h_source.html b/apidocs/icalversion_8h_source.html index 50aedfe4..14f7d3c3 100644 --- a/apidocs/icalversion_8h_source.html +++ b/apidocs/icalversion_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalversion.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icalversion.h
+
+
icalversion.h
-
1/*======================================================================
-
2 FILE: icalversion.h
-
3 CREATOR: eric 20 March 1999
-
4
-
5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
-
6
-
7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-
8
-
9 ======================================================================*/
-
10
-
11#ifndef ICAL_VERSION_H
-
12#define ICAL_VERSION_H
-
13
-
14#define ICAL_PACKAGE "libical"
-
15#define ICAL_VERSION "3.1"
-
16
-
17#define ICAL_MAJOR_VERSION (3)
-
18#define ICAL_MINOR_VERSION (0)
-
19#define ICAL_PATCH_VERSION (95)
-
20#define ICAL_MICRO_VERSION ICAL_PATCH_VERSION
-
21
-
31#define ICAL_CHECK_VERSION(major,minor,micro) \
-
32 (ICAL_MAJOR_VERSION > (major) || \
-
33 (ICAL_MAJOR_VERSION == (major) && ICAL_MINOR_VERSION > (minor)) || \
-
34 (ICAL_MAJOR_VERSION == (major) && ICAL_MINOR_VERSION == (minor) && \
-
35 ICAL_MICRO_VERSION >= (micro)))
-
36
-
37#endif
+
1 /*======================================================================
+
2  FILE: icalversion.h
+
3  CREATOR: eric 20 March 1999
+
4 
+
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
+
6 
+
7  This library is free software; you can redistribute it and/or modify
+
8  it under the terms of either:
+
9 
+
10  The LGPL as published by the Free Software Foundation, version
+
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
+
12 
+
13  Or:
+
14 
+
15  The Mozilla Public License Version 2.0. You may obtain a copy of
+
16  the License at https://www.mozilla.org/MPL/
+
17  ======================================================================*/
+
18 
+
19 #ifndef ICAL_VERSION_H
+
20 #define ICAL_VERSION_H
+
21 
+
22 #define ICAL_PACKAGE "libical"
+
23 #define ICAL_VERSION "3.0"
+
24 
+
25 #define ICAL_MAJOR_VERSION (3)
+
26 #define ICAL_MINOR_VERSION (0)
+
27 #define ICAL_PATCH_VERSION (15)
+
28 #define ICAL_MICRO_VERSION ICAL_PATCH_VERSION
+
29 
+
39 #define ICAL_CHECK_VERSION(major,minor,micro) \
+
40  (ICAL_MAJOR_VERSION > (major) || \
+
41  (ICAL_MAJOR_VERSION == (major) && ICAL_MINOR_VERSION > (minor)) || \
+
42  (ICAL_MAJOR_VERSION == (major) && ICAL_MINOR_VERSION == (minor) && \
+
43  ICAL_MICRO_VERSION >= (micro)))
+
44 
+
45 #endif
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icptrholder__cxx_8h.html b/apidocs/icptrholder__cxx_8h.html index 07ee7691..58d1ac1c 100644 --- a/apidocs/icptrholder__cxx_8h.html +++ b/apidocs/icptrholder__cxx_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icptrholder_cxx.h File Reference @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
Data Structures
-
icptrholder_cxx.h File Reference
+
+
icptrholder_cxx.h File Reference
@@ -77,25 +78,28 @@ $(function() {

Go to the source code of this file.

-

+

Data Structures

class  ICPointerHolder< T >
 

Detailed Description

-

C++ template classes for managing C++ pointers returned by VComponent::get_..._component, VComponent::get_..._property, ICalProperty::get_..._value.

+

C++ template classes for managing C++ pointers returned by VComponent::get_..._component, VComponent::get_..._property, ICalProperty::get_..._value.

Author
wyau (08/29/02)
Remarks
VComponent::get... functions returns a C++ object that wraps the libical implementation. It is important to note that the wrapped implementation still belongs to the original component. To stop memory leak, caller must delete the pointer. However, the destructor will call the appropriate free function. eg. ~VComponent calls icalcomponent_free(imp).

As stated previously, imp still belongs to the original component. To avoid freeing the wrapped "imp", caller must set the "imp" to null before deleting the pointer.

-

The template class relieves the burden of memory management when used as a stack based object. The class holds a pointer to the C++ Wrapper. The destructor set the imp to null before deleting the pointer.

-

Each C++ Wrapper instantiates a template class in its corresponding .h file.

-

Usage example: VComponentTmpPtr p;// VComponentTmpPtr is an instantiation of this template for (p=component.get_first_component; p!= 0; p=component.get_next_component) {

-

SPDX-FileCopyrightText: 2001, Critical Path

-

SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0

+

The template class relieves the burden of memory management when used as a stack based object. The class holds a pointer to the C++ Wrapper. The destructor set the imp to null before deleting the pointer.

+

Each C++ Wrapper instantiates a template class in its corresponding .h file.

+

Usage example: VComponentTmpPtr p;// VComponentTmpPtr is an instantiation of this template for (p=component.get_first_component; p!= 0; p=component.get_next_component) {

+

(C) COPYRIGHT 2001, Critical Path

+

This library is free software; you can redistribute it and/or modify it under the terms of either:

+

The LGPL as published by the Free Software Foundation, version 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html

+

Or:

+

The Mozilla Public License Version 2.0. You may obtain a copy of the License at https://www.mozilla.org/MPL/

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/icptrholder__cxx_8h_source.html b/apidocs/icptrholder__cxx_8h_source.html index f1776a76..9608f5a9 100644 --- a/apidocs/icptrholder__cxx_8h_source.html +++ b/apidocs/icptrholder__cxx_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icptrholder_cxx.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
icptrholder_cxx.h
+
+
icptrholder_cxx.h
-Go to the documentation of this file.
1
-
34#ifndef ICPTRHOLDER_CXX_H
-
35#define ICPTRHOLDER_CXX_H
-
36
-
37#include <cassert>
-
38
-
39template < class T > class ICPointerHolder
-
40{
-
41public:
-
42 ICPointerHolder()
-
43 : ptr(0)
-
44 {
-
45 }
-
46
-
47 ICPointerHolder(T *p)
-
48 : ptr(p)
-
49 {
-
50 }
-
51
-
52 // copy constructor to support assignment
-
53 ICPointerHolder(const ICPointerHolder &ip)
-
54 : ptr(ip.ptr)
-
55 {
-
56 // We need to transfer ownership of ptr to this object by setting
-
57 // ip's ptr to null. Otherwise, ptr will de deleted twice.
-
58 // const ugliness requires us to do the const_cast.
-
59 ICPointerHolder *ipp = const_cast < ICPointerHolder * >(&ip);
-
60
-
61 ipp->ptr = 0;
-
62 };
-
63
-
64 ~ICPointerHolder()
-
65 {
-
66 release();
-
67 }
-
68
-
69 ICPointerHolder &operator=(T *p)
-
70 {
-
71 this->release();
-
72 ptr = p;
-
73 return *this;
-
74 }
-
75
-
76 ICPointerHolder &operator=(ICPointerHolder &p)
-
77 {
-
78 this->release();
-
79 ptr = p.ptr; // this transfer ownership of the pointer
-
80 p.ptr = 0; // set it to null so the pointer won't get delete twice.
-
81 return *this;
-
82 }
-
83
-
84 bool operator!=(T *p)
-
85 {
-
86 return (ptr != p);
-
87 }
-
88
-
89 bool operator==(T *p)
-
90 {
-
91 return (ptr == p);
-
92 }
-
93
-
94 operator T *() const
-
95 {
-
96 return ptr;
-
97 }
-
98
-
99 T *operator->() const
-
100 {
-
101 icalassert(ptr);
-
102 return ptr;
-
103 }
-
104
-
105 T &operator*()
-
106 {
-
107 icalassert(ptr);
-
108 return *ptr;
-
109 }
-
110
-
111private:
-
112 void release()
-
113 {
-
114 if (ptr != 0) {
-
115 ptr->detach();
-
116 delete ptr;
-
117
-
118 ptr = 0;
-
119 }
-
120 }
-
121
-
122 T *ptr;
-
123};
-
124
-
125#endif
-
ICPointerHolder
Definition: icptrholder_cxx.h:40
+Go to the documentation of this file.
1 
+
42 #ifndef ICPTRHOLDER_CXX_H
+
43 #define ICPTRHOLDER_CXX_H
+
44 
+
45 #include <cassert>
+
46 
+
47 template < class T > class ICPointerHolder
+
48 {
+
49 public:
+
50  ICPointerHolder()
+
51  : ptr(0)
+
52  {
+
53  }
+
54 
+
55  ICPointerHolder(T *p)
+
56  : ptr(p)
+
57  {
+
58  }
+
59 
+
60  // copy constructor to support assignment
+
61  ICPointerHolder(const ICPointerHolder &ip)
+
62  : ptr(ip.ptr)
+
63  {
+
64  // We need to transfer ownership of ptr to this object by setting
+
65  // ip's ptr to null. Otherwise, ptr will de deleted twice.
+
66  // const ugliness requires us to do the const_cast.
+
67  ICPointerHolder *ipp = const_cast < ICPointerHolder * >(&ip);
+
68 
+
69  ipp->ptr = 0;
+
70  };
+
71 
+
72  ~ICPointerHolder()
+
73  {
+
74  release();
+
75  }
+
76 
+
77  ICPointerHolder &operator=(T *p)
+
78  {
+
79  this->release();
+
80  ptr = p;
+
81  return *this;
+
82  }
+
83 
+
84  ICPointerHolder &operator=(ICPointerHolder &p)
+
85  {
+
86  this->release();
+
87  ptr = p.ptr; // this transfer ownership of the pointer
+
88  p.ptr = 0; // set it to null so the pointer won't get delete twice.
+
89  return *this;
+
90  }
+
91 
+
92  bool operator!=(T *p)
+
93  {
+
94  return (ptr != p);
+
95  }
+
96 
+
97  bool operator==(T *p)
+
98  {
+
99  return (ptr == p);
+
100  }
+
101 
+
102  operator T *() const
+
103  {
+
104  return ptr;
+
105  }
+
106 
+
107  T *operator->() const
+
108  {
+
109  assert(ptr);
+
110  return ptr;
+
111  }
+
112 
+
113  T &operator*()
+
114  {
+
115  assert(ptr);
+
116  return *ptr;
+
117  }
+
118 
+
119 private:
+
120  void release()
+
121  {
+
122  if (ptr != 0) {
+
123  ptr->detach();
+
124  delete ptr;
+
125 
+
126  ptr = 0;
+
127  }
+
128  }
+
129 
+
130  T *ptr;
+
131 };
+
132 
+
133 #endif
+
ICPointerHolder
Definition: icptrholder_cxx.h:48
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/index.html b/apidocs/index.html index fd0e711e..b6999dae 100644 --- a/apidocs/index.html +++ b/apidocs/index.html @@ -2,10 +2,10 @@ - - + + -Libical API Documentation: Libical — an implementation of iCalendar protocols and data formats +Libical API Documentation: Libical - an implementation of iCalendar protocols and data formats @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
@@ -61,67 +61,28 @@ $(function() {
-
-
Libical — an implementation of iCalendar protocols and data formats
+
+
+
Libical - an implementation of iCalendar protocols and data formats
-

Appveyor status Packaging status

-

+

About

-

Libical — an implementation of iCalendar protocols and data formats

-

Most of the code in here was written by Eric Busboom at the end of the last millennium with help from dozens of contributors. It is currently maintained by Allen Winter and the libical team at https://github.com/libical/libical.

-

Libical is an Open Source implementation of the iCalendar protocols and protocol data units. The iCalendar specification describes how calendar clients can communicate with calendar servers so users can store their calendar data and arrange meetings with other users.

-

-RFCs

-

Libical implements RFC5545, RFC5546, RFC7529; the CalDav scheduling extensions in RFC6638; iCalendar extensions in RFC7986, RFC9073, RFC9074; plus the iCalendar iMIP protocol in RFC6047.

-

+

Libical is an Open Source implementation of the iCalendar protocols and protocol data units. The iCalendar specification describes how calendar clients can communicate with calendar servers so users can store their calendar data and arrange meetings with other users.

+

Libical implements RFC5545, RFC5546, RFC7529; the CalDav scheduling extensions in RFC6638; iCalendar extensions in RFC7986; plus the iCalendar iMIP protocol in RFC6047.

+

License

-

The code and datafiles in this distribution are licensed under the Mozilla Public License (MPL) v2.0. See https://www.mozilla.org/MPL for a copy of this license.

-

Alternately, you may use libical under the terms of the GNU Lesser General Public License (LGPL) v2.1. See https://www.gnu.org/licenses/lgpl-2.1.txt for a copy of this license.

-

This dual license ensures that the library can be incorporated into both proprietary code and GPL'd programs, and will benefit from improvements made by programmers in both realms. We (the libical developers) will only accept changes to this library if they are similarly dual-licensed.

-

-Building

-

See the top-level Install.txt file.

-

-Documentation

-

Documentation is hosted at https://libical.github.io/libical/apidocs/.

-

For a conceptual overview of the library, see Using Libical. There is other rudimentary, unfinished documentation in the doc/ directory of the source distribution, annotated examples in examples/ and the test code in src/test/.

-

+

The code and datafiles in this distribution are licensed under the Mozilla Public License (MPL) v2.0. See https://www.mozilla.org/MPL for a copy of the license.

+

Alternately, you may use libical under the terms of the GNU Library General Public License (LGPL) v2.1. See https://www.gnu.org/licenses/lgpl-2.1.txt for a copy of the license.

+

This dual license ensures that the library can be incorporated into both proprietary code and GPL'd programs, and will benefit from improvements made by programmers in both realms. I will only accept changes into my version of the library if they are similarly dual-licensed.

+

Acknowledgments

-

Portions of this distribution are (C) Copyright 1996 Apple Computer,Inc., AT&T Corp., International Business Machines Corporation and Siemens Rolm Communications Inc. See src/libicalvcal/README.TXT for details.

-

-Libical Users

-

In no particular order:

- -

-Get Involved

-

Subscribe to our mailing lists:

-

For developer discussions https://lists.infradead.org/mailman/listinfo/libical-devel

-

For general discussions about libical and related projects https://lists.infradead.org/mailman/listinfo/libical-interest

-

Report bugs to our issue tracker at https://github.com/libical/libical/issues

+

Portions of this distribution are (C) Copyright 1996 Apple Computer, Inc., AT&T Corp., International Business Machines Corporation and Siemens Rolm Communications Inc. See src/libicalvcal/README.TXT for details.

-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/inherit_graph_10.map b/apidocs/inherit_graph_10.map index f221b099..d088a0b9 100644 --- a/apidocs/inherit_graph_10.map +++ b/apidocs/inherit_graph_10.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_10.md5 b/apidocs/inherit_graph_10.md5 index 92b2a67e..0610859e 100644 --- a/apidocs/inherit_graph_10.md5 +++ b/apidocs/inherit_graph_10.md5 @@ -1 +1 @@ -709eac68d1ae40c0f157afdfb1d14996 \ No newline at end of file +51f946e1d0befa167932244f9d2a0ca3 \ No newline at end of file diff --git a/apidocs/inherit_graph_10.png b/apidocs/inherit_graph_10.png index 0bf50b80..a6c03908 100644 Binary files a/apidocs/inherit_graph_10.png and b/apidocs/inherit_graph_10.png differ diff --git a/apidocs/inherit_graph_11.map b/apidocs/inherit_graph_11.map index d088a0b9..9f329eb5 100644 --- a/apidocs/inherit_graph_11.map +++ b/apidocs/inherit_graph_11.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_11.md5 b/apidocs/inherit_graph_11.md5 index 0610859e..939659f9 100644 --- a/apidocs/inherit_graph_11.md5 +++ b/apidocs/inherit_graph_11.md5 @@ -1 +1 @@ -51f946e1d0befa167932244f9d2a0ca3 \ No newline at end of file +b958ac85b1094aedb6b9354d8120bbd0 \ No newline at end of file diff --git a/apidocs/inherit_graph_11.png b/apidocs/inherit_graph_11.png index a6c03908..bba1e1e9 100644 Binary files a/apidocs/inherit_graph_11.png and b/apidocs/inherit_graph_11.png differ diff --git a/apidocs/inherit_graph_12.map b/apidocs/inherit_graph_12.map index 9f329eb5..832b860d 100644 --- a/apidocs/inherit_graph_12.map +++ b/apidocs/inherit_graph_12.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_12.md5 b/apidocs/inherit_graph_12.md5 index 939659f9..f0bd9384 100644 --- a/apidocs/inherit_graph_12.md5 +++ b/apidocs/inherit_graph_12.md5 @@ -1 +1 @@ -b958ac85b1094aedb6b9354d8120bbd0 \ No newline at end of file +3218963cbf09042bbc7348b240151cb8 \ No newline at end of file diff --git a/apidocs/inherit_graph_12.png b/apidocs/inherit_graph_12.png index bba1e1e9..f1098227 100644 Binary files a/apidocs/inherit_graph_12.png and b/apidocs/inherit_graph_12.png differ diff --git a/apidocs/inherit_graph_13.map b/apidocs/inherit_graph_13.map index 832b860d..aed1b4d1 100644 --- a/apidocs/inherit_graph_13.map +++ b/apidocs/inherit_graph_13.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_13.md5 b/apidocs/inherit_graph_13.md5 index f0bd9384..842e6aab 100644 --- a/apidocs/inherit_graph_13.md5 +++ b/apidocs/inherit_graph_13.md5 @@ -1 +1 @@ -3218963cbf09042bbc7348b240151cb8 \ No newline at end of file +40ab56eb2bcc357c7610cf27f4ee1cba \ No newline at end of file diff --git a/apidocs/inherit_graph_13.png b/apidocs/inherit_graph_13.png index f1098227..abfb55e7 100644 Binary files a/apidocs/inherit_graph_13.png and b/apidocs/inherit_graph_13.png differ diff --git a/apidocs/inherit_graph_14.map b/apidocs/inherit_graph_14.map index aed1b4d1..fd69f955 100644 --- a/apidocs/inherit_graph_14.map +++ b/apidocs/inherit_graph_14.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_14.md5 b/apidocs/inherit_graph_14.md5 index 842e6aab..dd73af57 100644 --- a/apidocs/inherit_graph_14.md5 +++ b/apidocs/inherit_graph_14.md5 @@ -1 +1 @@ -40ab56eb2bcc357c7610cf27f4ee1cba \ No newline at end of file +7c8c8725fcdc25d1122ee99d52ee72c9 \ No newline at end of file diff --git a/apidocs/inherit_graph_14.png b/apidocs/inherit_graph_14.png index abfb55e7..23360437 100644 Binary files a/apidocs/inherit_graph_14.png and b/apidocs/inherit_graph_14.png differ diff --git a/apidocs/inherit_graph_15.map b/apidocs/inherit_graph_15.map index fd69f955..bfa53ddf 100644 --- a/apidocs/inherit_graph_15.map +++ b/apidocs/inherit_graph_15.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_15.md5 b/apidocs/inherit_graph_15.md5 index dd73af57..30cb713f 100644 --- a/apidocs/inherit_graph_15.md5 +++ b/apidocs/inherit_graph_15.md5 @@ -1 +1 @@ -7c8c8725fcdc25d1122ee99d52ee72c9 \ No newline at end of file +40463485080c459bc5f8848617e646f7 \ No newline at end of file diff --git a/apidocs/inherit_graph_15.png b/apidocs/inherit_graph_15.png index 23360437..229f116e 100644 Binary files a/apidocs/inherit_graph_15.png and b/apidocs/inherit_graph_15.png differ diff --git a/apidocs/inherit_graph_16.map b/apidocs/inherit_graph_16.map index bfa53ddf..edce1fe5 100644 --- a/apidocs/inherit_graph_16.map +++ b/apidocs/inherit_graph_16.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_16.md5 b/apidocs/inherit_graph_16.md5 index 30cb713f..aea6d12c 100644 --- a/apidocs/inherit_graph_16.md5 +++ b/apidocs/inherit_graph_16.md5 @@ -1 +1 @@ -40463485080c459bc5f8848617e646f7 \ No newline at end of file +2e27f478a557192f22db9490f167af7f \ No newline at end of file diff --git a/apidocs/inherit_graph_16.png b/apidocs/inherit_graph_16.png index 229f116e..321ff83d 100644 Binary files a/apidocs/inherit_graph_16.png and b/apidocs/inherit_graph_16.png differ diff --git a/apidocs/inherit_graph_17.map b/apidocs/inherit_graph_17.map index edce1fe5..815f1dad 100644 --- a/apidocs/inherit_graph_17.map +++ b/apidocs/inherit_graph_17.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_17.md5 b/apidocs/inherit_graph_17.md5 index aea6d12c..50701696 100644 --- a/apidocs/inherit_graph_17.md5 +++ b/apidocs/inherit_graph_17.md5 @@ -1 +1 @@ -2e27f478a557192f22db9490f167af7f \ No newline at end of file +0256c05252f4a5d77aedc1b1d1fad7a4 \ No newline at end of file diff --git a/apidocs/inherit_graph_17.png b/apidocs/inherit_graph_17.png index 321ff83d..c2e9a2e8 100644 Binary files a/apidocs/inherit_graph_17.png and b/apidocs/inherit_graph_17.png differ diff --git a/apidocs/inherit_graph_18.map b/apidocs/inherit_graph_18.map index 815f1dad..6d4193e3 100644 --- a/apidocs/inherit_graph_18.map +++ b/apidocs/inherit_graph_18.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_18.md5 b/apidocs/inherit_graph_18.md5 index 50701696..10c98443 100644 --- a/apidocs/inherit_graph_18.md5 +++ b/apidocs/inherit_graph_18.md5 @@ -1 +1 @@ -0256c05252f4a5d77aedc1b1d1fad7a4 \ No newline at end of file +928aff5ccb1686ea33f43e17c56d8036 \ No newline at end of file diff --git a/apidocs/inherit_graph_18.png b/apidocs/inherit_graph_18.png index c2e9a2e8..150a2073 100644 Binary files a/apidocs/inherit_graph_18.png and b/apidocs/inherit_graph_18.png differ diff --git a/apidocs/inherit_graph_19.map b/apidocs/inherit_graph_19.map index 6d4193e3..c785c713 100644 --- a/apidocs/inherit_graph_19.map +++ b/apidocs/inherit_graph_19.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_19.md5 b/apidocs/inherit_graph_19.md5 index 10c98443..14266bcb 100644 --- a/apidocs/inherit_graph_19.md5 +++ b/apidocs/inherit_graph_19.md5 @@ -1 +1 @@ -928aff5ccb1686ea33f43e17c56d8036 \ No newline at end of file +ac2e0d1588466b82820df48818ee34bb \ No newline at end of file diff --git a/apidocs/inherit_graph_19.png b/apidocs/inherit_graph_19.png index 150a2073..03151c58 100644 Binary files a/apidocs/inherit_graph_19.png and b/apidocs/inherit_graph_19.png differ diff --git a/apidocs/inherit_graph_2.map b/apidocs/inherit_graph_2.map index 648d981a..85a9e20b 100644 --- a/apidocs/inherit_graph_2.map +++ b/apidocs/inherit_graph_2.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_2.md5 b/apidocs/inherit_graph_2.md5 index 58e27c68..fe3b93ca 100644 --- a/apidocs/inherit_graph_2.md5 +++ b/apidocs/inherit_graph_2.md5 @@ -1 +1 @@ -49555e57c022381fb2bc0d3507c6da25 \ No newline at end of file +9dfcf1f599bc25fd699b6c92110abb88 \ No newline at end of file diff --git a/apidocs/inherit_graph_2.png b/apidocs/inherit_graph_2.png index e8fb0ae3..ad47dc2a 100644 Binary files a/apidocs/inherit_graph_2.png and b/apidocs/inherit_graph_2.png differ diff --git a/apidocs/inherit_graph_20.map b/apidocs/inherit_graph_20.map index c785c713..6b27355c 100644 --- a/apidocs/inherit_graph_20.map +++ b/apidocs/inherit_graph_20.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_20.md5 b/apidocs/inherit_graph_20.md5 index 14266bcb..1fcdec5c 100644 --- a/apidocs/inherit_graph_20.md5 +++ b/apidocs/inherit_graph_20.md5 @@ -1 +1 @@ -ac2e0d1588466b82820df48818ee34bb \ No newline at end of file +dc018d8531ec2306cc1d60c90c156ee2 \ No newline at end of file diff --git a/apidocs/inherit_graph_20.png b/apidocs/inherit_graph_20.png index 03151c58..4d5080e9 100644 Binary files a/apidocs/inherit_graph_20.png and b/apidocs/inherit_graph_20.png differ diff --git a/apidocs/inherit_graph_21.map b/apidocs/inherit_graph_21.map index 6b27355c..9d476c92 100644 --- a/apidocs/inherit_graph_21.map +++ b/apidocs/inherit_graph_21.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_21.md5 b/apidocs/inherit_graph_21.md5 index 1fcdec5c..7375f406 100644 --- a/apidocs/inherit_graph_21.md5 +++ b/apidocs/inherit_graph_21.md5 @@ -1 +1 @@ -dc018d8531ec2306cc1d60c90c156ee2 \ No newline at end of file +9fb94d87bcf7abd7a034fed3f0c77c40 \ No newline at end of file diff --git a/apidocs/inherit_graph_21.png b/apidocs/inherit_graph_21.png index 4d5080e9..7868ab52 100644 Binary files a/apidocs/inherit_graph_21.png and b/apidocs/inherit_graph_21.png differ diff --git a/apidocs/inherit_graph_22.map b/apidocs/inherit_graph_22.map index 9d476c92..66e59f58 100644 --- a/apidocs/inherit_graph_22.map +++ b/apidocs/inherit_graph_22.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_22.md5 b/apidocs/inherit_graph_22.md5 index 7375f406..7c91e1fa 100644 --- a/apidocs/inherit_graph_22.md5 +++ b/apidocs/inherit_graph_22.md5 @@ -1 +1 @@ -9fb94d87bcf7abd7a034fed3f0c77c40 \ No newline at end of file +2c53eb9f453887b8efaabc5cd0c0433e \ No newline at end of file diff --git a/apidocs/inherit_graph_22.png b/apidocs/inherit_graph_22.png index 7868ab52..d92153e2 100644 Binary files a/apidocs/inherit_graph_22.png and b/apidocs/inherit_graph_22.png differ diff --git a/apidocs/inherit_graph_23.map b/apidocs/inherit_graph_23.map index 66e59f58..ff56a714 100644 --- a/apidocs/inherit_graph_23.map +++ b/apidocs/inherit_graph_23.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_23.md5 b/apidocs/inherit_graph_23.md5 index 7c91e1fa..11eabd30 100644 --- a/apidocs/inherit_graph_23.md5 +++ b/apidocs/inherit_graph_23.md5 @@ -1 +1 @@ -2c53eb9f453887b8efaabc5cd0c0433e \ No newline at end of file +aab6e3ceb47a83f9cb3da5124f64747e \ No newline at end of file diff --git a/apidocs/inherit_graph_23.png b/apidocs/inherit_graph_23.png index d92153e2..f462c3cd 100644 Binary files a/apidocs/inherit_graph_23.png and b/apidocs/inherit_graph_23.png differ diff --git a/apidocs/inherit_graph_24.map b/apidocs/inherit_graph_24.map index ff56a714..91d06eec 100644 --- a/apidocs/inherit_graph_24.map +++ b/apidocs/inherit_graph_24.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_24.md5 b/apidocs/inherit_graph_24.md5 index 11eabd30..2bcf6ae6 100644 --- a/apidocs/inherit_graph_24.md5 +++ b/apidocs/inherit_graph_24.md5 @@ -1 +1 @@ -aab6e3ceb47a83f9cb3da5124f64747e \ No newline at end of file +5529adcd3737689507bf5c6fd0cb96de \ No newline at end of file diff --git a/apidocs/inherit_graph_24.png b/apidocs/inherit_graph_24.png index f462c3cd..68aeec13 100644 Binary files a/apidocs/inherit_graph_24.png and b/apidocs/inherit_graph_24.png differ diff --git a/apidocs/inherit_graph_25.map b/apidocs/inherit_graph_25.map index 91d06eec..bd34fe49 100644 --- a/apidocs/inherit_graph_25.map +++ b/apidocs/inherit_graph_25.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_25.md5 b/apidocs/inherit_graph_25.md5 index 2bcf6ae6..105391f4 100644 --- a/apidocs/inherit_graph_25.md5 +++ b/apidocs/inherit_graph_25.md5 @@ -1 +1 @@ -5529adcd3737689507bf5c6fd0cb96de \ No newline at end of file +74d24a7816cfbf71b1acf2ea675e47f1 \ No newline at end of file diff --git a/apidocs/inherit_graph_25.png b/apidocs/inherit_graph_25.png index 68aeec13..36aebcbb 100644 Binary files a/apidocs/inherit_graph_25.png and b/apidocs/inherit_graph_25.png differ diff --git a/apidocs/inherit_graph_26.map b/apidocs/inherit_graph_26.map index bd34fe49..ad8762a7 100644 --- a/apidocs/inherit_graph_26.map +++ b/apidocs/inherit_graph_26.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_26.md5 b/apidocs/inherit_graph_26.md5 index 105391f4..7a60d93c 100644 --- a/apidocs/inherit_graph_26.md5 +++ b/apidocs/inherit_graph_26.md5 @@ -1 +1 @@ -74d24a7816cfbf71b1acf2ea675e47f1 \ No newline at end of file +1e25fdbfadd375e166c45e1038154fbd \ No newline at end of file diff --git a/apidocs/inherit_graph_26.png b/apidocs/inherit_graph_26.png index 36aebcbb..392c7c6e 100644 Binary files a/apidocs/inherit_graph_26.png and b/apidocs/inherit_graph_26.png differ diff --git a/apidocs/inherit_graph_27.map b/apidocs/inherit_graph_27.map index ad8762a7..bda3c791 100644 --- a/apidocs/inherit_graph_27.map +++ b/apidocs/inherit_graph_27.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_27.md5 b/apidocs/inherit_graph_27.md5 index 7a60d93c..316489f9 100644 --- a/apidocs/inherit_graph_27.md5 +++ b/apidocs/inherit_graph_27.md5 @@ -1 +1 @@ -1e25fdbfadd375e166c45e1038154fbd \ No newline at end of file +bcdd0136e6332d935c57469380f583a6 \ No newline at end of file diff --git a/apidocs/inherit_graph_27.png b/apidocs/inherit_graph_27.png index 392c7c6e..66f9390c 100644 Binary files a/apidocs/inherit_graph_27.png and b/apidocs/inherit_graph_27.png differ diff --git a/apidocs/inherit_graph_28.map b/apidocs/inherit_graph_28.map index bda3c791..565f5c38 100644 --- a/apidocs/inherit_graph_28.map +++ b/apidocs/inherit_graph_28.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_28.md5 b/apidocs/inherit_graph_28.md5 index 316489f9..64aa2b91 100644 --- a/apidocs/inherit_graph_28.md5 +++ b/apidocs/inherit_graph_28.md5 @@ -1 +1 @@ -bcdd0136e6332d935c57469380f583a6 \ No newline at end of file +82c38f7306918afecacc999a42305dcb \ No newline at end of file diff --git a/apidocs/inherit_graph_28.png b/apidocs/inherit_graph_28.png index 66f9390c..98f4b4d4 100644 Binary files a/apidocs/inherit_graph_28.png and b/apidocs/inherit_graph_28.png differ diff --git a/apidocs/inherit_graph_29.map b/apidocs/inherit_graph_29.map index 565f5c38..00dbe417 100644 --- a/apidocs/inherit_graph_29.map +++ b/apidocs/inherit_graph_29.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_29.md5 b/apidocs/inherit_graph_29.md5 index 64aa2b91..f85ac261 100644 --- a/apidocs/inherit_graph_29.md5 +++ b/apidocs/inherit_graph_29.md5 @@ -1 +1 @@ -82c38f7306918afecacc999a42305dcb \ No newline at end of file +818e13600d9da790b1523bc6acba755f \ No newline at end of file diff --git a/apidocs/inherit_graph_29.png b/apidocs/inherit_graph_29.png index 98f4b4d4..8ff20271 100644 Binary files a/apidocs/inherit_graph_29.png and b/apidocs/inherit_graph_29.png differ diff --git a/apidocs/inherit_graph_3.map b/apidocs/inherit_graph_3.map index 85a9e20b..4b73d5da 100644 --- a/apidocs/inherit_graph_3.map +++ b/apidocs/inherit_graph_3.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_3.md5 b/apidocs/inherit_graph_3.md5 index fe3b93ca..af0f4fe1 100644 --- a/apidocs/inherit_graph_3.md5 +++ b/apidocs/inherit_graph_3.md5 @@ -1 +1 @@ -9dfcf1f599bc25fd699b6c92110abb88 \ No newline at end of file +e915f0a1ff1d07966e57a53b777cd7d5 \ No newline at end of file diff --git a/apidocs/inherit_graph_3.png b/apidocs/inherit_graph_3.png index ad47dc2a..30fc417b 100644 Binary files a/apidocs/inherit_graph_3.png and b/apidocs/inherit_graph_3.png differ diff --git a/apidocs/inherit_graph_30.map b/apidocs/inherit_graph_30.map index 00dbe417..4abc6c18 100644 --- a/apidocs/inherit_graph_30.map +++ b/apidocs/inherit_graph_30.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_30.md5 b/apidocs/inherit_graph_30.md5 index f85ac261..3776ddef 100644 --- a/apidocs/inherit_graph_30.md5 +++ b/apidocs/inherit_graph_30.md5 @@ -1 +1 @@ -818e13600d9da790b1523bc6acba755f \ No newline at end of file +c28e40c72d161e9b0ca3546c70d8204b \ No newline at end of file diff --git a/apidocs/inherit_graph_30.png b/apidocs/inherit_graph_30.png index 8ff20271..708581f0 100644 Binary files a/apidocs/inherit_graph_30.png and b/apidocs/inherit_graph_30.png differ diff --git a/apidocs/inherit_graph_31.map b/apidocs/inherit_graph_31.map index 4abc6c18..4be5f672 100644 --- a/apidocs/inherit_graph_31.map +++ b/apidocs/inherit_graph_31.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_31.md5 b/apidocs/inherit_graph_31.md5 index 3776ddef..d55b8777 100644 --- a/apidocs/inherit_graph_31.md5 +++ b/apidocs/inherit_graph_31.md5 @@ -1 +1 @@ -c28e40c72d161e9b0ca3546c70d8204b \ No newline at end of file +b9df8ad02606a58394fa532bcdd0b660 \ No newline at end of file diff --git a/apidocs/inherit_graph_31.png b/apidocs/inherit_graph_31.png index 708581f0..90ae72a0 100644 Binary files a/apidocs/inherit_graph_31.png and b/apidocs/inherit_graph_31.png differ diff --git a/apidocs/inherit_graph_32.map b/apidocs/inherit_graph_32.map index 4be5f672..422d7a83 100644 --- a/apidocs/inherit_graph_32.map +++ b/apidocs/inherit_graph_32.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_32.md5 b/apidocs/inherit_graph_32.md5 index d55b8777..26f4d655 100644 --- a/apidocs/inherit_graph_32.md5 +++ b/apidocs/inherit_graph_32.md5 @@ -1 +1 @@ -b9df8ad02606a58394fa532bcdd0b660 \ No newline at end of file +4aa3d21be9ca88034cf6fc8138494883 \ No newline at end of file diff --git a/apidocs/inherit_graph_32.png b/apidocs/inherit_graph_32.png index 90ae72a0..99681c20 100644 Binary files a/apidocs/inherit_graph_32.png and b/apidocs/inherit_graph_32.png differ diff --git a/apidocs/inherit_graph_33.map b/apidocs/inherit_graph_33.map index 422d7a83..9b9dc644 100644 --- a/apidocs/inherit_graph_33.map +++ b/apidocs/inherit_graph_33.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_33.md5 b/apidocs/inherit_graph_33.md5 index 26f4d655..bc135359 100644 --- a/apidocs/inherit_graph_33.md5 +++ b/apidocs/inherit_graph_33.md5 @@ -1 +1 @@ -4aa3d21be9ca88034cf6fc8138494883 \ No newline at end of file +76e595e135ae6d81ced897346228eab0 \ No newline at end of file diff --git a/apidocs/inherit_graph_33.png b/apidocs/inherit_graph_33.png index 99681c20..37541d39 100644 Binary files a/apidocs/inherit_graph_33.png and b/apidocs/inherit_graph_33.png differ diff --git a/apidocs/inherit_graph_34.map b/apidocs/inherit_graph_34.map index 9b9dc644..e2c81ebe 100644 --- a/apidocs/inherit_graph_34.map +++ b/apidocs/inherit_graph_34.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_34.md5 b/apidocs/inherit_graph_34.md5 index bc135359..e3406042 100644 --- a/apidocs/inherit_graph_34.md5 +++ b/apidocs/inherit_graph_34.md5 @@ -1 +1 @@ -76e595e135ae6d81ced897346228eab0 \ No newline at end of file +ab72c83547894739c7fe62c2fcb0d046 \ No newline at end of file diff --git a/apidocs/inherit_graph_34.png b/apidocs/inherit_graph_34.png index 37541d39..5a570bc9 100644 Binary files a/apidocs/inherit_graph_34.png and b/apidocs/inherit_graph_34.png differ diff --git a/apidocs/inherit_graph_35.map b/apidocs/inherit_graph_35.map index e2c81ebe..22865aa1 100644 --- a/apidocs/inherit_graph_35.map +++ b/apidocs/inherit_graph_35.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_35.md5 b/apidocs/inherit_graph_35.md5 index e3406042..869affc0 100644 --- a/apidocs/inherit_graph_35.md5 +++ b/apidocs/inherit_graph_35.md5 @@ -1 +1 @@ -ab72c83547894739c7fe62c2fcb0d046 \ No newline at end of file +d52e0c71797a39bb762a777905665f25 \ No newline at end of file diff --git a/apidocs/inherit_graph_35.png b/apidocs/inherit_graph_35.png index 5a570bc9..2cf22024 100644 Binary files a/apidocs/inherit_graph_35.png and b/apidocs/inherit_graph_35.png differ diff --git a/apidocs/inherit_graph_36.map b/apidocs/inherit_graph_36.map index 22865aa1..2ba2ce41 100644 --- a/apidocs/inherit_graph_36.map +++ b/apidocs/inherit_graph_36.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_36.md5 b/apidocs/inherit_graph_36.md5 index 869affc0..e6786ff4 100644 --- a/apidocs/inherit_graph_36.md5 +++ b/apidocs/inherit_graph_36.md5 @@ -1 +1 @@ -d52e0c71797a39bb762a777905665f25 \ No newline at end of file +45c1d58e40acd50ab83135c46637a6b7 \ No newline at end of file diff --git a/apidocs/inherit_graph_36.png b/apidocs/inherit_graph_36.png index 2cf22024..1f357a63 100644 Binary files a/apidocs/inherit_graph_36.png and b/apidocs/inherit_graph_36.png differ diff --git a/apidocs/inherit_graph_37.map b/apidocs/inherit_graph_37.map index 2ba2ce41..d1447a94 100644 --- a/apidocs/inherit_graph_37.map +++ b/apidocs/inherit_graph_37.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_37.md5 b/apidocs/inherit_graph_37.md5 index e6786ff4..c381e600 100644 --- a/apidocs/inherit_graph_37.md5 +++ b/apidocs/inherit_graph_37.md5 @@ -1 +1 @@ -45c1d58e40acd50ab83135c46637a6b7 \ No newline at end of file +045287d0c56b66ec1e00ceae1313909f \ No newline at end of file diff --git a/apidocs/inherit_graph_37.png b/apidocs/inherit_graph_37.png index 1f357a63..141a05d5 100644 Binary files a/apidocs/inherit_graph_37.png and b/apidocs/inherit_graph_37.png differ diff --git a/apidocs/inherit_graph_38.map b/apidocs/inherit_graph_38.map index d1447a94..150abb8b 100644 --- a/apidocs/inherit_graph_38.map +++ b/apidocs/inherit_graph_38.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_38.md5 b/apidocs/inherit_graph_38.md5 index c381e600..68d9f4ed 100644 --- a/apidocs/inherit_graph_38.md5 +++ b/apidocs/inherit_graph_38.md5 @@ -1 +1 @@ -045287d0c56b66ec1e00ceae1313909f \ No newline at end of file +1491012d1e5af24f2a5cd3f3faefbbd1 \ No newline at end of file diff --git a/apidocs/inherit_graph_38.png b/apidocs/inherit_graph_38.png index 141a05d5..354ccebf 100644 Binary files a/apidocs/inherit_graph_38.png and b/apidocs/inherit_graph_38.png differ diff --git a/apidocs/inherit_graph_39.map b/apidocs/inherit_graph_39.map index 150abb8b..82828311 100644 --- a/apidocs/inherit_graph_39.map +++ b/apidocs/inherit_graph_39.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_39.md5 b/apidocs/inherit_graph_39.md5 index 68d9f4ed..36155923 100644 --- a/apidocs/inherit_graph_39.md5 +++ b/apidocs/inherit_graph_39.md5 @@ -1 +1 @@ -1491012d1e5af24f2a5cd3f3faefbbd1 \ No newline at end of file +9de50a4d6a4c95ecaff7c0e2905c8916 \ No newline at end of file diff --git a/apidocs/inherit_graph_39.png b/apidocs/inherit_graph_39.png index 354ccebf..5553bee9 100644 Binary files a/apidocs/inherit_graph_39.png and b/apidocs/inherit_graph_39.png differ diff --git a/apidocs/inherit_graph_4.map b/apidocs/inherit_graph_4.map index 4b73d5da..c5854481 100644 --- a/apidocs/inherit_graph_4.map +++ b/apidocs/inherit_graph_4.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_4.md5 b/apidocs/inherit_graph_4.md5 index af0f4fe1..6186312f 100644 --- a/apidocs/inherit_graph_4.md5 +++ b/apidocs/inherit_graph_4.md5 @@ -1 +1 @@ -e915f0a1ff1d07966e57a53b777cd7d5 \ No newline at end of file +2278e2b02e8f65f6e77e8394d3c60872 \ No newline at end of file diff --git a/apidocs/inherit_graph_4.png b/apidocs/inherit_graph_4.png index 30fc417b..3594d37c 100644 Binary files a/apidocs/inherit_graph_4.png and b/apidocs/inherit_graph_4.png differ diff --git a/apidocs/inherit_graph_40.map b/apidocs/inherit_graph_40.map index 82828311..3365e6d4 100644 --- a/apidocs/inherit_graph_40.map +++ b/apidocs/inherit_graph_40.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_40.md5 b/apidocs/inherit_graph_40.md5 index 36155923..b56c17a4 100644 --- a/apidocs/inherit_graph_40.md5 +++ b/apidocs/inherit_graph_40.md5 @@ -1 +1 @@ -9de50a4d6a4c95ecaff7c0e2905c8916 \ No newline at end of file +90fbc17156a5d581d8cedb4a0fc43834 \ No newline at end of file diff --git a/apidocs/inherit_graph_40.png b/apidocs/inherit_graph_40.png index 5553bee9..aca84a7e 100644 Binary files a/apidocs/inherit_graph_40.png and b/apidocs/inherit_graph_40.png differ diff --git a/apidocs/inherit_graph_41.map b/apidocs/inherit_graph_41.map index 3365e6d4..698b6c63 100644 --- a/apidocs/inherit_graph_41.map +++ b/apidocs/inherit_graph_41.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_41.md5 b/apidocs/inherit_graph_41.md5 index b56c17a4..5f179ced 100644 --- a/apidocs/inherit_graph_41.md5 +++ b/apidocs/inherit_graph_41.md5 @@ -1 +1 @@ -90fbc17156a5d581d8cedb4a0fc43834 \ No newline at end of file +22bfbeda027e996268ab4710512c65bb \ No newline at end of file diff --git a/apidocs/inherit_graph_41.png b/apidocs/inherit_graph_41.png index aca84a7e..a23ac69d 100644 Binary files a/apidocs/inherit_graph_41.png and b/apidocs/inherit_graph_41.png differ diff --git a/apidocs/inherit_graph_42.map b/apidocs/inherit_graph_42.map index 698b6c63..64790b59 100644 --- a/apidocs/inherit_graph_42.map +++ b/apidocs/inherit_graph_42.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_42.md5 b/apidocs/inherit_graph_42.md5 index 5f179ced..f06559a3 100644 --- a/apidocs/inherit_graph_42.md5 +++ b/apidocs/inherit_graph_42.md5 @@ -1 +1 @@ -22bfbeda027e996268ab4710512c65bb \ No newline at end of file +73542935b9e8924dd50970b0389a29c4 \ No newline at end of file diff --git a/apidocs/inherit_graph_42.png b/apidocs/inherit_graph_42.png index a23ac69d..73fa579f 100644 Binary files a/apidocs/inherit_graph_42.png and b/apidocs/inherit_graph_42.png differ diff --git a/apidocs/inherit_graph_43.map b/apidocs/inherit_graph_43.map index 64790b59..c63aafea 100644 --- a/apidocs/inherit_graph_43.map +++ b/apidocs/inherit_graph_43.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_43.md5 b/apidocs/inherit_graph_43.md5 index f06559a3..20188890 100644 --- a/apidocs/inherit_graph_43.md5 +++ b/apidocs/inherit_graph_43.md5 @@ -1 +1 @@ -73542935b9e8924dd50970b0389a29c4 \ No newline at end of file +c9c7aaabf83a242e87a16834228eee79 \ No newline at end of file diff --git a/apidocs/inherit_graph_43.png b/apidocs/inherit_graph_43.png index 73fa579f..045d2a58 100644 Binary files a/apidocs/inherit_graph_43.png and b/apidocs/inherit_graph_43.png differ diff --git a/apidocs/inherit_graph_44.map b/apidocs/inherit_graph_44.map index c63aafea..3b718a80 100644 --- a/apidocs/inherit_graph_44.map +++ b/apidocs/inherit_graph_44.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_44.md5 b/apidocs/inherit_graph_44.md5 index 20188890..375f51df 100644 --- a/apidocs/inherit_graph_44.md5 +++ b/apidocs/inherit_graph_44.md5 @@ -1 +1 @@ -c9c7aaabf83a242e87a16834228eee79 \ No newline at end of file +9824a3dacd3f4136b4af7702f32a9960 \ No newline at end of file diff --git a/apidocs/inherit_graph_44.png b/apidocs/inherit_graph_44.png index 045d2a58..60d5fd1c 100644 Binary files a/apidocs/inherit_graph_44.png and b/apidocs/inherit_graph_44.png differ diff --git a/apidocs/inherit_graph_45.map b/apidocs/inherit_graph_45.map index 3b718a80..33958b6f 100644 --- a/apidocs/inherit_graph_45.map +++ b/apidocs/inherit_graph_45.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_45.md5 b/apidocs/inherit_graph_45.md5 index 375f51df..7ccd1f15 100644 --- a/apidocs/inherit_graph_45.md5 +++ b/apidocs/inherit_graph_45.md5 @@ -1 +1 @@ -9824a3dacd3f4136b4af7702f32a9960 \ No newline at end of file +6df2e30dbfeaa7f041c78e47f2e2be08 \ No newline at end of file diff --git a/apidocs/inherit_graph_45.png b/apidocs/inherit_graph_45.png index 60d5fd1c..9a1b4075 100644 Binary files a/apidocs/inherit_graph_45.png and b/apidocs/inherit_graph_45.png differ diff --git a/apidocs/inherit_graph_46.map b/apidocs/inherit_graph_46.map index 33958b6f..e2eef3b8 100644 --- a/apidocs/inherit_graph_46.map +++ b/apidocs/inherit_graph_46.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_46.md5 b/apidocs/inherit_graph_46.md5 index 7ccd1f15..23d2ace4 100644 --- a/apidocs/inherit_graph_46.md5 +++ b/apidocs/inherit_graph_46.md5 @@ -1 +1 @@ -6df2e30dbfeaa7f041c78e47f2e2be08 \ No newline at end of file +be0f0139f232a53e448bb982f7308961 \ No newline at end of file diff --git a/apidocs/inherit_graph_46.png b/apidocs/inherit_graph_46.png index 9a1b4075..3136c29b 100644 Binary files a/apidocs/inherit_graph_46.png and b/apidocs/inherit_graph_46.png differ diff --git a/apidocs/inherit_graph_47.map b/apidocs/inherit_graph_47.map index 26db47a0..8f26a994 100644 --- a/apidocs/inherit_graph_47.map +++ b/apidocs/inherit_graph_47.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_47.md5 b/apidocs/inherit_graph_47.md5 index 3de0fc99..f58ec200 100644 --- a/apidocs/inherit_graph_47.md5 +++ b/apidocs/inherit_graph_47.md5 @@ -1 +1 @@ -9ff9be7eecc51e4a0d63648c1e80183a \ No newline at end of file +549014b05e1bfd188a24f482be66142e \ No newline at end of file diff --git a/apidocs/inherit_graph_47.png b/apidocs/inherit_graph_47.png index 36b21323..f68182bb 100644 Binary files a/apidocs/inherit_graph_47.png and b/apidocs/inherit_graph_47.png differ diff --git a/apidocs/inherit_graph_48.map b/apidocs/inherit_graph_48.map index 698444e9..26db47a0 100644 --- a/apidocs/inherit_graph_48.map +++ b/apidocs/inherit_graph_48.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_48.md5 b/apidocs/inherit_graph_48.md5 index 247a6da8..3de0fc99 100644 --- a/apidocs/inherit_graph_48.md5 +++ b/apidocs/inherit_graph_48.md5 @@ -1 +1 @@ -d2df12e8a4c9c29ae641b28bfad51c50 \ No newline at end of file +9ff9be7eecc51e4a0d63648c1e80183a \ No newline at end of file diff --git a/apidocs/inherit_graph_48.png b/apidocs/inherit_graph_48.png index 848780c2..36b21323 100644 Binary files a/apidocs/inherit_graph_48.png and b/apidocs/inherit_graph_48.png differ diff --git a/apidocs/inherit_graph_49.map b/apidocs/inherit_graph_49.map index 7ab7507e..698444e9 100644 --- a/apidocs/inherit_graph_49.map +++ b/apidocs/inherit_graph_49.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_49.md5 b/apidocs/inherit_graph_49.md5 index 0fc1cd34..247a6da8 100644 --- a/apidocs/inherit_graph_49.md5 +++ b/apidocs/inherit_graph_49.md5 @@ -1 +1 @@ -c628566d4479f27f52543c4d3f35370f \ No newline at end of file +d2df12e8a4c9c29ae641b28bfad51c50 \ No newline at end of file diff --git a/apidocs/inherit_graph_49.png b/apidocs/inherit_graph_49.png index 81e2e506..848780c2 100644 Binary files a/apidocs/inherit_graph_49.png and b/apidocs/inherit_graph_49.png differ diff --git a/apidocs/inherit_graph_5.map b/apidocs/inherit_graph_5.map index c5854481..193835b1 100644 --- a/apidocs/inherit_graph_5.map +++ b/apidocs/inherit_graph_5.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_5.md5 b/apidocs/inherit_graph_5.md5 index 6186312f..3b592d50 100644 --- a/apidocs/inherit_graph_5.md5 +++ b/apidocs/inherit_graph_5.md5 @@ -1 +1 @@ -2278e2b02e8f65f6e77e8394d3c60872 \ No newline at end of file +190f11a2ed6aa3a04ca96e8363eb5baa \ No newline at end of file diff --git a/apidocs/inherit_graph_5.png b/apidocs/inherit_graph_5.png index 3594d37c..b6179a28 100644 Binary files a/apidocs/inherit_graph_5.png and b/apidocs/inherit_graph_5.png differ diff --git a/apidocs/inherit_graph_50.map b/apidocs/inherit_graph_50.map index 38f40e84..7ab7507e 100644 --- a/apidocs/inherit_graph_50.map +++ b/apidocs/inherit_graph_50.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_50.md5 b/apidocs/inherit_graph_50.md5 index 60be7c91..0fc1cd34 100644 --- a/apidocs/inherit_graph_50.md5 +++ b/apidocs/inherit_graph_50.md5 @@ -1 +1 @@ -3468880fb398eb85b636253f4d6c59be \ No newline at end of file +c628566d4479f27f52543c4d3f35370f \ No newline at end of file diff --git a/apidocs/inherit_graph_50.png b/apidocs/inherit_graph_50.png index 3d6b8047..81e2e506 100644 Binary files a/apidocs/inherit_graph_50.png and b/apidocs/inherit_graph_50.png differ diff --git a/apidocs/inherit_graph_51.map b/apidocs/inherit_graph_51.map index 6733399b..38f40e84 100644 --- a/apidocs/inherit_graph_51.map +++ b/apidocs/inherit_graph_51.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_51.md5 b/apidocs/inherit_graph_51.md5 index cca06d18..60be7c91 100644 --- a/apidocs/inherit_graph_51.md5 +++ b/apidocs/inherit_graph_51.md5 @@ -1 +1 @@ -e600ad06471f07db64d743c0ed012276 \ No newline at end of file +3468880fb398eb85b636253f4d6c59be \ No newline at end of file diff --git a/apidocs/inherit_graph_51.png b/apidocs/inherit_graph_51.png index d0b29a61..3d6b8047 100644 Binary files a/apidocs/inherit_graph_51.png and b/apidocs/inherit_graph_51.png differ diff --git a/apidocs/inherit_graph_52.map b/apidocs/inherit_graph_52.map index 9c659528..2795b964 100644 --- a/apidocs/inherit_graph_52.map +++ b/apidocs/inherit_graph_52.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_52.md5 b/apidocs/inherit_graph_52.md5 index cdf3f035..c39ab225 100644 --- a/apidocs/inherit_graph_52.md5 +++ b/apidocs/inherit_graph_52.md5 @@ -1 +1 @@ -3c68902ba13cd71c00c68f62f2e7dfcb \ No newline at end of file +2b552555c1eccb80765f5bef9b348d7d \ No newline at end of file diff --git a/apidocs/inherit_graph_52.png b/apidocs/inherit_graph_52.png index b3c28f57..2c730b99 100644 Binary files a/apidocs/inherit_graph_52.png and b/apidocs/inherit_graph_52.png differ diff --git a/apidocs/inherit_graph_53.map b/apidocs/inherit_graph_53.map index 28c0b38b..6733399b 100644 --- a/apidocs/inherit_graph_53.map +++ b/apidocs/inherit_graph_53.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_53.md5 b/apidocs/inherit_graph_53.md5 index 35942d47..cca06d18 100644 --- a/apidocs/inherit_graph_53.md5 +++ b/apidocs/inherit_graph_53.md5 @@ -1 +1 @@ -abdb1630120f6be406ca489072e0590b \ No newline at end of file +e600ad06471f07db64d743c0ed012276 \ No newline at end of file diff --git a/apidocs/inherit_graph_53.png b/apidocs/inherit_graph_53.png index 9a9476de..d0b29a61 100644 Binary files a/apidocs/inherit_graph_53.png and b/apidocs/inherit_graph_53.png differ diff --git a/apidocs/inherit_graph_54.map b/apidocs/inherit_graph_54.map index 76e13464..9c659528 100644 --- a/apidocs/inherit_graph_54.map +++ b/apidocs/inherit_graph_54.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_54.md5 b/apidocs/inherit_graph_54.md5 index d0733456..cdf3f035 100644 --- a/apidocs/inherit_graph_54.md5 +++ b/apidocs/inherit_graph_54.md5 @@ -1 +1 @@ -c298d60a26f2aa034579fd405b0a6f00 \ No newline at end of file +3c68902ba13cd71c00c68f62f2e7dfcb \ No newline at end of file diff --git a/apidocs/inherit_graph_54.png b/apidocs/inherit_graph_54.png index 202f8952..b3c28f57 100644 Binary files a/apidocs/inherit_graph_54.png and b/apidocs/inherit_graph_54.png differ diff --git a/apidocs/inherit_graph_55.map b/apidocs/inherit_graph_55.map index 4c99feda..28c0b38b 100644 --- a/apidocs/inherit_graph_55.map +++ b/apidocs/inherit_graph_55.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_55.md5 b/apidocs/inherit_graph_55.md5 index ea14a8ed..35942d47 100644 --- a/apidocs/inherit_graph_55.md5 +++ b/apidocs/inherit_graph_55.md5 @@ -1 +1 @@ -be9aa58f8bc573b4643a694ee6e6df52 \ No newline at end of file +abdb1630120f6be406ca489072e0590b \ No newline at end of file diff --git a/apidocs/inherit_graph_55.png b/apidocs/inherit_graph_55.png index 8e3e95ef..9a9476de 100644 Binary files a/apidocs/inherit_graph_55.png and b/apidocs/inherit_graph_55.png differ diff --git a/apidocs/inherit_graph_56.map b/apidocs/inherit_graph_56.map index 8452fa3a..76e13464 100644 --- a/apidocs/inherit_graph_56.map +++ b/apidocs/inherit_graph_56.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_56.md5 b/apidocs/inherit_graph_56.md5 index f77745de..d0733456 100644 --- a/apidocs/inherit_graph_56.md5 +++ b/apidocs/inherit_graph_56.md5 @@ -1 +1 @@ -6cda6af899940e245cf686d2b09d9edb \ No newline at end of file +c298d60a26f2aa034579fd405b0a6f00 \ No newline at end of file diff --git a/apidocs/inherit_graph_56.png b/apidocs/inherit_graph_56.png index 84594478..202f8952 100644 Binary files a/apidocs/inherit_graph_56.png and b/apidocs/inherit_graph_56.png differ diff --git a/apidocs/inherit_graph_57.map b/apidocs/inherit_graph_57.map index 33656f8b..4c99feda 100644 --- a/apidocs/inherit_graph_57.map +++ b/apidocs/inherit_graph_57.map @@ -1,14 +1,3 @@ - - - - - - - - - - - - + diff --git a/apidocs/inherit_graph_57.md5 b/apidocs/inherit_graph_57.md5 index b73dbe74..ea14a8ed 100644 --- a/apidocs/inherit_graph_57.md5 +++ b/apidocs/inherit_graph_57.md5 @@ -1 +1 @@ -a5e08ac81900084ca36b8e062c2f1b24 \ No newline at end of file +be9aa58f8bc573b4643a694ee6e6df52 \ No newline at end of file diff --git a/apidocs/inherit_graph_57.png b/apidocs/inherit_graph_57.png index 55514962..8e3e95ef 100644 Binary files a/apidocs/inherit_graph_57.png and b/apidocs/inherit_graph_57.png differ diff --git a/apidocs/inherit_graph_58.map b/apidocs/inherit_graph_58.map index 92f0c1a0..8452fa3a 100644 --- a/apidocs/inherit_graph_58.map +++ b/apidocs/inherit_graph_58.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_58.md5 b/apidocs/inherit_graph_58.md5 index e4191821..f77745de 100644 --- a/apidocs/inherit_graph_58.md5 +++ b/apidocs/inherit_graph_58.md5 @@ -1 +1 @@ -6ffddf273e7caac9832ab18d453de5b6 \ No newline at end of file +6cda6af899940e245cf686d2b09d9edb \ No newline at end of file diff --git a/apidocs/inherit_graph_58.png b/apidocs/inherit_graph_58.png index f3fd63d2..84594478 100644 Binary files a/apidocs/inherit_graph_58.png and b/apidocs/inherit_graph_58.png differ diff --git a/apidocs/inherit_graph_59.map b/apidocs/inherit_graph_59.map index 733779a7..33656f8b 100644 --- a/apidocs/inherit_graph_59.map +++ b/apidocs/inherit_graph_59.map @@ -1,3 +1,14 @@ - + + + + + + + + + + + + diff --git a/apidocs/inherit_graph_59.md5 b/apidocs/inherit_graph_59.md5 index 638c4df8..b73dbe74 100644 --- a/apidocs/inherit_graph_59.md5 +++ b/apidocs/inherit_graph_59.md5 @@ -1 +1 @@ -2c317f5e82ee41f8009c23fe3dcd1f49 \ No newline at end of file +a5e08ac81900084ca36b8e062c2f1b24 \ No newline at end of file diff --git a/apidocs/inherit_graph_59.png b/apidocs/inherit_graph_59.png index d96b8f01..55514962 100644 Binary files a/apidocs/inherit_graph_59.png and b/apidocs/inherit_graph_59.png differ diff --git a/apidocs/inherit_graph_6.map b/apidocs/inherit_graph_6.map index 193835b1..57e05ed6 100644 --- a/apidocs/inherit_graph_6.map +++ b/apidocs/inherit_graph_6.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_6.md5 b/apidocs/inherit_graph_6.md5 index 3b592d50..11feb435 100644 --- a/apidocs/inherit_graph_6.md5 +++ b/apidocs/inherit_graph_6.md5 @@ -1 +1 @@ -190f11a2ed6aa3a04ca96e8363eb5baa \ No newline at end of file +19c524250a32b9727d3f1cfec212768b \ No newline at end of file diff --git a/apidocs/inherit_graph_6.png b/apidocs/inherit_graph_6.png index b6179a28..1885f373 100644 Binary files a/apidocs/inherit_graph_6.png and b/apidocs/inherit_graph_6.png differ diff --git a/apidocs/inherit_graph_60.map b/apidocs/inherit_graph_60.map index 65231f49..92f0c1a0 100644 --- a/apidocs/inherit_graph_60.map +++ b/apidocs/inherit_graph_60.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_60.md5 b/apidocs/inherit_graph_60.md5 index 1a774ab3..e4191821 100644 --- a/apidocs/inherit_graph_60.md5 +++ b/apidocs/inherit_graph_60.md5 @@ -1 +1 @@ -7c26af206671792aaa7f69984b091611 \ No newline at end of file +6ffddf273e7caac9832ab18d453de5b6 \ No newline at end of file diff --git a/apidocs/inherit_graph_60.png b/apidocs/inherit_graph_60.png index e7d43e18..f3fd63d2 100644 Binary files a/apidocs/inherit_graph_60.png and b/apidocs/inherit_graph_60.png differ diff --git a/apidocs/inherit_graph_61.map b/apidocs/inherit_graph_61.map index f8fbf6b4..733779a7 100644 --- a/apidocs/inherit_graph_61.map +++ b/apidocs/inherit_graph_61.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_61.md5 b/apidocs/inherit_graph_61.md5 index 6d85f3e8..638c4df8 100644 --- a/apidocs/inherit_graph_61.md5 +++ b/apidocs/inherit_graph_61.md5 @@ -1 +1 @@ -228c44e38fa847d1f7d27798dc7403cc \ No newline at end of file +2c317f5e82ee41f8009c23fe3dcd1f49 \ No newline at end of file diff --git a/apidocs/inherit_graph_61.png b/apidocs/inherit_graph_61.png index 4ee225e2..d96b8f01 100644 Binary files a/apidocs/inherit_graph_61.png and b/apidocs/inherit_graph_61.png differ diff --git a/apidocs/inherit_graph_62.map b/apidocs/inherit_graph_62.map index 6c970188..65231f49 100644 --- a/apidocs/inherit_graph_62.map +++ b/apidocs/inherit_graph_62.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_62.md5 b/apidocs/inherit_graph_62.md5 index 7647144d..1a774ab3 100644 --- a/apidocs/inherit_graph_62.md5 +++ b/apidocs/inherit_graph_62.md5 @@ -1 +1 @@ -742f81bcc53e5cdc27b7a6335bebdd71 \ No newline at end of file +7c26af206671792aaa7f69984b091611 \ No newline at end of file diff --git a/apidocs/inherit_graph_62.png b/apidocs/inherit_graph_62.png index f232e5af..e7d43e18 100644 Binary files a/apidocs/inherit_graph_62.png and b/apidocs/inherit_graph_62.png differ diff --git a/apidocs/inherit_graph_63.map b/apidocs/inherit_graph_63.map index 6eb56ba4..f8fbf6b4 100644 --- a/apidocs/inherit_graph_63.map +++ b/apidocs/inherit_graph_63.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_63.md5 b/apidocs/inherit_graph_63.md5 index b76437c6..6d85f3e8 100644 --- a/apidocs/inherit_graph_63.md5 +++ b/apidocs/inherit_graph_63.md5 @@ -1 +1 @@ -a1fe824a31c23ba8e50c8d692b2d42be \ No newline at end of file +228c44e38fa847d1f7d27798dc7403cc \ No newline at end of file diff --git a/apidocs/inherit_graph_63.png b/apidocs/inherit_graph_63.png index 72d56472..4ee225e2 100644 Binary files a/apidocs/inherit_graph_63.png and b/apidocs/inherit_graph_63.png differ diff --git a/apidocs/inherit_graph_64.map b/apidocs/inherit_graph_64.map index 6802be00..6c970188 100644 --- a/apidocs/inherit_graph_64.map +++ b/apidocs/inherit_graph_64.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_64.md5 b/apidocs/inherit_graph_64.md5 index 637b2fe6..7647144d 100644 --- a/apidocs/inherit_graph_64.md5 +++ b/apidocs/inherit_graph_64.md5 @@ -1 +1 @@ -f38eb7f22cbd3fb1960094540e252aae \ No newline at end of file +742f81bcc53e5cdc27b7a6335bebdd71 \ No newline at end of file diff --git a/apidocs/inherit_graph_64.png b/apidocs/inherit_graph_64.png index ccca9d36..f232e5af 100644 Binary files a/apidocs/inherit_graph_64.png and b/apidocs/inherit_graph_64.png differ diff --git a/apidocs/inherit_graph_65.map b/apidocs/inherit_graph_65.map index 809eadc2..6eb56ba4 100644 --- a/apidocs/inherit_graph_65.map +++ b/apidocs/inherit_graph_65.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_65.md5 b/apidocs/inherit_graph_65.md5 index 633e6b69..b76437c6 100644 --- a/apidocs/inherit_graph_65.md5 +++ b/apidocs/inherit_graph_65.md5 @@ -1 +1 @@ -d90678d4615e60b3132ec2a8f01a356d \ No newline at end of file +a1fe824a31c23ba8e50c8d692b2d42be \ No newline at end of file diff --git a/apidocs/inherit_graph_65.png b/apidocs/inherit_graph_65.png index 2c8b2f2a..72d56472 100644 Binary files a/apidocs/inherit_graph_65.png and b/apidocs/inherit_graph_65.png differ diff --git a/apidocs/inherit_graph_66.map b/apidocs/inherit_graph_66.map index b629c52c..6802be00 100644 --- a/apidocs/inherit_graph_66.map +++ b/apidocs/inherit_graph_66.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_66.md5 b/apidocs/inherit_graph_66.md5 index ac44d526..637b2fe6 100644 --- a/apidocs/inherit_graph_66.md5 +++ b/apidocs/inherit_graph_66.md5 @@ -1 +1 @@ -bea457011e32e67f8624ab90f5b085b0 \ No newline at end of file +f38eb7f22cbd3fb1960094540e252aae \ No newline at end of file diff --git a/apidocs/inherit_graph_66.png b/apidocs/inherit_graph_66.png index 533d5f77..ccca9d36 100644 Binary files a/apidocs/inherit_graph_66.png and b/apidocs/inherit_graph_66.png differ diff --git a/apidocs/inherit_graph_67.map b/apidocs/inherit_graph_67.map index a179e9c3..809eadc2 100644 --- a/apidocs/inherit_graph_67.map +++ b/apidocs/inherit_graph_67.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_67.md5 b/apidocs/inherit_graph_67.md5 index ff358efe..633e6b69 100644 --- a/apidocs/inherit_graph_67.md5 +++ b/apidocs/inherit_graph_67.md5 @@ -1 +1 @@ -d06da90d13e3a0691d3337c6656c4ee0 \ No newline at end of file +d90678d4615e60b3132ec2a8f01a356d \ No newline at end of file diff --git a/apidocs/inherit_graph_67.png b/apidocs/inherit_graph_67.png index b2dfa937..2c8b2f2a 100644 Binary files a/apidocs/inherit_graph_67.png and b/apidocs/inherit_graph_67.png differ diff --git a/apidocs/inherit_graph_68.map b/apidocs/inherit_graph_68.map index 918039a1..b629c52c 100644 --- a/apidocs/inherit_graph_68.map +++ b/apidocs/inherit_graph_68.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_68.md5 b/apidocs/inherit_graph_68.md5 index 5a6c1196..ac44d526 100644 --- a/apidocs/inherit_graph_68.md5 +++ b/apidocs/inherit_graph_68.md5 @@ -1 +1 @@ -03cc6d8676193696ff06110f1ede17bc \ No newline at end of file +bea457011e32e67f8624ab90f5b085b0 \ No newline at end of file diff --git a/apidocs/inherit_graph_68.png b/apidocs/inherit_graph_68.png index 45f57934..533d5f77 100644 Binary files a/apidocs/inherit_graph_68.png and b/apidocs/inherit_graph_68.png differ diff --git a/apidocs/inherit_graph_69.map b/apidocs/inherit_graph_69.map index 82132c6d..a179e9c3 100644 --- a/apidocs/inherit_graph_69.map +++ b/apidocs/inherit_graph_69.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_69.md5 b/apidocs/inherit_graph_69.md5 index 37211d43..ff358efe 100644 --- a/apidocs/inherit_graph_69.md5 +++ b/apidocs/inherit_graph_69.md5 @@ -1 +1 @@ -a2816ff7a1381bf665b3b200a540b97f \ No newline at end of file +d06da90d13e3a0691d3337c6656c4ee0 \ No newline at end of file diff --git a/apidocs/inherit_graph_69.png b/apidocs/inherit_graph_69.png index b3083399..b2dfa937 100644 Binary files a/apidocs/inherit_graph_69.png and b/apidocs/inherit_graph_69.png differ diff --git a/apidocs/inherit_graph_7.map b/apidocs/inherit_graph_7.map index 57e05ed6..c1594127 100644 --- a/apidocs/inherit_graph_7.map +++ b/apidocs/inherit_graph_7.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_7.md5 b/apidocs/inherit_graph_7.md5 index 11feb435..46aa2e8e 100644 --- a/apidocs/inherit_graph_7.md5 +++ b/apidocs/inherit_graph_7.md5 @@ -1 +1 @@ -19c524250a32b9727d3f1cfec212768b \ No newline at end of file +94b978c68b91bc0967ac671351d52f04 \ No newline at end of file diff --git a/apidocs/inherit_graph_7.png b/apidocs/inherit_graph_7.png index 1885f373..8daf49b7 100644 Binary files a/apidocs/inherit_graph_7.png and b/apidocs/inherit_graph_7.png differ diff --git a/apidocs/inherit_graph_70.map b/apidocs/inherit_graph_70.map index 916c8ded..918039a1 100644 --- a/apidocs/inherit_graph_70.map +++ b/apidocs/inherit_graph_70.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_70.md5 b/apidocs/inherit_graph_70.md5 index 7a22f275..5a6c1196 100644 --- a/apidocs/inherit_graph_70.md5 +++ b/apidocs/inherit_graph_70.md5 @@ -1 +1 @@ -4491626e92a5a95f78c41c92758c0ad9 \ No newline at end of file +03cc6d8676193696ff06110f1ede17bc \ No newline at end of file diff --git a/apidocs/inherit_graph_70.png b/apidocs/inherit_graph_70.png index fcec7b4f..45f57934 100644 Binary files a/apidocs/inherit_graph_70.png and b/apidocs/inherit_graph_70.png differ diff --git a/apidocs/inherit_graph_71.map b/apidocs/inherit_graph_71.map index 90214b46..82132c6d 100644 --- a/apidocs/inherit_graph_71.map +++ b/apidocs/inherit_graph_71.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_71.md5 b/apidocs/inherit_graph_71.md5 index de43bd3c..37211d43 100644 --- a/apidocs/inherit_graph_71.md5 +++ b/apidocs/inherit_graph_71.md5 @@ -1 +1 @@ -67f003da4cfe16f0fdb3eb199ce4c738 \ No newline at end of file +a2816ff7a1381bf665b3b200a540b97f \ No newline at end of file diff --git a/apidocs/inherit_graph_71.png b/apidocs/inherit_graph_71.png index 131afd97..b3083399 100644 Binary files a/apidocs/inherit_graph_71.png and b/apidocs/inherit_graph_71.png differ diff --git a/apidocs/inherit_graph_72.map b/apidocs/inherit_graph_72.map index 031650c4..916c8ded 100644 --- a/apidocs/inherit_graph_72.map +++ b/apidocs/inherit_graph_72.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_72.md5 b/apidocs/inherit_graph_72.md5 index 83d61ddd..7a22f275 100644 --- a/apidocs/inherit_graph_72.md5 +++ b/apidocs/inherit_graph_72.md5 @@ -1 +1 @@ -7122072c793aa29121a9783c2825e9ba \ No newline at end of file +4491626e92a5a95f78c41c92758c0ad9 \ No newline at end of file diff --git a/apidocs/inherit_graph_72.png b/apidocs/inherit_graph_72.png index 508437cc..fcec7b4f 100644 Binary files a/apidocs/inherit_graph_72.png and b/apidocs/inherit_graph_72.png differ diff --git a/apidocs/inherit_graph_73.map b/apidocs/inherit_graph_73.map index 82cb3a26..90214b46 100644 --- a/apidocs/inherit_graph_73.map +++ b/apidocs/inherit_graph_73.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_73.md5 b/apidocs/inherit_graph_73.md5 index d04ecc1a..de43bd3c 100644 --- a/apidocs/inherit_graph_73.md5 +++ b/apidocs/inherit_graph_73.md5 @@ -1 +1 @@ -e4f1143cd669d3bd146279a0855fc6d8 \ No newline at end of file +67f003da4cfe16f0fdb3eb199ce4c738 \ No newline at end of file diff --git a/apidocs/inherit_graph_73.png b/apidocs/inherit_graph_73.png index 2d43ddf3..131afd97 100644 Binary files a/apidocs/inherit_graph_73.png and b/apidocs/inherit_graph_73.png differ diff --git a/apidocs/inherit_graph_74.map b/apidocs/inherit_graph_74.map index 085beef5..031650c4 100644 --- a/apidocs/inherit_graph_74.map +++ b/apidocs/inherit_graph_74.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_74.md5 b/apidocs/inherit_graph_74.md5 index e2a52012..83d61ddd 100644 --- a/apidocs/inherit_graph_74.md5 +++ b/apidocs/inherit_graph_74.md5 @@ -1 +1 @@ -8408a17b24a05206291d5f1573543185 \ No newline at end of file +7122072c793aa29121a9783c2825e9ba \ No newline at end of file diff --git a/apidocs/inherit_graph_74.png b/apidocs/inherit_graph_74.png index 157aaa50..508437cc 100644 Binary files a/apidocs/inherit_graph_74.png and b/apidocs/inherit_graph_74.png differ diff --git a/apidocs/inherit_graph_75.map b/apidocs/inherit_graph_75.map index 04303d17..82cb3a26 100644 --- a/apidocs/inherit_graph_75.map +++ b/apidocs/inherit_graph_75.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_75.md5 b/apidocs/inherit_graph_75.md5 index 470c2262..d04ecc1a 100644 --- a/apidocs/inherit_graph_75.md5 +++ b/apidocs/inherit_graph_75.md5 @@ -1 +1 @@ -7a99440e7a2d9264dcd83a06421f54e2 \ No newline at end of file +e4f1143cd669d3bd146279a0855fc6d8 \ No newline at end of file diff --git a/apidocs/inherit_graph_75.png b/apidocs/inherit_graph_75.png index a4eb18a4..2d43ddf3 100644 Binary files a/apidocs/inherit_graph_75.png and b/apidocs/inherit_graph_75.png differ diff --git a/apidocs/inherit_graph_76.map b/apidocs/inherit_graph_76.map index f291eb08..085beef5 100644 --- a/apidocs/inherit_graph_76.map +++ b/apidocs/inherit_graph_76.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_76.md5 b/apidocs/inherit_graph_76.md5 index 46edba02..e2a52012 100644 --- a/apidocs/inherit_graph_76.md5 +++ b/apidocs/inherit_graph_76.md5 @@ -1 +1 @@ -bd954b4755c547a1015f0b09907ec7ed \ No newline at end of file +8408a17b24a05206291d5f1573543185 \ No newline at end of file diff --git a/apidocs/inherit_graph_76.png b/apidocs/inherit_graph_76.png index 62833dfa..157aaa50 100644 Binary files a/apidocs/inherit_graph_76.png and b/apidocs/inherit_graph_76.png differ diff --git a/apidocs/inherit_graph_77.map b/apidocs/inherit_graph_77.map index 35f56136..04303d17 100644 --- a/apidocs/inherit_graph_77.map +++ b/apidocs/inherit_graph_77.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_77.md5 b/apidocs/inherit_graph_77.md5 index 2dd3ec95..470c2262 100644 --- a/apidocs/inherit_graph_77.md5 +++ b/apidocs/inherit_graph_77.md5 @@ -1 +1 @@ -db80721ed2d03e9b6504baa555b676e6 \ No newline at end of file +7a99440e7a2d9264dcd83a06421f54e2 \ No newline at end of file diff --git a/apidocs/inherit_graph_77.png b/apidocs/inherit_graph_77.png index 10b9451b..a4eb18a4 100644 Binary files a/apidocs/inherit_graph_77.png and b/apidocs/inherit_graph_77.png differ diff --git a/apidocs/inherit_graph_78.map b/apidocs/inherit_graph_78.map index c5fe39c4..634a5199 100644 --- a/apidocs/inherit_graph_78.map +++ b/apidocs/inherit_graph_78.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_78.md5 b/apidocs/inherit_graph_78.md5 index 01069f0d..2c8312c3 100644 --- a/apidocs/inherit_graph_78.md5 +++ b/apidocs/inherit_graph_78.md5 @@ -1 +1 @@ -4635c2e522d7dc48953104fc74068be7 \ No newline at end of file +af2a05a5645bb577316924c10fa04c6d \ No newline at end of file diff --git a/apidocs/inherit_graph_78.png b/apidocs/inherit_graph_78.png index f88a3d35..1db89a71 100644 Binary files a/apidocs/inherit_graph_78.png and b/apidocs/inherit_graph_78.png differ diff --git a/apidocs/inherit_graph_79.map b/apidocs/inherit_graph_79.map index bb7c1dd4..c9cc805a 100644 --- a/apidocs/inherit_graph_79.map +++ b/apidocs/inherit_graph_79.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_79.md5 b/apidocs/inherit_graph_79.md5 index 87d4a11d..03ab3faa 100644 --- a/apidocs/inherit_graph_79.md5 +++ b/apidocs/inherit_graph_79.md5 @@ -1 +1 @@ -e3664d335958ec4931d4139118ad2ec2 \ No newline at end of file +ab86d60b297e37a6294dd5409bd331ff \ No newline at end of file diff --git a/apidocs/inherit_graph_79.png b/apidocs/inherit_graph_79.png index 94bc49c3..6e407669 100644 Binary files a/apidocs/inherit_graph_79.png and b/apidocs/inherit_graph_79.png differ diff --git a/apidocs/inherit_graph_8.map b/apidocs/inherit_graph_8.map index c1594127..fa234239 100644 --- a/apidocs/inherit_graph_8.map +++ b/apidocs/inherit_graph_8.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_8.md5 b/apidocs/inherit_graph_8.md5 index 46aa2e8e..8e40685e 100644 --- a/apidocs/inherit_graph_8.md5 +++ b/apidocs/inherit_graph_8.md5 @@ -1 +1 @@ -94b978c68b91bc0967ac671351d52f04 \ No newline at end of file +4dda70e80573480a71acd3cd2a21302d \ No newline at end of file diff --git a/apidocs/inherit_graph_8.png b/apidocs/inherit_graph_8.png index 8daf49b7..9772830b 100644 Binary files a/apidocs/inherit_graph_8.png and b/apidocs/inherit_graph_8.png differ diff --git a/apidocs/inherit_graph_80.map b/apidocs/inherit_graph_80.map index 14bdf458..f291eb08 100644 --- a/apidocs/inherit_graph_80.map +++ b/apidocs/inherit_graph_80.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_80.md5 b/apidocs/inherit_graph_80.md5 index 3dda4b9f..46edba02 100644 --- a/apidocs/inherit_graph_80.md5 +++ b/apidocs/inherit_graph_80.md5 @@ -1 +1 @@ -db0b8e09a06e4013ef42eaaa3a2703a8 \ No newline at end of file +bd954b4755c547a1015f0b09907ec7ed \ No newline at end of file diff --git a/apidocs/inherit_graph_80.png b/apidocs/inherit_graph_80.png index 57a6910d..62833dfa 100644 Binary files a/apidocs/inherit_graph_80.png and b/apidocs/inherit_graph_80.png differ diff --git a/apidocs/inherit_graph_81.map b/apidocs/inherit_graph_81.map index 9870bad8..c5fe39c4 100644 --- a/apidocs/inherit_graph_81.map +++ b/apidocs/inherit_graph_81.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_81.md5 b/apidocs/inherit_graph_81.md5 index 0634a900..01069f0d 100644 --- a/apidocs/inherit_graph_81.md5 +++ b/apidocs/inherit_graph_81.md5 @@ -1 +1 @@ -36a3f4b34914f920c8421c143dbfea85 \ No newline at end of file +4635c2e522d7dc48953104fc74068be7 \ No newline at end of file diff --git a/apidocs/inherit_graph_81.png b/apidocs/inherit_graph_81.png index ca4f1e2b..f88a3d35 100644 Binary files a/apidocs/inherit_graph_81.png and b/apidocs/inherit_graph_81.png differ diff --git a/apidocs/inherit_graph_82.map b/apidocs/inherit_graph_82.map index f47bceb4..bb7c1dd4 100644 --- a/apidocs/inherit_graph_82.map +++ b/apidocs/inherit_graph_82.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_82.md5 b/apidocs/inherit_graph_82.md5 index efafbd81..87d4a11d 100644 --- a/apidocs/inherit_graph_82.md5 +++ b/apidocs/inherit_graph_82.md5 @@ -1 +1 @@ -093b86925496bcaa84a9153093944ce8 \ No newline at end of file +e3664d335958ec4931d4139118ad2ec2 \ No newline at end of file diff --git a/apidocs/inherit_graph_82.png b/apidocs/inherit_graph_82.png index 643f62df..94bc49c3 100644 Binary files a/apidocs/inherit_graph_82.png and b/apidocs/inherit_graph_82.png differ diff --git a/apidocs/inherit_graph_83.map b/apidocs/inherit_graph_83.map index eb14b47b..14bdf458 100644 --- a/apidocs/inherit_graph_83.map +++ b/apidocs/inherit_graph_83.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_83.md5 b/apidocs/inherit_graph_83.md5 index 05d693b5..3dda4b9f 100644 --- a/apidocs/inherit_graph_83.md5 +++ b/apidocs/inherit_graph_83.md5 @@ -1 +1 @@ -f4a3f7530ebe8e49d522ddf47c80593e \ No newline at end of file +db0b8e09a06e4013ef42eaaa3a2703a8 \ No newline at end of file diff --git a/apidocs/inherit_graph_83.png b/apidocs/inherit_graph_83.png index be15980b..57a6910d 100644 Binary files a/apidocs/inherit_graph_83.png and b/apidocs/inherit_graph_83.png differ diff --git a/apidocs/inherit_graph_84.map b/apidocs/inherit_graph_84.map index 03b5f834..9870bad8 100644 --- a/apidocs/inherit_graph_84.map +++ b/apidocs/inherit_graph_84.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_84.md5 b/apidocs/inherit_graph_84.md5 index 8f7f1ba8..0634a900 100644 --- a/apidocs/inherit_graph_84.md5 +++ b/apidocs/inherit_graph_84.md5 @@ -1 +1 @@ -18255e3a95fc8cd6c220e7bb66679b60 \ No newline at end of file +36a3f4b34914f920c8421c143dbfea85 \ No newline at end of file diff --git a/apidocs/inherit_graph_84.png b/apidocs/inherit_graph_84.png index 3437b3bb..ca4f1e2b 100644 Binary files a/apidocs/inherit_graph_84.png and b/apidocs/inherit_graph_84.png differ diff --git a/apidocs/inherit_graph_85.map b/apidocs/inherit_graph_85.map index b1f49d14..f47bceb4 100644 --- a/apidocs/inherit_graph_85.map +++ b/apidocs/inherit_graph_85.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_85.md5 b/apidocs/inherit_graph_85.md5 index 1d25d709..efafbd81 100644 --- a/apidocs/inherit_graph_85.md5 +++ b/apidocs/inherit_graph_85.md5 @@ -1 +1 @@ -a0bf9dc3105f676d4242e21e2ab2672e \ No newline at end of file +093b86925496bcaa84a9153093944ce8 \ No newline at end of file diff --git a/apidocs/inherit_graph_85.png b/apidocs/inherit_graph_85.png index 10882841..643f62df 100644 Binary files a/apidocs/inherit_graph_85.png and b/apidocs/inherit_graph_85.png differ diff --git a/apidocs/inherit_graph_86.map b/apidocs/inherit_graph_86.map index 5dda3944..eb14b47b 100644 --- a/apidocs/inherit_graph_86.map +++ b/apidocs/inherit_graph_86.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_86.md5 b/apidocs/inherit_graph_86.md5 index 9923274d..05d693b5 100644 --- a/apidocs/inherit_graph_86.md5 +++ b/apidocs/inherit_graph_86.md5 @@ -1 +1 @@ -d5fb7428f44c6674ddc33a7b2e70782f \ No newline at end of file +f4a3f7530ebe8e49d522ddf47c80593e \ No newline at end of file diff --git a/apidocs/inherit_graph_86.png b/apidocs/inherit_graph_86.png index 4c03dbbc..be15980b 100644 Binary files a/apidocs/inherit_graph_86.png and b/apidocs/inherit_graph_86.png differ diff --git a/apidocs/inherit_graph_87.map b/apidocs/inherit_graph_87.map index f56e2732..03b5f834 100644 --- a/apidocs/inherit_graph_87.map +++ b/apidocs/inherit_graph_87.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_87.md5 b/apidocs/inherit_graph_87.md5 index ab391809..8f7f1ba8 100644 --- a/apidocs/inherit_graph_87.md5 +++ b/apidocs/inherit_graph_87.md5 @@ -1 +1 @@ -c1fa7d2c683772fccbbb8f4511ecd377 \ No newline at end of file +18255e3a95fc8cd6c220e7bb66679b60 \ No newline at end of file diff --git a/apidocs/inherit_graph_87.png b/apidocs/inherit_graph_87.png index a0517572..3437b3bb 100644 Binary files a/apidocs/inherit_graph_87.png and b/apidocs/inherit_graph_87.png differ diff --git a/apidocs/inherit_graph_88.map b/apidocs/inherit_graph_88.map new file mode 100644 index 00000000..5dda3944 --- /dev/null +++ b/apidocs/inherit_graph_88.map @@ -0,0 +1,3 @@ + + + diff --git a/apidocs/inherit_graph_88.md5 b/apidocs/inherit_graph_88.md5 new file mode 100644 index 00000000..9923274d --- /dev/null +++ b/apidocs/inherit_graph_88.md5 @@ -0,0 +1 @@ +d5fb7428f44c6674ddc33a7b2e70782f \ No newline at end of file diff --git a/apidocs/inherit_graph_88.png b/apidocs/inherit_graph_88.png new file mode 100644 index 00000000..4c03dbbc Binary files /dev/null and b/apidocs/inherit_graph_88.png differ diff --git a/apidocs/inherit_graph_89.map b/apidocs/inherit_graph_89.map new file mode 100644 index 00000000..f56e2732 --- /dev/null +++ b/apidocs/inherit_graph_89.map @@ -0,0 +1,3 @@ + + + diff --git a/apidocs/inherit_graph_89.md5 b/apidocs/inherit_graph_89.md5 new file mode 100644 index 00000000..ab391809 --- /dev/null +++ b/apidocs/inherit_graph_89.md5 @@ -0,0 +1 @@ +c1fa7d2c683772fccbbb8f4511ecd377 \ No newline at end of file diff --git a/apidocs/inherit_graph_89.png b/apidocs/inherit_graph_89.png new file mode 100644 index 00000000..a0517572 Binary files /dev/null and b/apidocs/inherit_graph_89.png differ diff --git a/apidocs/inherit_graph_9.map b/apidocs/inherit_graph_9.map index fa234239..f221b099 100644 --- a/apidocs/inherit_graph_9.map +++ b/apidocs/inherit_graph_9.map @@ -1,3 +1,3 @@ - + diff --git a/apidocs/inherit_graph_9.md5 b/apidocs/inherit_graph_9.md5 index 8e40685e..92b2a67e 100644 --- a/apidocs/inherit_graph_9.md5 +++ b/apidocs/inherit_graph_9.md5 @@ -1 +1 @@ -4dda70e80573480a71acd3cd2a21302d \ No newline at end of file +709eac68d1ae40c0f157afdfb1d14996 \ No newline at end of file diff --git a/apidocs/inherit_graph_9.png b/apidocs/inherit_graph_9.png index 9772830b..0bf50b80 100644 Binary files a/apidocs/inherit_graph_9.png and b/apidocs/inherit_graph_9.png differ diff --git a/apidocs/inherits.html b/apidocs/inherits.html index 01094388..d0f4e681 100644 --- a/apidocs/inherits.html +++ b/apidocs/inherits.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: Class Hierarchy @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
@@ -62,7 +62,8 @@ $(function() {
-
Class Hierarchy
+
+
Class Hierarchy
@@ -78,282 +79,292 @@ $(function() { - - - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + - + - + - + - + + + + + + - + - + - + - + - + - + @@ -369,152 +380,152 @@ $(function() { - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - - - + + + - + + + + + + - + - + - + - + - + - + - - - - - - + - + @@ -523,7 +534,7 @@ $(function() {
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/jquery.js b/apidocs/jquery.js index c9ed3d99..103c32d7 100644 --- a/apidocs/jquery.js +++ b/apidocs/jquery.js @@ -1,5 +1,5 @@ -/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+k+"-]").length||v.push("~="),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+k+"+*").length||v.push(".#.+[+~]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",$)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e===C||e.ownerDocument===m&&y(m,e)?-1:t===C||t.ownerDocument===m&&y(m,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e===C?-1:t===C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]===m?-1:s[r]===m?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if((e.ownerDocument||e)!==C&&T(e),d.matchesSelector&&E&&!A[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){A(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===k.css(e,"position"))e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0 - - - - - - -Libical API Documentation: libical_deprecated.h Source File - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
libical_deprecated.h
-
-
-
1
-
6#ifndef LIBICAL_DEPRECATED_H
-
7#define LIBICAL_DEPRECATED_H
-
8
-
9/* Deprecated function macro */
-
10#if defined(NO_DEPRECATION_WARNINGS)
-
11#define LIBICAL_DEPRECATED(x) x
-
12#else
-
13#if !defined(LIBICAL_DEPRECATED)
-
14#ifdef __GNUC__
-
15#define LIBICAL_DEPRECATED(x) x __attribute__((deprecated))
-
16#elif defined(_MSC_VER)
-
17#define LIBICAL_DEPRECATED(x) __declspec(deprecated) x
-
18#else
-
19#define LIBICAL_DEPRECATED(x) x
-
20#endif
-
21#endif
-
22#endif
-
23
-
24#endif
-
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/libical__ical__export_8h_source.html b/apidocs/libical__ical__export_8h_source.html index 90d74855..33ad5c1f 100644 --- a/apidocs/libical__ical__export_8h_source.html +++ b/apidocs/libical__ical__export_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: libical_ical_export.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
libical_ical_export.h
+
+
libical_ical_export.h
-
1
-
6#ifndef LIBICAL_ICAL_EXPORT_H
-
7#define LIBICAL_ICAL_EXPORT_H
-
8
-
9#if !defined(S_SPLINT_S)
-
10
-
11#ifdef LIBICAL_ICAL_STATIC_DEFINE
-
12#define LIBICAL_ICAL_EXPORT
-
13#define LIBICAL_ICAL_NO_EXPORT
-
14#else
-
15#if defined(_MSC_VER) || defined(__CYGWIN__)
-
16#if defined(libical_ical_EXPORTS)
-
17 /* We are building this library */
-
18#define LIBICAL_ICAL_EXPORT __declspec(dllexport)
-
19#else
-
20 /* We are using this library */
-
21#define LIBICAL_ICAL_EXPORT __declspec(dllimport)
-
22#endif
-
23#define LIBICAL_ICAL_NO_EXPORT
-
24#else
-
25#define LIBICAL_ICAL_EXPORT __attribute__((visibility("default")))
-
26#define LIBICAL_ICAL_NO_EXPORT __attribute__((visibility("hidden")))
-
27#endif
-
28#endif
-
29
-
30#endif
-
31
-
32#endif
+
1 #ifndef LIBICAL_ICAL_EXPORT_H
+
2 #define LIBICAL_ICAL_EXPORT_H
+
3 
+
4 #if !defined(S_SPLINT_S)
+
5 
+
6 #ifdef LIBICAL_ICAL_STATIC_DEFINE
+
7 #define LIBICAL_ICAL_EXPORT
+
8 #define LIBICAL_ICAL_NO_EXPORT
+
9 #else
+
10 #if defined(_MSC_VER) || defined(__CYGWIN__)
+
11 #if defined(libical_ical_EXPORTS)
+
12  /* We are building this library */
+
13 #define LIBICAL_ICAL_EXPORT __declspec(dllexport)
+
14 #else
+
15  /* We are using this library */
+
16 #define LIBICAL_ICAL_EXPORT __declspec(dllimport)
+
17 #endif
+
18 #define LIBICAL_ICAL_NO_EXPORT
+
19 #else
+
20 #define LIBICAL_ICAL_EXPORT __attribute__((visibility("default")))
+
21 #define LIBICAL_ICAL_NO_EXPORT __attribute__((visibility("hidden")))
+
22 #endif
+
23 #endif
+
24 
+
25 #endif
+
26 
+
27 #endif
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/libical__icalss__export_8h_source.html b/apidocs/libical__icalss__export_8h_source.html index 8f81562d..d53c378c 100644 --- a/apidocs/libical__icalss__export_8h_source.html +++ b/apidocs/libical__icalss__export_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: libical_icalss_export.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
libical_icalss_export.h
+
+
libical_icalss_export.h
-
1
-
6#ifndef LIBICAL_ICALSS_EXPORT_H
-
7#define LIBICAL_ICALSS_EXPORT_H
-
8
-
9#if !defined(S_SPLINT_S)
-
10
-
11#ifdef LIBICAL_ICALSS_STATIC_DEFINE
-
12#define LIBICAL_ICALSS_EXPORT
-
13#define LIBICAL_ICALSS_NO_EXPORT
-
14#else
-
15#if defined(_MSC_VER) || defined(__CYGWIN__)
-
16#if defined(libical_icalss_EXPORTS)
-
17 /* We are building this library */
-
18#define LIBICAL_ICALSS_EXPORT __declspec(dllexport)
-
19#else
-
20 /* We are using this library */
-
21#define LIBICAL_ICALSS_EXPORT __declspec(dllimport)
-
22#endif
-
23#define LIBICAL_ICALSS_NO_EXPORT
-
24#else
-
25#define LIBICAL_ICALSS_EXPORT __attribute__((visibility("default")))
-
26#define LIBICAL_ICALSS_NO_EXPORT __attribute__((visibility("hidden")))
-
27#endif
-
28#endif
-
29
-
30#endif
-
31
-
32#endif
+
1 #ifndef LIBICAL_ICALSS_EXPORT_H
+
2 #define LIBICAL_ICALSS_EXPORT_H
+
3 
+
4 #if !defined(S_SPLINT_S)
+
5 
+
6 #ifdef LIBICAL_ICALSS_STATIC_DEFINE
+
7 #define LIBICAL_ICALSS_EXPORT
+
8 #define LIBICAL_ICALSS_NO_EXPORT
+
9 #else
+
10 #if defined(_MSC_VER) || defined(__CYGWIN__)
+
11 #if defined(libical_icalss_EXPORTS)
+
12  /* We are building this library */
+
13 #define LIBICAL_ICALSS_EXPORT __declspec(dllexport)
+
14 #else
+
15  /* We are using this library */
+
16 #define LIBICAL_ICALSS_EXPORT __declspec(dllimport)
+
17 #endif
+
18 #define LIBICAL_ICALSS_NO_EXPORT
+
19 #else
+
20 #define LIBICAL_ICALSS_EXPORT __attribute__((visibility("default")))
+
21 #define LIBICAL_ICALSS_NO_EXPORT __attribute__((visibility("hidden")))
+
22 #endif
+
23 #endif
+
24 
+
25 #endif
+
26 
+
27 #endif
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/libical__vcal__export_8h_source.html b/apidocs/libical__vcal__export_8h_source.html index e6e7d73c..df1776b6 100644 --- a/apidocs/libical__vcal__export_8h_source.html +++ b/apidocs/libical__vcal__export_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: libical_vcal_export.h Source File @@ -19,9 +19,10 @@
- - + @@ -29,22 +30,21 @@
-
Libical API Documentation 3.1 +
+
Libical API Documentation +  3.0
- + +/* @license-end */
-
libical_vcal_export.h
+
+
libical_vcal_export.h
-
1
-
5#ifndef LIBICAL_VCAL_EXPORT_H
-
6
-
7#define LIBICAL_VCAL_EXPORT_H
-
8
-
9#if !defined(S_SPLINT_S)
-
10
-
11#ifdef LIBICAL_VCAL_STATIC_DEFINE
-
12#define LIBICAL_VCAL_EXPORT
-
13#define LIBICAL_VCAL_NO_EXPORT
-
14#else
-
15#if defined(_MSC_VER) || defined(__CYGWIN__)
-
16#if defined(libical_vcal_EXPORTS)
-
17 /* We are building this library */
-
18#define LIBICAL_VCAL_EXPORT __declspec(dllexport)
-
19#else
-
20 /* We are using this library */
-
21#define LIBICAL_VCAL_EXPORT __declspec(dllimport)
-
22#endif
-
23#define LIBICAL_VCAL_NO_EXPORT
-
24#else
-
25#define LIBICAL_VCAL_EXPORT __attribute__((visibility("default")))
-
26#define LIBICAL_VCAL_NO_EXPORT __attribute__((visibility("hidden")))
-
27#endif
-
28#endif
-
29
-
30#endif
-
31
-
32#endif
+
1 #ifndef LIBICAL_VCAL_EXPORT_H
+
2 #define LIBICAL_VCAL_EXPORT_H
+
3 
+
4 #if !defined(S_SPLINT_S)
+
5 
+
6 #ifdef LIBICAL_VCAL_STATIC_DEFINE
+
7 #define LIBICAL_VCAL_EXPORT
+
8 #define LIBICAL_VCAL_NO_EXPORT
+
9 #else
+
10 #if defined(_MSC_VER) || defined(__CYGWIN__)
+
11 #if defined(libical_vcal_EXPORTS)
+
12  /* We are building this library */
+
13 #define LIBICAL_VCAL_EXPORT __declspec(dllexport)
+
14 #else
+
15  /* We are using this library */
+
16 #define LIBICAL_VCAL_EXPORT __declspec(dllimport)
+
17 #endif
+
18 #define LIBICAL_VCAL_NO_EXPORT
+
19 #else
+
20 #define LIBICAL_VCAL_EXPORT __attribute__((visibility("default")))
+
21 #define LIBICAL_VCAL_NO_EXPORT __attribute__((visibility("hidden")))
+
22 #endif
+
23 #endif
+
24 
+
25 #endif
+
26 
+
27 #endif
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
diff --git a/apidocs/md__home_allen_projects_libical_libical_doc_UsingLibical.html b/apidocs/md__home_allen_projects_libical_libical_doc_UsingLibical.html deleted file mode 100644 index d01c0e82..00000000 --- a/apidocs/md__home_allen_projects_libical_libical_doc_UsingLibical.html +++ /dev/null @@ -1,921 +0,0 @@ - - - - - - - -Libical API Documentation: Using Libical - - - - - - - - - -
-
- - - - - - -
-
Libical API Documentation 3.1 -
-
-
- - - - - - - - -
-
- - -
- -
- -
-
-
Using Libical
-
-
-
-

‍Author: Eric Busboom eric@.nosp@m.civi.nosp@m.cknow.nosp@m.ledg.nosp@m.e.com

-

Date: January 2001

-
-

-1 Introduction

-

Libical is an Open Source implementation of the iCalendar protocols and protocol data units. The iCalendar specification describes how calendar clients can communicate with calendar servers so users can store their calendar data and arrange meetings with other users.

-

Libical implements multiple RFC calendar standards.

-

This documentation assumes that you are familiar with the iCalendar standards RFC5545 and RFC5546. These specifications are available at the IETF Tools website:

-

-1.1 The libical project

-

This code is under active development. If you would like to contribute to the project, visit https://libical.github.io/libical/.

-

-1.2 License

-

The code and datafiles in this distribution are licensed under the Mozilla Public License version 2.0. See https://www.mozilla.org/MPL for a copy of the license. Alternately, you may use libical under the terms of the GNU Lesser General Public License, version 2.1. See https://www.gnu.org/licenses/lgpl-2.1.html for a copy of the LGPL.

-

This dual license ensures that the library can be incorporated into both proprietary code and GPL'd programs, and will benefit from improvements made by programmers in both realms. We (the libical developers) will only accept changes to this library if they are similarly dual-licensed.

-

-1.3 Example Code

-

A lot of the documentation for this library is in the form of example code. These examples are in the examples/ directory of the distribution. Also look in src/test/ for additional annotated examples.

-

-2 Building the Library

-

Libical uses autoconf to generate makefiles. It should build with no adjustments on Linux, FreeBSD and Solaris under gcc. Some versions have been successfully built on MacOS, Solaris, UnixWare, And Tru64 UNIX without gcc, but you may run into problems with a particular later version.

-

For a more complete guide to building the library, see the README file in the distribution.

-

-3 Structure

-

The iCalendar data model is based on four types of objects: components, properties, values and parameters.

-

Properties are the fundamental unit of information in iCalendar, and they work a bit like a hash entry, with a constant key and a variable value. Properties may also have modifiers, called parameters. In the iCal content line

-
ORGANIZER;ROLE=CHAIR:MAILTO:mrbig@host.com
-

The property name is ORGANIZER, the value of the property is mrbig@host.com and the ROLE parameter specifies that Mr Big is the chair of the meetings associated with this property.

-

Components are groups of properties that represent the core objects of a calendar system, such as events or timezones. Components are delimited by BEGIN and END tags.

-

When a component is sent across a network, if it is un-encrypted, it will look something like:

-
BEGIN:VCALENDAR
-
METHOD:REQUEST
-
PRODID: -//hacksw/handcal//NONSGML v1.0//EN
-
BEGIN:VEVENT
-
DTSTAMP:19980309T231000Z
-
UID:guid-1.host1.com
-
ORGANIZER;ROLE=CHAIR:MAILTO:mrbig@host.com
-
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;CUTYPE=GROUP:
-
MAILTO:employee-A@host.com
-
DESCRIPTION:Project XYZ Review Meeting
-
CATEGORIES:MEETING
-
CLASS:PUBLIC
-
CREATED:19980309T130000Z
-
SUMMARY:XYZ Project Review
-
DTSTART;TZID=US-Eastern:19980312T083000
-
DTEND;TZID=US-Eastern:19980312T093000
-
LOCATION:1CP Conference Room 4350
-
END:VEVENT
-
END:VCALENDAR
-

Note that components can be nested; this example has both a VCALENDAR and a VEVENT component, one nested inside the other.

-

-3.1 Core iCal classes

-

Libical is an object-based, data-oriented library. Nearly all of the routines in the library are associated with an opaque data types and perform some operation on that data type. Although the library does not actually have classes, we will use those terms since the behavior of these associations of data and routines is very similar to a class.

-

-3.1.1 Properties

-

Properties are represented with the icalproperty class and its many "derived" classes with one "derived" class per property type in [RFC5545][]. Again, there is no actual inheritance relations, but there are clusters of routines that make this term useful. A property is a container for a single value and a set of parameters.

-

-3.1.2 Components

-

In libical, components are represented with the icalcomponent class. icalcomponent is a container for a set of other components and properties.

-

-3.1.3 Values

-

Values are represented in a similar way to properties; a base class and many "derived " classes. A value is essentially a abstract handle on a single fundamental type, a structure or a union.

-

-3.1.4 Parameters

-

Parameters are represented in a similar way to properties, except that they contain only one value.

-

-3.2 Other elements of libical

-

In addition to the core iCal classes, libical has many other types, structures, and classes that aid in creating and using iCal components.

-

-3.2.1 Enumerations and types

-

Libical is strongly typed, so every component, property, parameter, and value type has an enumeration, and some have an associated structure or union.

-

-3.2.2 The parser

-

The libical parser offers a variety of ways to convert [RFC5545][] text into a libical internal component structure. The parser can parse blocks of text as a string, or it can parse line-by-line.

-

-3.2.3 Error objects

-

Libical has a substantial error reporting system for both programming errors and component usage errors.

-

-3.2.4 Memory Management

-

Since many of libical's interfaces return strings, the library has its own memory management system to eliminate the need to free every string returned from the library. See Memory Management.

-

-3.2.5 Storage classes

-

The library also offers several classes to store components to files, memory or databases.

-

-4 Differences From RFCs

-

Libical has been designed to follow the standards as closely as possible, so that the key objects in the standards are also key objects in the library. However, there are a few areas where the specifications are (arguably) irregular, and following them exactly would result in an unfriendly interface. These deviations make libical easier to use by maintaining a self-similar interface.

-

-4.1 Pseudo Components

-

Libical defines components for groups of properties that look and act like components, but are not defined as components in the specification. XDAYLIGHT and XSTANDARD are notable examples. These pseudo components group properties within the VTIMEZONE components. For instance, the timezone properties associated with daylight savings time starts with BEGIN:DAYLIGHT and ends with END:DAYLIGHT, just like other components, but is not defined as a component in [RFC5545][] (see section 3.6.5) In libical, this grouping is represented by the XDAYLIGHT component. Standard iCal components all start with the letter "V," while pseudo components start with "X."

-

There are also pseudo components that are conceptually derived classes of VALARM. [RFC5546][] defines what properties may be included in each component, and for VALARM, the set of properties it may have depends on the value of the ACTION property.

-

For instance, if a VALARM component has an ACTION property with the value of AUDIO, the component must also have an ATTACH property. However, if the ACTION value is DISPLAY, the component must have a DESCRIPTION property.

-

To handle these various, complex restrictions, libical has pseudo components for each type of alarm: XAUDIOALARM, XDISPLAYALARM, XEMAILALARM and XPROCEDUREALARM.

-

-4.2 Combined Values

-

Many values can take more than one type. TRIGGER, for instance, can have a value type of with DURATION or of DATE-TIME. These multiple types make it difficult to create routines to return the value associated with a property.

-

It is natural to have interfaces that would return the value of a property, but it is cumbersome for a single routine to return multiple types. So, in libical, properties that can have multiple types are given a single type that is the union of their RFC5545 types. For instance, in libical, the value of the TRIGGER property resolves to struct icaltriggertype. This type is a union of a DURATION and a DATE-TIME.

-

-4.3 Multi-Valued Properties

-

Some properties, such as CATEGORIES have only one value type, but each CATEGORIES property can have multiple value instances. This also results in a cumbersome interface – CATEGORIES accessors would have to return a list while all other accessors returned a single value. In libical, all properties have a single value, and multi-valued properties are broken down into multiple single valued properties during parsing. That is, an input line like,

-
CATEGORIES: work, home
-

becomes in libical's internal representation

-
CATEGORIES: work
-
CATEGORIES: home
-

Oddly, [RFC5545][] allows some multi-valued properties (like FREEBUSY) to exist as both a multi-values property and as multiple single value properties, while others (like CATEGORIES) can only exist as single multi-valued properties. This makes the internal representation for CATEGORIES illegal. However when you convert a component to a string, the library will collect all of the CATEGORIES properties into one.

-

-5 Using libical

-

-5.1 Creating Components

-

There are three ways to create components in Libical:

-
    -
  1. creating individual objects and assembling them,
    2. -
  2. building entire objects in massive vargs calls,
    3. -
  3. parsing a text file containing iCalendar data.
    4. -
-

-5.1.1 Constructor Interfaces

-

Using constructor interfaces, you create each of the objects separately and then assemble them in to components:

-
icalcomponent *event;
-
icalproperty *prop;
-
icalparameter *param;
-
struct icaltimetype atime;
-
-
// create new VEVENT component
-
event = icalcomponent_new(ICAL_VEVENT_COMPONENT);
-
-
// add DTSTAMP property to the event
-
prop = icalproperty_new_dtstamp(atime);
-
icalcomponent_add_property(event, prop);
-
-
// add UID property to the event
-
prop = icalproperty_new_uid("guid-1.example.com");
-
icalcomponent_add_property(event, prop);
-
-
// add ORGANIZER (with ROLE=CHAIR) to the event
-
prop = icalproperty_new_organizer("mrbig@example.com");
-
param = icalparameter_new_role(ICAL_ROLE_CHAIR);
-
icalproperty_add_parameter(prop, param);
-
icalcomponent_add_property(event, prop);
-
icalcomponent_new
icalcomponent * icalcomponent_new(icalcomponent_kind kind)
Constructor.
Definition: icalcomponent.c:103
-
icalcomponent_impl
Definition: icalcomponent.c:28
-
icaltimetype
Definition: icaltime.h:97
-

Notice that libical uses a semi-object-oriented style of interface. Most things you work with are objects, that are instantiated with a constructor that has "new" in the name. Also note that, other than the object reference, most structure data is passed in to libical routines by value. Libical has some complex but very regular memory handling rules. These are detailed in section Memory Management.

-

If any of the constructors fail, they will return 0. If you try to insert 0 into a property or component, or use a zero-valued object reference, libical will either silently ignore the error or will abort with an error message. This behavior is controlled by a compile time flag (ICAL_ERRORS_ARE_FATAL), and will abort by default.

-

-5.1.2 varargs Constructors

-

There is another way to create complex components, which is arguably more elegant, if you are not horrified by varargs. The varargs constructor interface allows you to create intricate components in a single block of code. Here is the previous examples in the vaargs style.

-
icalcomponent *calendar;
-
struct icaltimetype atime;
-
-
calendar =
-
icalcomponent_vanew(
-
ICAL_VCALENDAR_COMPONENT,
-
icalproperty_new_version("2.0"),
-
icalproperty_new_prodid(
-
"-//RDU Software//NONSGML HandCal//EN"),
-
icalcomponent_vanew(
-
ICAL_VEVENT_COMPONENT,
-
icalproperty_new_dtstamp(atime),
-
icalproperty_new_uid("guid-1.host1.com"),
-
icalproperty_vanew_organizer(
-
"mrbig@host.com",
-
icalparameter_new_role(ICAL_ROLE_CHAIR),
-
NULL),
-
icalproperty_vanew_attendee(
-
"employee-A@host.com",
-
icalparameter_new_role(
-
ICAL_ROLE_REQPARTICIPANT),
-
icalparameter_new_rsvp(1),
-
icalparameter_new_cutype(ICAL_CUTYPE_GROUP),
-
NULL),
-
icalproperty_new_location(
-
"1CP Conference Room 4350"),
-
NULL),
-
NULL);
-
icalcomponent_vanew
icalcomponent * icalcomponent_vanew(icalcomponent_kind kind,...)
Constructor.
Definition: icalcomponent.c:110
-

This form is similar to the constructor form, except that the constructors have vanew instead of new in the name. The arguments are similar too, except that the component constructor can have a list of properties, and the property constructor can have a list of parameters.

-

Be sure to terminate every list with a NULL (or a *(void 0), or your code will crash, if you are lucky*. The reason you can't use 0 itself is that depending on what platform you are on, sizeof(int) ≠ sizeof(void*).

-

-5.1.3 Parsing Text Files

-

The final way to create components will probably be the most common; you can create components from [RFC5545][] compliant text. If you have the string in memory, use

-
icalcomponent* icalparser_parse_string(char* str);
-
icalparser_parse_string
icalcomponent * icalparser_parse_string(const char *str)
Parses a string and returns the parsed icalcomponent.
Definition: icalparser.c:1336
-

If the string contains only one component, the parser will return the component in libical form. If the string contains multiple components, the multiple components will be returned as the children of an ICAL_XROOT_COMPONENT component.

-

Parsing a whole string may seem wasteful if you want to pull a large component off of the network or from a file; you may prefer to parse the component line by line. This is possible too by using:

-
icalparser* icalparser_new();
-
-
void icalparser_free(
-
icalparser* parser);
-
-
icalparser_get_line(
-
icalparser *parser,
-
char* (*read_stream)(char *s, size_t size, void* d));
-
-
icalparser_add_line(
-
icalparser *parser,
-
char *line);
-
-
icalparser_set_gen_data(
-
icalparser *parser,
-
void *data);
-
icalparser_free
void icalparser_free(icalparser *parser)
Frees an icalparser object.
Definition: icalparser.c:104
-
icalparser_new
icalparser * icalparser_new(void)
Creates a new icalparser.
Definition: icalparser.c:81
-
icalparser_add_line
icalcomponent * icalparser_add_line(icalparser *parser, char *str)
Adds a single line to be parsed by the icalparser.
Definition: icalparser.c:682
-
icalparser_set_gen_data
void icalparser_set_gen_data(icalparser *parser, void *data)
Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.
Definition: icalparser.c:121
-
icalparser_get_line
char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)
Given a line generator function, returns a single iCal content line.
Definition: icalparser.c:467
-
icalparser_impl
Definition: icalparser.c:32
-

These routines will construct a parser object to which you can add lines of input and retrieve any components that the parser creates from the input. These routines work by specifying an adaptor routine to get string data from a source. For example:

-
char* read_stream(char *s, size_t size, void *d)
-
{
-
return fgets(s, size, (FILE*)d);
-
}
-
-
int main(int argc, char *argv[])
-
{
-
char *line;
-
icalcomponent *component;
-
icalparser *parser = icalparser_new();
-
-
// open file (first command-line argument)
-
FILE* stream = fopen(argv[1], "r");
-
-
// associate the FILE with the parser so that read_stream
-
// will have access to it
-
icalparser_set_gen_data(parser, stream);
-
-
do {
-
// read the file, line-by-line, and parse the data
-
line = icalparser_get_line(parser, read_stream);
-
component = icalparser_add_line(parser, line);
-
-
// if icalparser has finished parsing a component,
-
// it will return it
-
if (component != 0) {
-
// print the parsed component
-
printf("%s", icalcomponent_as_ical_string(component));
-
icalparser_clean(parser);
-
-
printf("\n---------------\n");
-
-
icalcomponent_free(component);
-
}
-
} while (line != 0);
-
-
return 0;
-
}
-
icalparser_clean
icalcomponent * icalparser_clean(icalparser *parser)
Cleans out an icalparser and returns whatever it has parsed so far.
Definition: icalparser.c:1243
-

The parser object parameterizes the routine used to get input lines with icalparser_set_gen_data()and icalparser_get_line(). In this example, the routine read_stream() will fetch the next line from a stream, with the stream passed in as the void* parameter d. The parser calls read_stream() from icalparser_get_line(), but it also needs to know what stream to use. This is set by the call to icalparser_set_gen_data(). By using a different routine for read_stream() or passing in different data with icalparser_set_gen_data(), you can connect to any data source.

-

Using the same mechanism, other implementations could read from memory buffers, sockets or other interfaces.

-

Since the example code is a very common way to use the parser, there is a convenience routine;

-
icalcomponent* icalparser_parse(
-
icalparser *parser,
-
char* (*line_gen_func)(char *s, size_t size, void* d));
-
icalparser_parse
icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)
Message oriented parsing.
Definition: icalparser.c:622
-

To use this routine, you still must construct the parser object and pass in a reference to a line reading routine. If the parser can create a single component from the input, it will return a pointer to the newly constructed component. If the parser can construct multiple components from the input, it will return a reference to an XROOT component (of type ICAL_XROOT_COMPONENT.) This XROOT component will hold all of the components constructed from the input as children.

-
char* read_stream(char *s, size_t size, void *d)
-
{
-
return fgets(s, size, (FILE*)d);
-
}
-
-
int main(int argc, char *argv[])
-
{
-
char* line;
-
icalcomponent *component;
-
icalparser *parser = icalparser_new();
-
-
// open file (first command-line argument)
-
FILE* stream = fopen(argv[1], "r");
-
-
// associate the FILE with the parser so that read_stream
-
// will have access to it
-
icalparser_set_gen_data(parser, stream);
-
-
// parse the opened file
-
component = icalparser_parse(parser, read_stream);
-
-
if (component != 0) {
-
// print the parsed component
-
printf("%s", icalcomponent_as_ical_string(component));
-
icalcomponent_free(component);
-
}
-
-
icalparser_free(parser);
-
-
return 0;
-
}
-

-5.2 Accessing Components

-

Given a reference to a component, you probably will want to access the properties, parameters and values inside. Libical interfaces let you find sub-component, add and remove sub-components, and do the same three operations on properties.

-

-5.2.1 Finding Components

-

To find a sub-component of a component, use:

-
icalcomponent* icalcomponent_get_first_component(
-
icalcomponent* component,
-
icalcomponent_kind kind);
-

This routine will return a reference to the first component of the type kind. The key kind values, listed in icalenums.h are:

-
    -
  • ICAL_ANY_COMPONENT
    • -
  • ICAL_VEVENT_COMPONENT
    • -
  • ICAL_VTODO_COMPONENT
    • -
  • ICAL_VJOURNAL_COMPONENT
    • -
  • ICAL_VCALENDAR_COMPONENT
    • -
  • ICAL_VFREEBUSY_COMPONENT
    • -
  • ICAL_VALARM_COMPONENT
    • -
-

These are only the most common components; there are many more listed in icalenums.h.

-

As you might guess, if there is more than one subcomponent of the type you have chosen, this routine will return only the first. to get at the others, you need to iterate through the component.

-

-5.2.2 Iterating Through Components

-

Iteration requires a second routine to get the next subcomponent after the first:

-
icalcomponent* icalcomponent_get_next_component(
-
icalcomponent* component,
-
icalcomponent_kind kind);
-

With the 'first' and 'next' routines, you can create a for loop to iterate through all of a components subcomponents

-
icalcomponent *c;
-
-
for(c = icalcomponent_get_first_component(comp, ICAL_ANY_COMPONENT);
-
c != 0;
-
c = icalcomponent_get_next_component(comp, ICAL_ANY_COMPONENT))
-
{
-
do_something(c);
-
}
-

This code bit will iterate through all of the subcomponents in comp but you can select a specific type of component by changing ICAL_ANY_COMPONENT to another component type.

-

-5.2.3 Using Component Iterators

-

The iteration model in the previous section requires the component to keep the state of the iteration. So, you could not use this model to perform a sorting operations, since you'd need two iterators and there is only space for one. If you ever call icalcomponent_get_first_component() when an iteration is in progress, the pointer will be reset to the beginning.

-

To solve this problem, there are also external iterators for components. The routines associated with these external iterators are:

-
icalcompiter icalcomponent_begin_component(
-
icalcomponent* component,
-
icalcomponent_kind kind);
-
-
icalcompiter icalcomponent_end_component(
-
icalcomponent* component,
-
icalcomponent_kind kind);
-
-
icalcomponent* icalcompiter_next(
-
icalcompiter* i);
-
-
icalcomponent* icalcompiter_prior(
-
icalcompiter* i);
-
-
icalcomponent* icalcompiter_deref(
-
icalcompiter* i);
-
icalcompiter
Definition: icalcomponent.h:29
-

The *_begin_*() and *_end_*() routines return a new iterator that points to the beginning and end of the list of subcomponent for the given component, and the kind argument works like the kind argument for internal iterators.

-

After creating an iterators, use *_next() and *_prior() to step forward and backward through the list and get the component that the iterator points to, and use _deref() to return the component that the iterator points to without moving the iterator. All routines will return 0 when they move to point off the end of the list.

-

Here is an example of a loop using these routines:

-
for(i = icalcomponent_begin_component(impl->cluster, ICAL_ANY_COMPONENT);
-
icalcompiter_deref(&i)!= 0;
-
icalcompiter_next(&i))
-
{
-
icalcomponent *this = icalcompiter_deref(&i);
-
}
-

-5.2.4 Removing Components

-

Removing an element from a list while iterating through the list with the internal iterators can cause problems, since you will probably be removing the element that the internal iterator points to. The _remove() routine will keep the iterator valid by moving it to the next component, but in a normal loop, this will result in two advances per iteration, and you will remove only every other component. To avoid the problem, you will need to step the iterator ahead of the element you are going to remove, like this:

-
for(c = icalcomponent_get_first_component(parent_comp, ICAL_ANY_COMPONENT);
-
c != 0;
-
c = next)
-
{
-
next = icalcomponent_get_next_component(parent_comp, ICAL_ANY_COMPONENT);
-
icalcomponent_remove_component(parent_comp,c);
-
}
-

Another way to remove components is to rely on the side effect of icalcomponent_remove_component(): if component iterator in the parent component is pointing to the child that will be removed, it will move the iterator to the component after the child. The following code will exploit this behavior:

-
icalcomponent_get_first_component(parent_comp,ICAL_VEVENT_COMPONENT);
-
-
while((c=icalcomponent_get_current_component(c)) != 0){
-
if(icalcomponent_isa(c) == ICAL_VEVENT_COMPONENT){
-
icalcomponent_remove_component(parent_comp,inner);
-
} else {
-
icalcomponent_get_next_component(parent_comp,ICAL_VEVENT_COMPONENT);
-
}
-
}
-

-5.2.5 Working with properties and parameters

-

Finding, iterating and removing properties works the same as it does for components, using the property-specific or parameter-specific interfaces:

-
icalproperty* icalcomponent_get_first_property(
-
icalcomponent* component,
-
icalproperty_kind kind);
-
-
icalproperty* icalcomponent_get_next_property(
-
icalcomponent* component,
-
icalproperty_kind kind);
-
-
void icalcomponent_add_property(
-
icalcomponent* component,
-
icalproperty* property);
-
-
void icalcomponent_remove_property(
-
icalcomponent* component,
-
icalproperty* property);
-

For parameters:

-
icalparameter* icalproperty_get_first_parameter(
-
icalproperty* prop,
-
icalparameter_kind kind);
-
-
icalparameter* icalproperty_get_next_parameter(
-
icalproperty* prop,
-
icalparameter_kind kind);
-
-
void icalproperty_add_parameter(
-
icalproperty* prop,
-
icalparameter* parameter);
-
-
void icalproperty_remove_parameter_by_kind(
-
icalproperty* prop,
-
icalparameter_kind kind);
-
icalproperty_remove_parameter_by_kind
void icalproperty_remove_parameter_by_kind(icalproperty *prop, icalparameter_kind kind)
Removes all parameters with the specified kind.
Definition: icalproperty.c:624
-

Note that since there should be only one parameter of each type in a property, you will rarely need to use icalparameter_get_next_parameter().

-

-5.2.6 Working with values

-

Values are typically part of a property, although they can exist on their own. You can manipulate them either as part of the property or independently.

-

The most common way to work with values to is to manipulate them from the properties that contain them. This involves fewer routine calls and intermediate variables than working with them independently, and it is type-safe.

-

For each property, there are a _get_() and a _set_() routine that accesses the internal value. For instanace, for the UID property, the routines are:

-
void icalproperty_set_uid(
-
icalproperty* prop,
-
const char* v);
-
-
const char* icalproperty_get_uid(
-
icalproperty* prop);
-

For multi-valued properties, like ATTACH, the value type is usually a struct or union that holds both possible types.

-

If you want to work with the underlying value object, you can get and set it with:

-
icalvalue* icalproperty_get_value(
-
icalproperty* prop);
-
-
void icalproperty_set_value(
-
icalproperty* prop,
-
icalvalue* value);
-

icalproperty_get_value() will return a reference that you can manipulate with other icalvalue routines. Most of the time, you will have to know what the type of the value is. For instance, if you know that the value is a DATETIME type, you can manipulate it with:

-
struct icaltimetype icalvalue_get_datetime(
-
icalvalue* value);
-
-
void icalvalue_set_datetime(
-
icalvalue* value,
-
struct icaltimetype v);
-

When working with an extension property or value (and X-PROPERTY or a property that has the parameter VALUE=x-name), the value type is always a string. To get and set the value, use:

-
void icalproperty_set_x(
-
icalproperty* prop,
-
char* v);
-
-
char* icalproperty_get_x(
-
icalproperty* prop);
-

All X properties have the type of ICAL_X_PROPERTY, so you will need these routines to get and set the name of the property:

-
char* icalproperty_get_x_name(
-
icalproperty* prop)
-
-
void icalproperty_set_x_name(
-
icalproperty* prop,
-
char* name);
-

-5.2.7 Checking Component Validity

-

[RFC5546][] defines rules for what properties must exist in a component to be used for transferring scheduling data. Most of these rules relate to the existence of properties relative to the METHOD property, which declares what operation a remote receiver should use to process a component. For instance, if the METHOD is REQUEST and the component is a VEVENT, the sender is probably asking the receiver to join in a meeting. In this case, RFC5546 says that the component must specify a start time (DTSTART) and list the receiver as an attendee (ATTENDEE).

-

Libical can check these restrictions with the routine:

-
int icalrestriction_check(icalcomponent* comp);
-
icalrestriction_check
int icalrestriction_check(icalcomponent *comp)
Checks if a given VCALENDAR meets all the restrictions imposed by the standard.
-

This routine returns 0 if the component does not pass RFC5546 restrictions, or if the component is malformed. The component you pass in must be a VCALENDAR, with one or more children, like the examples in RFC5546.

-

When this routine runs, it will insert new properties into the component to indicate any errors it finds. See section 6.5.3, X-LIC-ERROR for more information about these error properties.

-

5.2.8 Converting Components to Text

-

To create an RFC5545 compliant text representation of an object, use one of the *_as_ical_string() routines:

-
char* icalcomponent_as_ical_string(icalcomponent* component)
-
-
char* icalproperty_as_ical_string(icalproperty* property)
-
-
char* icalparameter_as_ical_string(icalparameter* parameter)
-
-
char* icalvalue_as_ical_string(icalvalue* value)
-
icalparameter_as_ical_string
char * icalparameter_as_ical_string(icalparameter *parameter)
Converts icalparameter into a string representation.
Definition: icalparameter.c:164
-

In most cases, you will only use icalcomponent_as_ical_string(), since it will cascade and convert all of the parameters, properties and values that are attached to the root component.

-

Remember that the string returned by these routines is owned by the library, and will eventually be re-written. You should copy it if you want to preserve it.

-

-5.3 Time

-

-5.3.1 Time structure

-

Libical defines its own time structure for storing all dates and times. It would have been nice to re-use the C library's struct tm, but that structure does not differentiate between dates and times, and between local time and UTC. The libical structure is:

-
struct icaltimetype {
-
int year;
-
int month;
-
int day;
-
int hour;
-
int minute;
-
int second;
-
int is_utc; /* 1-> time is in UTC timezone */
-
int is_date; /* 1 -> interpret this as date. */
-
};
-
icaltimetype::is_date
int is_date
Definition: icaltime.h:105
-
icaltimetype::year
int year
Definition: icaltime.h:98
-
icaltimetype::month
int month
Definition: icaltime.h:99
-

The year, month, day, hour, minute and second fields hold the broken-out time values. The is_utc field distinguishes between times in UTC and a local time zone. The is_date field indicates if the time should be interpreted only as a date. If it is a date, the hour, minute and second fields are assumed to be zero, regardless of their actual values.

-

-5.3.2 Creating time structures

-

There are several ways to create a new icaltimetype structure:

-
struct icaltimetype icaltime_from_string(
-
const char* str);
-
-
struct icaltimetype icaltime_from_timet_with_zone(
-
icaltime_t v,
-
int is_date,
-
icaltimezone* zone);
-
icaltime_from_string
struct icaltimetype icaltime_from_string(const char *str)
Constructor.
Definition: icaltime.c:330
-
icaltime_from_timet_with_zone
struct icaltimetype icaltime_from_timet_with_zone(const time_t tm, const int is_date, const icaltimezone *zone)
Constructor.
-
_icaltimezone
Definition: icaltimezoneimpl.h:15
-
icaltimetype::zone
const icaltimezone * zone
Definition: icaltime.h:109
-

icaltime_from_string() takes any RFC5545 compliant time string:

-
struct icaltimetype tt = icaltime_from_string("19970101T103000");
-

icaltime_from_timet_with_zone() takes a icaltime_t value, representing seconds past the POSIX epoch, a flag to indicate if the time is a date, and a time zone. Dates have an identical structure to a time, but the time portion (hours, minutes and seconds) is always 00:00:00. Dates act differently in sorting and comparison, and they have a different string representation in [RFC5545][].

-

-5.3.3 Time manipulating routines

-

The null time value is used to indicate that the data in the structure is not a valid time.

-
struct icaltimetype icaltime_null_time(void);
-
-
int icaltime_is_null_time(struct icaltimetype t);
-
icaltime_is_null_time
int icaltime_is_null_time(const struct icaltimetype t)
Returns true if the time is null.
Definition: icaltime.c:593
-
icaltime_null_time
struct icaltimetype icaltime_null_time(void)
Constructor.
Definition: icaltime.c:546
-

It is sensible for the broken-out time fields to contain values that are not permitted in an ISO compliant time string. For instance, the seconds field can hold values greater than 59, and the hours field can hold values larger than 24. The excessive values will be rolled over into the next larger field when the structure is normalized.

-
struct icaltimetype icaltime_normalize(struct icaltimetype t);
-
icaltime_normalize
struct icaltimetype icaltime_normalize(const struct icaltimetype tt)
Normalizes the icaltime, so all of the time components are in their normal ranges.
Definition: icaltime.c:322
-

Normalizing allows you to do arithmetic operations on time values.

-
struct icaltimetype tt = icaltime_from_string("19970101T103000");
-
-
tt.days +=3
-
tt.second += 70;
-
-
tt = icaltime_normalize(tt);
-

There are several routines to get the day of the week or month, etc, from a time structure.

-
short icaltime_day_of_year(
-
struct icaltimetype t);
-
-
struct icaltimetype icaltime_from_day_of_year(
-
short doy,
-
short year);
-
-
short icaltime_day_of_week(
-
struct icaltimetype t);
-
-
short icaltime_start_doy_week(
-
struct icaltimetype t,
-
int fdow);
-
-
short icaltime_week_number(
-
short day_of_month,
-
short month,
-
short year);
-
-
short icaltime_days_in_month(
-
short month,
-
short year);
-
icaltime_from_day_of_year
struct icaltimetype icaltime_from_day_of_year(const int doy, const int year)
Constructor.
Definition: icaltime.c:511
-
icaltime_day_of_year
int icaltime_day_of_year(const struct icaltimetype t)
Returns the day of the year, counting from 1 (Jan 1st).
Definition: icaltime.c:504
-
icaltime_start_doy_week
int icaltime_start_doy_week(const struct icaltimetype t, int fdow)
Returns the day of the year for the first day of the week that the given time is within.
Definition: icaltime.c:467
-
icaltime_week_number
int icaltime_week_number(const struct icaltimetype t)
Returns the week number for the week the given time is within.
Definition: icaltime.c:488
-
icaltime_day_of_week
int icaltime_day_of_week(const struct icaltimetype t)
Returns the day of the week of the given time.
Definition: icaltime.c:452
-
icaltime_days_in_month
int icaltime_days_in_month(const int month, const int year)
Definition: icaltime.c:426
-

Two routines convert time structures to and from the number of seconds since the POSIX epoch. The is_date field indicates whether or not the hour, minute and second fields should be used in the conversion.

-
struct icaltimetype icaltime_from_timet_with_zone(
-
icaltime_t v,
-
int is_date,
-
icaltimezone* zone);
-
-
icaltime_t icaltime_as_timet(
-
struct icaltimetype);
-
icaltime_as_timet
time_t icaltime_as_timet(const struct icaltimetype)
Definition: icaltime.c:222
-

The compare routine works exactly like strcmp(), but on time structures.

-
int icaltime_compare(
-
struct icaltimetype a,
-
struct icaltimetype b);
-
icaltime_compare
int icaltime_compare(const struct icaltimetype a, const struct icaltimetype b)
Returns -1, 0, or 1 to indicate that a is less than b, a equals b, or a is greater than b.
Definition: icaltime.c:602
-

The following routines convert between UTC and a named timezone. The tzid field must be a timezone name from the Olsen database, such as America/Los_Angeles.

-

The utc_offset routine returns the offset of the named time zone from UTC, in seconds.

-

The tt parameter in the following routines indicates the date on which the conversion should be made. The parameter is necessary because timezones have many different rules for when daylight savings time is used, and these rules can change over time. So, for a single timezone one year may have daylight savings time on March 15, but for other years March 15 may be standard time, and some years may have standard time all year.

-
int icaltime_utc_offset(
-
struct icaltimetype tt,
-
char* tzid);
-
-
int icaltime_local_utc_offset();
-
-
struct icaltimetype icaltime_as_utc(
-
struct icaltimetype tt,
-
char* tzid);
-
-
struct icaltimetype icaltime_as_zone(
-
struct icaltimetype tt,
-
char* tzid);
-
-
struct icaltimetype icaltime_as_local(
-
struct icaltimetype tt);
-

-5.4 Storing Objects

-

The libical distribution includes a separate library, libicalss, that allows you to store iCal component data to disk in a variety of ways.

-

The file storage routines are organized in an inheritance hierarchy that is rooted in icalset, with the derived class icalfileset and icaldirset. Icalfileset stores components to a file, while icaldirset stores components to multiple files, one per month based on DTSTAMP. Other storages classes, for storage to a heap or a mysql database for example, could be added in the future.

-

All of the icalset derived classes have the same interface:

-
icaldirset* icaldirset_new(
-
const char* path);
-
-
void icaldirset_free(
-
icaldirset* store);
-
-
const char* icaldirset_path(
-
icaldirset* store);
-
-
void icaldirset_mark(
-
icaldirset* store);
-
-
icalerrorenum icaldirset_commit(
-
icaldirset* store);
-
-
icalerrorenum icaldirset_add_component(
-
icaldirset* store,
-
icalcomponent* comp);
-
-
icalerrorenum icaldirset_remove_component(
-
icaldirset* store,
-
icalcomponent* comp);
-
-
int icaldirset_count_components(
-
icaldirset* store,
-
icalcomponent_kind kind);
-
-
icalerrorenum icaldirset_select(
-
icaldirset* store,
-
icalcomponent* gauge);
-
-
void icaldirset_clear(
-
icaldirset* store);
-
-
icalcomponent* icaldirset_fetch(
-
icaldirset* store,
-
const char* uid);
-
-
int icaldirset_has_uid(
-
icaldirset* store,
-
const char* uid);
-
-
icalcomponent* icaldirset_fetch_match(
-
icaldirset* set,
-
icalcomponent *c);
-
-
icalerrorenum icaldirset_modify(
-
icaldirset* store,
-
icalcomponent *oldc,
-
icalcomponent *newc);
-
-
icalcomponent* icaldirset_get_current_component(
-
icaldirset* store);
-
-
icalcomponent* icaldirset_get_first_component(
-
icaldirset* store);
-
-
icalcomponent* icaldirset_get_next_component(
-
icaldirset* store);
-
icaldirset_add_component
icalerrorenum icaldirset_add_component(icalset *store, icalcomponent *comp)
Definition: icaldirset.c:288
-
icaldirset_remove_component
icalerrorenum icaldirset_remove_component(icalset *store, icalcomponent *comp)
Definition: icaldirset.c:375
-
icalerrorenum
icalerrorenum
Represents the different types of errors that can be triggered in libical.
Definition: icalerror.h:67
-
icaldirset_impl
Definition: icaldirsetimpl.h:22
-

-5.4.1 Creating a new set

-

You can create a new set from either the base class or the direved class. From the base class use one of:

-
icalset* icalset_new_file(const char* path);
-
-
icalset* icalset_new_dir(const char* path);
-
-
icalset* icalset_new_heap(void);
-
-
icalset* icalset_new_mysql(const char* path);
-
icalset_impl
Definition: icalset.h:52
-

You can also create a new set based on the derived class, For instance, with icalfileset:

-
icalfileset* icalfileset_new(
-
const char* path);
-
-
icalfileset* icalfileset_new_open(
-
const char* path,
-
int flags,
-
int mode);
-
icalfileset_impl
Definition: icalfilesetimpl.h:19
-

icalset_new_file() is identical to icalfileset_new(). Both routines will open an existing file for reading and writing, or create a new file if it does not exist. icalfileset_new_open() takes the same arguments as the open() system routine and behaves in the same way.

-

The icalset and icalfileset objects are somewhat interchangeable – you can use an icalfileset* as an argument to any of the icalset routines.

-

The following examples will all use icalfileset routines; using the other icalset derived classes will be similar.

-

-5.4.2 Adding, Finding and Removing Components

-

To add components to a set, use:

-
icalerrorenum icalfileset_add_component(
-
icalfileset* cluster,
-
icalcomponent* child);
-

The fileset keeps an in-memory copy of the components, and this set must be written back to the file occasionally. There are two routines to manage this:

-
void icalfileset_mark(icalfileset* cluster);
-
-
icalerrorenum icalfileset_commit(icalfileset* cluster);
-

icalfileset_mark() indicates that the in-memory components have changed. Calling the _add_component() routine will call _mark() automatically, but you may need to call it yourself if you have made a change to an existing component. The _commit() routine writes the data base to disk, but only if it is marked. The _commit() routine is called automatically when the icalfileset is freed.

-

To iterate through the components in a set, use:

-
icalcomponent* icalfileset_get_first_component(icalfileset* cluster);
-
-
icalcomponent* icalfileset_get_next_component(icalfileset* cluster);
-
-
icalcomponent* icalfileset_get_current_component (icalfileset* cluster);
-

These routines work like the corresponding routines from icalcomponent, except that their output is filtered through a gauge. A gauge is a test for the properties within a components; only components that pass the test are returned. A gauge can be constructed from a MINSQL string with:

-
icalgauge* icalgauge_new_from_sql(const char* sql);
-
icalgauge_impl
Definition: icalgaugeimpl.h:47
-

Then, you can add the gauge to the set with :

-
icalerrorenum icalfileset_select(
-
icalfileset* store,
-
icalgauge* gauge);
-

Here is an example that puts all of these routines together:

-
void test_fileset()
-
{
-
icalfileset *fs;
-
icalcomponent *c;
-
int i;
-
char *path = "test_fileset.ics";
-
-
icalgauge *g = icalgauge_new_from_sql(
-
"SELECT * FROM VEVENT WHERE DTSTART > '20000103T120000Z' AND
-
DTSTART <= '20000106T120000Z'");
-
-
fs = icalfileset_new(path);
-
-
for (i = 0; i!= 10; i++){
-
c = make_component(i); /* Make a new component where DTSTART has month of i */
-
icalfileset_add_component(fs,c);
-
}
-
-
icalfileset_commit(fs); /* Write to disk */
-
icalfileset_select(fs,g); /* Set the gauge to filter components */
-
-
for (c = icalfileset_get_first_component(fs);
-
c != 0;
-
c = icalfileset_get_next_component(fs))
-
{
-
struct icaltimetype t = icalcomponent_get_dtstart(c);
-
printf("%s\n",icaltime_as_ctime(t));
-
-
}
-
-
icalfileset_free(fs);
-
}
-
icalcomponent_get_dtstart
struct icaltimetype icalcomponent_get_dtstart(icalcomponent *comp)
Gets the DTSTART property as an icaltime.
Definition: icalcomponent.c:1398
-

-5.4.3 Other routines

-

There are several other routines in the icalset interface, but they not fully implemented yet.

-

-

-5.5 Memory Management

-

Libical relies heavily on dynamic allocation for both the core objects and for the strings used to hold values. Some of this memory the library caller owns and must free, and some of the memory is managed by the library. Here is a summary of the memory rules.

-
    -
  1. If the function name has "new" in it (such as icalcomponent_new(), or icalproperty_new_from_string()), the caller gets control of the memory. The caller also gets control over an object that is cloned via a function that ends with "_clone" (like icalcomponent_clone())
    2. -
  2. If you got the memory from a routine with "clone" or "new" in it, you must call the corresponding *_free() routine to free the memory, for example use icalcomponent_free() to free objects created with icalcomponent_new() or icalcomponent_clone()
    3. -
  3. If the function name has "add" in it, the caller is transferring control of the memory to the routine, for example the function icalproperty_add_parameter()
    4. -
  4. If the function name has "remove" in it, the caller passes in a pointer to an object and after the call returns, the caller owns the object. So, before you call icalcomponent_remove_property(comp, foo), you do not own "foo" and after the call returns, you do.
    5. -
  5. If the routine returns a string and its name does NOT end in _r, libical owns the memory and will put it on a ring buffer to reclaim later. For example, icalcomponent_as_ical_string(). You better strdup() it if you want to keep it, and you don't have to delete it.
    6. -
  6. If the routine returns a string and its name does end in _r, the caller gets control of the memory and is responsible for freeing it. For example, icalcomponent_as_ical_string_r() does the same thing as icalcomponent_as_ical_string(), except you now have control of the string buffer it returns.
    7. -
-

-5.6 Error Handling

-

Libical has several error handling mechanisms for the various types of programming, semantic and syntactic errors you may encounter.

-

-5.6.1 Return values

-

Many library routines signal errors through their return values. All routines that return a pointer, such as icalcomponent_new(), will return 0 (zero) on a fatal error. Some routines will return a value of enum icalerrorenum.

-

5.6.2 icalerrno

-

Most routines will set the global error value icalerrno on errors. This variable is an enumeration; permissible values can be found in libical/icalerror.h. If the routine returns an enum icalerrorenum, then the return value will be the same as icalerrno. You can use icalerror_strerror() to get a string that describes the error. The enumerations are:

-
    -
  • ICAL_BADARG_ERROR: One of the arguments to a routine was bad. Typically for a null pointer.
    • -
  • ICAL_NEWFAILED_ERROR: A new() or malloc() failed.
    • -
  • ICAL_MALFORMEDDATA_ERROR: An input string was not in the correct format
    • -
  • ICAL_PARSE_ERROR: The parser failed to parse an incoming component
    • -
  • ICAL_INTERNAL_ERROR: Largely equivalent to an assert
    • -
  • ICAL_FILE_ERROR: A file operation failed. Check errno for more detail.
    • -
  • ICAL_ALLOCATION_ERROR: ?
    • -
  • ICAL_USAGE_ERROR: ?
    • -
  • ICAL_NO_ERROR: No error
    • -
  • ICAL_MULTIPLEINCLUSION_ERROR: ?
    • -
  • ICAL_TIMEDOUT_ERROR: For CSTP and acquiring locks
    • -
  • ICAL_UNKNOWN_ERROR: ?
    • -
-

-5.6.3 <tt>X-LIC-ERROR</tt> and <tt>X-LIC-INVALID-COMPONENT</tt>

-

The library handles semantic and syntactic errors in components by inserting errors properties into the components. If the parser cannot parse incoming text (a syntactic error) or if the icalrestriction_check() routine indicates that the component does not meet the requirements of RFC5546 (a semantic error) the library will insert properties of the type X-LIC-ERROR to describe the error. Here is an example of the error property:

-
X-LIC-ERROR;X-LIC-ERRORTYPE=INVALID_ITIP :Failed iTIP restrictions
-
for property DTSTART.
-
-
Expected 1 instances of the property and got 0
-

This error resulted from a call to icalrestriction_check(), which discovered that the component does not have a DTSTART property, as required by RFC5545.

-

There are a few routines to manipulate error properties:

- - - - - - - - - - - -
Routine Purpose
void icalrestriction_check() Check a component against RFC5546 and insert error properties to indicate non compliance
int icalcomponent_count_errors() Return the number of error properties in a component
void icalcomponent_strip_errors() Remove all error properties in a component
void icalcomponent_convert_errors() Convert some error properties into REQUESTS-STATUS properties to indicate the inability to process the component as an iTIP request
-

The types of errors are listed in icalerror.h. They are:

-
    -
  • ICAL_XLICERRORTYPE_COMPONENTPARSEERROR
    • -
  • ICAL_XLICERRORTYPE_PARAMETERVALUEPARSEERROR
    • -
  • ICAL_XLICERRORTYPE_PARAMETERNAMEPARSEERROR
    • -
  • ICAL_XLICERRORTYPE_PROPERTYPARSEERROR
    • -
  • ICAL_XLICERRORTYPE_VALUEPARSEERROR
    • -
  • ICAL_XLICERRORTYPE_UNKVCALPROP
    • -
  • ICAL_XLICERRORTYPE_INVALIDITIP
    • -
-

The libical parser will generate the error that end in PARSEERROR when it encounters garbage in the input steam. ICAL_XLICERRORTYPE_INVALIDITIP is inserted by icalrestriction_check(), and ICAL_XLICERRORTYPE_UNKVCALPROP is generated by icalvcal_convert() when it encounters a vCal property that it cannot convert or does not know about.

-

icalcomponent_convert_errors() converts some of the error properties in a component into REQUEST-STATUS properties that indicate a failure. As of libical version 0.18, this routine only converts PARSEERROR errors and it always generates a 3.x (failure) code. This makes it more of a good idea than a really useful bit of code.

-

-5.6.4 <tt>ICAL_ERRORS_ARE_FATAL</tt> and <tt>icalerror_errors_are_fatal</tt>

-

If icalerror_get_errors_are_fatal() returns 1, then any error condition will cause the program to abort. The abort occurs in icalerror_set_errno(), and is done with an assert(0) if NDEBUG is undefined, and with icalerror_crash_here() if NDEBUG is defined. Initially, icalerror_get_errors_are_fatal() is 1 when ICAL_ERRORS_ARE_FATAL is defined, and 0 otherwise. Since ICAL_ERRORS_ARE_FATAL is defined by default, icalerror_get_errors_are_fatal() is also set to 1 by default.

-

You can change the compiled-in ICAL_ERRORS_ARE_FATAL behavior at runtime by calling icalerror_set_errors_are_fatal(0) (i.e, errors are not fatal) or icalerror_set_errors_are_fatal(1) (i.e, errors are fatal).

-

-5.7 Naming Standard

-

Structures that you access with the "struct" keyword, such as struct icaltimetype are things that you are allowed to see inside and poke at.

-

Structures that you access though a typedef, such as icalcomponent are things where all of the data is hidden.

-

Component names that start with "V" are part of RFC5545 or another iCal standard. Component names that start with "X" are also part of the spec, but they are not actually components in the spec. However, they look and act like components, so they are components in libical. Names that start with XLIC or X-LIC are not part of any iCal spec. They are used internally by libical.

-

Enums that identify a component, property, value or parameter end with _COMPONENT, _PROPERTY, _VALUE, or _PARAMETER" - -Enums that identify a parameter value have the name of the parameter -as the second word. For instance: <tt>ICAL_ROLE_REQPARTICIPANT</tt> or -<tt>ICAL_PARTSTAT_ACCEPTED</tt>. - -The enums for the parts of a recurrence rule and request statuses -are irregular. - -@section autotoc_md58 6 Hacks and Bugs - -There are a lot of hacks in the library &ndash; bits of code that I am not -proud of and should probably be changed. These are marked with the -comment string "HACK."

-

-7 Library Reference

-

-7.1 Manipulating struct icaltimetype

-

-7.1.1 Struct icaltimetype

-
struct icaltimetype
-
-
{
-
int year;
-
int month;
-
int day;
-
int hour;
-
int minute;
-
int second;
-
int is_utc;
-
int is_date;
-
const char* zone;
-
};
-
-
- -
-Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
- - diff --git a/apidocs/menu.js b/apidocs/menu.js index 54e81cf1..2fe2214f 100644 --- a/apidocs/menu.js +++ b/apidocs/menu.js @@ -36,91 +36,15 @@ function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { } return result; } - var searchBox; - if (searchEnabled) { - if (serverSide) { - searchBox='
'+ - '
'+ - '
'+ - ''+ - '
'+ - '
'+ - '
'+ - '
'; - } else { - searchBox='
'+ - ''+ - ''+ - ''+ - ''+ - ''+ - '' - '' - '
'; - } - } - $('#main-nav').before('
'+ - ''+ - ''+ - '
'); $('#main-nav').append(makeTree(menudata,relPath)); $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); - if (searchBox) { - $('#main-menu').append('
  • '); - } - var $mainMenuState = $('#main-menu-state'); - var prevWidth = 0; - if ($mainMenuState.length) { - function initResizableIfExists() { - if (typeof initResizable==='function') initResizable(); - } - // animate mobile menu - $mainMenuState.change(function(e) { - var $menu = $('#main-menu'); - var options = { duration: 250, step: initResizableIfExists }; - if (this.checked) { - options['complete'] = function() { $menu.css('display', 'block') }; - $menu.hide().slideDown(options); - } else { - options['complete'] = function() { $menu.css('display', 'none') }; - $menu.show().slideUp(options); - } - }); - // set default menu visibility - function resetState() { - var $menu = $('#main-menu'); - var $mainMenuState = $('#main-menu-state'); - var newWidth = $(window).outerWidth(); - if (newWidth!=prevWidth) { - if ($(window).outerWidth()<768) { - $mainMenuState.prop('checked',false); $menu.hide(); - $('#searchBoxPos1').html(searchBox); - $('#searchBoxPos2').hide(); - } else { - $menu.show(); - $('#searchBoxPos1').empty(); - $('#searchBoxPos2').html(searchBox); - $('#searchBoxPos2').show(); - } - prevWidth = newWidth; - } + if (searchEnabled) { + if (serverSide) { + $('#main-menu').append('
    • '); + } else { + $('#main-menu').append('
    • '); } - $(window).ready(function() { resetState(); initResizableIfExists(); }); - $(window).resize(resetState); } $('#main-menu').smartmenus(); } diff --git a/apidocs/menudata.js b/apidocs/menudata.js index c09a35b6..077ff0ba 100644 --- a/apidocs/menudata.js +++ b/apidocs/menudata.js @@ -24,7 +24,6 @@ */ var menudata={children:[ {text:"Main Page",url:"index.html"}, -{text:"Related Pages",url:"pages.html"}, {text:"Data Structures",url:"annotated.html",children:[ {text:"Data Structures",url:"annotated.html"}, {text:"Data Structure Index",url:"classes.html"}, @@ -84,14 +83,12 @@ var menudata={children:[ {text:"f",url:"globals_f.html#index_f"}, {text:"i",url:"globals_i.html#index_i"}, {text:"j",url:"globals_j.html#index_j"}, -{text:"q",url:"globals_q.html#index_q"}, {text:"s",url:"globals_s.html#index_s"}]}, {text:"Functions",url:"globals_func.html",children:[ {text:"c",url:"globals_func.html#index_c"}, {text:"f",url:"globals_func_f.html#index_f"}, {text:"i",url:"globals_func_i.html#index_i"}, {text:"j",url:"globals_func_j.html#index_j"}, -{text:"q",url:"globals_func_q.html#index_q"}, {text:"s",url:"globals_func_s.html#index_s"}]}, {text:"Variables",url:"globals_vars.html"}, {text:"Typedefs",url:"globals_type.html"}, diff --git a/apidocs/pages.html b/apidocs/pages.html deleted file mode 100644 index 90123be5..00000000 --- a/apidocs/pages.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - -Libical API Documentation: Related Pages - - - - - - - - - -
    -
    - - - - - - -
    -
    Libical API Documentation 3.1 -
    -
    -
    - - - - - - - -
    - -
    -
    - - -
    - -
    - -
    -
    Related Pages
    -
    -
    -
    Here is a list of all related documentation pages:
    - - - -
     Using Libical
     Deprecated List
    -
    -
    - -
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
    - - diff --git a/apidocs/pvl_8h_source.html b/apidocs/pvl_8h_source.html index dd019638..db1d48d0 100644 --- a/apidocs/pvl_8h_source.html +++ b/apidocs/pvl_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: pvl.h Source File @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    -
    pvl.h
    +
    +
    pvl.h
    -
    1/*======================================================================
    -
    2 FILE: pvl.h
    -
    3 CREATOR: eric November, 1995
    -
    4
    -
    5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
    -
    6
    -
    7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
    -
    8
    -
    9======================================================================*/
    -
    10
    -
    11#ifndef ICAL_PVL_H
    -
    12#define ICAL_PVL_H
    -
    13
    -
    14#include "libical_ical_export.h"
    -
    15
    -
    16typedef struct pvl_list_t *pvl_list;
    -
    17typedef struct pvl_elem_t *pvl_elem;
    -
    18
    -
    25typedef struct pvl_elem_t
    -
    26{
    -
    27 int MAGIC;
    -
    28 void *d;
    -
    29 struct pvl_elem_t *next;
    -
    30 struct pvl_elem_t *prior;
    -
    31} pvl_elem_t;
    -
    32
    -
    33/* Create new lists or elements */
    -
    34LIBICAL_ICAL_EXPORT pvl_elem pvl_new_element(void *d, pvl_elem next, pvl_elem prior);
    -
    35
    -
    36LIBICAL_ICAL_EXPORT pvl_list pvl_newlist(void);
    -
    37
    -
    38LIBICAL_ICAL_EXPORT void pvl_free(pvl_list);
    -
    39
    -
    40/* Add, remove, or get the head of the list */
    -
    41LIBICAL_ICAL_EXPORT void pvl_unshift(pvl_list l, void *d);
    -
    42
    -
    43LIBICAL_ICAL_EXPORT void *pvl_shift(pvl_list l);
    -
    44
    -
    45LIBICAL_ICAL_EXPORT pvl_elem pvl_head(pvl_list);
    -
    46
    -
    47/* Add, remove or get the tail of the list */
    -
    48LIBICAL_ICAL_EXPORT void pvl_push(pvl_list l, void *d);
    -
    49
    -
    50LIBICAL_ICAL_EXPORT void *pvl_pop(pvl_list l);
    -
    51
    -
    52LIBICAL_ICAL_EXPORT pvl_elem pvl_tail(pvl_list);
    -
    53
    -
    54/* Insert elements in random places */
    -
    55typedef int (*pvl_comparef) (void *a, void *b); /* a, b are of the data type */
    -
    56
    -
    57LIBICAL_ICAL_EXPORT void pvl_insert_ordered(pvl_list l, pvl_comparef f, void *d);
    -
    58
    -
    59LIBICAL_ICAL_EXPORT void pvl_insert_after(pvl_list l, pvl_elem e, void *d);
    -
    60
    -
    61LIBICAL_ICAL_EXPORT void pvl_insert_before(pvl_list l, pvl_elem e, void *d);
    -
    62
    -
    63/* Remove an element, or clear the entire list */
    -
    64LIBICAL_ICAL_EXPORT void *pvl_remove(pvl_list, pvl_elem); /* Remove element, return data */
    -
    65
    -
    66LIBICAL_ICAL_EXPORT void pvl_clear(pvl_list); /* Remove all elements, de-allocate all data */
    -
    67
    -
    68LIBICAL_ICAL_EXPORT int pvl_count(pvl_list);
    -
    69
    -
    70/* Navigate the list */
    -
    71LIBICAL_ICAL_EXPORT pvl_elem pvl_next(pvl_elem e);
    -
    72
    -
    73LIBICAL_ICAL_EXPORT pvl_elem pvl_prior(pvl_elem e);
    -
    74
    -
    75/* get the data in the list */
    -
    76#if !defined(PVL_USE_MACROS)
    -
    77LIBICAL_ICAL_EXPORT void *pvl_data(pvl_elem);
    -
    78#else
    -
    79#define pvl_data(x) x==0 ? 0 : ((struct pvl_elem_t *)x)->d;
    -
    80#endif
    -
    81
    -
    82/* Find an element for which a function returns true */
    -
    83typedef int (*pvl_findf) (void *a, void *b); /*a is list elem, b is other data */
    -
    84
    -
    85LIBICAL_ICAL_EXPORT pvl_elem pvl_find(pvl_list l, pvl_findf f, void *v);
    -
    86
    -
    87LIBICAL_ICAL_EXPORT pvl_elem pvl_find_next(pvl_list l, pvl_findf f, void *v);
    -
    88
    -
    93typedef void (*pvl_applyf) (void *a, void *b);
    -
    94
    -
    95LIBICAL_ICAL_EXPORT void pvl_apply(pvl_list l, pvl_applyf f, void *v);
    -
    96
    -
    97#endif /* ICAL_PVL_H */
    -
    pvl_elem_t
    Definition: pvl.h:26
    -
    pvl_elem_t::prior
    struct pvl_elem_t * prior
    Definition: pvl.h:30
    -
    pvl_elem_t::MAGIC
    int MAGIC
    Definition: pvl.h:27
    -
    pvl_elem_t::next
    struct pvl_elem_t * next
    Definition: pvl.h:29
    -
    pvl_elem_t::d
    void * d
    Definition: pvl.h:28
    -
    pvl_list_t
    Definition: pvl.c:59
    +
    1 /*======================================================================
    +
    2  FILE: pvl.h
    +
    3  CREATOR: eric November, 1995
    +
    4 
    +
    5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
    +
    6 
    +
    7  This library is free software; you can redistribute it and/or modify
    +
    8  it under the terms of either:
    +
    9 
    +
    10  The LGPL as published by the Free Software Foundation, version
    +
    11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
    +
    12 
    +
    13  Or:
    +
    14 
    +
    15  The Mozilla Public License Version 2.0. You may obtain a copy of
    +
    16  the License at https://www.mozilla.org/MPL/
    +
    17 ======================================================================*/
    +
    18 
    +
    19 #ifndef ICAL_PVL_H
    +
    20 #define ICAL_PVL_H
    +
    21 
    +
    22 #include "libical_ical_export.h"
    +
    23 
    +
    24 typedef struct pvl_list_t *pvl_list;
    +
    25 typedef struct pvl_elem_t *pvl_elem;
    +
    26 
    +
    33 typedef struct pvl_elem_t
    +
    34 {
    +
    35  int MAGIC;
    +
    36  void *d;
    +
    37  struct pvl_elem_t *next;
    +
    38  struct pvl_elem_t *prior;
    +
    39 } pvl_elem_t;
    +
    40 
    +
    41 /* Create new lists or elements */
    +
    42 LIBICAL_ICAL_EXPORT pvl_elem pvl_new_element(void *d, pvl_elem next, pvl_elem prior);
    +
    43 
    +
    44 LIBICAL_ICAL_EXPORT pvl_list pvl_newlist(void);
    +
    45 
    +
    46 LIBICAL_ICAL_EXPORT void pvl_free(pvl_list);
    +
    47 
    +
    48 /* Add, remove, or get the head of the list */
    +
    49 LIBICAL_ICAL_EXPORT void pvl_unshift(pvl_list l, void *d);
    +
    50 
    +
    51 LIBICAL_ICAL_EXPORT void *pvl_shift(pvl_list l);
    +
    52 
    +
    53 LIBICAL_ICAL_EXPORT pvl_elem pvl_head(pvl_list);
    +
    54 
    +
    55 /* Add, remove or get the tail of the list */
    +
    56 LIBICAL_ICAL_EXPORT void pvl_push(pvl_list l, void *d);
    +
    57 
    +
    58 LIBICAL_ICAL_EXPORT void *pvl_pop(pvl_list l);
    +
    59 
    +
    60 LIBICAL_ICAL_EXPORT pvl_elem pvl_tail(pvl_list);
    +
    61 
    +
    62 /* Insert elements in random places */
    +
    63 typedef int (*pvl_comparef) (void *a, void *b); /* a, b are of the data type */
    +
    64 
    +
    65 LIBICAL_ICAL_EXPORT void pvl_insert_ordered(pvl_list l, pvl_comparef f, void *d);
    +
    66 
    +
    67 LIBICAL_ICAL_EXPORT void pvl_insert_after(pvl_list l, pvl_elem e, void *d);
    +
    68 
    +
    69 LIBICAL_ICAL_EXPORT void pvl_insert_before(pvl_list l, pvl_elem e, void *d);
    +
    70 
    +
    71 /* Remove an element, or clear the entire list */
    +
    72 LIBICAL_ICAL_EXPORT void *pvl_remove(pvl_list, pvl_elem); /* Remove element, return data */
    +
    73 
    +
    74 LIBICAL_ICAL_EXPORT void pvl_clear(pvl_list); /* Remove all elements, de-allocate all data */
    +
    75 
    +
    76 LIBICAL_ICAL_EXPORT int pvl_count(pvl_list);
    +
    77 
    +
    78 /* Navigate the list */
    +
    79 LIBICAL_ICAL_EXPORT pvl_elem pvl_next(pvl_elem e);
    +
    80 
    +
    81 LIBICAL_ICAL_EXPORT pvl_elem pvl_prior(pvl_elem e);
    +
    82 
    +
    83 /* get the data in the list */
    +
    84 #if !defined(PVL_USE_MACROS)
    +
    85 LIBICAL_ICAL_EXPORT void *pvl_data(pvl_elem);
    +
    86 #else
    +
    87 #define pvl_data(x) x==0 ? 0 : ((struct pvl_elem_t *)x)->d;
    +
    88 #endif
    +
    89 
    +
    90 /* Find an element for which a function returns true */
    +
    91 typedef int (*pvl_findf) (void *a, void *b); /*a is list elem, b is other data */
    +
    92 
    +
    93 LIBICAL_ICAL_EXPORT pvl_elem pvl_find(pvl_list l, pvl_findf f, void *v);
    +
    94 
    +
    95 LIBICAL_ICAL_EXPORT pvl_elem pvl_find_next(pvl_list l, pvl_findf f, void *v);
    +
    96 
    +
    101 typedef void (*pvl_applyf) (void *a, void *b);
    +
    102 
    +
    103 LIBICAL_ICAL_EXPORT void pvl_apply(pvl_list l, pvl_applyf f, void *v);
    +
    104 
    +
    105 #endif /* ICAL_PVL_H */
    +
    pvl_elem_t
    Definition: pvl.h:34
    +
    pvl_elem_t::prior
    struct pvl_elem_t * prior
    Definition: pvl.h:38
    +
    pvl_elem_t::MAGIC
    int MAGIC
    Definition: pvl.h:35
    +
    pvl_elem_t::next
    struct pvl_elem_t * next
    Definition: pvl.h:37
    +
    pvl_elem_t::d
    void * d
    Definition: pvl.h:36
    +
    pvl_list_t
    Definition: pvl.c:65
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/qsort__gen_8h.html b/apidocs/qsort__gen_8h.html deleted file mode 100644 index 75653a0f..00000000 --- a/apidocs/qsort__gen_8h.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - - -Libical API Documentation: qsort_gen.h File Reference - - - - - - - - - -
    -
    - - - - - - -
    -
    Libical API Documentation 3.1 -
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    -Functions
    -
    qsort_gen.h File Reference
    -
    -
    - -

    An implementation of qsort that is more flexible than the version provided with stdlib. -More...

    - -

    Go to the source code of this file.

    - - - - - - - - -

    -Functions

    void qsort_gen (void *list, size_t nitems, int(*compar)(const void *, size_t, size_t), void(*swapr)(void *, size_t, size_t))
     Sort an arbitrary list of items using the qsort algorithm. interpreted by this function but passed to the compar and swapr functions. More...
     
    void qsort_gen_memswap (void *m1, void *m2, size_t size)
     Swaps two arbitrary blocks of memory. More...
     
    -

    Detailed Description

    -

    An implementation of qsort that is more flexible than the version provided with stdlib.

    -

    In contrast to the qsort provided with stdlib, this version doesn't assume that the data to be sorted is stored in a contiguous block of memory.

    -

    Function Documentation

    - -

    ◆ qsort_gen()

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    void qsort_gen (void * list,
    size_t nitems,
    int(*)(const void *, size_t, size_t) compar,
    void(*)(void *, size_t, size_t) swapr 
    )
    -
    - -

    Sort an arbitrary list of items using the qsort algorithm. interpreted by this function but passed to the compar and swapr functions.

    -
    Parameters
    - - - - -
    nitemsThe number of items in the list.
    comparThe comparator function. The function receives the pointer to the list to be sorted and the indices of the elements to be compared.
    swaprThe function used to swap two elements within the list. The function receives the pointer to the list to be sorted and the indices of the elements to be compared.
    -
    -
    - -
    -
    - -

    ◆ qsort_gen_memswap()

    - -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - -
    void qsort_gen_memswap (void * m1,
    void * m2,
    size_t size 
    )
    -
    - -

    Swaps two arbitrary blocks of memory.

    -
    Parameters
    - - - - -
    m1Pointer to the first block of memory.
    m2Pointer to the second block of memory.
    sizeSize of the memory blocks to be swapped.
    -
    -
    - -
    -
    -
    - -
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
    - - diff --git a/apidocs/qsort__gen_8h_source.html b/apidocs/qsort__gen_8h_source.html deleted file mode 100644 index 86969813..00000000 --- a/apidocs/qsort__gen_8h_source.html +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - - -Libical API Documentation: qsort_gen.h Source File - - - - - - - - - -
    -
    - - - - - - -
    -
    Libical API Documentation 3.1 -
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - - -
    -
    -
    qsort_gen.h
    -
    -
    -Go to the documentation of this file.
    1/*======================================================================
    -
    2 FILE: qsort_gen.h
    -
    3
    -
    4 SPDX-FileCopyrightText: 2018, Markus Minichmayr <markus@tapkey.com>
    -
    5
    -
    6 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
    -
    7
    -
    8 The Initial Developer of the Original Code is Markus Minichmayr.
    -
    9======================================================================*/
    -
    10
    -
    11#ifndef QSORT_GEN_H
    -
    12#define QSORT_GEN_H
    -
    13
    -
    33void qsort_gen(void *list, size_t nitems,
    -
    34 int(*compar)(const void *, size_t, size_t),
    -
    35 void(*swapr)(void *, size_t, size_t));
    -
    36
    -
    43void qsort_gen_memswap(void *m1, void *m2, size_t size);
    -
    44
    -
    45#endif /* QSORT_GEN_H */
    -
    qsort_gen_memswap
    void qsort_gen_memswap(void *m1, void *m2, size_t size)
    Swaps two arbitrary blocks of memory.
    Definition: qsort_gen.c:24
    -
    qsort_gen
    void qsort_gen(void *list, size_t nitems, int(*compar)(const void *, size_t, size_t), void(*swapr)(void *, size_t, size_t))
    Sort an arbitrary list of items using the qsort algorithm. interpreted by this function but passed to...
    Definition: qsort_gen.c:56
    -
    - -
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
    - - diff --git a/apidocs/search/all_0.html b/apidocs/search/all_0.html index c36c9af5..1ec5b2d5 100644 --- a/apidocs/search/all_0.html +++ b/apidocs/search/all_0.html @@ -2,7 +2,7 @@ - + @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/apidocs/search/all_1a.js b/apidocs/search/all_1a.js deleted file mode 100644 index 2b7af3f5..00000000 --- a/apidocs/search/all_1a.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['_7eicalspanlist_0',['~ICalSpanList',['../classLibICal_1_1ICalSpanList.html#aa60a6309d691037928c20d06709e47c2',1,'LibICal::ICalSpanList']]] -]; diff --git a/apidocs/search/all_2.html b/apidocs/search/all_2.html index 259dde4f..02cfffc2 100644 --- a/apidocs/search/all_2.html +++ b/apidocs/search/all_2.html @@ -2,7 +2,7 @@ - + @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/apidocs/search/files_3.js b/apidocs/search/files_3.js deleted file mode 100644 index 0c76a61e..00000000 --- a/apidocs/search/files_3.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['vcomponent_5fcxx_2eh_0',['vcomponent_cxx.h',['../vcomponent__cxx_8h.html',1,'']]] -]; diff --git a/apidocs/search/functions_0.html b/apidocs/search/functions_0.html index 2d2d9501..eb4c5014 100644 --- a/apidocs/search/functions_0.html +++ b/apidocs/search/functions_0.html @@ -2,7 +2,7 @@ - + @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/apidocs/search/functions_c.js b/apidocs/search/functions_c.js deleted file mode 100644 index 2b7af3f5..00000000 --- a/apidocs/search/functions_c.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['_7eicalspanlist_0',['~ICalSpanList',['../classLibICal_1_1ICalSpanList.html#aa60a6309d691037928c20d06709e47c2',1,'LibICal::ICalSpanList']]] -]; diff --git a/apidocs/search/pages_0.html b/apidocs/search/pages_0.html index e53c280e..8517b48f 100644 --- a/apidocs/search/pages_0.html +++ b/apidocs/search/pages_0.html @@ -2,7 +2,7 @@ - + @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/apidocs/search/pages_1.js b/apidocs/search/pages_1.js deleted file mode 100644 index 0a183fa9..00000000 --- a/apidocs/search/pages_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['libical_20—_20an_20implementation_20of_20icalendar_20protocols_20and_20data_20formats_0',['Libical — an implementation of iCalendar protocols and data formats',['../index.html',1,'']]] -]; diff --git a/apidocs/search/pages_2.html b/apidocs/search/pages_2.html deleted file mode 100644 index 023a2618..00000000 --- a/apidocs/search/pages_2.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/apidocs/search/pages_2.js b/apidocs/search/pages_2.js deleted file mode 100644 index c21e5a52..00000000 --- a/apidocs/search/pages_2.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['using_20libical_0',['Using Libical',['../md__home_allen_projects_libical_libical_doc_UsingLibical.html',1,'']]] -]; diff --git a/apidocs/search/search.css b/apidocs/search/search.css index 648a792f..9074198f 100644 --- a/apidocs/search/search.css +++ b/apidocs/search/search.css @@ -17,7 +17,7 @@ #MSearchSelect { display: inline-block; vertical-align: middle; - height: 19px; + height: 1.4em; padding: 0 0 0 0.3em; margin: 0; } @@ -26,7 +26,7 @@ display: inline-block; vertical-align: middle; width: 7.5em; - height: 19px; + height: 1.1em; margin: 0 0.15em; padding: 0; line-height: 1em; @@ -39,12 +39,6 @@ background: none; } -@media(hover: none) { - /* to avoid zooming on iOS */ - #MSearchField { - font-size: 16px; - } -} #MSearchBox .right { display: inline-block; @@ -144,7 +138,7 @@ a.SelectItem:hover { /*---------------- Search results window */ iframe#MSearchResults { - /*width: 60ex;*/ + width: 60ex; height: 15em; } diff --git a/apidocs/search/search.js b/apidocs/search/search.js index ac8055d1..fb226f73 100644 --- a/apidocs/search/search.js +++ b/apidocs/search/search.js @@ -80,7 +80,7 @@ function getYPos(item) storing this instance. Is needed to be able to set timeouts. resultPath - path to use for external files */ -function SearchBox(name, resultsPath, label, extension) +function SearchBox(name, resultsPath, inFrame, label, extension) { if (!name || !resultsPath) { alert("Missing parameters to SearchBox."); } if (!extension || extension == "") { extension = ".html"; } @@ -96,6 +96,7 @@ function SearchBox(name, resultsPath, label, extension) this.hideTimeout = 0; this.searchIndex = 0; this.searchActive = false; + this.insideFrame = inFrame; this.searchLabel = label; this.extension = extension; @@ -135,14 +136,30 @@ function SearchBox(name, resultsPath, label, extension) var searchSelectWindow = this.DOMSearchSelectWindow(); var searchField = this.DOMSearchSelect(); - var left = getXPos(searchField); - var top = getYPos(searchField); - top += searchField.offsetHeight; - - // show search selection popup - searchSelectWindow.style.display='block'; - searchSelectWindow.style.left = left + 'px'; - searchSelectWindow.style.top = top + 'px'; + if (this.insideFrame) + { + var left = getXPos(searchField); + var top = getYPos(searchField); + left += searchField.offsetWidth + 6; + top += searchField.offsetHeight; + + // show search selection popup + searchSelectWindow.style.display='block'; + left -= searchSelectWindow.offsetWidth; + searchSelectWindow.style.left = left + 'px'; + searchSelectWindow.style.top = top + 'px'; + } + else + { + var left = getXPos(searchField); + var top = getYPos(searchField); + top += searchField.offsetHeight; + + // show search selection popup + searchSelectWindow.style.display='block'; + searchSelectWindow.style.left = left + 'px'; + searchSelectWindow.style.top = top + 'px'; + } // stop selection hide timer if (this.hideTimeout) @@ -350,18 +367,25 @@ function SearchBox(name, resultsPath, label, extension) { var domSearchBox = this.DOMSearchBox(); this.DOMSearchClose().style.display = 'inline-block'; - var domPopupSearchResults = this.DOMPopupSearchResults(); - var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth; - var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1; - domPopupSearchResultsWindow.style.display = 'block'; - left -= domPopupSearchResults.offsetWidth; - var maxWidth = document.body.clientWidth; - var width = 400; - if (left<10) left=10; - if (width+left+8>maxWidth) width=maxWidth-left-8; - domPopupSearchResultsWindow.style.top = top + 'px'; - domPopupSearchResultsWindow.style.left = left + 'px'; - domPopupSearchResultsWindow.style.width = width + 'px'; + if (this.insideFrame) + { + var domPopupSearchResults = this.DOMPopupSearchResults(); + domPopupSearchResultsWindow.style.position = 'relative'; + domPopupSearchResultsWindow.style.display = 'block'; + var width = document.body.clientWidth - 8; // the -8 is for IE :-( + domPopupSearchResultsWindow.style.width = width + 'px'; + domPopupSearchResults.style.width = width + 'px'; + } + else + { + var domPopupSearchResults = this.DOMPopupSearchResults(); + var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth; + var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1; + domPopupSearchResultsWindow.style.display = 'block'; + left -= domPopupSearchResults.offsetWidth; + domPopupSearchResultsWindow.style.top = top + 'px'; + domPopupSearchResultsWindow.style.left = left + 'px'; + } } this.lastSearchValue = searchValue; @@ -740,7 +764,6 @@ function createResults() if (searchData[e][1].length==2) // single result { srLink.setAttribute('href',searchData[e][1][1][0]); - srLink.setAttribute('onclick','parent.searchBox.CloseResultsWindow()'); if (searchData[e][1][1][1]) { srLink.setAttribute('target','_parent'); @@ -762,7 +785,6 @@ function createResults() setKeyActions(srChild,'return searchResults.NavChild(event,'+e+','+c+')'); setClassAttr(srChild,'SRScope'); srChild.setAttribute('href',searchData[e][1][c+1][0]); - srChild.setAttribute('onclick','parent.searchBox.CloseResultsWindow()'); if (searchData[e][1][c+1][1]) { srChild.setAttribute('target','_parent'); diff --git a/apidocs/search/searchdata.js b/apidocs/search/searchdata.js index 1b785ab0..297835cd 100644 --- a/apidocs/search/searchdata.js +++ b/apidocs/search/searchdata.js @@ -1,15 +1,15 @@ var indexSectionsWithContent = { - 0: "_abcdefghijlmnopqrstuvwxyz~", + 0: "_abcdefghijlmnoprstuvwxyz~", 1: "_bcdefilmoprstuvwxyz", - 2: "aiqv", - 3: "abcdfgijoqrs~", + 2: "aiv", + 3: "abcdfgijors~", 4: "bcdefghijlmnopstuwyz", 5: "i", 6: "i", 7: "i", 8: "i", - 9: "dlu" + 9: "l" }; var indexSectionNames = diff --git a/apidocs/search/typedefs_0.html b/apidocs/search/typedefs_0.html index 882b2a19..a4684c4a 100644 --- a/apidocs/search/typedefs_0.html +++ b/apidocs/search/typedefs_0.html @@ -2,7 +2,7 @@ - + @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    @@ -12,14 +12,14 @@
    Loading...
    Searching...
    No Matches
    +/* @license-end */
    -
    sspm.h
    +
    +
    sspm.h
    -
    1/*======================================================================
    -
    2 FILE: sspm.h Mime Parser
    -
    3 CREATOR: eric 25 June 2000
    -
    4
    -
    5 SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
    -
    6
    -
    7 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
    -
    8
    -
    9 The Initial Developer of the Original Code is Eric Busboom
    -
    10======================================================================*/
    -
    11
    -
    12#ifndef ICAL_SSPM_H
    -
    13#define ICAL_SSPM_H
    -
    14
    -
    15#include "libical_ical_export.h"
    -
    16
    -
    17enum sspm_major_type
    -
    18{
    -
    19 SSPM_NO_MAJOR_TYPE,
    -
    20 SSPM_TEXT_MAJOR_TYPE,
    -
    21 SSPM_IMAGE_MAJOR_TYPE,
    -
    22 SSPM_AUDIO_MAJOR_TYPE,
    -
    23 SSPM_VIDEO_MAJOR_TYPE,
    -
    24 SSPM_APPLICATION_MAJOR_TYPE,
    -
    25 SSPM_MULTIPART_MAJOR_TYPE,
    -
    26 SSPM_MESSAGE_MAJOR_TYPE,
    -
    27 SSPM_UNKNOWN_MAJOR_TYPE
    -
    28};
    -
    29
    -
    30enum sspm_minor_type
    -
    31{
    -
    32 SSPM_NO_MINOR_TYPE,
    -
    33 SSPM_ANY_MINOR_TYPE,
    -
    34 SSPM_PLAIN_MINOR_TYPE,
    -
    35 SSPM_RFC822_MINOR_TYPE,
    -
    36 SSPM_DIGEST_MINOR_TYPE,
    -
    37 SSPM_CALENDAR_MINOR_TYPE,
    -
    38 SSPM_MIXED_MINOR_TYPE,
    -
    39 SSPM_RELATED_MINOR_TYPE,
    -
    40 SSPM_ALTERNATIVE_MINOR_TYPE,
    -
    41 SSPM_PARALLEL_MINOR_TYPE,
    -
    42 SSPM_UNKNOWN_MINOR_TYPE
    -
    43};
    -
    44
    -
    45enum sspm_encoding
    -
    46{
    -
    47 SSPM_NO_ENCODING,
    -
    48 SSPM_QUOTED_PRINTABLE_ENCODING,
    -
    49 SSPM_8BIT_ENCODING,
    -
    50 SSPM_7BIT_ENCODING,
    -
    51 SSPM_BINARY_ENCODING,
    -
    52 SSPM_BASE64_ENCODING,
    -
    53 SSPM_UNKNOWN_ENCODING
    -
    54};
    -
    55
    -
    56enum sspm_error
    -
    57{
    -
    58 SSPM_NO_ERROR,
    -
    59 SSPM_UNEXPECTED_BOUNDARY_ERROR,
    -
    60 SSPM_WRONG_BOUNDARY_ERROR,
    -
    61 SSPM_NO_BOUNDARY_ERROR,
    -
    62 SSPM_NO_HEADER_ERROR,
    -
    63 SSPM_MALFORMED_HEADER_ERROR
    -
    64};
    -
    65
    -
    66struct sspm_header
    -
    67{
    -
    68 int def;
    -
    69 char *boundary;
    -
    70 enum sspm_major_type major;
    -
    71 enum sspm_minor_type minor;
    -
    72 char *minor_text;
    -
    73 char **content_type_params;
    -
    74 char *charset;
    -
    75 enum sspm_encoding encoding;
    -
    76 char *filename;
    -
    77 char *content_id;
    -
    78 enum sspm_error error;
    -
    79 char *error_text;
    -
    80};
    -
    81
    -
    82struct sspm_part
    -
    83{
    -
    84 struct sspm_header header;
    -
    85 int level;
    -
    86 size_t data_size;
    -
    87 void *data;
    -
    88};
    -
    89
    -
    90struct sspm_action_map
    -
    91{
    -
    92 enum sspm_major_type major;
    -
    93 enum sspm_minor_type minor;
    -
    94 void *(*new_part) (void);
    -
    95 void (*add_line) (void *part, struct sspm_header * header, const char *line, size_t size);
    -
    96 void *(*end_part) (void *part);
    -
    97 void (*free_part) (void *part);
    -
    98};
    -
    99
    -
    100LIBICAL_ICAL_EXPORT const char *sspm_major_type_string(enum sspm_major_type type);
    -
    101
    -
    102LIBICAL_ICAL_EXPORT const char *sspm_minor_type_string(enum sspm_minor_type type);
    -
    103
    -
    104LIBICAL_ICAL_EXPORT const char *sspm_encoding_string(enum sspm_encoding type);
    -
    105
    -
    106LIBICAL_ICAL_EXPORT int sspm_parse_mime(struct sspm_part *parts,
    -
    107 size_t max_parts,
    -
    108 const struct sspm_action_map *actions,
    -
    109 char *(*get_string) (char *s, size_t size, void *data),
    -
    110 void *get_string_data, struct sspm_header *first_header);
    -
    111
    -
    112LIBICAL_ICAL_EXPORT void sspm_free_parts(struct sspm_part *parts, size_t max_parts);
    -
    113
    -
    114LIBICAL_ICAL_EXPORT char *decode_quoted_printable(char *dest, char *src, size_t *size);
    -
    115
    -
    116LIBICAL_ICAL_EXPORT char *decode_base64(char *dest, char *src, size_t *size);
    -
    117
    -
    118LIBICAL_ICAL_EXPORT int sspm_write_mime(struct sspm_part *parts, size_t num_parts,
    -
    119 char **output_string, const char *header);
    -
    120
    -
    121#endif /* ICAL_SSPM_H */
    -
    sspm_action_map
    Definition: sspm.h:91
    -
    sspm_header
    Definition: sspm.h:67
    -
    sspm_part
    Definition: sspm.h:83
    +
    1 /*======================================================================
    +
    2  FILE: sspm.h Mime Parser
    +
    3  CREATOR: eric 25 June 2000
    +
    4 
    +
    5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
    +
    6 
    +
    7  This library is free software; you can redistribute it and/or modify
    +
    8  it under the terms of either:
    +
    9 
    +
    10  The LGPL as published by the Free Software Foundation, version
    +
    11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
    +
    12 
    +
    13  Or:
    +
    14 
    +
    15  The Mozilla Public License Version 2.0. You may obtain a copy of
    +
    16  the License at https://www.mozilla.org/MPL/
    +
    17 
    +
    18  This library is free software; you can redistribute it and/or modify
    +
    19  it under the terms of either:
    +
    20 
    +
    21  The LGPL as published by the Free Software Foundation, version
    +
    22  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
    +
    23 
    +
    24  Or:
    +
    25 
    +
    26  The Mozilla Public License Version 2.0. You may obtain a copy of
    +
    27  the License at https://www.mozilla.org/MPL/
    +
    28 
    +
    29  The Initial Developer of the Original Code is Eric Busboom
    +
    30 ======================================================================*/
    +
    31 
    +
    32 #ifndef ICAL_SSPM_H
    +
    33 #define ICAL_SSPM_H
    +
    34 
    +
    35 #include "libical_ical_export.h"
    +
    36 
    +
    37 enum sspm_major_type
    +
    38 {
    +
    39  SSPM_NO_MAJOR_TYPE,
    +
    40  SSPM_TEXT_MAJOR_TYPE,
    +
    41  SSPM_IMAGE_MAJOR_TYPE,
    +
    42  SSPM_AUDIO_MAJOR_TYPE,
    +
    43  SSPM_VIDEO_MAJOR_TYPE,
    +
    44  SSPM_APPLICATION_MAJOR_TYPE,
    +
    45  SSPM_MULTIPART_MAJOR_TYPE,
    +
    46  SSPM_MESSAGE_MAJOR_TYPE,
    +
    47  SSPM_UNKNOWN_MAJOR_TYPE
    +
    48 };
    +
    49 
    +
    50 enum sspm_minor_type
    +
    51 {
    +
    52  SSPM_NO_MINOR_TYPE,
    +
    53  SSPM_ANY_MINOR_TYPE,
    +
    54  SSPM_PLAIN_MINOR_TYPE,
    +
    55  SSPM_RFC822_MINOR_TYPE,
    +
    56  SSPM_DIGEST_MINOR_TYPE,
    +
    57  SSPM_CALENDAR_MINOR_TYPE,
    +
    58  SSPM_MIXED_MINOR_TYPE,
    +
    59  SSPM_RELATED_MINOR_TYPE,
    +
    60  SSPM_ALTERNATIVE_MINOR_TYPE,
    +
    61  SSPM_PARALLEL_MINOR_TYPE,
    +
    62  SSPM_UNKNOWN_MINOR_TYPE
    +
    63 };
    +
    64 
    +
    65 enum sspm_encoding
    +
    66 {
    +
    67  SSPM_NO_ENCODING,
    +
    68  SSPM_QUOTED_PRINTABLE_ENCODING,
    +
    69  SSPM_8BIT_ENCODING,
    +
    70  SSPM_7BIT_ENCODING,
    +
    71  SSPM_BINARY_ENCODING,
    +
    72  SSPM_BASE64_ENCODING,
    +
    73  SSPM_UNKNOWN_ENCODING
    +
    74 };
    +
    75 
    +
    76 enum sspm_error
    +
    77 {
    +
    78  SSPM_NO_ERROR,
    +
    79  SSPM_UNEXPECTED_BOUNDARY_ERROR,
    +
    80  SSPM_WRONG_BOUNDARY_ERROR,
    +
    81  SSPM_NO_BOUNDARY_ERROR,
    +
    82  SSPM_NO_HEADER_ERROR,
    +
    83  SSPM_MALFORMED_HEADER_ERROR
    +
    84 };
    +
    85 
    +
    86 struct sspm_header
    +
    87 {
    +
    88  int def;
    +
    89  char *boundary;
    +
    90  enum sspm_major_type major;
    +
    91  enum sspm_minor_type minor;
    +
    92  char *minor_text;
    +
    93  char **content_type_params;
    +
    94  char *charset;
    +
    95  enum sspm_encoding encoding;
    +
    96  char *filename;
    +
    97  char *content_id;
    +
    98  enum sspm_error error;
    +
    99  char *error_text;
    +
    100 };
    +
    101 
    +
    102 struct sspm_part
    +
    103 {
    +
    104  struct sspm_header header;
    +
    105  int level;
    +
    106  size_t data_size;
    +
    107  void *data;
    +
    108 };
    +
    109 
    +
    110 struct sspm_action_map
    +
    111 {
    +
    112  enum sspm_major_type major;
    +
    113  enum sspm_minor_type minor;
    +
    114  void *(*new_part) (void);
    +
    115  void (*add_line) (void *part, struct sspm_header * header, const char *line, size_t size);
    +
    116  void *(*end_part) (void *part);
    +
    117  void (*free_part) (void *part);
    +
    118 };
    +
    119 
    +
    120 LIBICAL_ICAL_EXPORT const char *sspm_major_type_string(enum sspm_major_type type);
    +
    121 
    +
    122 LIBICAL_ICAL_EXPORT const char *sspm_minor_type_string(enum sspm_minor_type type);
    +
    123 
    +
    124 LIBICAL_ICAL_EXPORT const char *sspm_encoding_string(enum sspm_encoding type);
    +
    125 
    +
    126 LIBICAL_ICAL_EXPORT int sspm_parse_mime(struct sspm_part *parts,
    +
    127  size_t max_parts,
    +
    128  const struct sspm_action_map *actions,
    +
    129  char *(*get_string) (char *s, size_t size, void *data),
    +
    130  void *get_string_data, struct sspm_header *first_header);
    +
    131 
    +
    132 LIBICAL_ICAL_EXPORT void sspm_free_parts(struct sspm_part *parts, size_t max_parts);
    +
    133 
    +
    134 LIBICAL_ICAL_EXPORT char *decode_quoted_printable(char *dest, char *src, size_t *size);
    +
    135 
    +
    136 LIBICAL_ICAL_EXPORT char *decode_base64(char *dest, char *src, size_t *size);
    +
    137 
    +
    138 LIBICAL_ICAL_EXPORT int sspm_write_mime(struct sspm_part *parts, size_t num_parts,
    +
    139  char **output_string, const char *header);
    +
    140 
    +
    141 #endif /* ICAL_SSPM_H */
    +
    sspm_action_map
    Definition: sspm.h:111
    +
    sspm_header
    Definition: sspm.h:87
    +
    sspm_part
    Definition: sspm.h:103
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structLexBuf.html b/apidocs/structLexBuf.html index a921dc21..c4be0112 100644 --- a/apidocs/structLexBuf.html +++ b/apidocs/structLexBuf.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: LexBuf Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    LexBuf Struct Reference
    +
    +
    LexBuf Struct Reference
    - - - - - - - - - - - - -

    +

    Data Fields

    +
    short buf [64]
     
    +
    unsigned long curPos
     
    +
    unsigned long getPtr
     
    +
    FILE * inputFile
     
    +
    unsigned long inputLen
     
    +
    char * inputString
     
    +
    unsigned long len
     
    +
    enum LexMode lexModeStack [10]
     
    +
    unsigned long lexModeStackTop
     
    +
    unsigned long maxToken
     
    +
    char * strs
     
    +
    unsigned long strsLen
     
    @@ -113,7 +114,7 @@ unsigned long strsLen<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structOFile.html b/apidocs/structOFile.html index 6d09296b..0ae8d329 100644 --- a/apidocs/structOFile.html +++ b/apidocs/structOFile.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: OFile Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    OFile Struct Reference
    +
    +
    OFile Struct Reference
    - - - - - - -

    +

    Data Fields

    +
    int alloc:1
     
    +
    unsigned int fail:1
     
    +
    FILE * fp
     
    +
    int len
     
    +
    int limit
     
    +
    char * s
     
    @@ -95,7 +96,7 @@ char * s
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structPreDefProp.html b/apidocs/structPreDefProp.html index bfc8593c..14e05d4b 100644 --- a/apidocs/structPreDefProp.html +++ b/apidocs/structPreDefProp.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: PreDefProp Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    PreDefProp Struct Reference
    +
    +
    PreDefProp Struct Reference
    - - - - -

    +

    Data Fields

    +
    const char * alias
     
    +
    const char ** fields
     
    +
    unsigned int flags
     
    +
    const char * name
     
    @@ -89,7 +90,7 @@ const char * name
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structStrItem.html b/apidocs/structStrItem.html index d2507c47..caa4400e 100644 --- a/apidocs/structStrItem.html +++ b/apidocs/structStrItem.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: StrItem Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    StrItem Struct Reference
    +
    +
    StrItem Struct Reference
    - - - -

    +

    Data Fields

    +
    StrItem * next
     
    +
    unsigned int refCnt
     
    +
    const char * s
     
    @@ -86,7 +87,7 @@ const char * s
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structVObject.html b/apidocs/structVObject.html index e4522327..769d336c 100644 --- a/apidocs/structVObject.html +++ b/apidocs/structVObject.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: VObject Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    VObject Struct Reference
    +
    +
    VObject Struct Reference
    - - - - - -

    +

    Data Fields

    +
    const char * id
     
    +
    VObject * next
     
    +
    VObject * prop
     
    +
    ValueItem val
     
    +
    unsigned short valType
     
    @@ -92,7 +93,7 @@ unsigned short valType
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structVObjectIterator.html b/apidocs/structVObjectIterator.html index e878075d..6167df95 100644 --- a/apidocs/structVObjectIterator.html +++ b/apidocs/structVObjectIterator.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: VObjectIterator Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    VObjectIterator Struct Reference
    +
    +
    VObjectIterator Struct Reference
    - - -

    +

    Data Fields

    +
    VObject * next
     
    +
    VObject * start
     
    @@ -83,7 +84,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structYYSTACKDATA.html b/apidocs/structYYSTACKDATA.html deleted file mode 100644 index 1bb964c2..00000000 --- a/apidocs/structYYSTACKDATA.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - -Libical API Documentation: YYSTACKDATA Struct Reference - - - - - - - - - -
    -
    - - - - - - -
    -
    Libical API Documentation 3.1 -
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - -
    -
    -
    -Data Fields
    -
    YYSTACKDATA Struct Reference
    -
    -
    - - - - - - - - - - - - - - -

    -Data Fields

    -YYSTYPE * l_base
     
    -YYSTYPE * l_mark
     
    -YYINT * s_base
     
    -YYINT * s_last
     
    -YYINT * s_mark
     
    -unsigned stacksize
     
    -
    The documentation for this struct was generated from the following file:
      -
    • vcc.c
      • -
    -
    - -
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
    - - diff --git a/apidocs/struct__compat__tzids.html b/apidocs/struct__compat__tzids.html index f942446f..41da3131 100644 --- a/apidocs/struct__compat__tzids.html +++ b/apidocs/struct__compat__tzids.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: _compat_tzids Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    _compat_tzids Struct Reference
    +
    +
    _compat_tzids Struct Reference
    - - -

    +

    Data Fields

    +
    int slashes
     
    +
    const char * tzid
     
    @@ -83,7 +84,7 @@ const char * tzid
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/struct__icalarray.html b/apidocs/struct__icalarray.html index 64093e28..727ffeee 100644 --- a/apidocs/struct__icalarray.html +++ b/apidocs/struct__icalarray.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: _icalarray Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    _icalarray Struct Reference
    +
    +
    _icalarray Struct Reference
    - - - - - -

    +

    Data Fields

    +
    void ** chunks
     
    +
    size_t element_size
     
    +
    size_t increment_size
     
    +
    size_t num_elements
     
    +
    size_t space_allocated
     
    @@ -92,7 +93,7 @@ size_t space_allocated
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/struct__icalarray__sort__context.html b/apidocs/struct__icalarray__sort__context.html deleted file mode 100644 index 9907aa1c..00000000 --- a/apidocs/struct__icalarray__sort__context.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - -Libical API Documentation: _icalarray_sort_context Struct Reference - - - - - - - - - -
    -
    - - - - - - -
    -
    Libical API Documentation 3.1 -
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - -
    -
    -
    -Data Fields
    -
    _icalarray_sort_context Struct Reference
    -
    -
    - - - - - - -

    -Data Fields

    -icalarray * array
     
    -int(* compare )(const void *, const void *)
     
    -
    The documentation for this struct was generated from the following file:
      -
    • icalarray.c
      • -
    -
    - -
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
    - - diff --git a/apidocs/struct__icaltimezone.html b/apidocs/struct__icaltimezone.html index 5ad06b48..c02bc7b6 100644 --- a/apidocs/struct__icaltimezone.html +++ b/apidocs/struct__icaltimezone.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: _icaltimezone Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    _icaltimezone Struct Reference
    +
    +
    _icaltimezone Struct Reference
    - @@ -78,7 +79,7 @@ Data Fields - @@ -91,7 +92,7 @@ double 

    +

    Data Fields

    icaltimezone * builtin_timezone
     
     
    int end_year
     
    +
    double latitude
     
    char * location
    latitude 

    Field Documentation

    - +

    ◆ builtin_timezone

    @@ -102,11 +103,11 @@ double latitude
    -

    If this is not NULL it points to the builtin icaltimezone that the above TZID refers to. This icaltimezone should be used instead when accessing the timezone changes data, so that the expanded timezone changes data is shared between calendar components.

    +

    If this is not NULL it points to the builtin icaltimezone that the above TZID refers to. This icaltimezone should be used instead when accessing the timezone changes data, so that the expanded timezone changes data is shared between calendar components.

    - +

    ◆ changes

    @@ -117,11 +118,11 @@ double latitude
    -

    A dynamically-allocated array of time zone changes, sorted by the time of the change in local time. So we can do fast binary-searches to convert from local time to UTC.

    +

    A dynamically-allocated array of time zone changes, sorted by the time of the change in local time. So we can do fast binary-searches to convert from local time to UTC.

    - +

    ◆ component

    @@ -132,11 +133,11 @@ double latitude
    -

    The toplevel VTIMEZONE component loaded from the .ics file for this timezone. If we need to regenerate the changes data we need this.

    +

    The toplevel VTIMEZONE component loaded from the .ics file for this timezone. If we need to regenerate the changes data we need this.

    - +

    ◆ end_year

    @@ -147,11 +148,11 @@ double latitude
    -

    This is the last year for which we have expanded the data to. If we need to calculate a date past this we need to expand the timezone component data from scratch.

    +

    This is the last year for which we have expanded the data to. If we need to calculate a date past this we need to expand the timezone component data from scratch.

    - +

    ◆ location

    @@ -162,11 +163,11 @@ double latitude
    -

    The location for the timezone, e.g. "Africa/Accra" for the Olson database. We look for this in the "LOCATION" or "X-LIC-LOCATION" properties of the VTIMEZONE component. It isn't a standard property yet. This will be NULL if no location is found in the VTIMEZONE.

    +

    The location for the timezone, e.g. "Africa/Accra" for the Olson database. We look for this in the "LOCATION" or "X-LIC-LOCATION" properties of the VTIMEZONE component. It isn't a standard property yet. This will be NULL if no location is found in the VTIMEZONE.

    - +

    ◆ longitude

    @@ -177,11 +178,11 @@ double latitude
    -

    The coordinates of the city, in degrees.

    +

    The coordinates of the city, in degrees.

    - +

    ◆ tzid

    @@ -192,11 +193,11 @@ double latitude
    -

    The unique ID of this timezone, e.g. "/citadel.org/Olson_20010601_1/Africa/Banjul". This should only be used to identify a VTIMEZONE. It is not meant to be displayed to the user in any form.

    +

    The unique ID of this timezone, e.g. "/citadel.org/Olson_20010601_1/Africa/Banjul". This should only be used to identify a VTIMEZONE. It is not meant to be displayed to the user in any form.

    - +

    ◆ tznames

    @@ -207,7 +208,7 @@ double latitude
    -

    This will be set to a combination of the TZNAME properties from the last STANDARD and DAYLIGHT components in the VTIMEZONE, e.g. "EST/EDT". If they both use the same TZNAME, or only one type of component is found, then only one TZNAME will appear, e.g. "AZOT". If no TZNAME is found this will be NULL.

    +

    This will be set to a combination of the TZNAME properties from the last STANDARD and DAYLIGHT components in the VTIMEZONE, e.g. "EST/EDT". If they both use the same TZNAME, or only one type of component is found, then only one TZNAME will appear, e.g. "AZOT". If no TZNAME is found this will be NULL.

    @@ -217,7 +218,7 @@ double latitude
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/struct__icaltimezonechange.html b/apidocs/struct__icaltimezonechange.html index ccdf173d..8d7c2bd2 100644 --- a/apidocs/struct__icaltimezonechange.html +++ b/apidocs/struct__icaltimezonechange.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: _icaltimezonechange Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    _icaltimezonechange Struct Reference
    +
    +
    _icaltimezonechange Struct Reference
    - - - - @@ -93,7 +94,7 @@ int 

    +

    Data Fields

    +
    int day
     
    +
    int hour
     
    int is_daylight
     
    +
    int minute
     
    int month
    minute
     

    Field Documentation

    - +

    ◆ is_daylight

    @@ -104,11 +105,11 @@ int minute
    -

    Whether this is STANDARD or DAYLIGHT time.

    +

    Whether this is STANDARD or DAYLIGHT time.

    - +

    ◆ month

    @@ -119,11 +120,11 @@ int minute
    -

    1 (Jan) to 12 (Dec).

    +

    1 (Jan) to 12 (Dec).

    - +

    ◆ prev_utc_offset

    @@ -134,11 +135,11 @@ int minute
    -

    The offset to add to UTC, before this change, in seconds.

    +

    The offset to add to UTC, before this change, in seconds.

    - +

    ◆ second

    @@ -149,11 +150,11 @@ int minute
    -

    The time that the change came into effect, in UTC. Note that the prev_utc_offset applies to this local time, since we haven't changed to the new offset yet.

    +

    The time that the change came into effect, in UTC. Note that the prev_utc_offset applies to this local time, since we haven't changed to the new offset yet.

    - +

    ◆ utc_offset

    @@ -164,11 +165,11 @@ int minute
    -

    The offset to add to UTC to get local time, in seconds.

    +

    The offset to add to UTC to get local time, in seconds.

    - +

    ◆ year

    @@ -179,7 +180,7 @@ int minute
    -

    Actual year, e.g. 2001.

    +

    Actual year, e.g. 2001.

    @@ -189,7 +190,7 @@ int minute
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/struct__icalvcal__defaults.html b/apidocs/struct__icalvcal__defaults.html index 87d2c933..63558686 100644 --- a/apidocs/struct__icalvcal__defaults.html +++ b/apidocs/struct__icalvcal__defaults.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: _icalvcal_defaults Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    _icalvcal_defaults Struct Reference
    +
    +
    _icalvcal_defaults Struct Reference
    - - - -

    +

    Data Fields

    +
    char * alarm_audio_fmttype
     
    +
    char * alarm_audio_url
     
    +
    char * alarm_description
     
    @@ -86,7 +87,7 @@ char * alarm_description
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structbuffer__ring.html b/apidocs/structbuffer__ring.html index 827d504b..ca400b05 100644 --- a/apidocs/structbuffer__ring.html +++ b/apidocs/structbuffer__ring.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: buffer_ring Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    buffer_ring Struct Reference
    +
    +
    buffer_ring Struct Reference
    - - -

    +

    Data Fields

    +
    int pos
     
    +
    void * ring [2500]
     
    @@ -83,7 +84,7 @@ void * ring [2500]
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structconversion__table__struct.html b/apidocs/structconversion__table__struct.html index b1e21146..52901070 100644 --- a/apidocs/structconversion__table__struct.html +++ b/apidocs/structconversion__table__struct.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: conversion_table_struct Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    conversion_table_struct Struct Reference
    +
    +
    conversion_table_struct Struct Reference
    - - - - + - -

    +

    Data Fields

    +
    void *(* conversion_func )(int icaltype, VObject *o, icalcomponent *comp, icalvcal_defaults *defaults)
     
    +
     
    int icaltype
     
    +
    enum datatype type
     
    +
    const char * vcalname
     
    @@ -89,7 +90,7 @@ const char * vcalname<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structencoding__map.html b/apidocs/structencoding__map.html index e02f3593..8b86cae7 100644 --- a/apidocs/structencoding__map.html +++ b/apidocs/structencoding__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: encoding_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    encoding_map Struct Reference
    +
    +
    encoding_map Struct Reference
    - - -

    +

    Data Fields

    +
    enum sspm_encoding encoding
     
    +
    const char * str
     
    @@ -83,7 +84,7 @@ const char * str<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structexpand__split__map__struct.html b/apidocs/structexpand__split__map__struct.html index 181604f4..f7ce7378 100644 --- a/apidocs/structexpand__split__map__struct.html +++ b/apidocs/structexpand__split__map__struct.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: expand_split_map_struct Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    expand_split_map_struct Struct Reference
    +
    +
    expand_split_map_struct Struct Reference
    - - - - + +

    +

    Data Fields

    +
    icalrecurrencetype_frequency frequency
     
    -short map [9]
     
    +short map [BY_SET_POS+1]
     
    -
    The documentation for this struct was generated from the following file:
      +

      Detailed Description

      +

      The split map indicates, for a particular interval, whether a BY_* rule part expands the number of instances in the occurrence set or contracts it. 1=> contract, 2=>expand, and 3 means the pairing is not allowed.

      +
      The documentation for this struct was generated from the following file:
      • icalrecur.c
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structfreq__map.html b/apidocs/structfreq__map.html index 63537f9a..0a32cf3c 100644 --- a/apidocs/structfreq__map.html +++ b/apidocs/structfreq__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: freq_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    freq_map Struct Reference
    +
    +
    freq_map Struct Reference
    - - - - + +

    +

    Data Fields

    +
    icalrecurrencetype_frequency kind
     
    -const char str [9]
     
    +const char * str
     
    The documentation for this struct was generated from the following file:
    • icalrecur.c
      • @@ -83,7 +84,7 @@ const char str [9]
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalattach__impl.html b/apidocs/structicalattach__impl.html index dc05b48a..beb5dc95 100644 --- a/apidocs/structicalattach__impl.html +++ b/apidocs/structicalattach__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalattach_impl Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalattach_impl Struct Reference
      +
      +
      icalattach_impl Struct Reference
      - - - - @@ -107,7 +108,7 @@ union {
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalbdbset__id.html b/apidocs/structicalbdbset__id.html index bf53913e..4791846c 100644 --- a/apidocs/structicalbdbset__id.html +++ b/apidocs/structicalbdbset__id.html @@ -2,8 +2,8 @@ - - + +Libical API Documentation: icalbdbset_id Struct Reference @@ -19,9 +19,10 @@

      +

      Data Fields

      +
      unsigned int is_url:1
       
      +
      int refcount
       
      +
      union {
         struct {
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalbdbset_id Struct Reference
      +
      +
      icalbdbset_id Struct Reference
      - - - -

      +

      Data Fields

      +
      char * recurrence_id
       
      +
      int sequence
       
      +
      char * uid
       
      @@ -86,7 +87,7 @@ char * uid
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalbdbset__impl.html b/apidocs/structicalbdbset__impl.html index af74eb32..1bb488b8 100644 --- a/apidocs/structicalbdbset__impl.html +++ b/apidocs/structicalbdbset__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalbdbset_impl Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalbdbset_impl Struct Reference
      +
      +
      icalbdbset_impl Struct Reference
      - - - - - - - - - - - - - -

      +

      Data Fields

      +
      int changed
       
      +
      icalcomponent * cluster
       
      +
      void * data
       
      +
      int datasize
       
      +
      DBC * dbcp
       
      +
      DB_ENV * dbenv
       
      +
      DB * dbp
       
      +
      icalgauge * gauge
       
      +
      const char * key
       
      +
      const char * path
       
      +
      DB * sdbp
       
      +
      const char * sindex
       
      +
      const char * subdb
       
      icalset super
       

      Field Documentation

      - +

      ◆ super

      @@ -124,7 +125,7 @@ const char * subdb
      -

      parent class

      +

      parent class

      @@ -134,7 +135,7 @@ const char * subdb
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalbdbset__options.html b/apidocs/structicalbdbset__options.html index 363b7ad9..d24a4f15 100644 --- a/apidocs/structicalbdbset__options.html +++ b/apidocs/structicalbdbset__options.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalbdbset_options Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalbdbset_options Struct Reference
      +
      +
      icalbdbset_options Struct Reference
      - - @@ -79,13 +80,13 @@ int(*  - - + +

      +

      Data Fields

      +
      int(* callback )(DB *db, const DBT *dbt1, const DBT *dbt2, DBT *dbt3)
       
      int dbtype
      callback )(DB *d
       
      int mode
       
      char *(* pfunc )(const DBT *dbt)
       
      char *(* pfunc )(const DBT *dbt)
       
      icalbdbset_subdb_type subdb
       

      Field Documentation

      - +

      ◆ dbtype

      @@ -96,11 +97,11 @@ int(* callback )(DB *d
      -

      db_open type: DB_HASH | DB_BTREE

      +

      db_open type: DB_HASH | DB_BTREE

      - +

      ◆ flag

      @@ -111,11 +112,11 @@ int(* callback )(DB *d
      -

      DB->set_flags(): DB_DUP | DB_DUPSORT

      +

      DB->set_flags(): DB_DUP | DB_DUPSORT

    - +

    ◆ mode

    @@ -126,26 +127,26 @@ int(* callback )(DB *d
    -

    file mode

    +

    file mode

    - -

    ◆ pfunc

    + +

    ◆ pfunc

    - +
    char *(* icalbdbset_options::pfunc) (const DBT *dbt)char*(* icalbdbset_options::pfunc) (const DBT *dbt)
    -

    parsing function

    +

    parsing function

    - +

    ◆ subdb

    @@ -156,7 +157,7 @@ int(* callback )(DB *d
    -

    the subdatabase to open

    +

    the subdatabase to open

    @@ -166,7 +167,7 @@ int(* callback )(DB *d
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalcalendar__impl.html b/apidocs/structicalcalendar__impl.html index 028ac12a..0441e8b8 100644 --- a/apidocs/structicalcalendar__impl.html +++ b/apidocs/structicalcalendar__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcalendar_impl Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalcalendar_impl Struct Reference
    +
    +
    icalcalendar_impl Struct Reference
    - - - - - -

    +

    Data Fields

    +
    icalset * booked
     
    +
    char * dir
     
    +
    icalset * freebusy
     
    +
    icalset * incoming
     
    +
    icalset * properties
     
    @@ -92,7 +93,7 @@ char * dir
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalclassify__map.html b/apidocs/structicalclassify__map.html index c7683cb6..628c56a8 100644 --- a/apidocs/structicalclassify__map.html +++ b/apidocs/structicalclassify__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalclassify_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalclassify_map Struct Reference
    +
    +
    icalclassify_map Struct Reference
    - - - -

    +

    Data Fields

    +
    icalproperty_xlicclass class
     
    +
    int(* fn )(struct icalclassify_parts *comp, struct icalclassify_parts *match, const char *user)
     
    +
    icalproperty_method method
     
    @@ -86,7 +87,7 @@ icalproperty_method method
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalclassify__parts.html b/apidocs/structicalclassify__parts.html index ada92b69..95875d30 100644 --- a/apidocs/structicalclassify__parts.html +++ b/apidocs/structicalclassify__parts.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalclassify_parts Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalclassify_parts Struct Reference
    +
    +
    icalclassify_parts Struct Reference
    - - - - - - - - - - -

    +

    Data Fields

    +
    icalcomponent * c
     
    +
    struct icaltimetype dtstamp
     
    +
    icalcomponent_kind inner_kind
     
    +
    icalproperty_method method
     
    +
    char * organizer
     
    +
    struct icaltimetype recurrence_id
     
    +
    char * reply_attendee
     
    +
    icalparameter_partstat reply_partstat
     
    +
    int sequence
     
    +
    char * uid
     
    @@ -107,7 +108,7 @@ char * uid
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalcluster__impl.html b/apidocs/structicalcluster__impl.html index 039ccfa3..fe16eb66 100644 --- a/apidocs/structicalcluster__impl.html +++ b/apidocs/structicalcluster__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcluster_impl Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalcluster_impl Struct Reference
    +
    +
    icalcluster_impl Struct Reference
    - - - - -

    +

    Data Fields

    +
    int changed
     
    +
    icalcomponent * data
     
    +
    char id [5]
     
    +
    char * key
     
    @@ -89,7 +90,7 @@ char * key
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalcompiter.html b/apidocs/structicalcompiter.html index 6d5ceb40..647be7a3 100644 --- a/apidocs/structicalcompiter.html +++ b/apidocs/structicalcompiter.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcompiter Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalcompiter Struct Reference
    +
    +
    icalcompiter Struct Reference
    - - -

    +

    Data Fields

    +
    pvl_elem iter
     
    +
    icalcomponent_kind kind
     
    @@ -83,7 +84,7 @@ icalcomponent_kind kind
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalcomponent__impl.html b/apidocs/structicalcomponent__impl.html index 76db6933..1557d368 100644 --- a/apidocs/structicalcomponent__impl.html +++ b/apidocs/structicalcomponent__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcomponent_impl Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalcomponent_impl Struct Reference
    +
    +
    icalcomponent_impl Struct Reference
    - - - - - - - - - -

    +

    Data Fields

    +
    pvl_elem component_iterator
     
    +
    pvl_list components
     
    +
    char id [5]
     
    +
    icalcomponent_kind kind
     
    +
    struct icalcomponent_impl * parent
     
    +
    pvl_list properties
     
    +
    pvl_elem property_iterator
     
    icalarray * timezones
     
    +
    int timezones_sorted
     
    +
    char * x_name
     

    Field Documentation

    - +

    ◆ timezones

    @@ -112,7 +113,7 @@ char * x_name
    -

    An array of icaltimezone structs. We use this so we can do fast lookup of timezones using binary searches. timezones_sorted is set to 0 whenever we add a timezone, so we remember to sort the array before doing a binary search.

    +

    An array of icaltimezone structs. We use this so we can do fast lookup of timezones using binary searches. timezones_sorted is set to 0 whenever we add a timezone, so we remember to sort the array before doing a binary search.

    @@ -122,7 +123,7 @@ char * x_name
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalcomponent__kind__map.html b/apidocs/structicalcomponent__kind__map.html index 851f7afa..83acd773 100644 --- a/apidocs/structicalcomponent__kind__map.html +++ b/apidocs/structicalcomponent__kind__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalcomponent_kind_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalcomponent_kind_map Struct Reference
    +
    +
    icalcomponent_kind_map Struct Reference
    - - -

    +

    Data Fields

    +
    icalcomponent_kind kind
     
    +
    char name [20]
     
    @@ -83,7 +84,7 @@ char name [20]
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicaldatetimeperiodtype.html b/apidocs/structicaldatetimeperiodtype.html index 19a22958..922a4dcc 100644 --- a/apidocs/structicaldatetimeperiodtype.html +++ b/apidocs/structicaldatetimeperiodtype.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaldatetimeperiodtype Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icaldatetimeperiodtype Struct Reference
    +
    +
    icaldatetimeperiodtype Struct Reference
    - - -

    +

    Data Fields

    +
    struct icalperiodtype period
     
    +
    struct icaltimetype time
     
    @@ -83,7 +84,7 @@ struct icaltimetype <
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicaldirset__impl.html b/apidocs/structicaldirset__impl.html index 127d436f..6b186d14 100644 --- a/apidocs/structicaldirset__impl.html +++ b/apidocs/structicaldirset__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaldirset_impl Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icaldirset_impl Struct Reference
    +
    +
    icaldirset_impl Struct Reference
    - @@ -88,7 +89,7 @@ Data Fields

    +

    Data Fields

    icalcluster * cluster
     
     

    Field Documentation

    - +

    ◆ cluster

    @@ -99,11 +100,11 @@ Data Fields
    -

    cluster containing data

    +

    cluster containing data

    - +

    ◆ dir

    @@ -114,12 +115,12 @@ Data Fields
    -

    directory containing ics files
    +

    directory containing ics files

    - +

    ◆ directory

    @@ -130,11 +131,11 @@ Data Fields
    -

    ???

    +

    ???

    - +

    ◆ directory_iterator

    @@ -145,11 +146,11 @@ Data Fields
    -

    ???

    +

    ???

    - +

    ◆ first_component

    @@ -160,11 +161,11 @@ Data Fields
    -

    ???

    +

    ???

    - +

    ◆ gauge

    @@ -175,12 +176,12 @@ Data Fields
    -

    gauge for filtering out data
    +

    gauge for filtering out data

    - +

    ◆ options

    @@ -191,11 +192,11 @@ Data Fields
    -

    copy of options passed to icalset_new()

    +

    copy of options passed to icalset_new()

    - +

    ◆ super

    @@ -206,7 +207,7 @@ Data Fields
    -

    parent class

    +

    parent class

    @@ -216,7 +217,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicaldirset__options.html b/apidocs/structicaldirset__options.html index c61b9348..16bede83 100644 --- a/apidocs/structicaldirset__options.html +++ b/apidocs/structicaldirset__options.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaldirset_options Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icaldirset_options Struct Reference
    +
    +
    icaldirset_options Struct Reference
    -

    +

    Data Fields

    int flags
     

    Field Documentation

    - +

    ◆ flags

    @@ -85,7 +86,7 @@ Data Fields
    -

    flags corresponding to the open() system call O_RDWR, etc.

    +

    flags corresponding to the open() system call O_RDWR, etc.

    @@ -95,7 +96,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicaldurationtype.html b/apidocs/structicaldurationtype.html index 11513e13..48c8571c 100644 --- a/apidocs/structicaldurationtype.html +++ b/apidocs/structicaldurationtype.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaldurationtype Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icaldurationtype Struct Reference
    +
    +
    icaldurationtype Struct Reference

    A struct representing a duration. More...

    - -

    #include <icalduration.h>

    - - - - - - -

    +

    Data Fields

    +
    unsigned int days
     
    +
    unsigned int hours
     
    +
    int is_neg
     
    +
    unsigned int minutes
     
    +
    unsigned int seconds
     
    +
    unsigned int weeks
     

    Detailed Description

    -

    A struct representing a duration.

    +

    A struct representing a duration.

    The documentation for this struct was generated from the following file:
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalerror__state.html b/apidocs/structicalerror__state.html index 0befcefa..797c43fb 100644 --- a/apidocs/structicalerror__state.html +++ b/apidocs/structicalerror__state.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalerror_state Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalerror_state Struct Reference
    +
    +
    icalerror_state Struct Reference
    - - -

    +

    Data Fields

    +
    icalerrorenum error
     
    +
    icalerrorstate state
     
    @@ -83,7 +84,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalerror__string__map.html b/apidocs/structicalerror__string__map.html index 5e44c54a..78cb8848 100644 --- a/apidocs/structicalerror__string__map.html +++ b/apidocs/structicalerror__string__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalerror_string_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalerror_string_map Struct Reference
    +
    +
    icalerror_string_map Struct Reference
    - - - -

    +

    Data Fields

    +
    icalerrorenum error
     
    +
    char name [160]
     
    +
    const char * str
     
    @@ -86,7 +87,7 @@ const char * str<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalfileset__id.html b/apidocs/structicalfileset__id.html index d36fbf96..82acddbe 100644 --- a/apidocs/structicalfileset__id.html +++ b/apidocs/structicalfileset__id.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalfileset_id Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalfileset_id Struct Reference
    +
    +
    icalfileset_id Struct Reference
    - - - -

    +

    Data Fields

    +
    char * recurrence_id
     
    +
    int sequence
     
    +
    char * uid
     
    @@ -86,7 +87,7 @@ char * uid
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalfileset__impl.html b/apidocs/structicalfileset__impl.html index c9e9267b..0090b8fd 100644 --- a/apidocs/structicalfileset__impl.html +++ b/apidocs/structicalfileset__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalfileset_impl Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalfileset_impl Struct Reference
    +
    +
    icalfileset_impl Struct Reference
    - @@ -86,7 +87,7 @@ Data Fields

    +

    Data Fields

    int changed
     
     

    Field Documentation

    - +

    ◆ changed

    @@ -97,11 +98,11 @@ Data Fields
    -

    boolean flag, 1 if data has changed

    +

    boolean flag, 1 if data has changed

    - +

    ◆ cluster

    @@ -112,11 +113,11 @@ Data Fields
    -

    cluster containing data

    +

    cluster containing data

    - +

    ◆ fd

    @@ -127,11 +128,11 @@ Data Fields
    -

    file descriptor

    +

    file descriptor

    - +

    ◆ gauge

    @@ -142,11 +143,11 @@ Data Fields
    -

    gauge for filtering out data

    +

    gauge for filtering out data

    - +

    ◆ options

    @@ -157,11 +158,11 @@ Data Fields
    -

    copy of options passed to icalset_new()

    +

    copy of options passed to icalset_new()

    - +

    ◆ path

    @@ -172,11 +173,11 @@ Data Fields
    -

    pathname of file

    +

    pathname of file

    - +

    ◆ super

    @@ -187,7 +188,7 @@ Data Fields
    -

    parent class

    +

    parent class

    @@ -197,7 +198,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalfileset__options.html b/apidocs/structicalfileset__options.html index 0d0e7f50..9cb8509b 100644 --- a/apidocs/structicalfileset__options.html +++ b/apidocs/structicalfileset__options.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalfileset_options Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalfileset_options Struct Reference
    +
    +
    icalfileset_options Struct Reference

    Options for opening an icalfileset. More...

    - -

    #include <icalfileset.h>

    - @@ -85,10 +84,10 @@ Data Fields

    +

    Data Fields

    icalcluster * cluster
     
     

    Detailed Description

    -

    Options for opening an icalfileset.

    -

    These options should be passed to the icalset_new() function

    +

    Options for opening an icalfileset.

    +

    These options should be passed to the icalset_new() function

    Field Documentation

    - +

    ◆ cluster

    @@ -99,11 +98,11 @@ Data Fields
    -

    use this cluster to initialize data

    +

    use this cluster to initialize data

    - +

    ◆ flags

    @@ -114,12 +113,12 @@ Data Fields
    -

    flags for open() O_RDONLY, etc
    +

    flags for open() O_RDONLY, etc

    - +

    ◆ mode

    @@ -130,11 +129,11 @@ Data Fields
    -

    file mode

    +

    file mode

    - +

    ◆ safe_saves

    @@ -145,7 +144,7 @@ Data Fields
    -

    to lock or not

    +

    to lock or not

    @@ -155,7 +154,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalgauge__impl.html b/apidocs/structicalgauge__impl.html index f18b8d03..5546bc33 100644 --- a/apidocs/structicalgauge__impl.html +++ b/apidocs/structicalgauge__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalgauge_impl Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalgauge_impl Struct Reference
    +
    +
    icalgauge_impl Struct Reference
    - - @@ -81,7 +82,7 @@ int 

    +

    Data Fields

    +
    int expand
     
    pvl_list from
    expand
     

    Field Documentation

    - +

    ◆ from

    @@ -92,11 +93,11 @@ int expand
    -

    List of component_kinds, as integers

    +

    List of component_kinds, as integers

    - +

    ◆ select

    @@ -107,11 +108,11 @@ int expand
    -

    Of icalgaugecompare, using only prop and comp fields

    +

    Of icalgaugecompare, using only prop and comp fields

    - +

    ◆ where

    @@ -122,7 +123,7 @@ int expand
    -

    List of icalgaugecompare

    +

    List of icalgaugecompare

    @@ -132,7 +133,7 @@ int expand
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalgauge__where.html b/apidocs/structicalgauge__where.html index 906a66da..fdedbf99 100644 --- a/apidocs/structicalgauge__where.html +++ b/apidocs/structicalgauge__where.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalgauge_where Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalgauge_where Struct Reference
    +
    +
    icalgauge_where Struct Reference
    - - - - - -

    +

    Data Fields

    +
    icalcomponent_kind comp
     
    +
    icalgaugecompare compare
     
    +
    icalgaugelogic logic
     
    +
    icalproperty_kind prop
     
    +
    char * value
     
    @@ -92,7 +93,7 @@ char * value
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalgeotype.html b/apidocs/structicalgeotype.html index dd73e562..9f7a0af2 100644 --- a/apidocs/structicalgeotype.html +++ b/apidocs/structicalgeotype.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalgeotype Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalgeotype Struct Reference
    +
    +
    icalgeotype Struct Reference
    - - - - - + + + +

    +

    Data Fields

    -char lat [16]
     
    -char lon [16]
     
    +double lat
     
    +double lon
     
    The documentation for this struct was generated from the following file:
    • icaltypes.h
      • @@ -83,7 +84,7 @@ char lon [16]
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalparameter__impl.html b/apidocs/structicalparameter__impl.html index 7e6d85a5..e44b3c82 100644 --- a/apidocs/structicalparameter__impl.html +++ b/apidocs/structicalparameter__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparameter_impl Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalparameter_impl Struct Reference
      +
      +
      icalparameter_impl Struct Reference
      - - - - - - - -

      +

      Data Fields

      +
      int data
       
      +
      char id [5]
       
      +
      icalparameter_kind kind
       
      +
      icalproperty * parent
       
      +
      int size
       
      +
      const char * string
       
      +
      const char * x_name
       
      @@ -98,7 +99,7 @@ const char * x_name
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalparser__impl.html b/apidocs/structicalparser__impl.html index be8f7771..c647d16c 100644 --- a/apidocs/structicalparser__impl.html +++ b/apidocs/structicalparser__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalparser_impl Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalparser_impl Struct Reference
      +
      +
      icalparser_impl Struct Reference
      - - - - - - - - - - - - - -

      +

      Data Fields

      +
      int buffer_full
       
      +
      pvl_list components
       
      +
      int continuation_line
       
      -int error_count
       
      +
      int level
       
      +
      void * line_gen_data
       
      +
      int lineno
       
      +
      icalcomponent * root_component
       
      +
      icalparser_state state
       
      +
      char temp [80]
       
      +
      size_t tmp_buf_size
       
      +
      int version
       
      @@ -113,7 +111,7 @@ int version
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalperiodtype.html b/apidocs/structicalperiodtype.html index 3933e858..9fce6423 100644 --- a/apidocs/structicalperiodtype.html +++ b/apidocs/structicalperiodtype.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalperiodtype Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalperiodtype Struct Reference
      +
      +
      icalperiodtype Struct Reference

      Struct to represent a period in time. More...

      - -

      #include <icalperiod.h>

      - - - -

      +

      Data Fields

      +
      struct icaldurationtype duration
       
      +
      struct icaltimetype end
       
      +
      struct icaltimetype start
       

      Detailed Description

      -

      Struct to represent a period in time.

      +

      Struct to represent a period in time.

      The documentation for this struct was generated from the following file:
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalproperty__impl.html b/apidocs/structicalproperty__impl.html index cf4443de..61e8cd66 100644 --- a/apidocs/structicalproperty__impl.html +++ b/apidocs/structicalproperty__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalproperty_impl Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalproperty_impl Struct Reference
      +
      +
      icalproperty_impl Struct Reference
      - - - - - - - -

      +

      Data Fields

      +
      char id [5]
       
      +
      icalproperty_kind kind
       
      +
      pvl_elem parameter_iterator
       
      +
      pvl_list parameters
       
      +
      icalcomponent * parent
       
      +
      icalvalue * value
       
      +
      char * x_name
       
      @@ -98,7 +99,7 @@ char * x_name
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalrecur__iterator__impl.html b/apidocs/structicalrecur__iterator__impl.html index bcf50f36..2ad72756 100644 --- a/apidocs/structicalrecur__iterator__impl.html +++ b/apidocs/structicalrecur__iterator__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalrecur_iterator_impl Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalrecur_iterator_impl Struct Reference
      +
      +
      icalrecur_iterator_impl Struct Reference
      - - - - - - - - - - - - - -

      +

      Data Fields

      +
      short by_indices [9]
       
      short * by_ptrs [9]
       
      +
      enum byrule byrule
       
      +
      unsigned long days [(((367+7)+(8 *sizeof(unsigned long)) -1)/(8 *sizeof(unsigned long)))]
       
      +
      short days_index
       
      +
      struct icaltimetype dtstart
       
      -struct icaltimetype iend
       
      +
      struct icaltimetype istart
       
      +
      struct icaltimetype last
       
      +
      int occurrence_no
       
      short orig_data [9]
       
      +
      struct icaltimetype period_start
       
      +
      struct icaltimetype rstart
       
      +
      struct icalrecurrencetype rule
       

      Field Documentation

      - +

      ◆ by_ptrs

      @@ -123,11 +121,11 @@ struct icalrecurrencetype
      -

      Pointers into the by_* array elements of the rule

      +

      Pointers into the by_* array elements of the rule

      - +

      ◆ orig_data

      @@ -138,7 +136,7 @@ struct icalrecurrencetype
      -

      1 if there was data in the byrule

      +

      1 if there was data in the byrule

      @@ -148,7 +146,7 @@ struct icalrecurrencetype
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalrecur__parser.html b/apidocs/structicalrecur__parser.html index 66da7818..bdaf502b 100644 --- a/apidocs/structicalrecur__parser.html +++ b/apidocs/structicalrecur__parser.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalrecur_parser Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalrecur_parser Struct Reference
      +
      +
      icalrecur_parser Struct Reference
      - - - - - -

      +

      Data Fields

      +
      char * copy
       
      +
      char * next_clause
       
      +
      struct icalrecurrencetype rt
       
      +
      const char * rule
       
      +
      char * this_clause
       
      @@ -92,7 +93,7 @@ char * this_clause
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalrecurrencetype.html b/apidocs/structicalrecurrencetype.html index e0dc98e7..dcb4d2de 100644 --- a/apidocs/structicalrecurrencetype.html +++ b/apidocs/structicalrecurrencetype.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalrecurrencetype Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalrecurrencetype Struct Reference
      +
      +
      icalrecurrencetype Struct Reference
      - -

      #include <icalrecur.h>

      - - - - - - - - - - - - - - -

      +

      Data Fields

      short by_day [7 *(56 -1)+1]
       Encoded value. More...
       
      +
      short by_hour [25]
       
      +
      short by_minute [61]
       
      short by_month [14]
       Encoded value. More...
       
      +
      short by_month_day [32]
       
      +
      short by_second [62]
       
      +
      short by_set_pos [386]
       
      +
      short by_week_no [56]
       
      +
      short by_year_day [386]
       
      +
      int count
       
      +
      icalrecurrencetype_frequency freq
       
      +
      short interval
       
      +
      char * rscale
       
      +
      icalrecurrencetype_skip skip
       
      +
      struct icaltimetype until
       
      +
      icalrecurrencetype_weekday week_start
       

      Detailed Description

      -

      Main struct for holding digested recurrence rules

      +

      Main struct for holding digested recurrence rules

      Field Documentation

      - +

      ◆ by_day

      @@ -137,12 +136,12 @@ icalrecurrencetype_weekday 

      Encoded value.

      -

      The 'day' element of the by_day array is encoded to allow representation of both the day of the week ( Monday, Tuesday), but also the Nth day of the week (first Tuesday of the month, last Thursday of the year).

      -

      These values are decoded by icalrecurrencetype_day_day_of_week() and icalrecurrencetype_day_position().

      +

      The 'day' element of the by_day array is encoded to allow representation of both the day of the week ( Monday, Tuesday), but also the Nth day of the week (first Tuesday of the month, last Thursday of the year).

      +

      These values are decoded by icalrecurrencetype_day_day_of_week() and icalrecurrencetype_day_position().

      - +

      ◆ by_month

      @@ -155,8 +154,8 @@ icalrecurrencetype_weekday 

      Encoded value.

      -

      The 'month' element of the by_month array is encoded to allow representation of the "L" leap suffix (RFC 7529).

      -

      These values are decoded by icalrecurrencetype_month_is_leap() and icalrecurrencetype_month_month().

      +

      The 'month' element of the by_month array is encoded to allow representation of the "L" leap suffix (RFC 7529).

      +

      These values are decoded by icalrecurrencetype_month_is_leap() and icalrecurrencetype_month_month().

      @@ -166,7 +165,7 @@ icalrecurrencetype_weekday 
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalreqstattype.html b/apidocs/structicalreqstattype.html index 8d229042..d33c7872 100644 --- a/apidocs/structicalreqstattype.html +++ b/apidocs/structicalreqstattype.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalreqstattype Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalreqstattype Struct Reference
      +
      +
      icalreqstattype Struct Reference
      - - - -

      +

      Data Fields

      +
      icalrequeststatus code
       
      +
      const char * debug
       
      +
      const char * desc
       
      @@ -86,7 +87,7 @@ const char * desc
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalset__impl.html b/apidocs/structicalset__impl.html index fd061625..e357088d 100644 --- a/apidocs/structicalset__impl.html +++ b/apidocs/structicalset__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalset_impl Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalset_impl Struct Reference
      +
      +
      icalset_impl Struct Reference
      - - - - - - - - - + - - + - - - + - - + - - + - - - - + - - + - - + - - - - - + - -

      +

      Data Fields

      +
      icalerrorenum(* add_component )(icalset *set, icalcomponent *comp)
       
      +
      void(* clear )(icalset *set)
       
      +
      icalerrorenum(* commit )(icalset *set)
       
      +
      int(* count_components )(icalset *set, icalcomponent_kind kind)
       
      +
      char * dsn
       
      +
      icalcomponent *(* fetch )(icalset *set, icalcomponent_kind kind, const char *uid)
       
      +
       
      icalcomponent *(* fetch_match )(icalset *set, icalcomponent *comp)
       
      +
       
      void(* free )(icalset *set)
       
      +
      icalcomponent *(* get_current_component )(icalset *set)
       
      +
       
      icalcomponent *(* get_first_component )(icalset *set)
       
      +
       
      icalcomponent *(* get_next_component )(icalset *set)
       
      +
       
      int(* has_uid )(icalset *set, const char *uid)
       
      +
      icalsetiter(* icalset_begin_component )(icalset *set, icalcomponent_kind kind, icalgauge *gauge, const char *tzid)
       
      +
      icalcomponent *(* icalsetiter_to_next )(icalset *set, icalsetiter *i)
       
      +
       
      icalcomponent *(* icalsetiter_to_prior )(icalset *set, icalsetiter *i)
       
      +
       
      icalset *(* init )(icalset *set, const char *dsn, void *options)
       
      +
       
      icalset_kind kind
       
      +
      void(* mark )(icalset *set)
       
      +
      icalerrorenum(* modify )(icalset *set, icalcomponent *old, icalcomponent *newc)
       
      +
      const char *(* path )(icalset *set)
       
      +
       
      icalerrorenum(* remove_component )(icalset *set, icalcomponent *comp)
       
      +
      icalerrorenum(* select )(icalset *set, icalgauge *gauge)
       
      +
      size_t size
       
      @@ -146,7 +147,7 @@ size_t size
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalsetiter.html b/apidocs/structicalsetiter.html index a2209d53..6e3f79c4 100644 --- a/apidocs/structicalsetiter.html +++ b/apidocs/structicalsetiter.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalsetiter Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalsetiter Struct Reference
      +
      +
      icalsetiter Struct Reference
      - - - - - -

      +

      Data Fields

      +
      icalgauge * gauge
       
      +
      icalcompiter iter
       
      +
      icalcomponent * last_component
       
      +
      icalrecur_iterator * ritr
       
      +
      const char * tzid
       
      @@ -92,7 +93,7 @@ const char * tzid
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicalspanlist__impl.html b/apidocs/structicalspanlist__impl.html index fe0fa2f1..924c0ca3 100644 --- a/apidocs/structicalspanlist__impl.html +++ b/apidocs/structicalspanlist__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalspanlist_impl Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icalspanlist_impl Struct Reference
      +
      +
      icalspanlist_impl Struct Reference
      - @@ -78,7 +79,7 @@ Data Fields

      +

      Data Fields

      struct icaltimetype end
       
       

      Field Documentation

      - +

      ◆ end

      @@ -89,11 +90,11 @@ Data Fields
      -

      end time of span

      +

      end time of span

      - +

      ◆ spans

      @@ -104,11 +105,11 @@ Data Fields
      -

      list of icaltime_span data

      +

      list of icaltime_span data

      - +

      ◆ start

      @@ -119,7 +120,7 @@ Data Fields
      -

      start time of span

      +

      start time of span

      @@ -129,7 +130,7 @@ Data Fields
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structicaltime__span.html b/apidocs/structicaltime__span.html index 9d7dda23..0482abe4 100644 --- a/apidocs/structicaltime__span.html +++ b/apidocs/structicaltime__span.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltime_span Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      icaltime_span Struct Reference
      +
      +
      icaltime_span Struct Reference
      - -

      #include <icaltime.h>

      - @@ -80,9 +79,9 @@ Data Fields

      +

      Data Fields

      time_t end
       
       

      Detailed Description

      -

      icaltime_span is returned by icalcomponent_get_span()

      +

      icaltime_span is returned by icalcomponent_get_span()

      Field Documentation

      - +

      ◆ end

      @@ -93,11 +92,11 @@ Data Fields
      -

      in UTC

      +

      in UTC

      - +

      ◆ is_busy

      @@ -108,11 +107,11 @@ Data Fields
      -

      1->busy time, 0-> free time

      +

      1->busy time, 0-> free time

      - +

      ◆ start

      @@ -123,7 +122,7 @@ Data Fields
      -

      in UTC

      +

      in UTC

      @@ -133,7 +132,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicaltimetype.html b/apidocs/structicaltimetype.html index 897d8b30..41ad6b50 100644 --- a/apidocs/structicaltimetype.html +++ b/apidocs/structicaltimetype.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltimetype Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icaltimetype Struct Reference
    +
    +
    icaltimetype Struct Reference
    - - - - - @@ -94,7 +95,7 @@ int 

    +

    Data Fields

    +
    int day
     
    +
    int hour
     
    int is_date
     
    int is_daylight
     
    +
    int minute
     
    int month
     
    +
    int second
     
    int year
    second
     

    Field Documentation

    - +

    ◆ is_date

    @@ -105,11 +106,11 @@ int second
    -

    1 -> interpret this as date.

    +

    1 -> interpret this as date.

    - +

    ◆ is_daylight

    @@ -120,11 +121,11 @@ int second
    -

    1 -> time is in daylight savings time.

    +

    1 -> time is in daylight savings time.

    - +

    ◆ month

    @@ -135,11 +136,11 @@ int second
    -

    1 (Jan) to 12 (Dec).

    +

    1 (Jan) to 12 (Dec).

    - +

    ◆ year

    @@ -150,11 +151,11 @@ int second
    -

    Actual year, e.g. 2001.

    +

    Actual year, e.g. 2001.

    - +

    ◆ zone

    @@ -165,7 +166,7 @@ int second
    -

    timezone

    +

    timezone

    @@ -175,7 +176,7 @@ int second
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicaltimezonephase.html b/apidocs/structicaltimezonephase.html new file mode 100644 index 00000000..353aaf03 --- /dev/null +++ b/apidocs/structicaltimezonephase.html @@ -0,0 +1,108 @@ + + + + + + + +Libical API Documentation: icaltimezonephase Struct Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    Libical API Documentation +  3.0 +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Data Fields
    +
    +
    icaltimezonephase Struct Reference
    +
    +
    + + + + + + + + + + + + + + + + + + +

    +Data Fields

    +const char * comment
     
    +struct icaltimetype dtstart
     
    +int is_stdandard
     
    +int offsetto
     
    +struct icaldatetimeperiodtype rdate
     
    +const char * rrule
     
    +const char * tzname
     
    +int tzoffsetfrom
     
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1 +
    + + diff --git a/apidocs/structicaltimezonetype.html b/apidocs/structicaltimezonetype.html new file mode 100644 index 00000000..fe0489d1 --- /dev/null +++ b/apidocs/structicaltimezonetype.html @@ -0,0 +1,96 @@ + + + + + + + +Libical API Documentation: icaltimezonetype Struct Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    Libical API Documentation +  3.0 +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Data Fields
    +
    +
    icaltimezonetype Struct Reference
    +
    +
    + + + + + + + + + + +

    +Data Fields

    +struct icaltimetype last_mod
     
    +struct icaltimezonephase * phases
     
    +const char * tzid
     
    +const char * tzurl
     
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1 +
    + + diff --git a/apidocs/structicaltriggertype.html b/apidocs/structicaltriggertype.html index b94b8c43..dfd6ee04 100644 --- a/apidocs/structicaltriggertype.html +++ b/apidocs/structicaltriggertype.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icaltriggertype Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icaltriggertype Struct Reference
    +
    +
    icaltriggertype Struct Reference
    - - -

    +

    Data Fields

    +
    struct icaldurationtype duration
     
    +
    struct icaltimetype time
     
    @@ -83,7 +84,7 @@ struct icaltimetype <
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structicalvalue__impl.html b/apidocs/structicalvalue__impl.html index dc7233e6..71b8a723 100644 --- a/apidocs/structicalvalue__impl.html +++ b/apidocs/structicalvalue__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalvalue_impl Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */ -
    icalvalue_impl Struct Reference
    +
    +
    icalvalue_impl Struct Reference
    -

    +

    Data Structures

    union  data
     
    - - - - - - -

    +

    Data Fields

    +
    union icalvalue_impl::data data
     
    +
    char id [5]
     
    +
    icalvalue_kind kind
     
    +
    icalproperty * parent
     
    +
    int size
     
    +
    char * x_value
     
    @@ -101,7 +102,7 @@ char * x_value
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structleap.html b/apidocs/structleap.html new file mode 100644 index 00000000..f2eb692f --- /dev/null +++ b/apidocs/structleap.html @@ -0,0 +1,90 @@ + + + + + + + +Libical API Documentation: leap Struct Reference + + + + + + + + + +
    +
    + + + + + + +
    +
    Libical API Documentation +  3.0 +
    +
    +
    + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Data Fields
    +
    +
    leap Struct Reference
    +
    +
    + + + + + + +

    +Data Fields

    +long int change
     
    +time_t transition
     
    +
    The documentation for this struct was generated from the following file:
      +
    • icaltz-util.c
      • +
    +
    + +
    +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1 +
    + + diff --git a/apidocs/structmajor__content__type__map.html b/apidocs/structmajor__content__type__map.html index 6ecdd65c..753d92ba 100644 --- a/apidocs/structmajor__content__type__map.html +++ b/apidocs/structmajor__content__type__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: major_content_type_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    major_content_type_map Struct Reference
    +
    +
    major_content_type_map Struct Reference
    - - -

    +

    Data Fields

    +
    const char * str
     
    +
    enum sspm_major_type type
     
    @@ -83,7 +84,7 @@ enum sspm_major_type type<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structmime__impl.html b/apidocs/structmime__impl.html index 7f8fe018..c59ad101 100644 --- a/apidocs/structmime__impl.html +++ b/apidocs/structmime__impl.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: mime_impl Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    mime_impl Struct Reference
    +
    +
    mime_impl Struct Reference
    - - - - - + - - - - - -

    +

    Data Fields

    +
    const struct sspm_action_map * actions
     
    +
    char *(* get_string )(char *s, size_t size, void *data)
     
    +
     
    void * get_string_data
     
    +
    int level
     
    +
    size_t max_parts
     
    +
    int part_no
     
    +
    struct sspm_part * parts
     
    +
    enum mime_state state
     
    +
    char temp [1024]
     
    @@ -104,7 +105,7 @@ char temp [1024]<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structminor__content__type__map.html b/apidocs/structminor__content__type__map.html index 26285e70..02e6c2a4 100644 --- a/apidocs/structminor__content__type__map.html +++ b/apidocs/structminor__content__type__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: minor_content_type_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    minor_content_type_map Struct Reference
    +
    +
    minor_content_type_map Struct Reference
    - - -

    +

    Data Fields

    +
    const char * str
     
    +
    enum sspm_minor_type type
     
    @@ -83,7 +84,7 @@ enum sspm_minor_type type<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structobservance.html b/apidocs/structobservance.html index c43c92c0..bc829ad4 100644 --- a/apidocs/structobservance.html +++ b/apidocs/structobservance.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: observance Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    observance Struct Reference
    +
    +
    observance Struct Reference
    - - - - -

    +

    Data Fields

    +
    const char * name
     
    +
    int offset_from
     
    +
    int offset_to
     
    +
    icaltimetype onset
     
    @@ -89,7 +90,7 @@ int offset_to
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structpvl__elem__t.html b/apidocs/structpvl__elem__t.html index 8b112641..f8cd76c3 100644 --- a/apidocs/structpvl__elem__t.html +++ b/apidocs/structpvl__elem__t.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: pvl_elem_t Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    pvl_elem_t Struct Reference
    +
    +
    pvl_elem_t Struct Reference
    - -

    #include <pvl.h>

    - @@ -82,9 +81,9 @@ Data Fields

    +

    Data Fields

    void * d
     
     

    Detailed Description

    -

    This type is private. Always use pvl_elem instead. The struct would not even appear in this header except to make code in the USE_MACROS blocks work

    +

    This type is private. Always use pvl_elem instead. The struct would not even appear in this header except to make code in the USE_MACROS blocks work

    Field Documentation

    - +

    ◆ d

    @@ -95,11 +94,11 @@ Data Fields
    -

    Pointer to data user is storing

    +

    Pointer to data user is storing

    - +

    ◆ MAGIC

    @@ -110,11 +109,11 @@ Data Fields
    -

    Magic Identifier

    +

    Magic Identifier

    - +

    ◆ next

    @@ -125,11 +124,11 @@ Data Fields
    -

    Next element

    +

    Next element

    - +

    ◆ prior

    @@ -140,7 +139,7 @@ Data Fields
    -

    Prior element

    +

    Prior element

    @@ -150,7 +149,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structpvl__list__t.html b/apidocs/structpvl__list__t.html index 9b4f9f68..f2a66c5a 100644 --- a/apidocs/structpvl__list__t.html +++ b/apidocs/structpvl__list__t.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: pvl_list_t Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    pvl_list_t Struct Reference
    +
    +
    pvl_list_t Struct Reference
    - @@ -82,11 +83,11 @@ Data Fields

    +

    Data Fields

    int count
     
     

    Detailed Description

    -

    struct pvl_list_t

    -

    The list structure. This is the handle for the entire list

    -

    This type is also private. Use pvl_list instead

    +

    struct pvl_list_t

    +

    The list structure. This is the handle for the entire list

    +

    This type is also private. Use pvl_list instead

    Field Documentation

    - +

    ◆ count

    @@ -97,11 +98,11 @@ Data Fields
    -

    Number of items in the list

    +

    Number of items in the list

    - +

    ◆ head

    @@ -112,11 +113,11 @@ Data Fields
    -

    Head of list

    +

    Head of list

    - +

    ◆ MAGIC

    @@ -127,11 +128,11 @@ Data Fields
    -

    Magic Identifier

    +

    Magic Identifier

    - +

    ◆ p

    @@ -142,11 +143,11 @@ Data Fields
    -

    Pointer used for iterators

    +

    Pointer used for iterators

    - +

    ◆ tail

    @@ -157,7 +158,7 @@ Data Fields
    -

    Tail of list

    +

    Tail of list

    @@ -167,7 +168,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structrdate.html b/apidocs/structrdate.html index bd47ed76..feb271d5 100644 --- a/apidocs/structrdate.html +++ b/apidocs/structrdate.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: rdate Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    rdate Struct Reference
    +
    +
    rdate Struct Reference
    - - -

    +

    Data Fields

    +
    struct icaldatetimeperiodtype date
     
    +
    icalproperty * prop
     
    @@ -83,7 +84,7 @@ icalproperty * prop
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structrecur__map.html b/apidocs/structrecur__map.html index a2fdd149..7127f46c 100644 --- a/apidocs/structrecur__map.html +++ b/apidocs/structrecur__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: recur_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    recur_map Struct Reference
    +
    +
    recur_map Struct Reference
    - - - - + + - - -

    +

    Data Fields

    -int min
     
    +
    +int limit
     
    size_t offset
     
    -int size
     
    +
    const char * str
     
    @@ -89,7 +87,7 @@ const char * str<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structskip__map.html b/apidocs/structskip__map.html index acf901b6..1cccc34c 100644 --- a/apidocs/structskip__map.html +++ b/apidocs/structskip__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: skip_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    skip_map Struct Reference
    +
    +
    skip_map Struct Reference
    - - - - + +

    +

    Data Fields

    +
    icalrecurrencetype_skip kind
     
    -const char str [9]
     
    +const char * str
     
    The documentation for this struct was generated from the following file:
    • icalrecur.c
      • @@ -83,7 +84,7 @@ const char str [9]
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structslg__data.html b/apidocs/structslg__data.html index dbc2e7a1..256c2fcb 100644 --- a/apidocs/structslg__data.html +++ b/apidocs/structslg__data.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: slg_data Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      slg_data Struct Reference
      +
      +
      slg_data Struct Reference
      - - -

      +

      Data Fields

      +
      const char * pos
       
      +
      const char * str
       
      @@ -83,7 +84,7 @@ const char * str<
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structsspm__action__map.html b/apidocs/structsspm__action__map.html index 25a3080f..dd7795c4 100644 --- a/apidocs/structsspm__action__map.html +++ b/apidocs/structsspm__action__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: sspm_action_map Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      sspm_action_map Struct Reference
      +
      +
      sspm_action_map Struct Reference
      - - - - - + - - - - +

      +

      Data Fields

      +
      void(* add_line )(void *part, struct sspm_header *header, const char *line, size_t size)
       
      +
      void *(* end_part )(void *part)
       
      +
       
      void(* free_part )(void *part)
       
      +
      enum sspm_major_type major
       
      +
      enum sspm_minor_type minor
       
      +
      void *(* new_part )(void)
       
       
      The documentation for this struct was generated from the following file:
      • sspm.h
        • @@ -95,7 +96,7 @@ void *(* new_part )(vo
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structsspm__buffer.html b/apidocs/structsspm__buffer.html index 7484f04a..f8a4176f 100644 --- a/apidocs/structsspm__buffer.html +++ b/apidocs/structsspm__buffer.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: sspm_buffer Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      sspm_buffer Struct Reference
      +
      +
      sspm_buffer Struct Reference
      - - - - -

      +

      Data Fields

      +
      size_t buf_size
       
      +
      char * buffer
       
      +
      int line_pos
       
      +
      char * pos
       
      @@ -89,7 +90,7 @@ char * pos
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structsspm__header.html b/apidocs/structsspm__header.html index e36f3eff..7c4a0444 100644 --- a/apidocs/structsspm__header.html +++ b/apidocs/structsspm__header.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: sspm_header Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      sspm_header Struct Reference
      +
      +
      sspm_header Struct Reference
      - - - - - - - - - - - - -

      +

      Data Fields

      +
      char * boundary
       
      +
      char * charset
       
      +
      char * content_id
       
      +
      char ** content_type_params
       
      +
      int def
       
      +
      enum sspm_encoding encoding
       
      +
      enum sspm_error error
       
      +
      char * error_text
       
      +
      char * filename
       
      +
      enum sspm_major_type major
       
      +
      enum sspm_minor_type minor
       
      +
      char * minor_text
       
      @@ -113,7 +114,7 @@ char * minor_text
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structsspm__part.html b/apidocs/structsspm__part.html index 0cd2bcfd..245399ae 100644 --- a/apidocs/structsspm__part.html +++ b/apidocs/structsspm__part.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: sspm_part Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      sspm_part Struct Reference
      +
      +
      sspm_part Struct Reference
      - - - - -

      +

      Data Fields

      +
      void * data
       
      +
      size_t data_size
       
      +
      struct sspm_header header
       
      +
      int level
       
      @@ -89,7 +90,7 @@ int level
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structtext__part.html b/apidocs/structtext__part.html index 380104f8..11b381a4 100644 --- a/apidocs/structtext__part.html +++ b/apidocs/structtext__part.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: text_part Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      text_part Struct Reference
      +
      +
      text_part Struct Reference
      - - - -

      +

      Data Fields

      +
      char * buf
       
      +
      char * buf_pos
       
      +
      size_t buf_size
       
      @@ -86,7 +87,7 @@ size_t buf_size
      -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
      diff --git a/apidocs/structttinfo.html b/apidocs/structttinfo.html new file mode 100644 index 00000000..0e1ecaac --- /dev/null +++ b/apidocs/structttinfo.html @@ -0,0 +1,102 @@ + + + + + + + +Libical API Documentation: ttinfo Struct Reference + + + + + + + + + +
      +
      + + + + + + +
      +
      Libical API Documentation +  3.0 +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +Data Fields
      +
      +
      ttinfo Struct Reference
      +
      +
      + + + + + + + + + + + + + + +

      +Data Fields

      +unsigned int abbr
       
      +long int gmtoff
       
      +unsigned char isdst
       
      +unsigned char isgmt
       
      +unsigned char isstd
       
      +char * zname
       
      +
      The documentation for this struct was generated from the following file:
        +
      • icaltz-util.c
        • +
      +
      + +
      +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1 +
      + + diff --git a/apidocs/structtzinfo.html b/apidocs/structtzinfo.html new file mode 100644 index 00000000..46f6874d --- /dev/null +++ b/apidocs/structtzinfo.html @@ -0,0 +1,111 @@ + + + + + + + +Libical API Documentation: tzinfo Struct Reference + + + + + + + + + +
      +
      + + + + + + +
      +
      Libical API Documentation +  3.0 +
      +
      +
      + + + + + + + + +
      +
      + + +
      + +
      + +
      +
      +
      +Data Fields
      +
      +
      tzinfo Struct Reference
      +
      +
      + + + + + + + + + + + + + + + + + + + + +

      +Data Fields

      +char charcnt [4]
       
      +char leapcnt [4]
       
      +char magic [4]
       
      +char timecnt [4]
       
      +char ttisgmtcnt [4]
       
      +char ttisstdcnt [4]
       
      +char typecnt [4]
       
      +char unused [15]
       
      +char version
       
      +
      The documentation for this struct was generated from the following file:
        +
      • icaltz-util.c
        • +
      +
      + +
      +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1 +
      + + diff --git a/apidocs/structut__instant.html b/apidocs/structut__instant.html index dcc1b03f..e80a07dc 100644 --- a/apidocs/structut__instant.html +++ b/apidocs/structut__instant.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: ut_instant Struct Reference @@ -19,9 +19,10 @@
      - - + @@ -29,22 +30,21 @@
      -
      Libical API Documentation 3.1 +
      +
      Libical API Documentation +  3.0
      - + +/* @license-end */
      Data Fields
      -
      ut_instant Struct Reference
      +
      +
      ut_instant Struct Reference
      - @@ -96,7 +97,7 @@ Data Fields

      +

      Data Fields

      double d_hour
       
       

      Field Documentation

      - +

      ◆ d_hour

      @@ -107,11 +108,11 @@ Data Fields
      -

      [0.0-23.9999] includes minute and second

      +

      [0.0-23.9999] includes minute and second

      - +

      ◆ d_minute

      @@ -122,12 +123,12 @@ Data Fields
      -

      [0.0-59.9999] includes second
      +

      [0.0-59.9999] includes second

      - +

      ◆ d_second

      @@ -138,12 +139,12 @@ Data Fields
      -

      [0.0-59.9999]
      +

      [0.0-59.9999]

    - +

    ◆ day

    @@ -154,12 +155,12 @@ Data Fields
    -

    [1-31]
    +

    [1-31]

    - +

    ◆ day_of_year

    @@ -170,11 +171,11 @@ Data Fields
    -

    [1-366]

    +

    [1-366]

    - +

    ◆ i_hour

    @@ -185,12 +186,12 @@ Data Fields
    -

    [0-23]
    +

    [0-23]

    - +

    ◆ i_minute

    @@ -201,12 +202,12 @@ Data Fields
    -

    [0-59]
    +

    [0-59]

    - +

    ◆ i_second

    @@ -217,12 +218,12 @@ Data Fields
    -

    [0-59]
    +

    [0-59]

    - +

    ◆ j_date

    @@ -233,11 +234,11 @@ Data Fields
    -

    Julian decimal date, 0 = 01 Jan 4713 BC 12 HR UT

    +

    Julian decimal date, 0 = 01 Jan 4713 BC 12 HR UT

    - +

    ◆ month

    @@ -248,12 +249,12 @@ Data Fields
    -

    [1-12]
    +

    [1-12]

    - +

    ◆ weekday

    @@ -264,12 +265,12 @@ Data Fields
    -

    [0-6]
    +

    [0-6]

    - +

    ◆ year

    @@ -280,7 +281,7 @@ Data Fields
    -

    year, valid range [-4,713, +2,147,483,647]

    +

    year, valid range [-4,713, +2,147,483,647]

    @@ -290,7 +291,7 @@ Data Fields
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structut__instant__int.html b/apidocs/structut__instant__int.html deleted file mode 100644 index 063c1990..00000000 --- a/apidocs/structut__instant__int.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - - -Libical API Documentation: ut_instant_int Struct Reference - - - - - - - - - -
    -
    - - - - - - -
    -
    Libical API Documentation 3.1 -
    -
    -
    - - - - - - - - -
    -
    - - -
    - -
    - -
    -
    -
    -Data Fields
    -
    ut_instant_int Struct Reference
    -
    -
    - - - - - - - - - - - - - - -

    -Data Fields

    int day
     
    int day_of_year
     
    long j_date0
     
    int month
     
    int weekday
     
    long year
     
    -

    Field Documentation

    - -

    ◆ day

    - -
    -
    - - - - -
    int ut_instant_int::day
    -
    -

    [1-31]
    -

    - -
    -
    - -

    ◆ day_of_year

    - -
    -
    - - - - -
    int ut_instant_int::day_of_year
    -
    -

    [1-366]

    - -
    -
    - -

    ◆ j_date0

    - -
    -
    - - - - -
    long ut_instant_int::j_date0
    -
    -

    julian decimal date, 0 = 01 Jan 4713 BC

    - -
    -
    - -

    ◆ month

    - -
    -
    - - - - -
    int ut_instant_int::month
    -
    -

    [1-12]
    -

    - -
    -
    - -

    ◆ weekday

    - -
    -
    - - - - -
    int ut_instant_int::weekday
    -
    -

    [0-6]
    -

    - -
    -
    - -

    ◆ year

    - -
    -
    - - - - -
    long ut_instant_int::year
    -
    -

    year, valid range [-4,713, +32,767]

    - -
    -
    -
    The documentation for this struct was generated from the following file: -
    - -
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 -
    - - diff --git a/apidocs/structwd__map.html b/apidocs/structwd__map.html index 94635f98..6677ff95 100644 --- a/apidocs/structwd__map.html +++ b/apidocs/structwd__map.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: wd_map Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    wd_map Struct Reference
    +
    +
    wd_map Struct Reference
    - - - - + +

    +

    Data Fields

    -const char str [3]
     
    +
    +const char * str
     
    icalrecurrencetype_weekday wd
     
    @@ -83,7 +84,7 @@ icalrecurrencetype_weekday 
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structyy__buffer__state.html b/apidocs/structyy__buffer__state.html index 26a497e4..968ec7df 100644 --- a/apidocs/structyy__buffer__state.html +++ b/apidocs/structyy__buffer__state.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: yy_buffer_state Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    yy_buffer_state Struct Reference
    +
    +
    yy_buffer_state Struct Reference
    - - - - - - - - - - -

    +

    Data Fields

    +
    int yy_at_bol
     
    int yy_bs_column
     
    int yy_bs_lineno
     
    +
    char * yy_buf_pos
     
    +
    yy_size_t yy_buf_size
     
    +
    int yy_buffer_status
     
    +
    char * yy_ch_buf
     
    +
    int yy_fill_buffer
     
    +
    FILE * yy_input_file
     
    +
    int yy_is_interactive
     
    +
    int yy_is_our_buffer
     
    +
    int yy_n_chars
     

    Field Documentation

    - +

    ◆ yy_bs_column

    @@ -117,11 +118,11 @@ int yy_n_chars
    -

    The column count.

    +

    The column count.

    - +

    ◆ yy_bs_lineno

    @@ -132,7 +133,7 @@ int yy_n_chars
    -

    The line count.

    +

    The line count.

    @@ -142,7 +143,7 @@ int yy_n_chars
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structyy__trans__info.html b/apidocs/structyy__trans__info.html index ece9a676..2f96fd35 100644 --- a/apidocs/structyy__trans__info.html +++ b/apidocs/structyy__trans__info.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: yy_trans_info Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    yy_trans_info Struct Reference
    +
    +
    yy_trans_info Struct Reference
    - - -

    +

    Data Fields

    +
    flex_int32_t yy_nxt
     
    +
    flex_int32_t yy_verify
     
    @@ -83,7 +84,7 @@ flex_int32_t yy_verify
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/structzone__context.html b/apidocs/structzone__context.html index 554351b5..4f4d3c5d 100644 --- a/apidocs/structzone__context.html +++ b/apidocs/structzone__context.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: zone_context Struct Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    zone_context Struct Reference
    +
    +
    zone_context Struct Reference
    - - - - - - - - - - - - -

    +

    Data Fields

    +
    struct icalrecurrencetype final_recur
     
    +
    long gmtoff_from
     
    +
    long gmtoff_to
     
    +
    enum icalcomponent_kind kind
     
    +
    const char * name
     
    +
    short num_monthdays
     
    +
    icaltimetype prev_time
     
    +
    icalcomponent * rdate_comp
     
    +
    struct icalrecurrencetype recur
     
    +
    icalcomponent * rrule_comp
     
    +
    icalproperty * rrule_prop
     
    +
    icaltimetype time
     
    @@ -113,7 +114,7 @@ icalproperty * rrule_prop<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/tabs.css b/apidocs/tabs.css index 00d1c602..85a0cd5b 100644 --- a/apidocs/tabs.css +++ b/apidocs/tabs.css @@ -1 +1 @@ -.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:#666;-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file +.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace!important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0!important;-webkit-border-radius:0;border-radius:0!important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px!important;-webkit-border-radius:5px;border-radius:5px!important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0!important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px!important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file diff --git a/apidocs/unionValueItem.html b/apidocs/unionValueItem.html index 897d1516..c530d00c 100644 --- a/apidocs/unionValueItem.html +++ b/apidocs/unionValueItem.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: ValueItem Union Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    ValueItem Union Reference
    +
    +
    ValueItem Union Reference
    - - - - - - -

    +

    Data Fields

    +
    void * any
     
    +
    unsigned int i
     
    +
    unsigned long l
     
    +
    const char * strs
     
    +
    const wchar_t * ustrs
     
    +
    VObject * vobj
     
    @@ -95,7 +96,7 @@ const wchar_t * ustrs<
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/unionYYSTYPE.html b/apidocs/unionYYSTYPE.html index 2bc1dffe..56844069 100644 --- a/apidocs/unionYYSTYPE.html +++ b/apidocs/unionYYSTYPE.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: YYSTYPE Union Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    YYSTYPE Union Reference
    +
    +
    YYSTYPE Union Reference
    - - - -

    +

    Data Fields

    +
    char * str
     
    +
    char * v_string
     
    +
    VObject * vobj
     
    @@ -88,7 +89,7 @@ char * v_string
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/unionicalvalue__impl_1_1data.html b/apidocs/unionicalvalue__impl_1_1data.html index 99bafe9b..8bad80c6 100644 --- a/apidocs/unionicalvalue__impl_1_1data.html +++ b/apidocs/unionicalvalue__impl_1_1data.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: icalvalue_impl::data Union Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    icalvalue_impl::data Union Reference
    +
    +
    icalvalue_impl::data Union Reference
    - - - - - - - - - - - -

    +

    Data Fields

    +
    icalattach * v_attach
     
    +
    struct icaldurationtype v_duration
     
    +
    int v_enum
     
    +
    float v_float
     
    +
    struct icalgeotype v_geo
     
    +
    int v_int
     
    +
    struct icalperiodtype v_period
     
    +
    struct icalrecurrencetype * v_recur
     
    +
    struct icalreqstattype v_requeststatus
     
    +
    const char * v_string
     
    +
    struct icaltimetype v_time
     
    @@ -114,7 +115,7 @@ struct icaltimetype <
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/unionyyalloc.html b/apidocs/unionyyalloc.html index 91afab79..8acc58ed 100644 --- a/apidocs/unionyyalloc.html +++ b/apidocs/unionyyalloc.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: yyalloc Union Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    Data Fields
    -
    yyalloc Union Reference
    +
    +
    yyalloc Union Reference
    - - -

    +

    Data Fields

    +
    yytype_int16 yyss
     
    +
    YYSTYPE yyvs
     
    @@ -83,7 +84,7 @@ yytype_int16 yyss
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/vcaltmp_8h_source.html b/apidocs/vcaltmp_8h_source.html index 8cada0fc..0ca59eea 100644 --- a/apidocs/vcaltmp_8h_source.html +++ b/apidocs/vcaltmp_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: vcaltmp.h Source File @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    -
    vcaltmp.h
    +
    +
    vcaltmp.h
    -
    1/***************************************************************************
    -
    2SPDX-FileCopyrightText: 1996 Apple Computer, Inc., AT&T Corp., International
    -
    3Business Machines Corporation and Siemens Rolm Communications Inc.
    -
    4
    -
    5SPDX-License-Identifier: LicenseRef-APPLEMIT
    -
    6
    -
    7The software is provided with RESTRICTED RIGHTS. Use, duplication, or
    -
    8disclosure by the government are subject to restrictions set forth in
    -
    9DFARS 252.227-7013 or 48 CFR 52.227-19, as applicable.
    -
    10
    -
    11***************************************************************************/
    -
    12
    -
    13#ifndef VCALTMP_H
    -
    14#define VCALTMP_H
    -
    15
    -
    16#include "libical_vcal_export.h"
    -
    17#include "vcc.h"
    -
    18
    -
    19#if defined(__CPLUSPLUS__) || defined(__cplusplus)
    -
    20extern "C"
    -
    21{
    -
    22#endif
    -
    23
    -
    24 LIBICAL_VCAL_EXPORT VObject *vcsCreateVCal(char *date_created,
    -
    25 char *location,
    -
    26 char *product_id, char *time_zone, char *version);
    -
    27
    -
    28 LIBICAL_VCAL_EXPORT VObject *vcsAddEvent(VObject *vcal,
    -
    29 char *start_date_time,
    -
    30 char *end_date_time,
    -
    31 char *description,
    -
    32 char *summary,
    -
    33 char *categories,
    -
    34 char *classification,
    -
    35 char *status, char *transparency, char *uid,
    -
    36 char *url);
    -
    37
    -
    38 LIBICAL_VCAL_EXPORT VObject *vcsAddTodo(VObject *vcal,
    -
    39 char *start_date_time,
    -
    40 char *due_date_time,
    -
    41 char *date_time_complete,
    -
    42 char *description,
    -
    43 char *summary,
    -
    44 char *priority,
    -
    45 char *classification, char *status, char *uid,
    -
    46 char *url);
    -
    47
    -
    48 LIBICAL_VCAL_EXPORT VObject *vcsAddAAlarm(VObject *vevent,
    -
    49 char *run_time,
    -
    50 char *snooze_time,
    -
    51 char *repeat_count, char *audio_content);
    -
    52
    -
    53 LIBICAL_VCAL_EXPORT VObject *vcsAddMAlarm(VObject *vevent,
    -
    54 char *run_time,
    -
    55 char *snooze_time,
    -
    56 char *repeat_count, char *email_address, char *note);
    -
    57
    -
    58 LIBICAL_VCAL_EXPORT VObject *vcsAddDAlarm(VObject *vevent,
    -
    59 char *run_time,
    -
    60 char *snooze_time,
    -
    61 char *repeat_count, char *display_string);
    -
    62
    -
    63 LIBICAL_VCAL_EXPORT VObject *vcsAddPAlarm(VObject *vevent,
    -
    64 char *run_time,
    -
    65 char *snooze_time,
    -
    66 char *repeat_count, char *procedure_name);
    -
    67
    -
    68#if defined(__CPLUSPLUS__) || defined(__cplusplus)
    -
    69}
    -
    70
    -
    71#endif
    -
    72
    -
    73#endif /* VCALTMP_H */
    -
    VObject
    Definition: vobject.c:43
    +
    1 /***************************************************************************
    +
    2 (C) Copyright 1996 Apple Computer, Inc., AT&T Corp., International
    +
    3 Business Machines Corporation and Siemens Rolm Communications Inc.
    +
    4 
    +
    5 For purposes of this license notice, the term Licensors shall mean,
    +
    6 collectively, Apple Computer, Inc., AT&T Corp., International
    +
    7 Business Machines Corporation and Siemens Rolm Communications Inc.
    +
    8 The term Licensor shall mean any of the Licensors.
    +
    9 
    +
    10 Subject to acceptance of the following conditions, permission is hereby
    +
    11 granted by Licensors without the need for written agreement and without
    +
    12 license or royalty fees, to use, copy, modify and distribute this
    +
    13 software for any purpose.
    +
    14 
    +
    15 The above copyright notice and the following four paragraphs must be
    +
    16 reproduced in all copies of this software and any software including
    +
    17 this software.
    +
    18 
    +
    19 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS AND NO LICENSOR SHALL HAVE
    +
    20 ANY OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR
    +
    21 MODIFICATIONS.
    +
    22 
    +
    23 IN NO EVENT SHALL ANY LICENSOR BE LIABLE TO ANY PARTY FOR DIRECT,
    +
    24 INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES OR LOST PROFITS ARISING OUT
    +
    25 OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
    +
    26 DAMAGE.
    +
    27 
    +
    28 EACH LICENSOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, EXPRESS OR IMPLIED,
    +
    29 INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF NONINFRINGEMENT OR THE
    +
    30 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    +
    31 PURPOSE.
    +
    32 
    +
    33 The software is provided with RESTRICTED RIGHTS. Use, duplication, or
    +
    34 disclosure by the government are subject to restrictions set forth in
    +
    35 DFARS 252.227-7013 or 48 CFR 52.227-19, as applicable.
    +
    36 
    +
    37 ***************************************************************************/
    +
    38 
    +
    39 #ifndef VCALTMP_H
    +
    40 #define VCALTMP_H
    +
    41 
    +
    42 #include "libical_vcal_export.h"
    +
    43 #include "vcc.h"
    +
    44 
    +
    45 #if defined(__CPLUSPLUS__) || defined(__cplusplus)
    +
    46 extern "C"
    +
    47 {
    +
    48 #endif
    +
    49 
    +
    50  LIBICAL_VCAL_EXPORT VObject *vcsCreateVCal(char *date_created,
    +
    51  char *location,
    +
    52  char *product_id, char *time_zone, char *version);
    +
    53 
    +
    54  LIBICAL_VCAL_EXPORT VObject *vcsAddEvent(VObject *vcal,
    +
    55  char *start_date_time,
    +
    56  char *end_date_time,
    +
    57  char *description,
    +
    58  char *summary,
    +
    59  char *categories,
    +
    60  char *classification,
    +
    61  char *status, char *transparency, char *uid,
    +
    62  char *url);
    +
    63 
    +
    64  LIBICAL_VCAL_EXPORT VObject *vcsAddTodo(VObject *vcal,
    +
    65  char *start_date_time,
    +
    66  char *due_date_time,
    +
    67  char *date_time_complete,
    +
    68  char *description,
    +
    69  char *summary,
    +
    70  char *priority,
    +
    71  char *classification, char *status, char *uid,
    +
    72  char *url);
    +
    73 
    +
    74  LIBICAL_VCAL_EXPORT VObject *vcsAddAAlarm(VObject *vevent,
    +
    75  char *run_time,
    +
    76  char *snooze_time,
    +
    77  char *repeat_count, char *audio_content);
    +
    78 
    +
    79  LIBICAL_VCAL_EXPORT VObject *vcsAddMAlarm(VObject *vevent,
    +
    80  char *run_time,
    +
    81  char *snooze_time,
    +
    82  char *repeat_count, char *email_address, char *note);
    +
    83 
    +
    84  LIBICAL_VCAL_EXPORT VObject *vcsAddDAlarm(VObject *vevent,
    +
    85  char *run_time,
    +
    86  char *snooze_time,
    +
    87  char *repeat_count, char *display_string);
    +
    88 
    +
    89  LIBICAL_VCAL_EXPORT VObject *vcsAddPAlarm(VObject *vevent,
    +
    90  char *run_time,
    +
    91  char *snooze_time,
    +
    92  char *repeat_count, char *procedure_name);
    +
    93 
    +
    94 #if defined(__CPLUSPLUS__) || defined(__cplusplus)
    +
    95 }
    +
    96 
    +
    97 #endif
    +
    98 
    +
    99 #endif /* VCALTMP_H */
    +
    VObject
    Definition: vobject.c:69
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/vcc_8h_source.html b/apidocs/vcc_8h_source.html index 773ccb02..def70641 100644 --- a/apidocs/vcc_8h_source.html +++ b/apidocs/vcc_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: vcc.h Source File @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    -
    vcc.h
    +
    +
    vcc.h
    -
    1/***************************************************************************
    -
    2SPDX-FileCopyrightText: 1996 Apple Computer, Inc., AT&T Corp., International
    -
    3Business Machines Corporation and Siemens Rolm Communications Inc.
    -
    4
    -
    5SPDX-License-Identifier: LicenseRef-APPLEMIT
    -
    6
    -
    7The software is provided with RESTRICTED RIGHTS. Use, duplication, or
    -
    8disclosure by the government are subject to restrictions set forth in
    -
    9DFARS 252.227-7013 or 48 CFR 52.227-19, as applicable.
    -
    10
    -
    11***************************************************************************/
    -
    12
    -
    13#ifndef VCC_H
    -
    14#define VCC_H
    -
    15
    -
    16#include "libical_vcal_export.h"
    -
    17#include "vobject.h"
    -
    18
    -
    19#if defined(__CPLUSPLUS__) || defined(__cplusplus)
    -
    20extern "C"
    -
    21{
    -
    22#endif
    -
    23
    -
    24 typedef void (*MimeErrorHandler) (const char *);
    -
    25
    -
    26 LIBICAL_VCAL_EXPORT void registerMimeErrorHandler(MimeErrorHandler);
    -
    27
    -
    28 LIBICAL_VCAL_EXPORT VObject *Parse_MIME(const char *input, unsigned long len);
    -
    29
    -
    30 LIBICAL_VCAL_EXPORT VObject *Parse_MIME_FromFileName(const char *fname);
    -
    31
    -
    32/* NOTE regarding Parse_MIME_FromFile
    -
    33The function above, Parse_MIME_FromFile, comes in two flavors,
    -
    34neither of which is exported from the DLL. Each version takes
    -
    35a CFile or FILE* as a parameter, neither of which can be
    -
    36passed across a DLL interface (at least that is my experience).
    -
    37If you are linking this code into your build directly then
    -
    38you may find them a more convenient API that the other flavors
    -
    39that take a file name. If you use them with the DLL LIB you
    -
    40will get a link error.
    -
    41*/
    -
    42
    -
    43#ifdef INCLUDEMFC
    -
    44 LIBICAL_VCAL_EXPORT VObject *Parse_MIME_FromFile(CFile * file);
    -
    45#else
    -
    46 LIBICAL_VCAL_EXPORT VObject *Parse_MIME_FromFile(FILE * file);
    -
    47#endif
    -
    48
    -
    49#if defined(__CPLUSPLUS__) || defined(__cplusplus)
    -
    50}
    -
    51
    -
    52#endif
    -
    53
    -
    54#endif /* VCC_H */
    -
    VObject
    Definition: vobject.c:43
    +
    1 /***************************************************************************
    +
    2 (C) Copyright 1996 Apple Computer, Inc., AT&T Corp., International
    +
    3 Business Machines Corporation and Siemens Rolm Communications Inc.
    +
    4 
    +
    5 For purposes of this license notice, the term Licensors shall mean,
    +
    6 collectively, Apple Computer, Inc., AT&T Corp., International
    +
    7 Business Machines Corporation and Siemens Rolm Communications Inc.
    +
    8 The term Licensor shall mean any of the Licensors.
    +
    9 
    +
    10 Subject to acceptance of the following conditions, permission is hereby
    +
    11 granted by Licensors without the need for written agreement and without
    +
    12 license or royalty fees, to use, copy, modify and distribute this
    +
    13 software for any purpose.
    +
    14 
    +
    15 The above copyright notice and the following four paragraphs must be
    +
    16 reproduced in all copies of this software and any software including
    +
    17 this software.
    +
    18 
    +
    19 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS AND NO LICENSOR SHALL HAVE
    +
    20 ANY OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR
    +
    21 MODIFICATIONS.
    +
    22 
    +
    23 IN NO EVENT SHALL ANY LICENSOR BE LIABLE TO ANY PARTY FOR DIRECT,
    +
    24 INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES OR LOST PROFITS ARISING OUT
    +
    25 OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
    +
    26 DAMAGE.
    +
    27 
    +
    28 EACH LICENSOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, EXPRESS OR IMPLIED,
    +
    29 INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF NONINFRINGEMENT OR THE
    +
    30 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    +
    31 PURPOSE.
    +
    32 
    +
    33 The software is provided with RESTRICTED RIGHTS. Use, duplication, or
    +
    34 disclosure by the government are subject to restrictions set forth in
    +
    35 DFARS 252.227-7013 or 48 CFR 52.227-19, as applicable.
    +
    36 
    +
    37 ***************************************************************************/
    +
    38 
    +
    39 #ifndef VCC_H
    +
    40 #define VCC_H
    +
    41 
    +
    42 #include "libical_vcal_export.h"
    +
    43 #include "vobject.h"
    +
    44 
    +
    45 #if defined(__CPLUSPLUS__) || defined(__cplusplus)
    +
    46 extern "C"
    +
    47 {
    +
    48 #endif
    +
    49 
    +
    50  typedef void (*MimeErrorHandler) (char *);
    +
    51 
    +
    52  LIBICAL_VCAL_EXPORT void registerMimeErrorHandler(MimeErrorHandler);
    +
    53 
    +
    54  LIBICAL_VCAL_EXPORT VObject *Parse_MIME(const char *input, unsigned long len);
    +
    55 
    +
    56  LIBICAL_VCAL_EXPORT VObject *Parse_MIME_FromFileName(const char *fname);
    +
    57 
    +
    58 /* NOTE regarding Parse_MIME_FromFile
    +
    59 The function above, Parse_MIME_FromFile, comes in two flavors,
    +
    60 neither of which is exported from the DLL. Each version takes
    +
    61 a CFile or FILE* as a parameter, neither of which can be
    +
    62 passed across a DLL interface (at least that is my experience).
    +
    63 If you are linking this code into your build directly then
    +
    64 you may find them a more convenient API that the other flavors
    +
    65 that take a file name. If you use them with the DLL LIB you
    +
    66 will get a link error.
    +
    67 */
    +
    68 
    +
    69 #ifdef INCLUDEMFC
    +
    70  LIBICAL_VCAL_EXPORT VObject *Parse_MIME_FromFile(CFile * file);
    +
    71 #else
    +
    72  LIBICAL_VCAL_EXPORT VObject *Parse_MIME_FromFile(FILE * file);
    +
    73 #endif
    +
    74 
    +
    75 #if defined(__CPLUSPLUS__) || defined(__cplusplus)
    +
    76 }
    +
    77 
    +
    78 #endif
    +
    79 
    +
    80 #endif /* VCC_H */
    +
    VObject
    Definition: vobject.c:69
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/vcomponent__cxx_8h.html b/apidocs/vcomponent__cxx_8h.html index d52997d2..d25b1a7b 100644 --- a/apidocs/vcomponent__cxx_8h.html +++ b/apidocs/vcomponent__cxx_8h.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: vcomponent_cxx.h File Reference @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */ -
    vcomponent_cxx.h File Reference
    +
    +
    vcomponent_cxx.h File Reference
    @@ -78,7 +79,7 @@ $(function() {

    Go to the source code of this file.

    - @@ -106,21 +107,24 @@ Data Structures

    +

    Data Structures

    class  LibICal::VAgenda
     
    class  LibICal::XStandard
     
    - -

    +

    Typedefs

    +
    typedef ICPointerHolder< LibICal::VComponent > VComponentTmpPtr
     

    Detailed Description

    -

    C++ classes for the icalcomponent wrapper (VToDo VEvent, etc..).

    +

    C++ classes for the icalcomponent wrapper (VToDo VEvent, etc..).

    Author
    fnguyen (12/10/01)
    -

    SPDX-FileCopyrightText: 2001, Critical Path

    -

    SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0

    +

    (C) COPYRIGHT 2001, Critical Path

    +

    This library is free software; you can redistribute it and/or modify it under the terms of either:

    +

    The LGPL as published by the Free Software Foundation, version 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html

    +

    Or:

    +

    The Mozilla Public License Version 2.0. You may obtain a copy of the License at https://www.mozilla.org/MPL/

    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/vcomponent__cxx_8h_source.html b/apidocs/vcomponent__cxx_8h_source.html index e096d8fe..2448f03d 100644 --- a/apidocs/vcomponent__cxx_8h_source.html +++ b/apidocs/vcomponent__cxx_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: vcomponent_cxx.h Source File @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    -
    vcomponent_cxx.h
    +
    +
    vcomponent_cxx.h
    -Go to the documentation of this file.
    1
    -
    12#ifndef ICAL_VCOMPONENT_CXX_H
    -
    13#define ICAL_VCOMPONENT_CXX_H
    -
    14
    -
    15#include "libical_ical_export.h"
    -
    16#include "icptrholder_cxx.h"
    -
    17
    -
    18extern "C"
    -
    19{
    -
    20#include "icalerror.h"
    -
    21#include "icalcomponent.h"
    -
    22}
    -
    23
    -
    24#include <string>
    -
    25
    -
    26namespace LibICal
    -
    27{
    -
    28
    -
    29class ICalProperty;
    -
    30
    -
    39class LIBICAL_ICAL_EXPORT VComponent
    -
    40{
    -
    41public:
    -
    42 VComponent();
    -
    43 VComponent(const VComponent &);
    -
    44 VComponent &operator=(const VComponent &);
    -
    45 virtual ~VComponent();
    -
    46
    -
    47 explicit VComponent(icalcomponent *v);
    -
    48 explicit VComponent(const std::string &str);
    -
    49 explicit VComponent(const icalcomponent_kind &kind);
    -
    50
    -
    51 operator icalcomponent *()
    -
    52 {
    -
    53 return imp;
    -
    54 }
    -
    55
    -
    56 void new_from_string(const std::string &str);
    -
    57
    -
    58 // detach imp to this object. use with caution. it would cause
    -
    59 // memory leak if you are not careful.
    -
    60 void detach();
    -
    61
    -
    62public:
    -
    63 std::string as_ical_string();
    -
    64 bool is_valid();
    -
    65 icalcomponent_kind isa();
    -
    66 int isa_component(void *component);
    -
    67
    -
    69 void add_property(ICalProperty *property);
    -
    70 void remove_property(ICalProperty *property);
    -
    71 int count_properties(const icalproperty_kind &kind);
    -
    72
    -
    73 // Iterate through the properties
    -
    74 ICalProperty *get_current_property();
    -
    75 ICalProperty *get_first_property(const icalproperty_kind &kind);
    -
    76 ICalProperty *get_next_property(const icalproperty_kind &kind);
    -
    77
    -
    78 // Working with components
    -
    79
    -
    85 VComponent *get_inner();
    -
    86
    -
    87 void add_component(VComponent *child);
    -
    88 void remove_component(VComponent *child);
    -
    89 int count_components(const icalcomponent_kind &kind);
    -
    90
    -
    100 VComponent *get_current_component();
    -
    101 VComponent *get_first_component(const icalcomponent_kind &kind);
    -
    102 VComponent *get_next_component(const icalcomponent_kind &kind);
    -
    103
    -
    105 icalcompiter begin_component(const icalcomponent_kind &kind);
    -
    106 icalcompiter end_component(const icalcomponent_kind &kind);
    -
    107 VComponent *next(icalcompiter *i);
    -
    108 VComponent *prev(icalcompiter *i);
    -
    109 VComponent *current(icalcompiter *i);
    -
    110
    -
    112 int count_errors();
    -
    113
    -
    115 void strip_errors();
    -
    116
    -
    118 void convert_errors();
    -
    119
    -
    121 static icalcomponent_kind string_to_kind(const std::string &str);
    -
    122 static std::string kind_to_string(const icalcomponent_kind &kind);
    -
    123
    -
    124public:
    -
    125 struct icaltimetype get_dtstart() const;
    -
    126 void set_dtstart(const struct icaltimetype &v);
    -
    127
    -
    139 struct icaltimetype get_dtend() const;
    -
    140 void set_dtend(const struct icaltimetype &v);
    -
    141
    -
    142 struct icaltimetype get_due() const;
    -
    143 void set_due(const struct icaltimetype &v);
    -
    144
    -
    145 struct icaldurationtype get_duration() const;
    -
    146 void set_duration(const struct icaldurationtype &v);
    -
    147
    -
    148 icalproperty_method get_method() const;
    -
    149 void set_method(const icalproperty_method &method);
    -
    150
    -
    151 struct icaltimetype get_dtstamp() const;
    -
    152 void set_dtstamp(const struct icaltimetype &v);
    -
    153
    -
    154 std::string get_summary() const;
    -
    155 void set_summary(const std::string &v);
    -
    156
    -
    157 std::string get_location() const;
    -
    158 void set_location(const std::string &v);
    -
    159
    -
    160 std::string get_description() const;
    -
    161 void set_description(const std::string &v);
    -
    162
    -
    163 std::string get_comment() const;
    -
    164 void set_comment(const std::string &v);
    -
    165
    -
    166 std::string get_uid() const;
    -
    167 void set_uid(const std::string &v);
    -
    168
    -
    169 std::string get_relcalid() const;
    -
    170 void set_relcalid(const std::string &v);
    -
    171
    -
    172 struct icaltimetype get_recurrenceid() const;
    -
    173 void set_recurrenceid(const struct icaltimetype &v);
    -
    174
    -
    175 int get_sequence() const;
    -
    176 void set_sequence(const int &v);
    -
    177
    -
    178 int get_status() const;
    -
    179 void set_status(const enum icalproperty_status &v);
    -
    180
    -
    181public:
    -
    186 VComponent *get_first_real_component();
    -
    187
    -
    192 virtual struct icaltime_span get_span();
    -
    193
    -
    194 int recurrence_is_excluded(struct icaltimetype *dtstart, struct icaltimetype *recurtime);
    -
    195
    -
    196public:
    -
    197 /* helper functions for adding/removing/updating property and sub-components */
    -
    198
    -
    200
    -
    201 bool remove(VComponent &, bool ignoreValue);
    -
    202 bool update(VComponent &, bool removeMissing);
    -
    203 bool add(VComponent &);
    -
    204
    -
    205private:
    -
    206 /* Internal operations. They are private, and you should not be using them. */
    -
    207 VComponent *get_parent();
    -
    208 void set_parent(VComponent *parent);
    -
    209
    -
    210 char *quote_ical_string(char *str);
    -
    211
    -
    212private:
    -
    213 icalcomponent *imp;
    -
    214};
    -
    215
    -
    216class LIBICAL_ICAL_EXPORT VCalendar: public VComponent
    -
    217{
    -
    218public:
    -
    219 VCalendar();
    -
    220 VCalendar(const VCalendar &);
    -
    221 VCalendar &operator=(const VCalendar &);
    -
    222 ~VCalendar();
    -
    223
    -
    224 explicit VCalendar(icalcomponent *v);
    -
    225 explicit VCalendar(const std::string &str);
    -
    226};
    -
    227
    -
    228class LIBICAL_ICAL_EXPORT VEvent: public VComponent
    -
    229{
    -
    230public:
    -
    231 VEvent();
    -
    232 VEvent(const VEvent &);
    -
    233 VEvent &operator=(const VEvent &);
    -
    234 ~VEvent();
    -
    235
    -
    236 explicit VEvent(icalcomponent *v);
    -
    237 explicit VEvent(const std::string &str);
    -
    238};
    -
    239
    -
    240class LIBICAL_ICAL_EXPORT VToDo: public VComponent
    -
    241{
    -
    242public:
    -
    243 VToDo();
    -
    244 VToDo(const VToDo &);
    -
    245 VToDo &operator=(const VToDo &);
    -
    246 ~VToDo();
    -
    247
    -
    248 explicit VToDo(icalcomponent *v);
    -
    249 explicit VToDo(const std::string &str);
    -
    250};
    -
    251
    -
    252class LIBICAL_ICAL_EXPORT VAgenda: public VComponent
    -
    253{
    -
    254public:
    -
    255 VAgenda();
    -
    256 VAgenda(const VAgenda &);
    -
    257 VAgenda &operator=(const VAgenda &);
    -
    258 ~VAgenda();
    -
    259
    -
    260 explicit VAgenda(icalcomponent *v);
    -
    261 explicit VAgenda(const std::string &str);
    -
    262};
    -
    263
    -
    264class LIBICAL_ICAL_EXPORT VQuery: public VComponent
    -
    265{
    -
    266public:
    -
    267 VQuery();
    -
    268 VQuery(const VQuery &);
    -
    269 VQuery &operator=(const VQuery &);
    -
    270 ~VQuery();
    -
    271
    -
    272 explicit VQuery(icalcomponent *v);
    -
    273 explicit VQuery(const std::string &str);
    -
    274};
    -
    275
    -
    276class LIBICAL_ICAL_EXPORT VJournal: public VComponent
    -
    277{
    -
    278public:
    -
    279 VJournal();
    -
    280 VJournal(const VJournal &);
    -
    281 VJournal &operator=(const VJournal &);
    -
    282 ~VJournal();
    -
    283
    -
    284 explicit VJournal(icalcomponent *v);
    -
    285 explicit VJournal(const std::string &str);
    -
    286};
    -
    287
    -
    288class LIBICAL_ICAL_EXPORT VAlarm: public VComponent
    -
    289{
    -
    290public:
    -
    291 VAlarm();
    -
    292 VAlarm(const VAlarm &);
    -
    293 VAlarm &operator=(const VAlarm &);
    -
    294 ~VAlarm();
    -
    295
    -
    296 explicit VAlarm(icalcomponent *v);
    -
    297 explicit VAlarm(const std::string &str);
    -
    298
    -
    304 icalrequeststatus getTriggerTime(VComponent &c, struct icaltriggertype *tr);
    -
    305};
    -
    306
    -
    307class LIBICAL_ICAL_EXPORT VFreeBusy: public VComponent
    -
    308{
    -
    309public:
    -
    310 VFreeBusy();
    -
    311 VFreeBusy(const VFreeBusy &);
    -
    312 VFreeBusy &operator=(const VFreeBusy &);
    -
    313 ~VFreeBusy();
    -
    314
    -
    315 explicit VFreeBusy(icalcomponent *v);
    -
    316 explicit VFreeBusy(const std::string &str);
    -
    317};
    -
    318
    -
    319class LIBICAL_ICAL_EXPORT VTimezone: public VComponent
    -
    320{
    -
    321public:
    -
    322 VTimezone();
    -
    323 VTimezone(const VTimezone &);
    -
    324 VTimezone &operator=(const VTimezone &);
    -
    325 ~VTimezone();
    -
    326
    -
    327 explicit VTimezone(icalcomponent *v);
    -
    328 explicit VTimezone(const std::string &str);
    -
    329};
    -
    330
    -
    331class LIBICAL_ICAL_EXPORT XStandard: public VComponent
    -
    332{
    -
    333public:
    -
    334 XStandard();
    -
    335 XStandard(const XStandard &);
    -
    336 XStandard &operator=(const XStandard &);
    -
    337 ~XStandard();
    -
    338
    -
    339 explicit XStandard(icalcomponent *v);
    -
    340 explicit XStandard(const std::string &str);
    -
    341};
    -
    342
    -
    343class LIBICAL_ICAL_EXPORT XDaylight: public VComponent
    -
    344{
    -
    345public:
    -
    346 XDaylight();
    -
    347 XDaylight(const XDaylight &);
    -
    348 XDaylight &operator=(const XDaylight &);
    -
    349 ~XDaylight();
    -
    350
    -
    351 explicit XDaylight(icalcomponent *v);
    -
    352 explicit XDaylight(const std::string &str);
    -
    353};
    -
    354
    -
    355} // namespace LibICal;
    -
    356
    -
    357typedef ICPointerHolder < LibICal::VComponent > VComponentTmpPtr;
    -
    358
    -
    359#endif /* ICAL_VCOMPONENT_H */
    -
    ICPointerHolder
    Definition: icptrholder_cxx.h:40
    -
    LibICal::ICalProperty
    Definition: icalproperty_cxx.h:33
    -
    LibICal::VAgenda
    Definition: vcomponent_cxx.h:253
    -
    LibICal::VAlarm
    Definition: vcomponent_cxx.h:289
    +Go to the documentation of this file.
    1 
    +
    20 #ifndef ICAL_VCOMPONENT_CXX_H
    +
    21 #define ICAL_VCOMPONENT_CXX_H
    +
    22 
    +
    23 #include "libical_ical_export.h"
    +
    24 #include "icptrholder_cxx.h"
    +
    25 
    +
    26 extern "C"
    +
    27 {
    +
    28 #include "icalerror.h"
    +
    29 #include "icalcomponent.h"
    +
    30 }
    +
    31 
    +
    32 #include <string>
    +
    33 
    +
    34 namespace LibICal
    +
    35 {
    +
    36 
    +
    37 class ICalProperty;
    +
    38 
    +
    47 class LIBICAL_ICAL_EXPORT VComponent
    +
    48 {
    +
    49 public:
    +
    50  VComponent();
    +
    51  VComponent(const VComponent &);
    +
    52  VComponent &operator=(const VComponent &);
    +
    53  virtual ~VComponent();
    +
    54 
    +
    55  explicit VComponent(icalcomponent *v);
    +
    56  explicit VComponent(const std::string &str);
    +
    57  explicit VComponent(const icalcomponent_kind &kind);
    +
    58 
    +
    59  operator icalcomponent *()
    +
    60  {
    +
    61  return imp;
    +
    62  }
    +
    63 
    +
    64  void new_from_string(const std::string &str);
    +
    65 
    +
    66  // detach imp to this object. use with caution. it would cause
    +
    67  // memory leak if you are not careful.
    +
    68  void detach();
    +
    69 
    +
    70 public:
    +
    71  std::string as_ical_string();
    +
    72  bool is_valid();
    +
    73  icalcomponent_kind isa();
    +
    74  int isa_component(void *component);
    +
    75 
    +
    77  void add_property(ICalProperty *property);
    +
    78  void remove_property(ICalProperty *property);
    +
    79  int count_properties(const icalproperty_kind &kind);
    +
    80 
    +
    81  // Iterate through the properties
    +
    82  ICalProperty *get_current_property();
    +
    83  ICalProperty *get_first_property(const icalproperty_kind &kind);
    +
    84  ICalProperty *get_next_property(const icalproperty_kind &kind);
    +
    85 
    +
    86  // Working with components
    +
    87 
    +
    93  VComponent *get_inner();
    +
    94 
    +
    95  void add_component(VComponent *child);
    +
    96  void remove_component(VComponent *child);
    +
    97  int count_components(const icalcomponent_kind &kind);
    +
    98 
    +
    108  VComponent *get_current_component();
    +
    109  VComponent *get_first_component(const icalcomponent_kind &kind);
    +
    110  VComponent *get_next_component(const icalcomponent_kind &kind);
    +
    111 
    +
    113  icalcompiter begin_component(const icalcomponent_kind &kind);
    +
    114  icalcompiter end_component(const icalcomponent_kind &kind);
    +
    115  VComponent *next(icalcompiter *i);
    +
    116  VComponent *prev(icalcompiter *i);
    +
    117  VComponent *current(icalcompiter *i);
    +
    118 
    +
    120  int count_errors();
    +
    121 
    +
    123  void strip_errors();
    +
    124 
    +
    126  void convert_errors();
    +
    127 
    +
    129  static icalcomponent_kind string_to_kind(const std::string &str);
    +
    130  static std::string kind_to_string(const icalcomponent_kind &kind);
    +
    131 
    +
    132 public:
    +
    133  struct icaltimetype get_dtstart() const;
    +
    134  void set_dtstart(const struct icaltimetype &v);
    +
    135 
    +
    147  struct icaltimetype get_dtend() const;
    +
    148  void set_dtend(const struct icaltimetype &v);
    +
    149 
    +
    150  struct icaltimetype get_due() const;
    +
    151  void set_due(const struct icaltimetype &v);
    +
    152 
    +
    153  struct icaldurationtype get_duration() const;
    +
    154  void set_duration(const struct icaldurationtype &v);
    +
    155 
    +
    156  icalproperty_method get_method() const;
    +
    157  void set_method(const icalproperty_method &method);
    +
    158 
    +
    159  struct icaltimetype get_dtstamp() const;
    +
    160  void set_dtstamp(const struct icaltimetype &v);
    +
    161 
    +
    162  std::string get_summary() const;
    +
    163  void set_summary(const std::string &v);
    +
    164 
    +
    165  std::string get_location() const;
    +
    166  void set_location(const std::string &v);
    +
    167 
    +
    168  std::string get_description() const;
    +
    169  void set_description(const std::string &v);
    +
    170 
    +
    171  std::string get_comment() const;
    +
    172  void set_comment(const std::string &v);
    +
    173 
    +
    174  std::string get_uid() const;
    +
    175  void set_uid(const std::string &v);
    +
    176 
    +
    177  std::string get_relcalid() const;
    +
    178  void set_relcalid(const std::string &v);
    +
    179 
    +
    180  struct icaltimetype get_recurrenceid() const;
    +
    181  void set_recurrenceid(const struct icaltimetype &v);
    +
    182 
    +
    183  int get_sequence() const;
    +
    184  void set_sequence(const int &v);
    +
    185 
    +
    186  int get_status() const;
    +
    187  void set_status(const enum icalproperty_status &v);
    +
    188 
    +
    189 public:
    +
    194  VComponent *get_first_real_component();
    +
    195 
    +
    200  virtual struct icaltime_span get_span();
    +
    201 
    +
    202  int recurrence_is_excluded(struct icaltimetype *dtstart, struct icaltimetype *recurtime);
    +
    203 
    +
    204 public:
    +
    205  /* helper functions for adding/removing/updating property and sub-components */
    +
    206 
    +
    208 
    +
    209  bool remove(VComponent &, bool ignoreValue);
    +
    210  bool update(VComponent &, bool removeMissing);
    +
    211  bool add(VComponent &);
    +
    212 
    +
    213 private:
    +
    214  /* Internal operations. They are private, and you should not be using them. */
    +
    215  VComponent *get_parent();
    +
    216  void set_parent(VComponent *parent);
    +
    217 
    +
    218  char *quote_ical_string(char *str);
    +
    219 
    +
    220 private:
    +
    221  icalcomponent *imp;
    +
    222 };
    +
    223 
    +
    224 class LIBICAL_ICAL_EXPORT VCalendar: public VComponent
    +
    225 {
    +
    226 public:
    +
    227  VCalendar();
    +
    228  VCalendar(const VCalendar &);
    +
    229  VCalendar &operator=(const VCalendar &);
    +
    230  ~VCalendar();
    +
    231 
    +
    232  explicit VCalendar(icalcomponent *v);
    +
    233  explicit VCalendar(const std::string &str);
    +
    234 };
    +
    235 
    +
    236 class LIBICAL_ICAL_EXPORT VEvent: public VComponent
    +
    237 {
    +
    238 public:
    +
    239  VEvent();
    +
    240  VEvent(const VEvent &);
    +
    241  VEvent &operator=(const VEvent &);
    +
    242  ~VEvent();
    +
    243 
    +
    244  explicit VEvent(icalcomponent *v);
    +
    245  explicit VEvent(const std::string &str);
    +
    246 };
    +
    247 
    +
    248 class LIBICAL_ICAL_EXPORT VToDo: public VComponent
    +
    249 {
    +
    250 public:
    +
    251  VToDo();
    +
    252  VToDo(const VToDo &);
    +
    253  VToDo &operator=(const VToDo &);
    +
    254  ~VToDo();
    +
    255 
    +
    256  explicit VToDo(icalcomponent *v);
    +
    257  explicit VToDo(const std::string &str);
    +
    258 };
    +
    259 
    +
    260 class LIBICAL_ICAL_EXPORT VAgenda: public VComponent
    +
    261 {
    +
    262 public:
    +
    263  VAgenda();
    +
    264  VAgenda(const VAgenda &);
    +
    265  VAgenda &operator=(const VAgenda &);
    +
    266  ~VAgenda();
    +
    267 
    +
    268  explicit VAgenda(icalcomponent *v);
    +
    269  explicit VAgenda(const std::string &str);
    +
    270 };
    +
    271 
    +
    272 class LIBICAL_ICAL_EXPORT VQuery: public VComponent
    +
    273 {
    +
    274 public:
    +
    275  VQuery();
    +
    276  VQuery(const VQuery &);
    +
    277  VQuery &operator=(const VQuery &);
    +
    278  ~VQuery();
    +
    279 
    +
    280  explicit VQuery(icalcomponent *v);
    +
    281  explicit VQuery(const std::string &str);
    +
    282 };
    +
    283 
    +
    284 class LIBICAL_ICAL_EXPORT VJournal: public VComponent
    +
    285 {
    +
    286 public:
    +
    287  VJournal();
    +
    288  VJournal(const VJournal &);
    +
    289  VJournal &operator=(const VJournal &);
    +
    290  ~VJournal();
    +
    291 
    +
    292  explicit VJournal(icalcomponent *v);
    +
    293  explicit VJournal(const std::string &str);
    +
    294 };
    +
    295 
    +
    296 class LIBICAL_ICAL_EXPORT VAlarm: public VComponent
    +
    297 {
    +
    298 public:
    +
    299  VAlarm();
    +
    300  VAlarm(const VAlarm &);
    +
    301  VAlarm &operator=(const VAlarm &);
    +
    302  ~VAlarm();
    +
    303 
    +
    304  explicit VAlarm(icalcomponent *v);
    +
    305  explicit VAlarm(const std::string &str);
    +
    306 
    +
    312  icalrequeststatus getTriggerTime(VComponent &c, struct icaltriggertype *tr);
    +
    313 };
    +
    314 
    +
    315 class LIBICAL_ICAL_EXPORT VFreeBusy: public VComponent
    +
    316 {
    +
    317 public:
    +
    318  VFreeBusy();
    +
    319  VFreeBusy(const VFreeBusy &);
    +
    320  VFreeBusy &operator=(const VFreeBusy &);
    +
    321  ~VFreeBusy();
    +
    322 
    +
    323  explicit VFreeBusy(icalcomponent *v);
    +
    324  explicit VFreeBusy(const std::string &str);
    +
    325 };
    +
    326 
    +
    327 class LIBICAL_ICAL_EXPORT VTimezone: public VComponent
    +
    328 {
    +
    329 public:
    +
    330  VTimezone();
    +
    331  VTimezone(const VTimezone &);
    +
    332  VTimezone &operator=(const VTimezone &);
    +
    333  ~VTimezone();
    +
    334 
    +
    335  explicit VTimezone(icalcomponent *v);
    +
    336  explicit VTimezone(const std::string &str);
    +
    337 };
    +
    338 
    +
    339 class LIBICAL_ICAL_EXPORT XStandard: public VComponent
    +
    340 {
    +
    341 public:
    +
    342  XStandard();
    +
    343  XStandard(const XStandard &);
    +
    344  XStandard &operator=(const XStandard &);
    +
    345  ~XStandard();
    +
    346 
    +
    347  explicit XStandard(icalcomponent *v);
    +
    348  explicit XStandard(const std::string &str);
    +
    349 };
    +
    350 
    +
    351 class LIBICAL_ICAL_EXPORT XDaylight: public VComponent
    +
    352 {
    +
    353 public:
    +
    354  XDaylight();
    +
    355  XDaylight(const XDaylight &);
    +
    356  XDaylight &operator=(const XDaylight &);
    +
    357  ~XDaylight();
    +
    358 
    +
    359  explicit XDaylight(icalcomponent *v);
    +
    360  explicit XDaylight(const std::string &str);
    +
    361 };
    +
    362 
    +
    363 } // namespace LibICal;
    +
    364 
    +
    365 typedef ICPointerHolder < LibICal::VComponent > VComponentTmpPtr;
    +
    366 
    +
    367 #endif /* ICAL_VCOMPONENT_H */
    +
    ICPointerHolder
    Definition: icptrholder_cxx.h:48
    +
    LibICal::ICalProperty
    Definition: icalproperty_cxx.h:41
    +
    LibICal::VAgenda
    Definition: vcomponent_cxx.h:261
    +
    LibICal::VAlarm
    Definition: vcomponent_cxx.h:297
    LibICal::VAlarm::getTriggerTime
    icalrequeststatus getTriggerTime(VComponent &c, struct icaltriggertype *tr)
    -
    LibICal::VCalendar
    Definition: vcomponent_cxx.h:217
    -
    LibICal::VComponent
    A class wrapping the libical icalcomponent functions.
    Definition: vcomponent_cxx.h:40
    +
    LibICal::VCalendar
    Definition: vcomponent_cxx.h:225
    +
    LibICal::VComponent
    A class wrapping the libical icalcomponent functions.
    Definition: vcomponent_cxx.h:48
    +
    LibICal::VComponent::get_current_component
    VComponent * get_current_component()
    Iterate through components.
    LibICal::VComponent::convert_errors
    void convert_errors()
    Convert some X-LIC-ERROR properties into RETURN-STATUS properties.
    -
    LibICal::VComponent::get_current_component
    VComponent * get_current_component()
    Iterate through components.
    -
    LibICal::VComponent::get_inner
    VComponent * get_inner()
    LibICal::VComponent::count_errors
    int count_errors()
    Working with embedded error properties.
    +
    LibICal::VComponent::get_first_real_component
    VComponent * get_first_real_component()
    LibICal::VComponent::string_to_kind
    static icalcomponent_kind string_to_kind(const std::string &str)
    Kind conversion routines.
    LibICal::VComponent::add_property
    void add_property(ICalProperty *property)
    Working with properties.
    LibICal::VComponent::strip_errors
    void strip_errors()
    Remove all X-LIC-ERROR properties.
    LibICal::VComponent::remove
    bool remove(VComponent &, bool ignoreValue)
    Note: the VComponent kind have to be the same.
    +
    LibICal::VComponent::get_inner
    VComponent * get_inner()
    LibICal::VComponent::begin_component
    icalcompiter begin_component(const icalcomponent_kind &kind)
    Using external iterators.
    -
    LibICal::VComponent::get_first_real_component
    VComponent * get_first_real_component()
    -
    LibICal::VEvent
    Definition: vcomponent_cxx.h:229
    -
    LibICal::VFreeBusy
    Definition: vcomponent_cxx.h:308
    -
    LibICal::VJournal
    Definition: vcomponent_cxx.h:277
    -
    LibICal::VQuery
    Definition: vcomponent_cxx.h:265
    -
    LibICal::VTimezone
    Definition: vcomponent_cxx.h:320
    -
    LibICal::VToDo
    Definition: vcomponent_cxx.h:241
    -
    LibICal::XDaylight
    Definition: vcomponent_cxx.h:344
    -
    LibICal::XStandard
    Definition: vcomponent_cxx.h:332
    +
    LibICal::VEvent
    Definition: vcomponent_cxx.h:237
    +
    LibICal::VFreeBusy
    Definition: vcomponent_cxx.h:316
    +
    LibICal::VJournal
    Definition: vcomponent_cxx.h:285
    +
    LibICal::VQuery
    Definition: vcomponent_cxx.h:273
    +
    LibICal::VTimezone
    Definition: vcomponent_cxx.h:328
    +
    LibICal::VToDo
    Definition: vcomponent_cxx.h:249
    +
    LibICal::XDaylight
    Definition: vcomponent_cxx.h:352
    +
    LibICal::XStandard
    Definition: vcomponent_cxx.h:340
    icalerror.h
    Error handling for libical.
    icptrholder_cxx.h
    C++ template classes for managing C++ pointers returned by VComponent::get_..._component,...
    -
    icalcompiter
    Definition: icalcomponent.h:29
    -
    icalcomponent_impl
    Definition: icalcomponent.c:28
    -
    icaldurationtype
    A struct representing a duration.
    Definition: icalduration.h:28
    -
    icaltime_span
    Definition: icaltime.h:88
    -
    icaltimetype
    Definition: icaltime.h:97
    -
    icaltriggertype
    Definition: icaltypes.h:33
    +
    icalcompiter
    Definition: icalcomponent.h:36
    +
    icalcomponent_impl
    Definition: icalcomponent.c:36
    +
    icaldurationtype
    A struct representing a duration.
    Definition: icalduration.h:37
    +
    icaltime_span
    Definition: icaltime.h:96
    +
    icaltimetype
    Definition: icaltime.h:105
    +
    icaltriggertype
    Definition: icaltypes.h:40
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
    diff --git a/apidocs/vobject_8h_source.html b/apidocs/vobject_8h_source.html index b8143eef..9285e5c5 100644 --- a/apidocs/vobject_8h_source.html +++ b/apidocs/vobject_8h_source.html @@ -2,8 +2,8 @@ - - + + Libical API Documentation: vobject.h Source File @@ -19,9 +19,10 @@
    - - + @@ -29,22 +30,21 @@
    -
    Libical API Documentation 3.1 +
    +
    Libical API Documentation +  3.0
    - + +/* @license-end */
    -
    vobject.h
    +
    +
    vobject.h
    -
    1/***************************************************************************
    -
    2SPDX-FileCopyrightText: 1996 Apple Computer, Inc., AT&T Corp., International
    -
    3Business Machines Corporation and Siemens Rolm Communications Inc.
    -
    4
    -
    5SPDX-License-Identifier: LicenseRef-APPLEMIT
    -
    6
    -
    7The software is provided with RESTRICTED RIGHTS. Use, duplication, or
    -
    8disclosure by the government are subject to restrictions set forth in
    -
    9DFARS 252.227-7013 or 48 CFR 52.227-19, as applicable.
    -
    10
    -
    11***************************************************************************/
    -
    12
    -
    13/*
    -
    14
    -
    15The vCard/vCalendar C interface is implemented in the set
    -
    16of files as follows:
    -
    17
    -
    18vcc.y, yacc source, and vcc.c, the yacc output you will use
    -
    19implements the core parser
    -
    20
    -
    21vobject.c implements an API that insulates the caller from
    -
    22the parser and changes in the vCard/vCalendar BNF
    -
    23
    -
    24vcc.h and vobject.h are header files for their .c counterparts
    -
    25
    -
    26vcaltmp.h and vcaltmp.c implement vCalendar "macro" functions
    -
    27which you may find useful.
    -
    28
    -
    29test.c is a standalone test driver that exercises some of
    -
    30the features of the APIs provided. Invoke test.exe on a
    -
    31VCARD/VCALENDAR input text file and you will see the pretty
    -
    32print output of the internal representation (this pretty print
    -
    33output should give you a good idea of how the internal
    -
    34representation looks like -- there is one such output in the
    -
    35following too). Also, a file with the .out suffix is generated
    -
    36to show that the internal representation can be written back
    -
    37in the original text format.
    -
    38
    -
    39For more information on this API see the readme.txt file
    -
    40which accompanied this distribution.
    -
    41*/
    -
    42
    -
    43#ifndef VOBJECT_H
    -
    44#define VOBJECT_H
    -
    45
    -
    46#include "libical_vcal_export.h"
    -
    47#include <stdlib.h>
    -
    48#include <stdio.h>
    -
    49
    -
    50#if defined(__CPLUSPLUS__) || defined(__cplusplus)
    -
    51extern "C"
    -
    52{
    -
    53#endif
    -
    54
    -
    55#define VC7bitProp "7BIT"
    -
    56#define VC8bitProp "8BIT"
    -
    57#define VCAAlarmProp "AALARM"
    -
    58#define VCAdditionalNamesProp "ADDN"
    -
    59#define VCAdrProp "ADR"
    -
    60#define VCAgentProp "AGENT"
    -
    61#define VCAIFFProp "AIFF"
    -
    62#define VCAOLProp "AOL"
    -
    63#define VCAppleLinkProp "APPLELINK"
    -
    64#define VCAttachProp "ATTACH"
    -
    65#define VCAttendeeProp "ATTENDEE"
    -
    66#define VCATTMailProp "ATTMAIL"
    -
    67#define VCAudioContentProp "AUDIOCONTENT"
    -
    68#define VCAVIProp "AVI"
    -
    69#define VCBase64Prop "BASE64"
    -
    70#define VCBBSProp "BBS"
    -
    71#define VCBirthDateProp "BDAY"
    -
    72#define VCBMPProp "BMP"
    -
    73#define VCBodyProp "BODY"
    -
    74#define VCBusinessRoleProp "ROLE"
    -
    75#define VCCalProp "VCALENDAR"
    -
    76#define VCCaptionProp "CAP"
    -
    77#define VCCardProp "VCARD"
    -
    78#define VCCarProp "CAR"
    -
    79#define VCCategoriesProp "CATEGORIES"
    -
    80#define VCCellularProp "CELL"
    -
    81#define VCCGMProp "CGM"
    -
    82#define VCCharSetProp "CS"
    -
    83#define VCCIDProp "CID"
    -
    84#define VCCISProp "CIS"
    -
    85#define VCCityProp "L"
    -
    86#define VCClassProp "CLASS"
    -
    87#define VCCommentProp "NOTE"
    -
    88#define VCCompletedProp "COMPLETED"
    -
    89#define VCContentIDProp "CONTENT-ID"
    -
    90#define VCCountryNameProp "C"
    -
    91#define VCDAlarmProp "DALARM"
    -
    92#define VCDataSizeProp "DATASIZE"
    -
    93#define VCDayLightProp "DAYLIGHT"
    -
    94#define VCDCreatedProp "DCREATED"
    -
    95#define VCDeliveryLabelProp "LABEL"
    -
    96#define VCDescriptionProp "DESCRIPTION"
    -
    97#define VCDIBProp "DIB"
    -
    98#define VCDisplayStringProp "DISPLAYSTRING"
    -
    99#define VCDomesticProp "DOM"
    -
    100#define VCDTendProp "DTEND"
    -
    101#define VCDTstartProp "DTSTART"
    -
    102#define VCDueProp "DUE"
    -
    103#define VCEmailAddressProp "EMAIL"
    -
    104#define VCEncodingProp "ENCODING"
    -
    105#define VCEndProp "END"
    -
    106#define VCEventProp "VEVENT"
    -
    107#define VCEWorldProp "EWORLD"
    -
    108#define VCExNumProp "EXNUM"
    -
    109#define VCExpDateProp "EXDATE"
    -
    110#define VCExpectProp "EXPECT"
    -
    111#define VCExtAddressProp "EXT ADD"
    -
    112#define VCFamilyNameProp "F"
    -
    113#define VCFaxProp "FAX"
    -
    114#define VCFullNameProp "FN"
    -
    115#define VCGeoProp "GEO"
    -
    116#define VCGeoLocationProp "GEO"
    -
    117#define VCGIFProp "GIF"
    -
    118#define VCGivenNameProp "G"
    -
    119#define VCGroupingProp "Grouping"
    -
    120#define VCHomeProp "HOME"
    -
    121#define VCIBMMailProp "IBMMail"
    -
    122#define VCInlineProp "INLINE"
    -
    123#define VCInternationalProp "INTL"
    -
    124#define VCInternetProp "INTERNET"
    -
    125#define VCISDNProp "ISDN"
    -
    126#define VCJPEGProp "JPEG"
    -
    127#define VCLanguageProp "LANG"
    -
    128#define VCLastModifiedProp "LAST-MODIFIED"
    -
    129#define VCLastRevisedProp "REV"
    -
    130#define VCLocationProp "LOCATION"
    -
    131#define VCLogoProp "LOGO"
    -
    132#define VCMailerProp "MAILER"
    -
    133#define VCMAlarmProp "MALARM"
    -
    134#define VCMCIMailProp "MCIMAIL"
    -
    135#define VCMessageProp "MSG"
    -
    136#define VCMETProp "MET"
    -
    137#define VCModemProp "MODEM"
    -
    138#define VCMPEG2Prop "MPEG2"
    -
    139#define VCMPEGProp "MPEG"
    -
    140#define VCMSNProp "MSN"
    -
    141#define VCNamePrefixesProp "NPRE"
    -
    142#define VCNameProp "N"
    -
    143#define VCNameSuffixesProp "NSUF"
    -
    144#define VCNoteProp "NOTE"
    -
    145#define VCOrgNameProp "ORGNAME"
    -
    146#define VCOrgProp "ORG"
    -
    147#define VCOrgUnit2Prop "OUN2"
    -
    148#define VCOrgUnit3Prop "OUN3"
    -
    149#define VCOrgUnit4Prop "OUN4"
    -
    150#define VCOrgUnitProp "OUN"
    -
    151#define VCPagerProp "PAGER"
    -
    152#define VCPAlarmProp "PALARM"
    -
    153#define VCParcelProp "PARCEL"
    -
    154#define VCPartProp "PART"
    -
    155#define VCPCMProp "PCM"
    -
    156#define VCPDFProp "PDF"
    -
    157#define VCPGPProp "PGP"
    -
    158#define VCPhotoProp "PHOTO"
    -
    159#define VCPICTProp "PICT"
    -
    160#define VCPMBProp "PMB"
    -
    161#define VCPostalBoxProp "BOX"
    -
    162#define VCPostalCodeProp "PC"
    -
    163#define VCPostalProp "POSTAL"
    -
    164#define VCPowerShareProp "POWERSHARE"
    -
    165#define VCPreferredProp "PREF"
    -
    166#define VCPriorityProp "PRIORITY"
    -
    167#define VCProcedureNameProp "PROCEDURENAME"
    -
    168#define VCProdIdProp "PRODID"
    -
    169#define VCProdigyProp "PRODIGY"
    -
    170#define VCPronunciationProp "SOUND"
    -
    171#define VCPSProp "PS"
    -
    172#define VCPublicKeyProp "KEY"
    -
    173#define VCQPProp "QP"
    -
    174#define VCQuickTimeProp "QTIME"
    -
    175#define VCQuotedPrintableProp "QUOTED-PRINTABLE"
    -
    176#define VCRDateProp "RDATE"
    -
    177#define VCRegionProp "R"
    -
    178#define VCRelatedToProp "RELATED-TO"
    -
    179#define VCRepeatCountProp "REPEATCOUNT"
    -
    180#define VCResourcesProp "RESOURCES"
    -
    181#define VCRNumProp "RNUM"
    -
    182#define VCRoleProp "ROLE"
    -
    183#define VCRRuleProp "RRULE"
    -
    184#define VCRSVPProp "RSVP"
    -
    185#define VCRunTimeProp "RUNTIME"
    -
    186#define VCSequenceProp "SEQUENCE"
    -
    187#define VCSnoozeTimeProp "SNOOZETIME"
    -
    188#define VCStartProp "START"
    -
    189#define VCStatusProp "STATUS"
    -
    190#define VCStreetAddressProp "STREET"
    -
    191#define VCSubTypeProp "SUBTYPE"
    -
    192#define VCSummaryProp "SUMMARY"
    -
    193#define VCTelephoneProp "TEL"
    -
    194#define VCTIFFProp "TIFF"
    -
    195#define VCTimeZoneProp "TZ"
    -
    196#define VCTitleProp "TITLE"
    -
    197#define VCTLXProp "TLX"
    -
    198#define VCTodoProp "VTODO"
    -
    199#define VCTranspProp "TRANSP"
    -
    200#define VCUniqueStringProp "UID"
    -
    201#define VCURLProp "URL"
    -
    202#define VCURLValueProp "URLVAL"
    -
    203#define VCValueProp "VALUE"
    -
    204#define VCVersionProp "VERSION"
    -
    205#define VCVideoProp "VIDEO"
    -
    206#define VCVoiceProp "VOICE"
    -
    207#define VCWAVEProp "WAVE"
    -
    208#define VCWMFProp "WMF"
    -
    209#define VCWorkProp "WORK"
    -
    210#define VCX400Prop "X400"
    -
    211#define VCX509Prop "X509"
    -
    212#define VCXRuleProp "XRULE"
    -
    213
    -
    214/* Extensions */
    -
    215
    -
    216#define XPilotIdProp "X-PILOTID"
    -
    217#define XPilotStatusProp "X-PILOTSTAT"
    -
    218
    -
    219 typedef struct VObject VObject;
    -
    220
    -
    221 typedef struct VObjectIterator
    -
    222 {
    -
    223 VObject *start;
    -
    224 VObject *next;
    -
    225 } VObjectIterator;
    -
    226
    -
    227 LIBICAL_VCAL_EXPORT VObject *newVObject(const char *id);
    -
    228 LIBICAL_VCAL_EXPORT void deleteVObject(VObject *p);
    -
    229 LIBICAL_VCAL_EXPORT char *dupStr(const char *s, size_t size);
    -
    230 LIBICAL_VCAL_EXPORT void deleteStr(const char *p);
    -
    231 LIBICAL_VCAL_EXPORT void unUseStr(const char *s);
    -
    232
    -
    233 LIBICAL_VCAL_EXPORT void setVObjectName(VObject *o, const char *id);
    -
    234 LIBICAL_VCAL_EXPORT void setVObjectStringZValue(VObject *o, const char *s);
    -
    235 LIBICAL_VCAL_EXPORT void setVObjectStringZValue_(VObject *o, const char *s);
    -
    236 LIBICAL_VCAL_EXPORT void setVObjectUStringZValue(VObject *o, const wchar_t *s);
    -
    237 LIBICAL_VCAL_EXPORT void setVObjectUStringZValue_(VObject *o, const wchar_t *s);
    -
    238 LIBICAL_VCAL_EXPORT void setVObjectIntegerValue(VObject *o, unsigned int i);
    -
    239 LIBICAL_VCAL_EXPORT void setVObjectLongValue(VObject *o, unsigned long l);
    -
    240 LIBICAL_VCAL_EXPORT void setVObjectAnyValue(VObject *o, void *t);
    -
    241 LIBICAL_VCAL_EXPORT VObject *setValueWithSize(VObject *prop, void *val, unsigned int size);
    -
    242 LIBICAL_VCAL_EXPORT VObject *setValueWithSize_(VObject *prop, void *val, unsigned int size);
    -
    243
    -
    244 LIBICAL_VCAL_EXPORT const char *vObjectName(VObject *o);
    -
    245 LIBICAL_VCAL_EXPORT const char *vObjectStringZValue(VObject *o);
    -
    246 LIBICAL_VCAL_EXPORT const wchar_t *vObjectUStringZValue(VObject *o);
    -
    247 LIBICAL_VCAL_EXPORT unsigned int vObjectIntegerValue(VObject *o);
    -
    248 LIBICAL_VCAL_EXPORT unsigned long vObjectLongValue(VObject *o);
    -
    249 LIBICAL_VCAL_EXPORT void *vObjectAnyValue(VObject *o);
    -
    250 LIBICAL_VCAL_EXPORT VObject *vObjectVObjectValue(VObject *o);
    -
    251 LIBICAL_VCAL_EXPORT void setVObjectVObjectValue(VObject *o, VObject *p);
    -
    252
    -
    253 LIBICAL_VCAL_EXPORT VObject *addVObjectProp(VObject *o, VObject *p);
    -
    254 LIBICAL_VCAL_EXPORT VObject *addProp(VObject *o, const char *id);
    -
    255 LIBICAL_VCAL_EXPORT VObject *addPropValue(VObject *o, const char *p, const char *v);
    -
    256 LIBICAL_VCAL_EXPORT VObject *addPropSizedValue_(VObject *o, const char *p, const char *v,
    -
    257 unsigned int size);
    -
    258 LIBICAL_VCAL_EXPORT VObject *addPropSizedValue(VObject *o, const char *p, const char *v,
    -
    259 unsigned int size);
    -
    260 LIBICAL_VCAL_EXPORT VObject *addGroup(VObject *o, const char *g);
    -
    261 LIBICAL_VCAL_EXPORT void addList(VObject ** o, VObject *p);
    -
    262
    -
    263 LIBICAL_VCAL_EXPORT VObject *isAPropertyOf(VObject *o, const char *id);
    -
    264
    -
    265 LIBICAL_VCAL_EXPORT VObject *nextVObjectInList(VObject *o);
    -
    266 LIBICAL_VCAL_EXPORT void initPropIterator(VObjectIterator * i, VObject *o);
    -
    267 LIBICAL_VCAL_EXPORT int moreIteration(VObjectIterator * i);
    -
    268 LIBICAL_VCAL_EXPORT VObject *nextVObject(VObjectIterator * i);
    -
    269
    -
    270 LIBICAL_VCAL_EXPORT char *writeMemVObject(char *s, int *len, VObject *o);
    -
    271 LIBICAL_VCAL_EXPORT char *writeMemVObjects(char *s, int *len, VObject *list);
    -
    272
    -
    273 LIBICAL_VCAL_EXPORT const char *lookupStr(const char *s);
    -
    274 LIBICAL_VCAL_EXPORT void cleanStrTbl();
    -
    275
    -
    276 LIBICAL_VCAL_EXPORT void cleanVObject(VObject *o);
    -
    277 LIBICAL_VCAL_EXPORT void cleanVObjects(VObject *list);
    -
    278
    -
    279 LIBICAL_VCAL_EXPORT const char *lookupProp(const char *str);
    -
    280 LIBICAL_VCAL_EXPORT const char *lookupProp_(const char *str);
    -
    281
    -
    282 LIBICAL_VCAL_EXPORT wchar_t *fakeUnicode(const char *ps, size_t *bytes);
    -
    283 LIBICAL_VCAL_EXPORT int uStrLen(const wchar_t *u);
    -
    284 LIBICAL_VCAL_EXPORT char *fakeCString(const wchar_t *u);
    -
    285
    -
    286 LIBICAL_VCAL_EXPORT void printVObjectToFile(char *fname, VObject *o);
    -
    287 LIBICAL_VCAL_EXPORT void printVObjectsToFile(char *fname, VObject *list);
    -
    288 LIBICAL_VCAL_EXPORT void writeVObjectToFile(char *fname, VObject *o);
    -
    289 LIBICAL_VCAL_EXPORT void writeVObjectsToFile(char *fname, VObject *list);
    -
    290
    -
    291 LIBICAL_VCAL_EXPORT int vObjectValueType(VObject *o);
    -
    292
    -
    293/* return type of vObjectValueType: */
    -
    294#define VCVT_NOVALUE 0
    -
    295 /* if the VObject has no value associated with it. */
    -
    296#define VCVT_STRINGZ 1
    -
    297 /* if the VObject has value set by setVObjectStringZValue. */
    -
    298#define VCVT_USTRINGZ 2
    -
    299 /* if the VObject has value set by setVObjectUStringZValue. */
    -
    300#define VCVT_UINT 3
    -
    301 /* if the VObject has value set by setVObjectIntegerValue. */
    -
    302#define VCVT_ULONG 4
    -
    303 /* if the VObject has value set by setVObjectLongValue. */
    -
    304#define VCVT_RAW 5
    -
    305 /* if the VObject has value set by setVObjectAnyValue. */
    -
    306#define VCVT_VOBJECT 6
    -
    307 /* if the VObject has value set by setVObjectVObjectValue. */
    -
    308
    -
    309 extern const char **fieldedProp;
    -
    310
    -
    311/* NOTE regarding printVObject and writeVObject
    -
    312
    -
    313The functions below are not exported from the DLL because they
    -
    314take a FILE* as a parameter, which cannot be passed across a DLL
    -
    315interface (at least that is my experience). Instead you can use
    -
    316their companion functions which take file names or pointers
    -
    317to memory. However, if you are linking this code into
    -
    318your build directly then you may find them a more convenient API
    -
    319and you can go ahead and use them. If you try to use them with
    -
    320the DLL LIB you will get a link error.
    -
    321*/
    -
    322 extern void printVObject(FILE *fp, VObject *o);
    -
    323 extern void writeVObject(FILE *fp, VObject *o);
    -
    324
    -
    325#if defined(__CPLUSPLUS__) || defined(__cplusplus)
    -
    326}
    -
    327
    -
    328#endif
    -
    329
    -
    330#endif /* VOBJECT_H */
    -
    VObjectIterator
    Definition: vobject.h:222
    -
    VObject
    Definition: vobject.c:43
    +
    1 /***************************************************************************
    +
    2 (C) Copyright 1996 Apple Computer, Inc., AT&T Corp., International
    +
    3 Business Machines Corporation and Siemens Rolm Communications Inc.
    +
    4 
    +
    5 For purposes of this license notice, the term Licensors shall mean,
    +
    6 collectively, Apple Computer, Inc., AT&T Corp., International
    +
    7 Business Machines Corporation and Siemens Rolm Communications Inc.
    +
    8 The term Licensor shall mean any of the Licensors.
    +
    9 
    +
    10 Subject to acceptance of the following conditions, permission is hereby
    +
    11 granted by Licensors without the need for written agreement and without
    +
    12 license or royalty fees, to use, copy, modify and distribute this
    +
    13 software for any purpose.
    +
    14 
    +
    15 The above copyright notice and the following four paragraphs must be
    +
    16 reproduced in all copies of this software and any software including
    +
    17 this software.
    +
    18 
    +
    19 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS AND NO LICENSOR SHALL HAVE
    +
    20 ANY OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR
    +
    21 MODIFICATIONS.
    +
    22 
    +
    23 IN NO EVENT SHALL ANY LICENSOR BE LIABLE TO ANY PARTY FOR DIRECT,
    +
    24 INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES OR LOST PROFITS ARISING OUT
    +
    25 OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
    +
    26 DAMAGE.
    +
    27 
    +
    28 EACH LICENSOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, EXPRESS OR IMPLIED,
    +
    29 INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF NONINFRINGEMENT OR THE
    +
    30 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    +
    31 PURPOSE.
    +
    32 
    +
    33 The software is provided with RESTRICTED RIGHTS. Use, duplication, or
    +
    34 disclosure by the government are subject to restrictions set forth in
    +
    35 DFARS 252.227-7013 or 48 CFR 52.227-19, as applicable.
    +
    36 
    +
    37 ***************************************************************************/
    +
    38 
    +
    39 /*
    +
    40 
    +
    41 The vCard/vCalendar C interface is implemented in the set
    +
    42 of files as follows:
    +
    43 
    +
    44 vcc.y, yacc source, and vcc.c, the yacc output you will use
    +
    45 implements the core parser
    +
    46 
    +
    47 vobject.c implements an API that insulates the caller from
    +
    48 the parser and changes in the vCard/vCalendar BNF
    +
    49 
    +
    50 vcc.h and vobject.h are header files for their .c counterparts
    +
    51 
    +
    52 vcaltmp.h and vcaltmp.c implement vCalendar "macro" functions
    +
    53 which you may find useful.
    +
    54 
    +
    55 test.c is a standalone test driver that exercises some of
    +
    56 the features of the APIs provided. Invoke test.exe on a
    +
    57 VCARD/VCALENDAR input text file and you will see the pretty
    +
    58 print output of the internal representation (this pretty print
    +
    59 output should give you a good idea of how the internal
    +
    60 representation looks like -- there is one such output in the
    +
    61 following too). Also, a file with the .out suffix is generated
    +
    62 to show that the internal representation can be written back
    +
    63 in the original text format.
    +
    64 
    +
    65 For more information on this API see the readme.txt file
    +
    66 which accompanied this distribution.
    +
    67 */
    +
    68 
    +
    69 #ifndef VOBJECT_H
    +
    70 #define VOBJECT_H
    +
    71 
    +
    72 #include "libical_vcal_export.h"
    +
    73 #include <stdlib.h>
    +
    74 #include <stdio.h>
    +
    75 
    +
    76 #if defined(__CPLUSPLUS__) || defined(__cplusplus)
    +
    77 extern "C"
    +
    78 {
    +
    79 #endif
    +
    80 
    +
    81 #define VC7bitProp "7BIT"
    +
    82 #define VC8bitProp "8BIT"
    +
    83 #define VCAAlarmProp "AALARM"
    +
    84 #define VCAdditionalNamesProp "ADDN"
    +
    85 #define VCAdrProp "ADR"
    +
    86 #define VCAgentProp "AGENT"
    +
    87 #define VCAIFFProp "AIFF"
    +
    88 #define VCAOLProp "AOL"
    +
    89 #define VCAppleLinkProp "APPLELINK"
    +
    90 #define VCAttachProp "ATTACH"
    +
    91 #define VCAttendeeProp "ATTENDEE"
    +
    92 #define VCATTMailProp "ATTMAIL"
    +
    93 #define VCAudioContentProp "AUDIOCONTENT"
    +
    94 #define VCAVIProp "AVI"
    +
    95 #define VCBase64Prop "BASE64"
    +
    96 #define VCBBSProp "BBS"
    +
    97 #define VCBirthDateProp "BDAY"
    +
    98 #define VCBMPProp "BMP"
    +
    99 #define VCBodyProp "BODY"
    +
    100 #define VCBusinessRoleProp "ROLE"
    +
    101 #define VCCalProp "VCALENDAR"
    +
    102 #define VCCaptionProp "CAP"
    +
    103 #define VCCardProp "VCARD"
    +
    104 #define VCCarProp "CAR"
    +
    105 #define VCCategoriesProp "CATEGORIES"
    +
    106 #define VCCellularProp "CELL"
    +
    107 #define VCCGMProp "CGM"
    +
    108 #define VCCharSetProp "CS"
    +
    109 #define VCCIDProp "CID"
    +
    110 #define VCCISProp "CIS"
    +
    111 #define VCCityProp "L"
    +
    112 #define VCClassProp "CLASS"
    +
    113 #define VCCommentProp "NOTE"
    +
    114 #define VCCompletedProp "COMPLETED"
    +
    115 #define VCContentIDProp "CONTENT-ID"
    +
    116 #define VCCountryNameProp "C"
    +
    117 #define VCDAlarmProp "DALARM"
    +
    118 #define VCDataSizeProp "DATASIZE"
    +
    119 #define VCDayLightProp "DAYLIGHT"
    +
    120 #define VCDCreatedProp "DCREATED"
    +
    121 #define VCDeliveryLabelProp "LABEL"
    +
    122 #define VCDescriptionProp "DESCRIPTION"
    +
    123 #define VCDIBProp "DIB"
    +
    124 #define VCDisplayStringProp "DISPLAYSTRING"
    +
    125 #define VCDomesticProp "DOM"
    +
    126 #define VCDTendProp "DTEND"
    +
    127 #define VCDTstartProp "DTSTART"
    +
    128 #define VCDueProp "DUE"
    +
    129 #define VCEmailAddressProp "EMAIL"
    +
    130 #define VCEncodingProp "ENCODING"
    +
    131 #define VCEndProp "END"
    +
    132 #define VCEventProp "VEVENT"
    +
    133 #define VCEWorldProp "EWORLD"
    +
    134 #define VCExNumProp "EXNUM"
    +
    135 #define VCExpDateProp "EXDATE"
    +
    136 #define VCExpectProp "EXPECT"
    +
    137 #define VCExtAddressProp "EXT ADD"
    +
    138 #define VCFamilyNameProp "F"
    +
    139 #define VCFaxProp "FAX"
    +
    140 #define VCFullNameProp "FN"
    +
    141 #define VCGeoProp "GEO"
    +
    142 #define VCGeoLocationProp "GEO"
    +
    143 #define VCGIFProp "GIF"
    +
    144 #define VCGivenNameProp "G"
    +
    145 #define VCGroupingProp "Grouping"
    +
    146 #define VCHomeProp "HOME"
    +
    147 #define VCIBMMailProp "IBMMail"
    +
    148 #define VCInlineProp "INLINE"
    +
    149 #define VCInternationalProp "INTL"
    +
    150 #define VCInternetProp "INTERNET"
    +
    151 #define VCISDNProp "ISDN"
    +
    152 #define VCJPEGProp "JPEG"
    +
    153 #define VCLanguageProp "LANG"
    +
    154 #define VCLastModifiedProp "LAST-MODIFIED"
    +
    155 #define VCLastRevisedProp "REV"
    +
    156 #define VCLocationProp "LOCATION"
    +
    157 #define VCLogoProp "LOGO"
    +
    158 #define VCMailerProp "MAILER"
    +
    159 #define VCMAlarmProp "MALARM"
    +
    160 #define VCMCIMailProp "MCIMAIL"
    +
    161 #define VCMessageProp "MSG"
    +
    162 #define VCMETProp "MET"
    +
    163 #define VCModemProp "MODEM"
    +
    164 #define VCMPEG2Prop "MPEG2"
    +
    165 #define VCMPEGProp "MPEG"
    +
    166 #define VCMSNProp "MSN"
    +
    167 #define VCNamePrefixesProp "NPRE"
    +
    168 #define VCNameProp "N"
    +
    169 #define VCNameSuffixesProp "NSUF"
    +
    170 #define VCNoteProp "NOTE"
    +
    171 #define VCOrgNameProp "ORGNAME"
    +
    172 #define VCOrgProp "ORG"
    +
    173 #define VCOrgUnit2Prop "OUN2"
    +
    174 #define VCOrgUnit3Prop "OUN3"
    +
    175 #define VCOrgUnit4Prop "OUN4"
    +
    176 #define VCOrgUnitProp "OUN"
    +
    177 #define VCPagerProp "PAGER"
    +
    178 #define VCPAlarmProp "PALARM"
    +
    179 #define VCParcelProp "PARCEL"
    +
    180 #define VCPartProp "PART"
    +
    181 #define VCPCMProp "PCM"
    +
    182 #define VCPDFProp "PDF"
    +
    183 #define VCPGPProp "PGP"
    +
    184 #define VCPhotoProp "PHOTO"
    +
    185 #define VCPICTProp "PICT"
    +
    186 #define VCPMBProp "PMB"
    +
    187 #define VCPostalBoxProp "BOX"
    +
    188 #define VCPostalCodeProp "PC"
    +
    189 #define VCPostalProp "POSTAL"
    +
    190 #define VCPowerShareProp "POWERSHARE"
    +
    191 #define VCPreferredProp "PREF"
    +
    192 #define VCPriorityProp "PRIORITY"
    +
    193 #define VCProcedureNameProp "PROCEDURENAME"
    +
    194 #define VCProdIdProp "PRODID"
    +
    195 #define VCProdigyProp "PRODIGY"
    +
    196 #define VCPronunciationProp "SOUND"
    +
    197 #define VCPSProp "PS"
    +
    198 #define VCPublicKeyProp "KEY"
    +
    199 #define VCQPProp "QP"
    +
    200 #define VCQuickTimeProp "QTIME"
    +
    201 #define VCQuotedPrintableProp "QUOTED-PRINTABLE"
    +
    202 #define VCRDateProp "RDATE"
    +
    203 #define VCRegionProp "R"
    +
    204 #define VCRelatedToProp "RELATED-TO"
    +
    205 #define VCRepeatCountProp "REPEATCOUNT"
    +
    206 #define VCResourcesProp "RESOURCES"
    +
    207 #define VCRNumProp "RNUM"
    +
    208 #define VCRoleProp "ROLE"
    +
    209 #define VCRRuleProp "RRULE"
    +
    210 #define VCRSVPProp "RSVP"
    +
    211 #define VCRunTimeProp "RUNTIME"
    +
    212 #define VCSequenceProp "SEQUENCE"
    +
    213 #define VCSnoozeTimeProp "SNOOZETIME"
    +
    214 #define VCStartProp "START"
    +
    215 #define VCStatusProp "STATUS"
    +
    216 #define VCStreetAddressProp "STREET"
    +
    217 #define VCSubTypeProp "SUBTYPE"
    +
    218 #define VCSummaryProp "SUMMARY"
    +
    219 #define VCTelephoneProp "TEL"
    +
    220 #define VCTIFFProp "TIFF"
    +
    221 #define VCTimeZoneProp "TZ"
    +
    222 #define VCTitleProp "TITLE"
    +
    223 #define VCTLXProp "TLX"
    +
    224 #define VCTodoProp "VTODO"
    +
    225 #define VCTranspProp "TRANSP"
    +
    226 #define VCUniqueStringProp "UID"
    +
    227 #define VCURLProp "URL"
    +
    228 #define VCURLValueProp "URLVAL"
    +
    229 #define VCValueProp "VALUE"
    +
    230 #define VCVersionProp "VERSION"
    +
    231 #define VCVideoProp "VIDEO"
    +
    232 #define VCVoiceProp "VOICE"
    +
    233 #define VCWAVEProp "WAVE"
    +
    234 #define VCWMFProp "WMF"
    +
    235 #define VCWorkProp "WORK"
    +
    236 #define VCX400Prop "X400"
    +
    237 #define VCX509Prop "X509"
    +
    238 #define VCXRuleProp "XRULE"
    +
    239 
    +
    240 /* Extensions */
    +
    241 
    +
    242 #define XPilotIdProp "X-PILOTID"
    +
    243 #define XPilotStatusProp "X-PILOTSTAT"
    +
    244 
    +
    245  typedef struct VObject VObject;
    +
    246 
    +
    247  typedef struct VObjectIterator
    +
    248  {
    +
    249  VObject *start;
    +
    250  VObject *next;
    +
    251  } VObjectIterator;
    +
    252 
    +
    253  LIBICAL_VCAL_EXPORT VObject *newVObject(const char *id);
    +
    254  LIBICAL_VCAL_EXPORT void deleteVObject(VObject *p);
    +
    255  LIBICAL_VCAL_EXPORT char *dupStr(const char *s, size_t size);
    +
    256  LIBICAL_VCAL_EXPORT void deleteStr(const char *p);
    +
    257  LIBICAL_VCAL_EXPORT void unUseStr(const char *s);
    +
    258 
    +
    259  LIBICAL_VCAL_EXPORT void setVObjectName(VObject *o, const char *id);
    +
    260  LIBICAL_VCAL_EXPORT void setVObjectStringZValue(VObject *o, const char *s);
    +
    261  LIBICAL_VCAL_EXPORT void setVObjectStringZValue_(VObject *o, const char *s);
    +
    262  LIBICAL_VCAL_EXPORT void setVObjectUStringZValue(VObject *o, const wchar_t *s);
    +
    263  LIBICAL_VCAL_EXPORT void setVObjectUStringZValue_(VObject *o, const wchar_t *s);
    +
    264  LIBICAL_VCAL_EXPORT void setVObjectIntegerValue(VObject *o, unsigned int i);
    +
    265  LIBICAL_VCAL_EXPORT void setVObjectLongValue(VObject *o, unsigned long l);
    +
    266  LIBICAL_VCAL_EXPORT void setVObjectAnyValue(VObject *o, void *t);
    +
    267  LIBICAL_VCAL_EXPORT VObject *setValueWithSize(VObject *prop, void *val, unsigned int size);
    +
    268  LIBICAL_VCAL_EXPORT VObject *setValueWithSize_(VObject *prop, void *val, unsigned int size);
    +
    269 
    +
    270  LIBICAL_VCAL_EXPORT const char *vObjectName(VObject *o);
    +
    271  LIBICAL_VCAL_EXPORT const char *vObjectStringZValue(VObject *o);
    +
    272  LIBICAL_VCAL_EXPORT const wchar_t *vObjectUStringZValue(VObject *o);
    +
    273  LIBICAL_VCAL_EXPORT unsigned int vObjectIntegerValue(VObject *o);
    +
    274  LIBICAL_VCAL_EXPORT unsigned long vObjectLongValue(VObject *o);
    +
    275  LIBICAL_VCAL_EXPORT void *vObjectAnyValue(VObject *o);
    +
    276  LIBICAL_VCAL_EXPORT VObject *vObjectVObjectValue(VObject *o);
    +
    277  LIBICAL_VCAL_EXPORT void setVObjectVObjectValue(VObject *o, VObject *p);
    +
    278 
    +
    279  LIBICAL_VCAL_EXPORT VObject *addVObjectProp(VObject *o, VObject *p);
    +
    280  LIBICAL_VCAL_EXPORT VObject *addProp(VObject *o, const char *id);
    +
    281  LIBICAL_VCAL_EXPORT VObject *addPropValue(VObject *o, const char *p, const char *v);
    +
    282  LIBICAL_VCAL_EXPORT VObject *addPropSizedValue_(VObject *o, const char *p, const char *v,
    +
    283  unsigned int size);
    +
    284  LIBICAL_VCAL_EXPORT VObject *addPropSizedValue(VObject *o, const char *p, const char *v,
    +
    285  unsigned int size);
    +
    286  LIBICAL_VCAL_EXPORT VObject *addGroup(VObject *o, const char *g);
    +
    287  LIBICAL_VCAL_EXPORT void addList(VObject ** o, VObject *p);
    +
    288 
    +
    289  LIBICAL_VCAL_EXPORT VObject *isAPropertyOf(VObject *o, const char *id);
    +
    290 
    +
    291  LIBICAL_VCAL_EXPORT VObject *nextVObjectInList(VObject *o);
    +
    292  LIBICAL_VCAL_EXPORT void initPropIterator(VObjectIterator * i, VObject *o);
    +
    293  LIBICAL_VCAL_EXPORT int moreIteration(VObjectIterator * i);
    +
    294  LIBICAL_VCAL_EXPORT VObject *nextVObject(VObjectIterator * i);
    +
    295 
    +
    296  LIBICAL_VCAL_EXPORT char *writeMemVObject(char *s, int *len, VObject *o);
    +
    297  LIBICAL_VCAL_EXPORT char *writeMemVObjects(char *s, int *len, VObject *list);
    +
    298 
    +
    299  LIBICAL_VCAL_EXPORT const char *lookupStr(const char *s);
    +
    300  LIBICAL_VCAL_EXPORT void cleanStrTbl();
    +
    301 
    +
    302  LIBICAL_VCAL_EXPORT void cleanVObject(VObject *o);
    +
    303  LIBICAL_VCAL_EXPORT void cleanVObjects(VObject *list);
    +
    304 
    +
    305  LIBICAL_VCAL_EXPORT const char *lookupProp(const char *str);
    +
    306  LIBICAL_VCAL_EXPORT const char *lookupProp_(const char *str);
    +
    307 
    +
    308  LIBICAL_VCAL_EXPORT wchar_t *fakeUnicode(const char *ps, size_t *bytes);
    +
    309  LIBICAL_VCAL_EXPORT int uStrLen(const wchar_t *u);
    +
    310  LIBICAL_VCAL_EXPORT char *fakeCString(const wchar_t *u);
    +
    311 
    +
    312  LIBICAL_VCAL_EXPORT void printVObjectToFile(char *fname, VObject *o);
    +
    313  LIBICAL_VCAL_EXPORT void printVObjectsToFile(char *fname, VObject *list);
    +
    314  LIBICAL_VCAL_EXPORT void writeVObjectToFile(char *fname, VObject *o);
    +
    315  LIBICAL_VCAL_EXPORT void writeVObjectsToFile(char *fname, VObject *list);
    +
    316 
    +
    317  LIBICAL_VCAL_EXPORT int vObjectValueType(VObject *o);
    +
    318 
    +
    319 /* return type of vObjectValueType: */
    +
    320 #define VCVT_NOVALUE 0
    +
    321  /* if the VObject has no value associated with it. */
    +
    322 #define VCVT_STRINGZ 1
    +
    323  /* if the VObject has value set by setVObjectStringZValue. */
    +
    324 #define VCVT_USTRINGZ 2
    +
    325  /* if the VObject has value set by setVObjectUStringZValue. */
    +
    326 #define VCVT_UINT 3
    +
    327  /* if the VObject has value set by setVObjectIntegerValue. */
    +
    328 #define VCVT_ULONG 4
    +
    329  /* if the VObject has value set by setVObjectLongValue. */
    +
    330 #define VCVT_RAW 5
    +
    331  /* if the VObject has value set by setVObjectAnyValue. */
    +
    332 #define VCVT_VOBJECT 6
    +
    333  /* if the VObject has value set by setVObjectVObjectValue. */
    +
    334 
    +
    335  extern const char **fieldedProp;
    +
    336 
    +
    337 /* NOTE regarding printVObject and writeVObject
    +
    338 
    +
    339 The functions below are not exported from the DLL because they
    +
    340 take a FILE* as a parameter, which cannot be passed across a DLL
    +
    341 interface (at least that is my experience). Instead you can use
    +
    342 their companion functions which take file names or pointers
    +
    343 to memory. However, if you are linking this code into
    +
    344 your build directly then you may find them a more convenient API
    +
    345 and you can go ahead and use them. If you try to use them with
    +
    346 the DLL LIB you will get a link error.
    +
    347 */
    +
    348  extern void printVObject(FILE *fp, VObject *o);
    +
    349  extern void writeVObject(FILE *fp, VObject *o);
    +
    350 
    +
    351 #if defined(__CPLUSPLUS__) || defined(__cplusplus)
    +
    352 }
    +
    353 
    +
    354 #endif
    +
    355 
    +
    356 #endif /* VOBJECT_H */
    +
    VObjectIterator
    Definition: vobject.h:248
    +
    VObject
    Definition: vobject.c:69
    -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by doxygen 1.9.3 +Generated on Thu Oct 6 2022 14:47:00 for Libical API Documentation by doxygen 1.9.1
    -- cgit v1.2.1