Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / libkcal

libkcal recurrencerule.h Go to the documentation of this file. /* This file is part of libkcal. Copyright (c) 1998 Preston Brown <pbrown@kde.org> Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org> Copyright (c) 2002 David Jarvie <software@astrojar.org.uk> Copyright (c) 2005, Reinhold Kainhofer <reinhold@kainhofer.com> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #ifndef KCAL_RECURRENCERULE_H #define KCAL_RECURRENCERULE_H #include <qdatetime.h> #include <libkcal/listbase.h> #include "libkcal_export.h" template <class T> Q_INLINE_TEMPLATES void qSortUnique( QValueList<T> &lst ) { qHeapSort( lst ); if ( lst.isEmpty() ) return; // Remove all duplicates from the times list // TODO: Make this more efficient! QValueListIterator<T> it = lst.begin(); T last = *it; ++it; T newlast; while ( it != lst.end() ) { newlast = (*it); if ( newlast == last ) it = lst.remove( it ); else { last = newlast; ++it; } } } namespace KCal { typedef QValueList<QDateTime> DateTimeList; typedef QValueList<QDate> DateList; typedef QValueList<QTime> TimeList; class LIBKCAL_EXPORT RecurrenceRule { public: class Observer { public: virtual ~Observer() {} virtual void recurrenceChanged( RecurrenceRule * ) = 0; }; typedef ListBase<RecurrenceRule> List; enum PeriodType { rNone = 0, rSecondly, rMinutely, rHourly, rDaily, rWeekly, rMonthly, rYearly }; class WDayPos { public: WDayPos( int ps = 0 , short dy = 0 ) : mDay(dy), mPos(ps) {} short day() const { return mDay; } int pos() const { return mPos; } void setDay( short dy ) { mDay = dy; } void setPos( int ps ) { mPos = ps; } bool operator==( const RecurrenceRule::WDayPos &pos2 ) const { return ( mDay == pos2.mDay ) && ( mPos == pos2.mPos ); } protected: short mDay; // Weekday, 1=monday, 7=sunday int mPos; // week of the day (-1 for last, 1 for first, 0 for all weeks) // Bounded by -366 and +366, 0 means all weeks in that period }; RecurrenceRule( /*Incidence *parent, int compatVersion = 0*/ ); RecurrenceRule(const RecurrenceRule&); ~RecurrenceRule(); bool operator==( const RecurrenceRule& ) const; bool operator!=( const RecurrenceRule& r ) const { return !operator==(r); } RecurrenceRule &operator=(const RecurrenceRule&); // Incidence *parent() const { return mParent; } void setReadOnly(bool readOnly) { mIsReadOnly = readOnly; } bool isReadOnly() const { return mIsReadOnly; } bool doesRecur() const { return mPeriod!=rNone; } void setRecurrenceType( PeriodType period ); PeriodType recurrenceType() const { return mPeriod; } void clear(); uint frequency() const { return mFrequency; } void setFrequency( int freq ); QDateTime startDt() const { return mDateStart; } void setStartDt(const QDateTime &start); bool doesFloat() const { return mFloating; } void setFloats( bool floats ); QDateTime endDt( bool* result = 0 ) const; void setEndDt(const QDateTime &endDateTime); int duration() const { return mDuration; } void setDuration(int duration); // /** Returns the number of recurrences up to and including the date specified. */ // int durationTo(const QDate &) const; int durationTo(const QDateTime &) const; int durationTo( const QDate &date ) const { return durationTo( QDateTime( date, QTime( 23, 59, 59 ) ) ); } bool recursOn( const QDate &qd ) const; bool recursAt( const QDateTime & ) const; bool dateMatchesRules( const QDateTime &qdt ) const; TimeList recurTimesOn( const QDate &date ) const; QDateTime getNextDate( const QDateTime& preDateTime ) const; QDateTime getPreviousDate( const QDateTime& afterDateTime ) const; void setBySeconds( const QValueList<int> bySeconds ); void setByMinutes( const QValueList<int> byMinutes ); void setByHours( const QValueList<int> byHours ); void setByDays( const QValueList<WDayPos> byDays ); void setByMonthDays( const QValueList<int> byMonthDays ); void setByYearDays( const QValueList<int> byYearDays ); void setByWeekNumbers( const QValueList<int> byWeekNumbers ); void setByMonths( const QValueList<int> byMonths ); void setBySetPos( const QValueList<int> bySetPos ); void setWeekStart( short weekStart ); const QValueList<int> &bySeconds() const { return mBySeconds; } const QValueList<int> &byMinutes() const { return mByMinutes; } const QValueList<int> &byHours() const { return mByHours; } const QValueList<WDayPos> &byDays() const { return mByDays; } const QValueList<int> &byMonthDays() const { return mByMonthDays; } const QValueList<int> &byYearDays() const { return mByYearDays; } const QValueList<int> &byWeekNumbers() const { return mByWeekNumbers; } const QValueList<int> &byMonths() const { return mByMonths; } const QValueList<int> &bySetPos() const { return mBySetPos; } short weekStart() const { return mWeekStart; } void setDirty(); void addObserver( Observer *observer ); void removeObserver( Observer *observer ); void dump() const; QString mRRule; private: class Constraint { public: typedef QValueList<Constraint> List; Constraint( int wkst = 1 ); /* Constraint( const Constraint &con ) : year(con.year), month(con.month), day(con.day), hour(con.hour), minute(con.minute), second(con.second), weekday(con.weekday), weeknumber(con.weeknumber), yearday(con.yearday), weekstart(con.weekstart) {}*/ Constraint( const QDateTime &preDate, PeriodType type, int wkst ); void clear(); int year; // 0 means unspecified int month; // 0 means unspecified int day; // 0 means unspecified int hour; // -1 means unspecified int minute; // -1 means unspecified int second; // -1 means unspecified int weekday; // 0 means unspecified int weekdaynr; // index of weekday in month/year (0=unspecified) int weeknumber; // 0 means unspecified int yearday; // 0 means unspecified int weekstart; // first day of week (1=monday, 7=sunday, 0=unspec.) bool readDateTime( const QDateTime &preDate, PeriodType type ); bool matches( const QDate &dt, RecurrenceRule::PeriodType type ) const; bool matches( const QDateTime &dt, RecurrenceRule::PeriodType type ) const; bool isConsistent() const; bool isConsistent( PeriodType period ) const; bool increase( PeriodType type, int freq ); QDateTime intervalDateTime( PeriodType type ) const; DateTimeList dateTimes( PeriodType type ) const; void dump() const; }; Constraint getNextValidDateInterval( const QDateTime &preDate, PeriodType type ) const; Constraint getPreviousValidDateInterval( const QDateTime &preDate, PeriodType type ) const; DateTimeList datesForInterval( const Constraint &interval, PeriodType type ) const; bool mergeIntervalConstraint( Constraint *merged, const Constraint &conit, const Constraint &interval ) const; bool buildCache() const; PeriodType mPeriod; QDateTime mDateStart; int mDuration; QDateTime mDateEnd; uint mFrequency; bool mIsReadOnly; bool mFloating; QValueList<int> mBySeconds; // values: second 0-59 QValueList<int> mByMinutes; // values: minute 0-59 QValueList<int> mByHours; // values: hour 0-23 QValueList<WDayPos> mByDays; // n-th weekday of the month or year QValueList<int> mByMonthDays; // values: day -31 to -1 and 1-31 QValueList<int> mByYearDays; // values: day -366 to -1 and 1-366 QValueList<int> mByWeekNumbers; // values: week -53 to -1 and 1-53 QValueList<int> mByMonths; // values: month 1-12 QValueList<int> mBySetPos; // values: position -366 to -1 and 1-366 short mWeekStart; // first day of the week (1=Monday, 7=Sunday) Constraint::List mConstraints; void buildConstraints(); bool mDirty; QValueList<Observer*> mObservers; // Cache for duration mutable DateTimeList mCachedDates; mutable bool mCached; mutable QDateTime mCachedDateEnd; class Private; Private *d; }; } #endif libkcal Skip menu "libkcal" Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Namespace Members Class Members API Reference Skip menu "API Reference"   doc kioslaves kmail konsolekalendar kpilot libemailfunctions libkcal Generated for API Reference by doxygen 1.5.9 This website is maintained by Adriaan de Groot and Allen Winter. KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal