KCalendarCore::RecurrenceRule

KCalendarCore::RecurrenceRule Class Reference

#include <recurrencerule.h>

Classes

class  WDayPos
 

Public Types

typedef QList< RecurrenceRule * > List
 
enum  PeriodType {
  rNone = 0, rSecondly, rMinutely, rHourly,
  rDaily, rWeekly, rMonthly, rYearly
}
 

Public Member Functions

 RecurrenceRule ()
 
 RecurrenceRule (const RecurrenceRule &r)
 
void addObserver (RuleObserver *observer)
 
bool allDay () const
 
const QList< WDayPos > & byDays () const
 
const QList< int > & byHours () const
 
const QList< int > & byMinutes () const
 
const QList< int > & byMonthDays () const
 
const QList< int > & byMonths () const
 
const QList< int > & bySeconds () const
 
const QList< int > & bySetPos () const
 
const QList< int > & byWeekNumbers () const
 
const QList< int > & byYearDays () const
 
void clear ()
 
bool dateMatchesRules (const QDateTime &dt) const
 
void dump () const
 
int duration () const
 
int durationTo (const QDateTime &dt) const
 
int durationTo (const QDate &date) const
 
QDateTime endDt (bool *result=nullptr) const
 
uint frequency () const
 
QDateTime getNextDate (const QDateTime &preDateTime) const
 
QDateTime getPreviousDate (const QDateTime &afterDateTime) const
 
bool isReadOnly () const
 
bool operator!= (const RecurrenceRule &r) const
 
RecurrenceRuleoperator= (const RecurrenceRule &r)
 
bool operator== (const RecurrenceRule &r) const
 
PeriodType recurrenceType () const
 
bool recurs () const
 
bool recursAt (const QDateTime &dt) const
 
bool recursOn (const QDate &date, const QTimeZone &timeZone) const
 
TimeList recurTimesOn (const QDate &date, const QTimeZone &timeZone) const
 
void removeObserver (RuleObserver *observer)
 
QString rrule () const
 
void setAllDay (bool allDay)
 
void setByDays (const QList< WDayPos > &byDays)
 
void setByHours (const QList< int > &byHours)
 
void setByMinutes (const QList< int > &byMinutes)
 
void setByMonthDays (const QList< int > &byMonthDays)
 
void setByMonths (const QList< int > &byMonths)
 
void setBySeconds (const QList< int > &bySeconds)
 
void setBySetPos (const QList< int > &bySetPos)
 
void setByWeekNumbers (const QList< int > &byWeekNumbers)
 
void setByYearDays (const QList< int > &byYearDays)
 
void setDirty ()
 
void setDuration (int duration)
 
void setEndDt (const QDateTime &endDateTime)
 
void setFrequency (int freq)
 
void setReadOnly (bool readOnly)
 
void setRecurrenceType (PeriodType period)
 
void setRRule (const QString &rrule)
 
void setStartDt (const QDateTime &start)
 
void setWeekStart (short weekStart)
 
void shiftTimes (const QTimeZone &oldTz, const QTimeZone &newTz)
 
QDateTime startDt () const
 
QList< QDateTimetimesInInterval (const QDateTime &start, const QDateTime &end) const
 
short weekStart () const
 

Friends

KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &out, const KCalendarCore::RecurrenceRule *)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &in, const KCalendarCore::RecurrenceRule *)
 

Detailed Description

This class represents a recurrence rule for a calendar incidence.

Definition at line 30 of file recurrencerule.h.

Member Enumeration Documentation

enum for describing the frequency how an event recurs, if at all.

Definition at line 43 of file recurrencerule.h.

Constructor & Destructor Documentation

RecurrenceRule::RecurrenceRule ( )

