blob: 7e0ad916bf677d533f1328bcaf6491fe429218d1 (
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
|
<!--
SPDX-FileCopyrightText: 2015 William Yu <williamyu@gnome.org>
SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
-->
<structure namespace="ICal" name="RecurIterator" native="icalrecur_iterator" destroy_func="icalrecur_iterator_free">
<method name="i_cal_recur_iterator_new" corresponds="icalrecur_iterator_new" kind="constructor" since="1.0">
<parameter type="ICalRecurrence *" name="rule" comment="The rule applied on the #ICalRecurIterator"/>
<parameter type="ICalTime *" name="dtstart" comment="The start time of the recurrence"/>
<returns type="ICalRecurIterator *" annotation="transfer full" comment="The newly created #ICalRecurIterator"/>
<comment xml:space="preserve">Creates an #ICalRecurIterator.</comment>
</method>
<method name="i_cal_recur_iterator_next" corresponds="icalrecur_iterator_next" since="1.0">
<parameter type="ICalRecurIterator *" name="iterator" comment="The iterator"/>
<returns type="ICalTime *" annotation="transfer full" comment="The next occurrence according to this recurrence rule."/>
<comment xml:space="preserve">Gets the next occurrence from an iterator.</comment>
</method>
<method name="i_cal_recur_iterator_set_start" corresponds="icalrecur_iterator_set_start" since="3.0">
<parameter type="ICalRecurIterator *" name="iterator" comment="The iterator"/>
<parameter type="ICalTime *" name="start" comment="The date-time to move the iterator to"/>
<returns type="gint" comment="1 if succeeded, 0 if failed, like when the recurrence type is unsupported."/>
<comment xml:space="preserve">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.</comment>
</method>
<method name="i_cal_recur_iterator_set_end" corresponds="icalrecur_iterator_set_end" since="3.1">
<parameter type="ICalRecurIterator *" name="iterator" comment="The iterator"/>
<parameter type="ICalTime *" name="end" comment="The date-time at which the iterator will stop"/>
<returns type="gint" comment="1 if succeeded, 0 if failed"/>
<comment xml:space="preserve">Sets 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.</comment>
</method>
<method name="i_cal_recur_iterator_free" corresponds="icalrecur_iterator_free" annotation="skip" kind="destructor" since="1.0">
<parameter type="ICalRecurIterator *" name="iterator" comment="The iterator to be freed"/>
<comment xml:space="preserve">Frees an iterator.</comment>
</method>
</structure>
|
