summaryrefslogtreecommitdiff
path: root/src/Net-ICal-Libical/netical_wrap.doc
blob: 41616c00daf9961cf66271769d8d603a4987ff93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
netical_wrap.c

[ Module : Net__ICal__Libical, Package : Net::ICal::Libical ]


icalparser_parse_string(str);
        [ returns icalcomponent * ]

icalcomponent_new(kind);
        [ returns icalcomponent * ]

icalcomponent_new_clone(component);
        [ returns icalcomponent * ]

icalcomponent_new_from_string(str);
        [ returns icalcomponent * ]

icalcomponent_as_ical_string(component);
        [ returns char * ]

icalcomponent_free(component);
        [ returns void  ]

icalcomponent_count_errors(component);
        [ returns int  ]

icalcomponent_strip_errors(component);
        [ returns void  ]

icalcomponent_convert_errors(component);
        [ returns void  ]

icalcomponent_get_current_property(component);
        [ returns icalproperty * ]

icalcomponent_get_first_property(component,kind);
        [ returns icalproperty * ]

icalcomponent_get_next_property(component,kind);
        [ returns icalproperty * ]

icalcomponent_get_current_component(component);
        [ returns icalcomponent * ]

icalcomponent_get_first_component(component,kind);
        [ returns icalcomponent * ]

icalcomponent_get_next_component(component,kind);
        [ returns icalcomponent * ]

icalcomponent_add_property(component,property);
        [ returns void  ]

icalcomponent_remove_property(component,property);
        [ returns void  ]

icalcomponent_get_parent(component);
        [ returns icalcomponent * ]

icalcomponent_isa(component);
        [ returns icalcomponent_kind  ]

icalrestriction_check(comp);
        [ returns int  ]

icalproperty_string_to_kind(string);
        [ returns int  ]

icalproperty_new(kind);
        [ returns icalproperty * ]

icalproperty_new_from_string(str);
        [ returns icalproperty * ]

icalproperty_as_ical_string(prop);
        [ returns char * ]

icalproperty_set_parameter_from_string(prop,name,value);
        [ returns void  ]

icalproperty_set_value_from_string(prop,value,kind);
        [ returns void  ]

icalproperty_get_value_as_string(prop);
        [ returns char * ]

icalproperty_get_parameter_as_string(prop,name);
        [ returns char * ]

icalproperty_get_parent(property);
        [ returns icalcomponent * ]

$ICAL_BADARG_ERROR = ICAL_BADARG_ERROR
        [ Constant: int  ]

$ICAL_NEWFAILED_ERROR = ICAL_NEWFAILED_ERROR
        [ Constant: int  ]

$ICAL_MALFORMEDDATA_ERROR = ICAL_MALFORMEDDATA_ERROR
        [ Constant: int  ]

$ICAL_PARSE_ERROR = ICAL_PARSE_ERROR
        [ Constant: int  ]

$ICAL_INTERNAL_ERROR = ICAL_INTERNAL_ERROR
        [ Constant: int  ]
        Like assert --internal consist. prob 

$ICAL_FILE_ERROR = ICAL_FILE_ERROR
        [ Constant: int  ]

$ICAL_ALLOCATION_ERROR = ICAL_ALLOCATION_ERROR
        [ Constant: int  ]

$ICAL_USAGE_ERROR = ICAL_USAGE_ERROR
        [ Constant: int  ]

$ICAL_NO_ERROR = ICAL_NO_ERROR
        [ Constant: int  ]
        Used for problems in input to icalerror_strerror() 

$ICAL_UNKNOWN_ERROR = ICAL_UNKNOWN_ERROR
        [ Constant: int  ]

$ICAL_ERROR_FATAL = ICAL_ERROR_FATAL
        [ Constant: int  ]
        Not fata 

$ICAL_ERROR_NONFATAL = ICAL_ERROR_NONFATAL
        [ Constant: int  ]
        Fatal 

$ICAL_ERROR_DEFAULT = ICAL_ERROR_DEFAULT
        [ Constant: int  ]
        Use the value of icalerror_errors_are_fatal Asked state for an unknown
        error type 

$ICAL_ERROR_UNKNOWN = ICAL_ERROR_UNKNOWN
        [ Constant: int  ]

icalerror_set_error_state(error,icalerrorstate );
        [ returns void  ]

icalerror_get_error_state(error);
        [ returns icalerrorstate  ]

icalenum_property_kind_to_string(kind);
        [ returns char * ]

icalenum_string_to_property_kind(string);
        [ returns icalproperty_kind  ]

icalenum_value_kind_to_string(kind);
        [ returns char * ]
        icalvalue_kind icalenum_value_kind_by_prop(icalproperty_kind kind);
        

icalenum_parameter_kind_to_string(kind);
        [ returns char * ]

icalenum_string_to_parameter_kind(string);
        [ returns icalparameter_kind  ]

icalenum_component_kind_to_string(kind);
        [ returns char * ]

icalenum_string_to_component_kind(string);
        [ returns icalcomponent_kind  ]

icalenum_property_kind_to_value_kind(kind);
        [ returns icalvalue_kind  ]

icallangbind_new_array(size);
        [ returns int * ]

icallangbind_free_array(array);
        [ returns void  ]

icallangbind_access_array(array,index);
        [ returns int  ]

icalrecur_expand_recurrence(rule,start,count,array);
        [ returns int  ]

icallangbind_get_first_property(c,prop);
        [ returns icalproperty * ]

icallangbind_get_next_property(c,prop);
        [ returns icalproperty * ]

icallangbind_get_first_component(c,comp);
        [ returns icalcomponent * ]

icallangbind_get_next_component(c,comp);
        [ returns icalcomponent * ]

icallangbind_property_eval_string(prop,sep);
        [ returns char * ]

1.  class icaltimetype
======================
[ created from struct icaltimetype ]


icaltimetype_year_set(struct icaltimetype *,int );
icaltimetype_year_get(struct icaltimetype *);
        [ Member data: returns int  ]

icaltimetype_month_set(struct icaltimetype *,int );
icaltimetype_month_get(struct icaltimetype *);
        [ Member data: returns int  ]

icaltimetype_day_set(struct icaltimetype *,int );
icaltimetype_day_get(struct icaltimetype *);
        [ Member data: returns int  ]

icaltimetype_hour_set(struct icaltimetype *,int );
icaltimetype_hour_get(struct icaltimetype *);
        [ Member data: returns int  ]

icaltimetype_minute_set(struct icaltimetype *,int );
icaltimetype_minute_get(struct icaltimetype *);
        [ Member data: returns int  ]

icaltimetype_second_set(struct icaltimetype *,int );
icaltimetype_second_get(struct icaltimetype *);
        [ Member data: returns int  ]

icaltimetype_is_utc_set(struct icaltimetype *,int );
icaltimetype_is_utc_get(struct icaltimetype *);
        [ Member data: returns int  ]
        1-> time is in UTC timezone 

icaltimetype_is_date_set(struct icaltimetype *,int );
icaltimetype_is_date_get(struct icaltimetype *);
        [ Member data: returns int  ]
        1 -> interpret this as date. 

$icaltimetype_zone = icaltimetype::zone
        [ Constant: char * ]
        Ptr to Olsen placename. Libical does not own mem 

----------

icaltime_from_timet(v,is_date);
        [ returns struct icaltimetype  ]

icaltime_as_timet(struct icaltimetype *);
        [ returns int  ]

icaltime_as_ical_string(tt);
        [ returns char * ]

icaltime_from_string(str);
        [ returns struct icaltimetype  ]

icaltime_utc_offset(tt,tzid);
        [ returns int  ]

icaltime_as_utc(tt,tzid);
        [ returns struct icaltimetype  ]

