diff options
Diffstat (limited to 'libkcal/recurrence.h')
-rw-r--r-- | libkcal/recurrence.h | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/libkcal/recurrence.h b/libkcal/recurrence.h index ec6965977..0a594a6fb 100644 --- a/libkcal/recurrence.h +++ b/libkcal/recurrence.h @@ -166,6 +166,21 @@ class LIBKCAL_EXPORT Recurrence : public RecurrenceRule::Observer */ TQValueList<TQTime> recurTimesOn(const TQDate &date) 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 TQDateTime value. If you need further values, call the + * method again with a start time set to just after the last valid time returned. + * + * @param start inclusive start of interval + * @param end inclusive end of interval + * @return list of date/time values + */ + DateTimeList timesInInterval( const TQDateTime &start, const TQDateTime &end ) 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. * @param preDateTime the date/time after which to find the recurrence. |