:right-sidebar: True

RecurIterator
===================================================================

.. currentmodule:: gi.repository.ICalGLib





.. class:: RecurIterator(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.ICalGLib.Object`, :class:`~gi.repository.GObject.Object`





This is the ICalRecurIterator instance.


Constructors
------------

.. rst-class:: interim-class

.. class:: RecurIterator
   :no-index:


   .. classmethod:: new(rule: ~gi.repository.ICalGLib.Recurrence, dtstart: ~gi.repository.ICalGLib.Time) -> ~gi.repository.ICalGLib.RecurIterator

      Creates an :obj:`~gi.repository.ICalGLib.RecurIterator`\.


      .. versionadded:: 1.0





      :param rule: The rule applied on the :obj:`~gi.repository.ICalGLib.RecurIterator`

      :param dtstart: The start time of the recurrence








Methods
-------

.. rst-class:: interim-class

.. class:: RecurIterator
   :no-index:


   .. method:: next() -> ~gi.repository.ICalGLib.Time

      Gets the next occurrence from an iterator.



      .. versionadded:: 1.0








   .. method:: set_start(start: ~gi.repository.ICalGLib.Time) -> 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.



      .. versionadded:: 3.0





      :param start: The date-time to move the iterator to