Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / libkcal

libkcal recurrence.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_RECURRENCE_H #define KCAL_RECURRENCE_H #include <qstring.h> #include <qbitarray.h> #include <qptrlist.h> #include "libkcal_export.h" #include "recurrencerule.h" namespace KCal { class RecurrenceRule; class LIBKCAL_EXPORT Recurrence : public RecurrenceRule::Observer { public: class Observer { public: virtual ~Observer() {} virtual void recurrenceUpdated( Recurrence * ) = 0; }; 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 }; Recurrence(); Recurrence( const Recurrence& ); virtual ~Recurrence(); bool operator==( const Recurrence& ) const; bool operator!=( const Recurrence& r ) const { return !operator==(r); } QDateTime startDateTime() const; QDate startDate() const { return mStartDateTime.date(); } void setStartDateTime( const QDateTime &start ); void setStartDate( const QDate &start ); bool doesFloat() const { return mFloating; } void setFloats( bool floats ); void setRecurReadOnly(bool readOnly) { mRecurReadOnly = readOnly; } bool recurReadOnly() const { return mRecurReadOnly; } bool doesRecur() const; ushort recurrenceType() const; static ushort recurrenceType( const RecurrenceRule *rrule ); bool recursOn( const QDate &qd ) const; bool recursAt( const QDateTime & ) const; void unsetRecurs(); void clear(); QValueList<QTime> recurTimesOn(const QDate &date) const; QDateTime getNextDateTime( const QDateTime& preDateTime ) const; QDateTime getPreviousDateTime( const QDateTime& afterDateTime ) const; int frequency() const; void setFrequency(int freq); int duration() const; void setDuration(int duration); int durationTo(const QDateTime &) const; int durationTo( const QDate &date ) const { return durationTo( QDateTime( date, QTime( 23, 59, 59 ) ) ); } QDateTime endDateTime() const; QDate endDate() const; void setEndDate( const QDate &endDate ); void setEndDateTime( const QDateTime &endDateTime ); void setMinutely( int freq ); void setHourly( int freq ); void setDaily( int freq ); void setWeekly( int freq, int weekStart = 1 ); void setWeekly( int freq, const QBitArray &days, int weekStart = 1 ); void addWeeklyDays( const QBitArray &days ); int weekStart() const; QBitArray days() const; // Emulate the old behavior void setMonthly( int freq ); void addMonthlyPos( short pos, const QBitArray &days ); void addMonthlyPos( short pos, ushort day ); void addMonthlyDate( short day ); QValueList<RecurrenceRule::WDayPos> monthPositions() const; // Emulate old behavior QValueList<int> monthDays() const; void setYearly( int freq ); void addYearlyDay( int day ); void addYearlyDate( int date ); void addYearlyMonth( short _rNum ); void addYearlyPos( short pos, const QBitArray &days ); QValueList<int> yearDays() const; QValueList<int> yearDates() const; QValueList<int> yearMonths() const; QValueList<RecurrenceRule::WDayPos> yearPositions() const; static const QDate MAX_DATE; void dump() const; // RRULE RecurrenceRule::List rRules() const; void addRRule( RecurrenceRule *rrule ); void removeRRule( RecurrenceRule *rrule ); // EXRULE RecurrenceRule::List exRules() const; void addExRule( RecurrenceRule *exrule ); void removeExRule( RecurrenceRule *exrule ); // RDATE DateTimeList rDateTimes() const; DateList rDates() const; void setRDateTimes( const DateTimeList &rdates); void setRDates( const DateList &rdates); void addRDateTime( const QDateTime &rdate ); void addRDate( const QDate &rdate ); // ExDATE DateTimeList exDateTimes() const; DateList exDates() const; void setExDateTimes( const DateTimeList &exdates); void setExDates( const DateList &exdates); void addExDateTime( const QDateTime &exdate ); void addExDate( const QDate &exdate ); RecurrenceRule *defaultRRule( bool create = false ) const; RecurrenceRule *defaultRRuleConst() const; void updated(); void addObserver( Observer *observer ); void removeObserver( Observer *observer ); void recurrenceChanged( RecurrenceRule * ); protected: RecurrenceRule *setNewRecurrenceType( RecurrenceRule::PeriodType type, int freq ); private: RecurrenceRule::List mExRules; RecurrenceRule::List mRRules; QValueList<QDateTime>mRDateTimes; QValueList<QDate> mRDates; QValueList<QDateTime> mExDateTimes; QValueList<QDate> mExDates; QDateTime mStartDateTime; // date/time of first recurrence bool mFloating; // the recurrence has no time, just a date bool mRecurReadOnly; // Cache the type of the recurrence with the old system (e.g. MonthlyPos) mutable ushort mCachedType; QValueList<Observer*> mObservers; 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