ICalGLib.RecurIterator

ICalGLib.RecurIterator

ICalGLib.RecurIterator¶

Subclasses:: None

Methods¶

Inherited:: ICalGLib.Object (11), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (rule, dtstart)
	`next` ()
	`set_start` (start)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: ICalGLib.Object (5)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class ICalGLib.RecurIterator(**kwargs)¶

Bases:: ICalGLib.Object
Abstract:: No
Structure:: ICalGLib.RecurIteratorClass

This is the ICalGLib.RecurIterator instance.

classmethod new(rule, dtstart)¶

Parameters:

rule (ICalGLib.Recurrence) – The rule applied on the ICalGLib.RecurIterator
dtstart (ICalGLib.Time) – The start time of the recurrence

Returns:

The newly created ICalGLib.RecurIterator

Return type:

ICalGLib.RecurIterator

Creates an ICalGLib.RecurIterator.

New in version 1.0.

next()¶

Returns:: The next occurrence according to this recurrence rule.
Return type:: ICalGLib.Time

Gets the next occurrence from an iterator.

New in version 1.0.

set_start(start)¶

Parameters:: start (ICalGLib.Time) – The date-time to move the iterator to
Returns:: 1 if succeeded, 0 if failed, like when the recurrence type is unsupported.
Return type:: int

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.

New in version 3.0.