KCalCore::OccurrenceIterator Class Reference

#include <occurrenceiterator.h>

Public Member Functions
	OccurrenceIterator (const Calendar &calendar, const KDateTime &start=KDateTime(), const KDateTime &end=KDateTime())
	OccurrenceIterator (const Calendar &calendar, const KCalCore::Incidence::Ptr &incidence, const KDateTime &start=KDateTime(), const KDateTime &end=KDateTime())
bool	hasNext () const
Incidence::Ptr	incidence () const
void	next ()
KDateTime	occurrenceStartDate () const

Detailed Description

Iterate over calendar items in a calendar.

The iterator takes recurrences and exceptions to recurrences into account

The iterator does not iterate the occurrences of all incidences chronologically.

Since

4.11

Definition at line 46 of file occurrenceiterator.h.

Constructor & Destructor Documentation

OccurrenceIterator::OccurrenceIterator ( const Calendar &  calendar, const KDateTime &  start = KDateTime(), const KDateTime &  end = KDateTime()  )

explicit

Creates iterator that iterates over all occurrences of all incidences between.

Right now there is little point in the iterator, but: With an iterator it should be possible to solve this more memory efficiently and with immediate results at the beginning of the selected timeframe.

Parameters

start	and
end	(inclusive)

Either all events are iterated simoulatneously, resulting in occurrences of all events in parallel in the correct time-order, or incidence after incidence, which would be even more efficient.

By making this class a friend of calendar, we could also use the internally available data structures.

Definition at line 173 of file occurrenceiterator.cpp.

OccurrenceIterator::OccurrenceIterator	(	const Calendar &	calendar,
		const KCalCore::Incidence::Ptr &	incidence,
		const KDateTime &	start = KDateTime(),
		const KDateTime &	end = KDateTime()
	)

Creates iterator that iterates over all occurrences of.

Parameters

incidence	between
start	and
end	(inclusive)

Definition at line 210 of file occurrenceiterator.cpp.

Member Function Documentation

Incidence::Ptr OccurrenceIterator::incidence

(

)

const

Returns either main incidence or exception, depending on occurrence.

Definition at line 236 of file occurrenceiterator.cpp.

void OccurrenceIterator::next

(

)

Advance iterator to the next occurrence.

Definition at line 231 of file occurrenceiterator.cpp.

KDateTime OccurrenceIterator::occurrenceStartDate

(

)

const

Returns the start date of the occurrence.

This is either the occurrence date, or the start date of an exception which overrides that occurrence.

Definition at line 241 of file occurrenceiterator.cpp.

---

The documentation for this class was generated from the following files:

• occurrenceiterator.h
• occurrenceiterator.cpp