libkcal

KCal::Recurrence

KCal::Recurrence Class Reference

This class represents a recurrence rule for a calendar incidence. More...

#include <recurrence.h>

Inheritance diagram for KCal::Recurrence:

Inheritance graph
[legend]

List of all members.


Classes

class  Observer

Public Types

enum  {
  rNone = 0, rMinutely = 0x001, rHourly = 0x0002, rDaily = 0x0003,
  rWeekly = 0x0004, rMonthlyPos = 0x0005, rMonthlyDay = 0x0006, rYearlyMonth = 0x0007,
  rYearlyDay = 0x0008, rYearlyPos = 0x0009, rOther = 0x000A, rMax = 0x00FF
}

Public Member Functions

void addExDate (const QDate &exdate)
void addExDateTime (const QDateTime &exdate)
void addExRule (RecurrenceRule *exrule)
void addMonthlyDate (short day)
void addMonthlyPos (short pos, ushort day)
void addMonthlyPos (short pos, const QBitArray &days)
void addObserver (Observer *observer)
void addRDate (const QDate &rdate)
void addRDateTime (const QDateTime &rdate)
void addRRule (RecurrenceRule *rrule)
void addWeeklyDays (const QBitArray &days)
void addYearlyDate (int date)
void addYearlyDay (int day)
void addYearlyMonth (short _rNum)
void addYearlyPos (short pos, const QBitArray &days)
void clear ()
QBitArray days () const
RecurrenceRule * defaultRRule (bool create=false) const
RecurrenceRule * defaultRRuleConst () const
bool doesFloat () const
bool doesRecur () const
void dump () const
int duration () const
int durationTo (const QDate &date) const
int durationTo (const QDateTime &) const
QDate endDate () const
QDateTime endDateTime () const
DateList exDates () const
DateTimeList exDateTimes () const
RecurrenceRule::List exRules () const
int frequency () const
QDateTime getNextDateTime (const QDateTime &preDateTime) const
QDateTime getPreviousDateTime (const QDateTime &afterDateTime) const
QValueList< int > monthDays () const
QValueList
< RecurrenceRule::WDayPos > 		monthPositions () const
bool operator!= (const Recurrence &r) const
bool operator== (const Recurrence &) const
DateList rDates () const
DateTimeList rDateTimes () const
bool recurReadOnly () const
 Recurrence (const Recurrence &)
 Recurrence ()
void recurrenceChanged (RecurrenceRule *)
ushort recurrenceType () const
bool recursAt (const QDateTime &) const
bool recursOn (const QDate &qd) const
QValueList< QTime > recurTimesOn (const QDate &date) const
void removeExRule (RecurrenceRule *exrule)
void removeObserver (Observer *observer)
void removeRRule (RecurrenceRule *rrule)
RecurrenceRule::List rRules () const
void setDaily (int freq)
void setDuration (int duration)
void setEndDate (const QDate &endDate)
void setEndDateTime (const QDateTime &endDateTime)
void setExDates (const DateList &exdates)
void setExDateTimes (const DateTimeList &exdates)
void setFloats (bool floats)
void setFrequency (int freq)
void setHourly (int freq)
void setMinutely (int freq)
void setMonthly (int freq)
void setRDates (const DateList &rdates)
void setRDateTimes (const DateTimeList &rdates)
void setRecurReadOnly (bool readOnly)
void setStartDate (const QDate &start)
void setStartDateTime (const QDateTime &start)
void setWeekly (int freq, const QBitArray &days, int weekStart=1)
void setWeekly (int freq, int weekStart=1)
void setYearly (int freq)
QDate startDate () const
QDateTime startDateTime () const
void unsetRecurs ()
void updated ()
int weekStart () const
QValueList< int > yearDates () const
QValueList< int > yearDays () const
QValueList< int > yearMonths () const
QValueList
< RecurrenceRule::WDayPos > 		yearPositions () const
virtual ~Recurrence ()

Static Public Member Functions

static ushort recurrenceType (const RecurrenceRule *rrule)

Static Public Attributes

static const QDate MAX_DATE

Protected Member Functions

RecurrenceRule * setNewRecurrenceType (RecurrenceRule::PeriodType type, int freq)

Detailed Description

This class represents a recurrence rule for a calendar incidence.

It manages all recurrence rules, recurrence date/times, exception rules and exception date times that can appear inside calendar items. Each recurrence rule and exception rule is represented as an object of type RecurrenceRule.

For the simple case where at most one recurrence rule is present, this class provides shortcut methods to set the type: setMinutely() setHourly() setDaily() setWeekly() setMonthly() setYearly() to set/get general information about the recurrence: setEndDate() setEndDateTime() duration() durationTo() setDuration() frequency() setFrequency() and to set/get specific information about the recurrence within the interval: days() monthDays() monthPositions() yearDays() yearDates() yearMonths() yearPositions() addMonthlyPos() addMonthlyDate() addYearlyDay() addYearlyDate() addYearlyPos() addYearlyMonth() These are all available so that you don't have to work on the RecurrenceRule objects themselves. In other words, in that simple situation the interface stays almost the same compared to the old Recurrence class, which allowed only one recurrence rule.

As soon as your recurrence consists of multiple recurrence rules or exception rules, you cannot use the methods mentioned above any more (since each rule will have a different type and different settings). If you still call any of them, the set*ly methods will remove all rules and add one rule with the specified type. The add* and the other set* methods will change only the first recurrence rule, but leave the others untouched.

Definition at line 89 of file recurrence.h.

Member Enumeration Documentation

anonymous enum

enumeration for describing how an event recurs, if at all.

Enumerator:
rNone 
rMinutely 
rHourly 
rDaily 
rWeekly 
rMonthlyPos 
rMonthlyDay 
rYearlyMonth 
rYearlyDay 
rYearlyPos 
rOther 
rMax 

Definition at line 100 of file recurrence.h.

Constructor & Destructor Documentation

Recurrence::Recurrence (  ) 

Definition at line 38 of file recurrence.cpp.

Recurrence::Recurrence ( const Recurrence &  r  ) 

Definition at line 47 of file recurrence.cpp.

Recurrence::~Recurrence (  )  [virtual]

Definition at line 71 of file recurrence.cpp.

Member Function Documentation

void Recurrence::addExDate ( const QDate &  exdate  ) 

Definition at line 1031 of file recurrence.cpp.

void Recurrence::addExDateTime ( const QDateTime &  exdate  ) 

Definition at line 1009 of file recurrence.cpp.

void Recurrence::addExRule ( RecurrenceRule *  exrule  ) 

Definition at line 935 of file recurrence.cpp.

void Recurrence::addMonthlyDate ( short  day  ) 

Adds a date (e.g.

the 15th of each month) to the monthly day recurrence list.

Parameters:
day the date in the month to recur.

Definition at line 659 of file recurrence.cpp.

void Recurrence::addMonthlyPos ( short  pos,
ushort  day 
)

Definition at line 642 of file recurrence.cpp.

void Recurrence::addMonthlyPos ( short  pos,
const QBitArray &  days 
)

Adds a position (e.g.

first monday) to the monthly recurrence rule.

Parameters:
pos the position in the month for the recurrence, with valid values being 1-5 (5 weeks max in a month).
days the days for the position to recur on (bit 0 = Monday). Example: pos = 2, and bits 0 and 2 are set in days: the rule is to repeat every 2nd Monday and Wednesday in the month.

Definition at line 617 of file recurrence.cpp.

