karecurrence.h

/*
 *  karecurrence.h  -  recurrence with special yearly February 29th handling
 *  This file is part of kalarmcal library, which provides access to KAlarm
 *  calendar data.
 *  Copyright © 2005-2012 by David Jarvie <djarvie@kde.org>
 *
 *  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 KALARM_KARECURRENCE_H
#define KALARM_KARECURRENCE_H

#include "kalarmcal_export.h"

#ifndef KALARMCAL_USE_KRESOURCES
#include <kcalcore/recurrencerule.h>
#include <kcalcore/duration.h>
namespace KCalCore { class Recurrence; }
#else
#include <kcal/recurrencerule.h>
#include <kcal/duration.h>
namespace KCal { class Recurrence; }
#endif

#include <QtCore/QBitArray>

namespace KAlarmCal
{

class KALARMCAL_EXPORT KARecurrence
{
    public:
        enum Type
        {
            NO_RECUR,      
            MINUTELY,      
            DAILY,         
            WEEKLY,        
            MONTHLY_POS,   
            MONTHLY_DAY,   
            ANNUAL_DATE,   
            ANNUAL_POS     
        };
        enum Feb29Type
        {
            Feb29_Feb28,   
            Feb29_Mar1,    
            Feb29_None     
        };

        KARecurrence();
#ifndef KALARMCAL_USE_KRESOURCES
        KARecurrence(const KCalCore::Recurrence& r);
#else
        KARecurrence(const KCal::Recurrence& r);
#endif
        KARecurrence(const KARecurrence& r);
        ~KARecurrence();
        KARecurrence& operator=(const KARecurrence& r);

        bool operator==(const KARecurrence& r) const;

        bool operator!=(const KARecurrence& r) const  { return !operator==(r); }

        bool set(const QString& icalRRULE);

        bool set(Type t, int freq, int count, const KDateTime& start, const KDateTime& end);

        bool set(Type t, int freq, int count, const KDateTime& start, const KDateTime& end, Feb29Type f29);

#ifndef KALARMCAL_USE_KRESOURCES
        bool init(KCalCore::RecurrenceRule::PeriodType t, int freq, int count, const KDateTime& start, const KDateTime& end);
#else
        bool init(KCal::RecurrenceRule::PeriodType t, int freq, int count, const KDateTime& start, const KDateTime& end);
#endif

#ifndef KALARMCAL_USE_KRESOURCES
        bool init(KCalCore::RecurrenceRule::PeriodType t, int freq, int count, const KDateTime& start, const KDateTime& end, Feb29Type f29);
#else
        bool init(KCal::RecurrenceRule::PeriodType t, int freq, int count, const KDateTime& start, const KDateTime& end, Feb29Type f29);
#endif

        void clear();

#ifndef KALARMCAL_USE_KRESOURCES
        void writeRecurrence(KCalCore::Recurrence&) const;
#else
        void writeRecurrence(KCal::Recurrence&) const;
#endif

        void fix();

        KDateTime startDateTime() const;
        QDate startDate() const;

        void        setStartDateTime(const KDateTime& dt, bool dateOnly);

        KDateTime   endDateTime() const;

        QDate       endDate() const;

    void setEndDate(const QDate& endDate);

    void setEndDateTime(const KDateTime& endDateTime);

    bool allDay() const;

    void setRecurReadOnly(bool readOnly);

    bool recurReadOnly() const;

    bool recurs() const;

    QBitArray days() const; // Emulate the old behavior

#ifndef KALARMCAL_USE_KRESOURCES
    QList<KCalCore::RecurrenceRule::WDayPos> monthPositions() const;
#else
    QList<KCal::RecurrenceRule::WDayPos> monthPositions() const;
#endif

    // Emulate old behavior
    QList<int> monthDays() const;

    QList<int> yearDays() const;

    QList<int> yearDates() const;

    QList<int> yearMonths() const;

#ifndef KALARMCAL_USE_KRESOURCES
    QList<KCalCore::RecurrenceRule::WDayPos> yearPositions() const;
#else
    QList<KCal::RecurrenceRule::WDayPos> yearPositions() const;
#endif

    void addWeeklyDays(const QBitArray& days);

    void addYearlyDay(int day);

    void addYearlyDate(int date);

    void addYearlyMonth(short month);

    void addYearlyPos(short pos, const QBitArray& days);

    void addMonthlyPos(short pos, const QBitArray& days);
    void addMonthlyPos(short pos, ushort day);

    void addMonthlyDate(short day);

        KDateTime   getNextDateTime(const KDateTime& preDateTime) const;

        KDateTime   getPreviousDateTime(const KDateTime& afterDateTime) const;

        bool        recursOn(const QDate&, const KDateTime::Spec&) const;

    bool recursAt(const KDateTime& dt) const;

#ifndef KALARMCAL_USE_KRESOURCES
    KCalCore::TimeList recurTimesOn(const QDate& date, const KDateTime::Spec& timeSpec) const;
#else
    KCal::TimeList recurTimesOn(const QDate& date, const KDateTime::Spec& timeSpec) const;
#endif

#ifndef KALARMCAL_USE_KRESOURCES
    KCalCore::DateTimeList timesInInterval(const KDateTime& start, const KDateTime& end) const;
#else
    KCal::DateTimeList timesInInterval(const KDateTime& start, const KDateTime& end) const;
#endif

    int frequency() const;

    void setFrequency(int freq);

    int duration() const;

    void setDuration(int duration);

    int durationTo(const KDateTime& dt) const;

    int durationTo(const QDate& date) const;

#ifndef KALARMCAL_USE_KRESOURCES
        KCalCore::Duration longestInterval() const;
#else
        KCal::Duration longestInterval() const;
#endif

#ifndef KALARMCAL_USE_KRESOURCES
        KCalCore::Duration regularInterval() const;
#else
        KCal::Duration regularInterval() const;
#endif
#ifndef KALARMCAL_USE_KRESOURCES
    KCalCore::DateTimeList exDateTimes() const;
    KCalCore::DateList exDates() const;
    void setExDateTimes(const KCalCore::DateTimeList& exdates);
    void setExDates(const KCalCore::DateList& exdates);
#else
    KCal::DateTimeList exDateTimes() const;
    KCal::DateList exDates() const;
    void setExDateTimes(const KCal::DateTimeList& exdates);
    void setExDates(const KCal::DateList& exdates);
#endif
    void addExDateTime(const KDateTime& exdate);
    void addExDate(const QDate& exdate);

    void shiftTimes(const KDateTime::Spec& oldSpec, const KDateTime::Spec& newSpec);

#ifndef KALARMCAL_USE_KRESOURCES
    KCalCore::RecurrenceRule* defaultRRuleConst() const;
#else
    KCal::RecurrenceRule* defaultRRuleConst() const;
#endif

        Type type() const;

#ifndef KALARMCAL_USE_KRESOURCES
        static Type type(const KCalCore::RecurrenceRule*);
#else
        static Type type(const KCal::RecurrenceRule*);
#endif

#ifndef KALARMCAL_USE_KRESOURCES
        static bool dailyType(const KCalCore::RecurrenceRule*);
#else
        static bool dailyType(const KCal::RecurrenceRule*);
#endif

        Feb29Type feb29Type() const;

        static Feb29Type defaultFeb29Type();

        static void setDefaultFeb29Type(Feb29Type t);

    private:
        //@cond PRIVATE
        class Private;
        Private* const d;
        //@endcond
};

} // namespace KAlarmCal

#endif // KALARM_KARECURRENCE_H

// vim: et sw=4: