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
|
<!--
Copyright (C) 2015 William Yu <williamyu@gnome.org>
This library is free software: you can redistribute it and/or modify it
under the terms of version 2.1. of the GNU Lesser General Public License
as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
for more details.
You should have received a copy of the GNU Lesser General Public License
along with this library. If not, see <https://www.gnu.org/licenses/>.
-->
<structure namespace="ICal" name="Recur">
<method name="i_cal_recur_expand_recurrence" corresponds="CUSTOM" since="1.0">
<parameter type="const gchar *" name="rule" comment="The rule of the recurrence"/>
<parameter type="time_t" name="start" comment="The start seconds past the POSIX epoch"/>
<parameter type="gint" name="count" comment="The number of elements to be filled up in the @array"/>
<returns type="GArray *" annotation="array, element-type long, transfer full" comment="If successful, return the array. NULL if failed."/>
<comment xml:space="preserve">Fills an array with the 'count' number of occurrences generated by the rrule. 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.</comment>
<custom> time_t *array;
GArray *garray;
gint result;
g_return_val_if_fail (rule != NULL, 0);
array = g_new (time_t, count);
result = icalrecur_expand_recurrence (rule, start, count, array);
if (result == 0) {
g_free (array);
return NULL;
} else {
garray = g_array_new (FALSE, FALSE, sizeof (time_t));
g_array_append_vals (garray, array, count);
g_free (array);
return garray;
}</custom>
</method>
<method name="i_cal_recurrence_weekday_from_string" corresponds="icalrecur_string_to_weekday" since="1.0">
<parameter type="const gchar *" name="str" comment="The string representation of the weekday"/>
<returns type="ICalRecurrenceWeekday" comment="The enum representation of the weekday."/>
<comment xml:space="preserve">Converts a string representation to an enum representation for the weekday.</comment>
</method>
<method name="i_cal_recurrence_weekday_to_string" corresponds="icalrecur_weekday_to_string" since="2.0">
<parameter type="ICalRecurrenceWeekday" name="kind" comment="The frequency enum"/>
<returns type="const gchar *" comment="The string representation of weekday"/>
<comment xml:space="preserve">Converts a enum representation to a string representation for the weekday.</comment>
</method>
<method name="i_cal_recurrence_frequency_from_string" corresponds="icalrecur_string_to_freq" since="2.0">
<parameter type="const gchar *" name="str" comment="The string representation of the frequency"/>
<returns type="ICalRecurrenceFrequency" comment="The enum representation of the frequency."/>
<comment xml:space="preserve">Converts a string representation to an enum representation for the frequency.</comment>
</method>
<method name="i_cal_recurrence_frequency_to_string" corresponds="icalrecur_freq_to_string" since="2.0">
<parameter type="ICalRecurrenceFrequency" name="kind" comment="The frequency enum"/>
<returns type="const gchar *" comment="The string representation of frequency"/>
<comment xml:space="preserve">Converts a enum representation to a string representation for the frequency.</comment>
</method>
<method name="i_cal_recurrence_skip_from_string" corresponds="icalrecur_string_to_skip" since="2.0">
<parameter type="const gchar *" name="str" comment="The string representation of the skip"/>
<returns type="ICalRecurrenceSkip" comment="The enum representation of the skip."/>
<comment xml:space="preserve">Converts a string representation to an enum representation for the skip.</comment>
</method>
<method name="i_cal_recurrence_skip_to_string" corresponds="icalrecur_skip_to_string" since="2.0">
<parameter type="ICalRecurrenceSkip" name="kind" comment="The frequency enum"/>
<returns type="const gchar *" comment="The string representation of skip"/>
<comment xml:space="preserve">Converts a enum representation to a string representation for the skip.</comment>
</method>
</structure>
|
