src/Net-ICal-Libical/netical_wrap.doc

   1 netical_wrap.c
   2
   3 [ Module : Net__ICal__Libical, Package : Net::ICal::Libical ]
   4
   5
   6 icalparser_parse_string(str);
   7         [ returns icalcomponent * ]
   8
   9 icalcomponent_new(kind);
  10         [ returns icalcomponent * ]
  11
  12 icalcomponent_new_clone(component);
  13         [ returns icalcomponent * ]
  14
  15 icalcomponent_new_from_string(str);
  16         [ returns icalcomponent * ]
  17
  18 icalcomponent_as_ical_string(component);
  19         [ returns char * ]
  20
  21 icalcomponent_free(component);
  22         [ returns void  ]
  23
  24 icalcomponent_count_errors(component);
  25         [ returns int  ]
  26
  27 icalcomponent_strip_errors(component);
  28         [ returns void  ]
  29
  30 icalcomponent_convert_errors(component);
  31         [ returns void  ]
  32
  33 icalcomponent_get_current_property(component);
  34         [ returns icalproperty * ]
  35
  36 icalcomponent_get_first_property(component,kind);
  37         [ returns icalproperty * ]
  38
  39 icalcomponent_get_next_property(component,kind);
  40         [ returns icalproperty * ]
  41
  42 icalcomponent_get_current_component(component);
  43         [ returns icalcomponent * ]
  44
  45 icalcomponent_get_first_component(component,kind);
  46         [ returns icalcomponent * ]
  47
  48 icalcomponent_get_next_component(component,kind);
  49         [ returns icalcomponent * ]
  50
  51 icalcomponent_add_property(component,property);
  52         [ returns void  ]
  53
  54 icalcomponent_remove_property(component,property);
  55         [ returns void  ]
  56
  57 icalcomponent_get_parent(component);
  58         [ returns icalcomponent * ]
  59
  60 icalcomponent_isa(component);
  61         [ returns icalcomponent_kind  ]
  62
  63 icalrestriction_check(comp);
  64         [ returns int  ]
  65
  66 icalproperty_string_to_kind(string);
  67         [ returns int  ]
  68
  69 icalproperty_new(kind);
  70         [ returns icalproperty * ]
  71
  72 icalproperty_new_from_string(str);
  73         [ returns icalproperty * ]
  74
  75 icalproperty_as_ical_string(prop);
  76         [ returns char * ]
  77
  78 icalproperty_set_parameter_from_string(prop,name,value);
  79         [ returns void  ]
  80
  81 icalproperty_set_value_from_string(prop,value,kind);
  82         [ returns void  ]
  83
  84 icalproperty_get_value_as_string(prop);
  85         [ returns char * ]
  86
  87 icalproperty_get_parameter_as_string(prop,name);
  88         [ returns char * ]
  89
  90 icalproperty_get_parent(property);
  91         [ returns icalcomponent * ]
  92
  93 $ICAL_BADARG_ERROR = ICAL_BADARG_ERROR
  94         [ Constant: int  ]
  95
  96 $ICAL_NEWFAILED_ERROR = ICAL_NEWFAILED_ERROR
  97         [ Constant: int  ]
  98
  99 $ICAL_MALFORMEDDATA_ERROR = ICAL_MALFORMEDDATA_ERROR
 100         [ Constant: int  ]
 101
 102 $ICAL_PARSE_ERROR = ICAL_PARSE_ERROR
 103         [ Constant: int  ]
 104
 105 $ICAL_INTERNAL_ERROR = ICAL_INTERNAL_ERROR
 106         [ Constant: int  ]
 107         Like assert --internal consist. prob
 108
 109 $ICAL_FILE_ERROR = ICAL_FILE_ERROR
 110         [ Constant: int  ]
 111
 112 $ICAL_ALLOCATION_ERROR = ICAL_ALLOCATION_ERROR
 113         [ Constant: int  ]
 114
 115 $ICAL_USAGE_ERROR = ICAL_USAGE_ERROR
 116         [ Constant: int  ]
 117
 118 $ICAL_NO_ERROR = ICAL_NO_ERROR
 119         [ Constant: int  ]
 120         Used for problems in input to icalerror_strerror()
 121
 122 $ICAL_UNKNOWN_ERROR = ICAL_UNKNOWN_ERROR
 123         [ Constant: int  ]
 124
 125 $ICAL_ERROR_FATAL = ICAL_ERROR_FATAL
 126         [ Constant: int  ]
 127         Not fata
 128
 129 $ICAL_ERROR_NONFATAL = ICAL_ERROR_NONFATAL
 130         [ Constant: int  ]
 131         Fatal
 132
 133 $ICAL_ERROR_DEFAULT = ICAL_ERROR_DEFAULT
 134         [ Constant: int  ]
 135         Use the value of icalerror_errors_are_fatal Asked state for an unknown
 136         error type
 137
 138 $ICAL_ERROR_UNKNOWN = ICAL_ERROR_UNKNOWN
 139         [ Constant: int  ]
 140
 141 icalerror_set_error_state(error,icalerrorstate );
 142         [ returns void  ]
 143
 144 icalerror_get_error_state(error);
 145         [ returns icalerrorstate  ]
 146
 147 icalenum_property_kind_to_string(kind);
 148         [ returns char * ]
 149
 150 icalenum_string_to_property_kind(string);
 151         [ returns icalproperty_kind  ]
 152
 153 icalenum_value_kind_to_string(kind);
 154         [ returns char * ]
 155         icalvalue_kind icalenum_value_kind_by_prop(icalproperty_kind kind);
 156
 157
 158 icalenum_parameter_kind_to_string(kind);
 159         [ returns char * ]
 160
 161 icalenum_string_to_parameter_kind(string);
 162         [ returns icalparameter_kind  ]
 163
 164 icalenum_component_kind_to_string(kind);
 165         [ returns char * ]
 166
 167 icalenum_string_to_component_kind(string);
 168         [ returns icalcomponent_kind  ]
 169
 170 icalenum_property_kind_to_value_kind(kind);
 171         [ returns icalvalue_kind  ]
 172
 173 icallangbind_new_array(size);
 174         [ returns int * ]
 175
 176 icallangbind_free_array(array);
 177         [ returns void  ]
 178
 179 icallangbind_access_array(array,index);
 180         [ returns int  ]
 181
 182 icalrecur_expand_recurrence(rule,start,count,array);
 183         [ returns int  ]
 184
 185 icallangbind_get_first_property(c,prop);
 186         [ returns icalproperty * ]
 187
 188 icallangbind_get_next_property(c,prop);
 189         [ returns icalproperty * ]
 190
 191 icallangbind_get_first_component(c,comp);
 192         [ returns icalcomponent * ]
 193
 194 icallangbind_get_next_component(c,comp);
 195         [ returns icalcomponent * ]
 196
 197 icallangbind_property_eval_string(prop,sep);
 198         [ returns char * ]
 199
 200 1.  class icaltimetype
 201 ======================
 202 [ created from struct icaltimetype ]
 203
 204
 205 icaltimetype_year_set(struct icaltimetype *,int );
 206 icaltimetype_year_get(struct icaltimetype *);
 207         [ Member data: returns int  ]
 208
 209 icaltimetype_month_set(struct icaltimetype *,int );
 210 icaltimetype_month_get(struct icaltimetype *);
 211         [ Member data: returns int  ]
 212
 213 icaltimetype_day_set(struct icaltimetype *,int );
 214 icaltimetype_day_get(struct icaltimetype *);
 215         [ Member data: returns int  ]
 216
 217 icaltimetype_hour_set(struct icaltimetype *,int );
 218 icaltimetype_hour_get(struct icaltimetype *);
 219         [ Member data: returns int  ]
 220
 221 icaltimetype_minute_set(struct icaltimetype *,int );
 222 icaltimetype_minute_get(struct icaltimetype *);
 223         [ Member data: returns int  ]
 224
 225 icaltimetype_second_set(struct icaltimetype *,int );
 226 icaltimetype_second_get(struct icaltimetype *);
 227         [ Member data: returns int  ]
 228
 229 icaltimetype_is_utc_set(struct icaltimetype *,int );
 230 icaltimetype_is_utc_get(struct icaltimetype *);
 231         [ Member data: returns int  ]
 232         1-> time is in UTC timezone
 233
 234 icaltimetype_is_date_set(struct icaltimetype *,int );
 235 icaltimetype_is_date_get(struct icaltimetype *);
 236         [ Member data: returns int  ]
 237         1 -> interpret this as date.
 238
 239 $icaltimetype_zone = icaltimetype::zone
 240         [ Constant: char * ]
 241         Ptr to Olsen placename. Libical does not own mem
 242
 243 ----------
 244
 245 icaltime_from_timet(v,is_date);
 246         [ returns struct icaltimetype  ]
 247
 248 icaltime_as_timet(struct icaltimetype *);
 249         [ returns int  ]
 250
 251 icaltime_as_ical_string(tt);
 252         [ returns char * ]
 253
 254 icaltime_from_string(str);
 255         [ returns struct icaltimetype  ]
 256
 257 icaltime_utc_offset(tt,tzid);
 258         [ returns int  ]
 259
 260 icaltime_as_utc(tt,tzid);
 261         [ returns struct icaltimetype  ]
 262
 263 icaltime_as_zone(tt,tzid);
 264         [ returns struct icaltimetype  ]
 265
 266 icaltime_null_time();
 267         [ returns struct icaltimetype  ]
 268
 269 icaltime_is_null_time(t);
 270         [ returns int  ]
 271
 272 icaltime_is_valid_time(t);
 273         [ returns int  ]
 274
 275 icaltime_normalize(t);
 276         [ returns struct icaltimetype  ]
 277
 278 icaltime_day_of_year(t);
 279         [ returns short  ]
 280
 281 icaltime_from_day_of_year(doy,year);
 282         [ returns struct icaltimetype  ]
 283
 284 icaltime_day_of_week(t);
 285         [ returns short  ]
 286
 287 icaltime_start_doy_of_week(t);
 288         [ returns short  ]
 289
 290 icaltime_as_ctime(struct icaltimetype *);
 291         [ returns char * ]
 292
 293 icaltime_week_number(t);
 294         [ returns short  ]
 295
 296 icaltime_compare(a,b);
 297         [ returns int  ]
 298
 299 icaltime_compare_date_only(a,b);
 300         [ returns int  ]
 301
 302 icaltime_days_in_month(month,year);
 303         [ returns short  ]
 304
 305 2.  class icaldurationtype
 306 ==========================
 307 [ created from struct icaldurationtype ]
 308
 309
 310 icaldurationtype_is_neg_set(struct icaldurationtype *,int );
 311 icaldurationtype_is_neg_get(struct icaldurationtype *);
 312         [ Member data: returns int  ]
 313
 314 icaldurationtype_days_set(struct icaldurationtype *,unsigned int );
 315 icaldurationtype_days_get(struct icaldurationtype *);
 316         [ Member data: returns unsigned int  ]
 317
 318 icaldurationtype_weeks_set(struct icaldurationtype *,unsigned int );
 319 icaldurationtype_weeks_get(struct icaldurationtype *);
 320         [ Member data: returns unsigned int  ]
 321
 322 icaldurationtype_hours_set(struct icaldurationtype *,unsigned int );
 323 icaldurationtype_hours_get(struct icaldurationtype *);
 324         [ Member data: returns unsigned int  ]
 325
 326 icaldurationtype_minutes_set(struct icaldurationtype *,unsigned int );
 327 icaldurationtype_minutes_get(struct icaldurationtype *);
 328         [ Member data: returns unsigned int  ]
 329
 330 icaldurationtype_seconds_set(struct icaldurationtype *,unsigned int );
 331 icaldurationtype_seconds_get(struct icaldurationtype *);
 332         [ Member data: returns unsigned int  ]
 333
 334 ----------
 335
 336 icaldurationtype_from_int(t);
 337         [ returns struct icaldurationtype  ]
 338
 339 icaldurationtype_from_string(char *);
 340         [ returns struct icaldurationtype  ]
 341
 342 icaldurationtype_as_int(duration);
 343         [ returns int  ]
 344
 345 icaldurationtype_as_ical_string(d);
 346         [ returns char * ]
 347
 348 icaldurationtype_null_duration();
 349         [ returns struct icaldurationtype  ]
 350
 351 icaldurationtype_is_null_duration(d);
 352         [ returns int  ]
 353
 354 icaltime_add(t,d);
 355         [ returns struct icaltimetype  ]
 356
 357 icaltime_subtract(t1,t2);
 358         [ returns struct icaldurationtype  ]
 359
 360 3.  class icalperiodtype
 361 ========================
 362 [ created from struct icalperiodtype ]
 363
 364
 365 icalperiodtype_start_set(struct icalperiodtype *,struct icaltimetype *);
 366 icalperiodtype_start_get(struct icalperiodtype *);
 367         [ Member data: returns struct icaltimetype * ]
 368
 369 icalperiodtype_end_set(struct icalperiodtype *,struct icaltimetype *);
 370 icalperiodtype_end_get(struct icalperiodtype *);
 371         [ Member data: returns struct icaltimetype * ]
 372
 373 icalperiodtype_duration_set(struct icalperiodtype *,struct icaldurationtype *);
 374 icalperiodtype_duration_get(struct icalperiodtype *);
 375         [ Member data: returns struct icaldurationtype * ]
 376
 377 ----------
 378
 379 icalperiodtype_from_string(str);
 380         [ returns struct icalperiodtype  ]
 381
 382 icalperiodtype_as_ical_string(p);
 383         [ returns char * ]
 384
 385 icalperiodtype_null_period();
 386         [ returns struct icalperiodtype  ]
 387
 388 icalperiodtype_is_null_period(p);
 389         [ returns int  ]
 390
 391 icalperiodtype_is_valid_period(p);
 392         [ returns int  ]
 393