void Recurrence::addObserver ( Observer *  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:
observer the Recurrence::Observer-derived object, which will be installed as an observer of this object.

Definition at line 114 of file recurrence.cpp.

void Recurrence::addRDate ( const QDate &  rdate  ) 

Definition at line 988 of file recurrence.cpp.

void Recurrence::addRDateTime ( const QDateTime &  rdate  ) 

Definition at line 966 of file recurrence.cpp.

void Recurrence::addRRule ( RecurrenceRule *  rrule  ) 

Definition at line 913 of file recurrence.cpp.

void Recurrence::addWeeklyDays ( const QBitArray &  days  ) 

Adds days to the weekly day recurrence list.

Parameters:
days a 7 bit array indicating which days on which to recur (bit 0 = Monday).

Definition at line 606 of file recurrence.cpp.

void Recurrence::addYearlyDate ( int  date  ) 

Adds date within a yearly recurrence.

The month(s) for the recurrence can be specified with addYearlyMonth(), otherwise the month of the start date is used.

By default infinite recurrence is used. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

Parameters:
date the day of the month for the event

Definition at line 695 of file recurrence.cpp.

void Recurrence::addYearlyDay ( int  day  ) 

Adds day number of year within a yearly recurrence.

By default infinite recurrence is used. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

Parameters:
day the day of the year for the event. E.g. if day is 60, this means Feb 29 in leap years and March 1 in non-leap years.

Definition at line 681 of file recurrence.cpp.

void Recurrence::addYearlyMonth ( short  _rNum  ) 

Adds month in yearly recurrence.

You can specify specific day numbers within the months (by calling addYearlyDate()) or specific day positions within the month (by calling addYearlyPos).

Parameters:
_rNum the month in which the event shall recur.

Definition at line 708 of file recurrence.cpp.

void Recurrence::addYearlyPos ( short  pos,
const QBitArray &  days 
)

Adds position within month/year within a yearly recurrence.

If months are specified (via addYearlyMonth()), the parameters are understood as position within these months, otherwise within the year.

By default infinite recurrence is used. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

Parameters:
pos the position in the month/year for the recurrence, with valid values being 1 to 53 and -1 to -53 (53 weeks max in a year).
days the days for the position to recur on (bit 0 = Monday). Example: pos = 2, and bits 0 and 2 are set in days If months are specified (via addYearlyMonth), e.g. March, the rule is to repeat every year on the 2nd Monday and Wednesday of March. If no months are specified, the fule is to repeat every year on the 2nd Monday and Wednesday of the year.

Definition at line 701 of file recurrence.cpp.

void Recurrence::clear (  ) 

Removes all recurrence and exception rules and dates.

Definition at line 433 of file recurrence.cpp.

QBitArray Recurrence::days (  )  const

Returns week day mask (bit 0 = Monday).

Definition at line 496 of file recurrence.cpp.

RecurrenceRule * Recurrence::defaultRRule ( bool  create = false  )  const

Definition at line 153 of file recurrence.cpp.

RecurrenceRule * Recurrence::defaultRRuleConst (  )  const

Definition at line 166 of file recurrence.cpp.

bool KCal::Recurrence::doesFloat (  )  const [inline]

Set whether the recurrence has no time, just a date.

Floating means -- according to rfc2445 -- that the event has no time associated. N.B. This property is derived by default from whether setStartDateTime() or setStartDate() is called.

Returns:
whether the recurrence has a time (false) or it is just a date (true).

Definition at line 132 of file recurrence.h.

bool Recurrence::doesRecur (  )  const

Returns whether the event recurs at all.

Definition at line 185 of file recurrence.cpp.

void Recurrence::dump (  )  const

Debug output.

Definition at line 1047 of file recurrence.cpp.

int Recurrence::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 397 of file recurrence.cpp.

int KCal::Recurrence::durationTo ( const QDate &  date  )  const [inline]

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

Definition at line 199 of file recurrence.h.

int Recurrence::durationTo ( const QDateTime &  datetime  )  const

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

Definition at line 409 of file recurrence.cpp.

QDate Recurrence::endDate (  )  const

Returns the date of the last recurrence.

Calculates the cumulative end of the whole recurrence (rdates and rrules).

An invalid date is returned if the recurrence has no end.

If any rrule is infinite, or the recurrence doesn't have any rrules or rdates, an invalid date is returned.

Definition at line 373 of file recurrence.cpp.

QDateTime Recurrence::endDateTime (  )  const

Returns the date/time of the last recurrence.

Calculates the cumulative end of the whole recurrence (rdates and rrules).

An invalid date is returned if the recurrence has no end.

If any rrule is infinite, or the recurrence doesn't have any rrules or rdates, an invalid date is returned.

Definition at line 353 of file recurrence.cpp.

DateList Recurrence::exDates (  )  const

Definition at line 1018 of file recurrence.cpp.

DateTimeList Recurrence::exDateTimes (  )  const

Definition at line 997 of file recurrence.cpp.

RecurrenceRule::List Recurrence::exRules (  )  const

Definition at line 930 of file recurrence.cpp.

int Recurrence::frequency (  )  const

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

Definition at line 467 of file recurrence.cpp.

QDateTime Recurrence::getNextDateTime ( 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:
preDateTime the date/time after which to find the recurrence.
Returns:
date/time of next recurrence (strictly later than the given QDateTiem), or invalid date if none.

Definition at line 774 of file recurrence.cpp.

QDateTime Recurrence::getPreviousDateTime ( 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:
afterDateTime the date/time before which to find the recurrence.
Returns:
date/time of previous recurrence (strictly earlier than the given QDateTime), or invalid date if none.

Definition at line 839 of file recurrence.cpp.

QValueList< int > Recurrence::monthDays (  )  const

Returns list of day numbers of a month.

Definition at line 517 of file recurrence.cpp.

QValueList< RecurrenceRule::WDayPos > Recurrence::monthPositions (  )  const

Returns list of day positions in months.

Definition at line 525 of file recurrence.cpp.

bool KCal::Recurrence::operator!= ( const Recurrence &  r  )  const [inline]

Definition at line 110 of file recurrence.h.

bool Recurrence::operator== ( const Recurrence &  r2  )  const

Definition at line 77 of file recurrence.cpp.

DateList Recurrence::rDates (  )  const

Definition at line 975 of file recurrence.cpp.

DateTimeList Recurrence::rDateTimes (  )  const

Definition at line 953 of file recurrence.cpp.

bool KCal::Recurrence::recurReadOnly (  )  const [inline]

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

Definition at line 141 of file recurrence.h.

void Recurrence::recurrenceChanged ( RecurrenceRule *   )  [virtual]

This method will be called on each change of the recurrence object.

Implements KCal::RecurrenceRule::Observer.

Definition at line 1039 of file recurrence.cpp.

ushort Recurrence::recurrenceType ( const RecurrenceRule *  rrule  )  [static]

Returns the recurrence status for a recurrence rule.

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

Definition at line 198 of file recurrence.cpp.

ushort Recurrence::recurrenceType (  )  const

Returns the event's recurrence status.

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

Definition at line 190 of file recurrence.cpp.

bool Recurrence::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.

Definition at line 330 of file recurrence.cpp.

bool Recurrence::recursOn ( const QDate &  qd  )  const

Returns true if the date specified is one on which the event will recur.

Definition at line 269 of file recurrence.cpp.

TimeList Recurrence::recurTimesOn ( const QDate &  date  )  const

Returns a list of the times on the specified date at which the recurrence will occur.

Parameters:
date the date for which to find the recurrence times.

Definition at line 723 of file recurrence.cpp.

void Recurrence::removeExRule ( RecurrenceRule *  exrule  ) 

Definition at line 944 of file recurrence.cpp.

void Recurrence::removeObserver ( Observer *  observer  ) 

Removes an observer that was added with addObserver.

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

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

Definition at line 120 of file recurrence.cpp.

void Recurrence::removeRRule ( RecurrenceRule *  rrule  ) 

Definition at line 922 of file recurrence.cpp.

RecurrenceRule::List Recurrence::rRules (  )  const

Definition at line 908 of file recurrence.cpp.

void Recurrence::setDaily ( int  freq  ) 

Sets an event to recur daily.

By default infinite recurrence is used. The minute and second of the recurrence is taken from the start date (if you need to change them, you will have to modify the defaultRRule's byMinute list manually. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

This method clears all recurrence rules and adds one rule with a daily recurrence. All other recurrence components (recurrence date/times, exception date/times and exception rules) are not modified.

Parameters:
freq the frequency to recur, e.g. 2 is every other day

Definition at line 586 of file recurrence.cpp.

void Recurrence::setDuration ( int  duration  ) 

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

Definition at line 417 of file recurrence.cpp.

void Recurrence::setEndDate ( const QDate &  endDate  ) 

Sets the date of the last recurrence.

The end time is set to the recurrence start time.

Parameters:
endDate the ending date after which to stop recurring. If the incidence is not floating, the end time will be 23:59.

Definition at line 380 of file recurrence.cpp.

void Recurrence::setEndDateTime ( const QDateTime &  endDateTime  ) 

Sets the date and time of the last recurrence.

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

Definition at line 388 of file recurrence.cpp.

void Recurrence::setExDates ( const DateList &  exdates  ) 

Definition at line 1023 of file recurrence.cpp.

void Recurrence::setExDateTimes ( const DateTimeList &  exdates  ) 

Definition at line 1002 of file recurrence.cpp.

void Recurrence::setFloats ( bool  floats  ) 

Sets whether the dtstart is a floating time (i.e.

has no time attached)

Parameters:
floats If the recurrence is for all-day item (true) or has a time associated (false).

Definition at line 134 of file recurrence.cpp.

void Recurrence::setFrequency ( int  freq  ) 

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

Definition at line 476 of file recurrence.cpp.

void Recurrence::setHourly ( int  freq  ) 

Sets an event to recur hourly.

By default infinite recurrence is used. The minute of the recurrence is taken from the start date (if you need to change it, you will have to modify the defaultRRule's byMinute list manually. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

This method clears all recurrence rules and adds one rule with a hourly recurrence. All other recurrence components (recurrence date/times, exception date/times and exception rules) are not modified.

Parameters:
freq the frequency to recur, e.g. 2 is every other hour

Definition at line 580 of file recurrence.cpp.

void Recurrence::setMinutely ( int  freq  ) 

Sets an event to recur minutely.

By default infinite recurrence is used. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

This method clears all recurrence rules and adds one rule with a minutely recurrence. All other recurrence components (recurrence date/times, exception date/times and exception rules) are not modified.

Parameters:
freq the frequency to recur, e.g. 2 is every other minute

Definition at line 574 of file recurrence.cpp.

void Recurrence::setMonthly ( int  freq  ) 

Sets an event to recur monthly.

By default infinite recurrence is used. The date of the monthly recurrence will be taken from the start date unless you explicitly add one or more recurrence dates with addMonthlyDate or a recurrence position in the month (e.g. first monday) using addMonthlyPos. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

This method clears all recurrence rules and adds one rule with a monthly recurrence. All other recurrence components (recurrence date/times, exception date/times and exception rules) are not modified.

Parameters:
freq the frequency to recur, e.g. 3 for every third month.

Definition at line 611 of file recurrence.cpp.

RecurrenceRule * Recurrence::setNewRecurrenceType ( RecurrenceRule::PeriodType  type,
int  freq 
) [protected]

Definition at line 561 of file recurrence.cpp.

void Recurrence::setRDates ( const DateList &  rdates  ) 

Definition at line 980 of file recurrence.cpp.

void Recurrence::setRDateTimes ( const DateTimeList &  rdates  ) 

Definition at line 958 of file recurrence.cpp.

void KCal::Recurrence::setRecurReadOnly ( bool  readOnly  )  [inline]

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

Definition at line 139 of file recurrence.h.

void Recurrence::setStartDate ( const QDate &  start  ) 

Set start of recurrence, as a date.

Also sets the incidence to floating.

Parameters:
start The new start date of the incidence.

Definition at line 461 of file recurrence.cpp.

void Recurrence::setStartDateTime ( const QDateTime &  start  ) 

Set start of recurrence, as a date and time.

Also sets the incidence to non-floating.

Parameters:
start the new start date/time of the incidence.

Definition at line 446 of file recurrence.cpp.

void Recurrence::setWeekly ( int  freq,
const QBitArray &  days,
int  weekStart = 1 
)

Sets an event to recur weekly.

By default infinite recurrence is used. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

This method clears all recurrence rules and adds one rule with a weekly recurrence. All other recurrence components (recurrence date/times, exception date/times and exception rules) are not modified.

Parameters:
freq the frequency to recur, e.g. every other week etc.
days a 7 bit array indicating which days on which to recur (bit 0 = Monday).
weekStart the first day of the week (Monday=1 .. Sunday=7, default is Monday).

Definition at line 600 of file recurrence.cpp.

void Recurrence::setWeekly ( int  freq,
int  weekStart = 1 
)

Sets an event to recur weekly.

By default infinite recurrence is used. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

This method clears all recurrence rules and adds one rule with a weekly recurrence. All other recurrence components (recurrence date/times, exception date/times and exception rules) are not modified.

Parameters:
freq the frequency to recur, e.g. every other week etc.
weekStart the first day of the week (Monday=1 .. Sunday=7, default is Monday).

Definition at line 592 of file recurrence.cpp.

void Recurrence::setYearly ( int  freq  ) 

Sets an event to recur yearly.

By default, this will recur every year on the same date (e.g. every year on April 15 if the start date was April 15). The day of the year can be specified with addYearlyDay(). The day of the month can be specified with addYearlyByDate If both a month and a day ar specified with addYearlyMonth and addYearlyDay, the day is understood as day number within the month.

A position (e.g. 3rd Sunday of year/month, or last Friday of year/month) can be specified with addYearlyPos. Again, if a month is specified, this position is understood as within that month, otherwise within the year.

By default infinite recurrence is used. To set an end date use the method setEndDate and to set the number of occurrences use setDuration.

This method clears all recurrence rules and adds one rule with a yearly recurrence. All other recurrence components (recurrence date/times, exception date/times and exception rules) are not modified.

Parameters:
freq the frequency to recur, e.g. 3 for every third year.

Definition at line 673 of file recurrence.cpp.

QDate KCal::Recurrence::startDate (  )  const [inline]

Return the start date/time of the recurrence.

Definition at line 116 of file recurrence.h.

QDateTime Recurrence::startDateTime (  )  const

Return the start date/time of the recurrence (Time for floating incidences will be 0:00).

Returns:
the current start/time of the recurrence.

Definition at line 127 of file recurrence.cpp.

void Recurrence::unsetRecurs (  ) 

Removes all recurrence rules.

Recurrence dates and exceptions are not removed.

Definition at line 426 of file recurrence.cpp.

void Recurrence::updated (  ) 

Definition at line 175 of file recurrence.cpp.

int Recurrence::weekStart (  )  const

Returns the first day of the week.

Uses only the first RRULE if present (i.e. a second RRULE as well as all EXRULES are ignored!

Returns:
Weekday of the first day of the week (Monday=1 .. Sunday=7)

Definition at line 488 of file recurrence.cpp.

QValueList< int > Recurrence::yearDates (  )  const

Returns the dates within a yearly recurrence.

Returns:
the days of the month for the event. E.g. if the list contains 13, this means the recurrence happens on the 13th of the month. The months for the recurrence can be obtained through yearlyMonths(). If this list is empty, the month of the start date is used.

Definition at line 542 of file recurrence.cpp.

QValueList< int > Recurrence::yearDays (  )  const

Returns the day numbers within a yearly recurrence.

Returns:
the days of the year for the event. E.g. if the list contains 60, this means the recurrence happens on day 60 of the year, i.e. on Feb 29 in leap years and March 1 in non-leap years.

Definition at line 535 of file recurrence.cpp.

QValueList< int > Recurrence::yearMonths (  )  const

Returns the months within a yearly recurrence.

Returns:
the months for the event. E.g. if the list contains 11, this means the recurrence happens in November. The days for the recurrence can be obtained either through yearDates() if they are given as dates within the month or through yearlyPositions() if they are given as positions within the month. If none is specified, the date of the start date is used.

Definition at line 547 of file recurrence.cpp.

QValueList< RecurrenceRule::WDayPos > Recurrence::yearPositions (  )  const

Returns the positions within a yearly recurrence.

Returns:
the positions for the event, either within a month (if months are set through addYearlyMonth()) or within the year. E.g. if the list contains {Pos=3, Day=5}, this means the third friday. If a month is set this position is understoodas third Friday in the given months, otherwise as third Friday of the year. Returns list of day positions in months, for a recursYearlyPos recurrence rule.

Definition at line 554 of file recurrence.cpp.

Member Data Documentation

const QDate KCal::Recurrence::MAX_DATE [static]

Upper date limit for recurrences.

Definition at line 432 of file recurrence.h.

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