KCalendarCore::RecurrenceRule Class

Member Function Documentation

void RecurrenceRule::addObserver(KCalendarCore::RecurrenceRule::RuleObserver *observer)

Installs an observer. Whenever some setting of this recurrence object is changed, the recurrenceUpdated( Recurrence* ) method of each observer will be called to inform it of changes.

observer the Recurrence::Observer-derived object, which will be installed as an observer of this object.

bool RecurrenceRule::allDay() const

Returns whether the start date has no time associated. All-Day means – according to rfc2445 – that the event has no time associate.

See also setAllDay().

void RecurrenceRule::clear()

Turns off recurrence for the event.

bool RecurrenceRule::dateMatchesRules(const QDateTime &dt) const

Returns true if the date matches the rules. It does not necessarily mean that this is an actual occurrence. In particular, the method does not check if the date is after the end date, or if the frequency interval matches.

dt the date+time to check for matching the rules

void RecurrenceRule::dump() const

Debug output.

int RecurrenceRule::duration() const

Returns -1 if the event recurs infinitely, 0 if the end date is set, otherwise the total number of recurrences, including the initial occurrence.

See also setDuration().

int RecurrenceRule::durationTo(const QDate &date) const

Returns the number of recurrences up to and including the date specified.

int RecurrenceRule::durationTo(const QDateTime &dt) const

Returns the number of recurrences up to and including the date/time specified.

QDateTime RecurrenceRule::endDt(bool *result = nullptr) const

Returns the date and time of the last recurrence. An invalid date is returned if the recurrence has no end.

result if non-null, *result is updated to true if successful, or false if there is no recurrence or its end date cannot be determined.

See also setEndDt().

uint RecurrenceRule::frequency() const

Returns the recurrence frequency, in terms of the recurrence time period type.

See also setFrequency().

QDateTime RecurrenceRule::getNextDate(const QDateTime &preDateTime) const

Returns the date and time of the next recurrence, after the specified date/time. If the recurrence has no time, the next date after the specified date is returned.

preDateTime the date/time after which to find the recurrence.

Returns date/time of next recurrence, or invalid date if none.

QDateTime RecurrenceRule::getPreviousDate(const QDateTime &afterDateTime) const

Returns the date and time of the last previous recurrence, before the specified date/time. If a time later than 00:00:00 is specified and the recurrence has no time, 00:00:00 on the specified date is returned if that date recurs.

afterDateTime the date/time before which to find the recurrence.

Returns date/time of previous recurrence, or invalid date if none.

bool RecurrenceRule::isReadOnly() const

Returns true if the recurrence is read-only; false if it can be changed.

KCalendarCore::TimeList RecurrenceRule::recurTimesOn(const QDate &date, const QTimeZone &timeZone) const

Returns a list of the times on the specified date at which the recurrence will occur. The returned times should be interpreted in the context of timeZone.

date the date for which to find the recurrence times

timeZone time specification for date

bool RecurrenceRule::recurs() const

Returns the event's recurrence status. See the enumeration at the top of this file for possible values.

bool RecurrenceRule::recursAt(const QDateTime &dt) const

Returns true if the date/time specified is one at which the event will recur. Times are rounded down to the nearest minute to determine the result. The start date/time returns true only if it actually matches the rule.

dt the date+time to check for recurrency

bool RecurrenceRule::recursOn(const QDate &date, const QTimeZone &timeZone) const

Returns true if the date specified is one on which the event will recur. The start date returns true only if it actually matches the rule.

date date to check

timeZone time specification for date

void RecurrenceRule::removeObserver(KCalendarCore::RecurrenceRule::RuleObserver *observer)

Removes an observer that was added with addObserver. If the given object was not an observer, it does nothing.

observer the Recurrence::Observer-derived object to be removed from the list of observers of this object.

void RecurrenceRule::setAllDay(bool allDay)

Sets whether the dtstart is all-day (i.e. has no time attached)

allDay Whether start datetime is all-day

See also allDay().

void RecurrenceRule::setDuration(int duration)

Sets the total number of times the event is to occur to duration, including both the first and last.

See also duration().

void RecurrenceRule::setEndDt(const QDateTime &endDateTime)

Sets the date and time of the last recurrence.

endDateTime the ending date/time after which to stop recurring.

See also endDt().

void RecurrenceRule::setFrequency(int freq)

Sets the recurrence frequency to freq, in terms of the recurrence time period type.

See also frequency().

void RecurrenceRule::setRRule(const QString &rrule)

Set the RRULE string for the rule. This is merely stored for future reference. The string is not used in any way by the RecurrenceRule.

rrule the RRULE string

void RecurrenceRule::setReadOnly(bool readOnly)

Set if recurrence is read-only (if readOnly is true) or can be changed (if readOnly is false).

See also isReadOnly().

void RecurrenceRule::setStartDt(const QDateTime &start)

Sets the recurrence start date/time. Note that setting the start date/time does not make the recurrence occur on that date/time, it simply sets a lower limit to when the recurrences take place (this applies only for the by- rules, not for i.e. an hourly rule where the startDt is the first occurrence).

Note that setting start to a date-only value does not make an all-day recurrence: to do this, call setAllDay(true).

start the recurrence's start date and time

See also startDt().

void RecurrenceRule::shiftTimes(const QTimeZone &oldTz, const QTimeZone &newTz)

Shift the times of the rule so that they appear at the same clock time as before but in a new time zone. The shift is done from a viewing time zone rather than from the actual rule time zone.

For example, shifting a rule whose start time is 09:00 America/New York, using an old viewing time zone (oldTz) of Europe/London, to a new time zone (newTz) of Europe/Paris, will result in the time being shifted from 14:00 (which is the London time of the rule start) to 14:00 Paris time.

oldTz the time specification which provides the clock times

newTz the new time specification

QDateTime RecurrenceRule::startDt() const

Returns the recurrence start date/time. Note that the recurrence does not necessarily occur on the start date/time. For this to happen, it must actually match the rule.

See also setStartDt().

QList<QDateTime> RecurrenceRule::timesInInterval(const QDateTime &start, const QDateTime &end) const

Returns a list of all the times at which the recurrence will occur between two specified times.

There is a (large) maximum limit to the number of times returned. If due to this limit the list is incomplete, this is indicated by the last entry being set to an invalid QDateTime value. If you need further values, call the method again with a start time set to just after the last valid time returned.

start inclusive start of interval

end inclusive end of interval

Returns list of date/time values