icaltime_as_zone(tt,tzid);
        [ returns struct icaltimetype  ]

icaltime_null_time();
        [ returns struct icaltimetype  ]

icaltime_is_null_time(t);
        [ returns int  ]

icaltime_is_valid_time(t);
        [ returns int  ]

icaltime_normalize(t);
        [ returns struct icaltimetype  ]

icaltime_day_of_year(t);
        [ returns short  ]

icaltime_from_day_of_year(doy,year);
        [ returns struct icaltimetype  ]

icaltime_day_of_week(t);
        [ returns short  ]

icaltime_start_doy_of_week(t);
        [ returns short  ]

icaltime_as_ctime(struct icaltimetype *);
        [ returns char * ]

icaltime_week_number(t);
        [ returns short  ]

icaltime_compare(a,b);
        [ returns int  ]

icaltime_compare_date_only(a,b);
        [ returns int  ]

icaltime_days_in_month(month,year);
        [ returns short  ]

2.  class icaldurationtype
==========================
[ created from struct icaldurationtype ]


icaldurationtype_is_neg_set(struct icaldurationtype *,int );
icaldurationtype_is_neg_get(struct icaldurationtype *);
        [ Member data: returns int  ]

icaldurationtype_days_set(struct icaldurationtype *,unsigned int );
icaldurationtype_days_get(struct icaldurationtype *);
        [ Member data: returns unsigned int  ]

icaldurationtype_weeks_set(struct icaldurationtype *,unsigned int );
icaldurationtype_weeks_get(struct icaldurationtype *);
        [ Member data: returns unsigned int  ]

icaldurationtype_hours_set(struct icaldurationtype *,unsigned int );
icaldurationtype_hours_get(struct icaldurationtype *);
        [ Member data: returns unsigned int  ]

icaldurationtype_minutes_set(struct icaldurationtype *,unsigned int );
icaldurationtype_minutes_get(struct icaldurationtype *);
        [ Member data: returns unsigned int  ]

icaldurationtype_seconds_set(struct icaldurationtype *,unsigned int );
icaldurationtype_seconds_get(struct icaldurationtype *);
        [ Member data: returns unsigned int  ]

----------

icaldurationtype_from_int(t);
        [ returns struct icaldurationtype  ]

icaldurationtype_from_string(char *);
        [ returns struct icaldurationtype  ]

icaldurationtype_as_int(duration);
        [ returns int  ]

icaldurationtype_as_ical_string(d);
        [ returns char * ]

icaldurationtype_null_duration();
        [ returns struct icaldurationtype  ]

icaldurationtype_is_null_duration(d);
        [ returns int  ]

icaltime_add(t,d);
        [ returns struct icaltimetype  ]

icaltime_subtract(t1,t2);
        [ returns struct icaldurationtype  ]

3.  class icalperiodtype
========================
[ created from struct icalperiodtype ]


icalperiodtype_start_set(struct icalperiodtype *,struct icaltimetype *);
icalperiodtype_start_get(struct icalperiodtype *);
        [ Member data: returns struct icaltimetype * ]

icalperiodtype_end_set(struct icalperiodtype *,struct icaltimetype *);
icalperiodtype_end_get(struct icalperiodtype *);
        [ Member data: returns struct icaltimetype * ]

icalperiodtype_duration_set(struct icalperiodtype *,struct icaldurationtype *);
icalperiodtype_duration_get(struct icalperiodtype *);
        [ Member data: returns struct icaldurationtype * ]

----------

icalperiodtype_from_string(str);
        [ returns struct icalperiodtype  ]

icalperiodtype_as_ical_string(p);
        [ returns char * ]

icalperiodtype_null_period();
        [ returns struct icalperiodtype  ]

icalperiodtype_is_null_period(p);
        [ returns int  ]

icalperiodtype_is_valid_period(p);
        [ returns int  ]