recurrencerule.h

/*
  This file is part of the kcal library.

  Copyright (c) 1998 Preston Brown <pbrown@kde.org>
  Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>
  Copyright (c) 2002,2006,2007 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 "kcal_export.h"
#include "kcal/listbase.h"
#include "kcal/sortablelist.h"

#include <kdatetime.h>

#include <QtCore/QList>

namespace KCal {

// These two are duplicates wrt. incidencebase.h
typedef SortableList<KDateTime> DateTimeList;
typedef SortableList<QDate> DateList;
/* List of times */
typedef SortableList<QTime> TimeList;

class KCAL_DEPRECATED_EXPORT RecurrenceRule
{
  public:
    class RuleObserver
    {
      public:
        virtual ~RuleObserver() {}
        virtual void recurrenceChanged( RecurrenceRule * ) = 0;
    };
    typedef ListBase<RecurrenceRule> List;

    enum PeriodType {
      rNone = 0,
      rSecondly,
      rMinutely,
      rHourly,
      rDaily,
      rWeekly,
      rMonthly,
      rYearly
    };

    class WDayPos
    {
      public:
        explicit 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();
    RecurrenceRule( const RecurrenceRule &r );
    ~RecurrenceRule();

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

    void setReadOnly( bool readOnly );

    bool isReadOnly() const;

    bool recurs() const;
    void setRecurrenceType( PeriodType period );
    PeriodType recurrenceType() const;

    void clear();

    uint frequency() const;

    void setFrequency( int freq );

    KDateTime startDt() const;

    void setStartDt( const KDateTime &start );

    bool allDay() const;

    void setAllDay( bool allDay );

    KDateTime endDt( bool *result = 0 ) const;

    void setEndDt( const KDateTime &endDateTime );

    int duration() const;

    void setDuration( int duration );

    int durationTo( const KDateTime &dt ) const;

    int durationTo( const QDate &date ) const;

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

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

    bool recursAt( const KDateTime &dt ) const;

    bool dateMatchesRules( const KDateTime &dt ) const;

    TimeList recurTimesOn( const QDate &date, const KDateTime::Spec &timeSpec ) const;

    DateTimeList timesInInterval( const KDateTime &start, const KDateTime &end ) const;

    KDateTime getNextDate( const KDateTime &preDateTime ) const;

    KDateTime getPreviousDate( const KDateTime &afterDateTime ) const;

    void setBySeconds( const QList<int> bySeconds );
    void setByMinutes( const QList<int> byMinutes );
    void setByHours( const QList<int> byHours );

    void setByDays( const QList<WDayPos> byDays );
    void setByMonthDays( const QList<int> byMonthDays );
    void setByYearDays( const QList<int> byYearDays );
    void setByWeekNumbers( const QList<int> byWeekNumbers );
    void setByMonths( const QList<int> byMonths );
    void setBySetPos( const QList<int> bySetPos );
    void setWeekStart( short weekStart );

    const QList<int> &bySeconds() const;
    const QList<int> &byMinutes() const;
    const QList<int> &byHours() const;

    const QList<WDayPos> &byDays() const;
    const QList<int> &byMonthDays() const;
    const QList<int> &byYearDays() const;
    const QList<int> &byWeekNumbers() const;
    const QList<int> &byMonths() const;
    const QList<int> &bySetPos() const;
    short weekStart() const;

    void setRRule( const QString &rrule );
    QString rrule() const;

    void setDirty();
    void addObserver( RuleObserver *observer );

    void removeObserver( RuleObserver *observer );

    void dump() const;

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

}

#endif