/************************************************************************** RecurrenceRule *

Definition at line 882 of file recurrencerule.cpp.

Member Function Documentation

void RecurrenceRule::addObserver ( 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.

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

Definition at line 914 of file recurrencerule.cpp.

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.

Definition at line 2163 of file recurrencerule.cpp.

void RecurrenceRule::clear ( )

Turns off recurrence for the event.

Definition at line 996 of file recurrencerule.cpp.

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.

Parameters
dtthe date+time to check for matching the rules

Definition at line 1368 of file recurrencerule.cpp.

void RecurrenceRule::dump ( ) const

Debug output.

Definition at line 2033 of file recurrencerule.cpp.

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.

Definition at line 2133 of file recurrencerule.cpp.

int RecurrenceRule::durationTo ( const QDateTime dt) const

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

Definition at line 1571 of file recurrencerule.cpp.

int RecurrenceRule::durationTo ( const QDate date) const

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

Definition at line 1593 of file recurrencerule.cpp.

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.

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

Definition at line 935 of file recurrencerule.cpp.

uint RecurrenceRule::frequency ( ) const

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

Definition at line 2128 of file recurrencerule.cpp.

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.

Parameters
preDateTimethe date/time after which to find the recurrence.
Returns
date/time of next recurrence, or invalid date if none.

Definition at line 1664 of file recurrencerule.cpp.

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.

Parameters
afterDateTimethe date/time before which to find the recurrence.
Returns
date/time of previous recurrence, or invalid date if none.

Definition at line 1598 of file recurrencerule.cpp.

bool RecurrenceRule::isReadOnly ( ) const

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

Definition at line 2148 of file recurrencerule.cpp.

bool RecurrenceRule::recurs ( ) const

Returns the event's recurrence status.

See the enumeration at the top of this file for possible values.

Definition at line 2158 of file recurrencerule.cpp.

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.

Parameters
dtthe date+time to check for recurrency

Definition at line 1519 of file recurrencerule.cpp.

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.

Parameters
datedate to check
timeZonetime specification for date

Definition at line 1379 of file recurrencerule.cpp.

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.

Parameters
datethe date for which to find the recurrence times
timeZonetime specification for date

Definition at line 1555 of file recurrencerule.cpp.

void RecurrenceRule::removeObserver ( RuleObserver *  observer)

Removes an observer that was added with addObserver.

If the given object was not an observer, it does nothing.

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

Definition at line 921 of file recurrencerule.cpp.

void RecurrenceRule::setAllDay ( bool  allDay)

Sets whether the dtstart is all-day (i.e.

has no time attached)

Parameters
allDayWhether start datetime is all-day

Definition at line 987 of file recurrencerule.cpp.

void RecurrenceRule::setDuration ( int  duration)

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

Definition at line 978 of file recurrencerule.cpp.

void RecurrenceRule::setEndDt ( const QDateTime endDateTime)

Sets the date and time of the last recurrence.

Parameters
endDateTimethe ending date/time after which to stop recurring.

Definition at line 966 of file recurrencerule.cpp.

void RecurrenceRule::setFrequency ( int  freq)

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

Definition at line 1015 of file recurrencerule.cpp.

void RecurrenceRule::setReadOnly ( bool  readOnly)

Set if recurrence is read-only or can be changed.

Definition at line 2153 of file recurrencerule.cpp.

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.

Parameters
rrulethe RRULE string

Definition at line 2143 of file recurrencerule.cpp.

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

Parameters
startthe recurrence's start date and time

Definition at line 1006 of file recurrencerule.cpp.

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.

Parameters
oldTzthe time specification which provides the clock times
newTzthe new time specification

Definition at line 1114 of file recurrencerule.cpp.

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.

Definition at line 2118 of file recurrencerule.cpp.

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.

Parameters
startinclusive start of interval
endinclusive end of interval
Returns
list of date/time values

Definition at line 1727 of file recurrencerule.cpp.

Friends And Related Function Documentation

KCALENDARCORE_EXPORT QDataStream& operator<< ( QDataStream out,
const KCalendarCore::RecurrenceRule  
)
friend

RecurrenceRule serializer and deserializer.

Since
4.12

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jul 6 2020 22:50:15 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.