KCalendarCore::OccurrenceIterator Class

class KCalendarCore::OccurrenceIterator

Iterate over calendar items in a calendar. More...

Header:	`#include <KCalendarCore/OccurrenceIterator>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS CalendarCore)` `target_link_libraries(mytarget PRIVATE KF6::CalendarCore)`
Since:	4.11

List of all members, including inherited members

Public Functions

	OccurrenceIterator(const KCalendarCore::Calendar &calendar, const QDateTime &start = QDateTime(), const QDateTime &end = QDateTime())
	OccurrenceIterator(const KCalendarCore::Calendar &calendar, const KCalendarCore::Incidence::Ptr &incidence, const QDateTime &start = QDateTime(), const QDateTime &end = QDateTime())
KCalendarCore::Incidence::Ptr	incidence() const
void	next()
`(since 5.87)` QDateTime	occurrenceEndDate() const
QDateTime	occurrenceStartDate() const
QDateTime	recurrenceId() const

Detailed Description

The iterator takes recurrences and exceptions to recurrences into account

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

Member Function Documentation

`[explicit]` OccurrenceIterator::OccurrenceIterator(const KCalendarCore::Calendar &calendar, const QDateTime &start = QDateTime(), const QDateTime &end = QDateTime())

Creates iterator that iterates over all occurrences of all incidences between start and end (inclusive)

OccurrenceIterator::OccurrenceIterator(const KCalendarCore::Calendar &calendar, const KCalendarCore::Incidence::Ptr &incidence, const QDateTime &start = QDateTime(), const QDateTime &end = QDateTime())

Creates iterator that iterates over all occurrences of incidence between start and end (inclusive)

KCalendarCore::Incidence::Ptr OccurrenceIterator::incidence() const

Returns either main incidence or exception, depending on occurrence.

void OccurrenceIterator::next()

Advance iterator to the next occurrence.

`[since 5.87]` QDateTime OccurrenceIterator::occurrenceEndDate() const

Returns the end date of the occurrence

For incidence that supports end date (events and due date for todos), this is computed from the duration or directly the end date of the occurrence or an exception overriding that occurrence. For incidences without end date, an invalid date is returned.

This function was introduced in 5.87.

QDateTime 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.

QDateTime OccurrenceIterator::recurrenceId() const

Returns the recurrence Id.

This is the date where the occurrence starts without exceptions, this id is used to identify one exact occurrence.

Contents