holidayregion.h

/*
  This file is part of the kholidays library.

  Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
  Copyright (c) 2004 Allen Winter <winter@kde.org>
  Copyright (c) 2008 David Jarvie <djarvie@kde.org>
  Copyright 2010 John Layt <john@layt.net>

  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 KHOLIDAYS_HOLIDAYREGION_H
#define KHOLIDAYS_HOLIDAYREGION_H

#include "kholidays_export.h"

#include <QtCore/QList>
#include <QtCore/QSharedDataPointer>
#include <QtCore/QString>

#include "holiday.h"

class QDate;
class QStringList;
class QFileInfo;

namespace KHolidays {

class KHOLIDAYS_EXPORT HolidayRegion
{
  public:
    explicit HolidayRegion( const QString &regionCode = QString() );

    explicit HolidayRegion( const QFileInfo &regionFile );

    ~HolidayRegion();

    static QStringList locations();

    QString location() const;

    static QStringList regionCodes();

    static QString defaultRegionCode( const QString &country = QString(),
                                      const QString &language = QString() );

    QString regionCode() const;

    QString countryCode() const;

    static QString countryCode( const QString &regionCode );

    QString languageCode() const;

    static QString languageCode( const QString &regionCode );

    QString name() const;

    static QString name( const QString &regionCode );

    QString description() const;

    static QString description( const QString &regionCode );

    Holiday::List holidays( const QDate &startDate, const QDate &endDate ) const;

    //KDE5: merge with default multidayMode
    Holiday::List holidays( const QDate &startDate, const QDate &endDate,
                            Holiday::MultidayMode multidayMode ) const;

    Holiday::List holidays( const QDate &date ) const;

    //KDE5: merge with default multidayMode
    Holiday::List holidays( const QDate &date, Holiday::MultidayMode multidayMode ) const;

    Holiday::List holidays( int calendarYear, const QString &calendarType ) const;

    //KDE5: merge with default multidayMode
    Holiday::List holidays( int calendarYear, const QString &calendarType,
                            Holiday::MultidayMode multidayMode ) const;

    bool isHoliday( const QDate &date ) const;

    bool isValid() const;

    static bool isValid( const QString &regionCode );

  private:
    Q_DISABLE_COPY( HolidayRegion )

    class Private;
    Private *const d;
};

}

#endif // KHOLIDAYS_HOLIDAYREGION_H