daterange.h

Go to the documentation of this file.

/*
   Copyright (c) 2009-2010 Sebastian Trueg <trueg@kde.org>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 of
   the License or (at your option) version 3 or any later version
   accepted by the membership of KDE e.V. (or its successor approved
   by the membership of KDE e.V.), which shall act as a proxy
   defined in Section 14 of version 3 of the license.

   This program 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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef _DATE_RANGE_H_
#define _DATE_RANGE_H_

#include <QtCore/QDate>
#include <QtCore/QSharedDataPointer>

class QDebug;

class DateRange
{
public:
    DateRange( const QDate& s = QDate(),
               const QDate& e = QDate() );

    DateRange( const DateRange& other );

    ~DateRange();

    DateRange& operator=( const DateRange& other );

    QDate start() const;

    QDate end() const;

    bool isValid() const;

    void setStart( const QDate& date );

    void setEnd( const QDate& date );

    static DateRange today();

    enum DateRangeFlag {
        NoDateRangeFlags = 0x0,

        ExcludeFutureDays = 0x1
    };
    Q_DECLARE_FLAGS( DateRangeFlags, DateRangeFlag )

    
    static DateRange thisWeek( DateRangeFlags flags = NoDateRangeFlags );

    static DateRange weekOf( const QDate& date, DateRangeFlags flags = NoDateRangeFlags );

    static DateRange thisMonth( DateRangeFlags flags = NoDateRangeFlags );

    static DateRange monthOf( const QDate& date, DateRangeFlags flags = NoDateRangeFlags );

    static DateRange thisYear( DateRangeFlags flags = NoDateRangeFlags );

    static DateRange yearOf( const QDate& date, DateRangeFlags flags = NoDateRangeFlags );

    static DateRange lastNDays( int n );

    static DateRange lastNWeeks( int n );

    static DateRange lastNMonths( int n );

private:
    class Private;
    QSharedDataPointer<Private> d;
};

bool operator==( const DateRange& r1, const DateRange& r2 );

bool operator!=( const DateRange& r1, const DateRange& r2 );

uint qHash( const DateRange& range );

QDebug operator<<( QDebug dbg, const DateRange& range );

Q_DECLARE_OPERATORS_FOR_FLAGS( DateRange::DateRangeFlags )

#endif