kcalendarsystem.h

Go to the documentation of this file.

/*
    Copyright (c) 2002 Carlos Moro <cfmoro@correo.uniovi.es>
    Copyright (c) 2002-2003 Hans Petter Bieker <bieker@kde.org>
    Copyright 2007, 2009, 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 KCALENDARSYSTEM_H
#define KCALENDARSYSTEM_H

#include <kdecore_export.h>
#include "klocale.h"  // needed for enums
#include "kglobal.h"

#include <QtCore/QStringList>
#include <QtCore/QDate>

class KCalendarSystemPrivate;
class KCalendarEra;

class KDECORE_EXPORT KCalendarSystem
{
public:

    enum StringFormat {
        ShortFormat,      
        LongFormat        
    };

    enum MonthNameFormat {
        ShortName,                
        LongName,                 
        ShortNamePossessive,      
        LongNamePossessive,       
        NarrowName                
    };

    enum WeekDayNameFormat {
        ShortDayName,                
        LongDayName,                 
        NarrowDayName                
    };

    //KDE5 remove
    KDE_DEPRECATED static KCalendarSystem *create(const QString & calType = QLatin1String("gregorian"),
                                                  const KLocale * locale = 0);

    //KDE5 remove
    KDE_DEPRECATED static KCalendarSystem *create(const QString & calType, KSharedConfig::Ptr config,
                                                  const KLocale * locale = 0);

    //KDE5 add default value to calendarSystem
    static KCalendarSystem *create(KLocale::CalendarSystem calendarSystem,
                                   const KLocale *locale = 0);

    static KCalendarSystem *create(KLocale::CalendarSystem calendarSystem, KSharedConfig::Ptr config,
                                   const KLocale *locale = 0);

    //KDE5 remove
    KDE_DEPRECATED static QStringList calendarSystems();

    static QList<KLocale::CalendarSystem> calendarSystemsList();

    //KDE5 remove
    KDE_DEPRECATED static QString calendarLabel(const QString &calendarType);

    static QString calendarLabel(KLocale::CalendarSystem calendarSystem, const KLocale *locale = KGlobal::locale());

    //KDE5 Remove
    KDE_DEPRECATED static KLocale::CalendarSystem calendarSystemForCalendarType(const QString &calendarType);

    //KDE5 Remove
    static KLocale::CalendarSystem calendarSystem(const QString &calendarType);

    //KDE5 remove
    static QString calendarType(KLocale::CalendarSystem calendarSystem);

    explicit KCalendarSystem(const KLocale *locale = 0);

    explicit KCalendarSystem(const KSharedConfig::Ptr config, const KLocale *locale = 0);

    virtual ~KCalendarSystem();

    KDE_DEPRECATED virtual QString calendarType() const = 0;

    //KDE5 make virtual?
    KLocale::CalendarSystem calendarSystem() const;

    //KDE5 make virtual?
    QString calendarLabel() const;

    virtual QDate epoch() const;

    virtual QDate earliestValidDate() const;

    virtual QDate latestValidDate() const;

    virtual bool isValid(int year, int month, int day) const = 0;

    //KDE5 make virtual?
    bool isValid(int year, int dayOfYear) const;

    //KDE5 make virtual?
    bool isValid(const QString &eraName, int yearInEra, int month, int day) const;

    //KDE5 make virtual?
    bool isValidIsoWeekDate(int year, int isoWeekNumber, int dayOfIsoWeek) const;

    virtual bool isValid(const QDate &date) const;

    virtual bool setDate(QDate &date, int year, int month, int day) const;

    //KDE5 make virtual?
    bool setDate(QDate &date, int year, int dayOfYear) const;

    //KDE5 make virtual?
    bool setDate(QDate &date, QString eraName, int yearInEra, int month, int day) const;

    //KDE5 make virtual?
    bool setDateIsoWeek(QDate &date, int year, int isoWeekNumber, int dayOfIsoWeek) const;

    KDE_DEPRECATED virtual bool setYMD(QDate &date, int y, int m, int d) const;

    //KDE5 make virtual?
    void getDate(const QDate date, int *year, int *month, int *day) const;

    virtual int year(const QDate &date) const;

    virtual int month(const QDate &date) const;

    virtual int day(const QDate &date) const;

    //KDE5 make virtual?
    QString eraName(const QDate &date, StringFormat format = ShortFormat) const;

    //KDE5 make virtual?
    QString eraYear(const QDate &date, StringFormat format = ShortFormat) const;

    //KDE5 make virtual?
    int yearInEra(const QDate &date) const;

    virtual QDate addYears(const QDate &date, int nyears) const;

    virtual QDate addMonths(const QDate &date, int nmonths) const;

    virtual QDate addDays(const QDate &date, int ndays) const;

    //KDE5 make virtual?
    void dateDifference(const QDate &fromDate, const QDate &toDate,
                        int *yearsDiff, int *monthsDiff, int *daysDiff, int *direction) const;

    //KDE5 make virtual?
    int yearsDifference(const QDate &fromDate, const QDate &toDate) const;

    //KDE5 make virtual?
    int monthsDifference(const QDate &fromDate, const QDate &toDate) const;

    //KDE5 make virtual?
    int daysDifference(const QDate &fromDate, const QDate &toDate) const;

    virtual int monthsInYear(const QDate &date) const;

    //KDE5 make virtual?
    int monthsInYear(int year) const;

    virtual int weeksInYear(const QDate &date) const;

    //KDE5 Merge with virtual weeksInYear with default
    int weeksInYear(const QDate &date, KLocale::WeekNumberSystem weekNumberSystem) const;

    virtual int weeksInYear(int year) const;

    //KDE5 Merge with virtual weeksInYear with default
    int weeksInYear(int year, KLocale::WeekNumberSystem weekNumberSystem) const;

    virtual int daysInYear(const QDate &date) const;

    //KDE5 make virtual?
    int daysInYear(int year) const;

    virtual int daysInMonth(const QDate &date) const;

    //KDE5 make virtual?
    int daysInMonth(int year, int month) const;

    virtual int daysInWeek(const QDate &date) const;

    virtual int dayOfYear(const QDate &date) const;

    virtual int dayOfWeek(const QDate &date) const;

    KDE_DEPRECATED virtual int weekNumber(const QDate &date, int *yearNum = 0) const;

    //KDE5 Make virtual?
    int week(const QDate &date, int *yearNum = 0) const;

    //KDE5 Make virtual?
    int week(const QDate &date, KLocale::WeekNumberSystem weekNumberSystem, int *yearNum = 0) const;

    virtual bool isLeapYear(int year) const = 0;

    virtual bool isLeapYear(const QDate &date) const;

    //KDE5 Make virtual?
    QDate firstDayOfYear(int year) const;

    //KDE5 Make virtual?
    QDate lastDayOfYear(int year) const;

    //KDE5 Make virtual?
    QDate firstDayOfYear(const QDate &date = QDate::currentDate()) const;

    //KDE5 Make virtual?
    QDate lastDayOfYear(const QDate &date = QDate::currentDate()) const;

    //KDE5 Make virtual?
    QDate firstDayOfMonth(int year, int month) const;

    //KDE5 Make virtual?
    QDate lastDayOfMonth(int year, int month) const;

    //KDE5 Make virtual?
    QDate firstDayOfMonth(const QDate &date = QDate::currentDate()) const;

    //KDE5 Make virtual?
    QDate lastDayOfMonth(const QDate &date = QDate::currentDate()) const;

    virtual QString monthName(int month, int year, MonthNameFormat format = LongName) const = 0;

    virtual QString monthName(const QDate &date, MonthNameFormat format = LongName) const;

    virtual QString weekDayName(int weekDay, WeekDayNameFormat format = LongDayName) const = 0;

    virtual QString weekDayName(const QDate &date, WeekDayNameFormat format = LongDayName) const;

    KDE_DEPRECATED virtual QString yearString(const QDate &date, StringFormat format = LongFormat) const;

    KDE_DEPRECATED virtual QString monthString(const QDate &pDate, StringFormat format = LongFormat) const;

    KDE_DEPRECATED virtual QString dayString(const QDate &pDate, StringFormat format = LongFormat) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString yearInEraString(const QDate &date, StringFormat format = ShortFormat) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString dayOfYearString(const QDate &pDate, StringFormat format = LongFormat) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString dayOfWeekString(const QDate &pDate) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString weekNumberString(const QDate &pDate, StringFormat format = LongFormat) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString monthsInYearString(const QDate &pDate, StringFormat format = LongFormat) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString weeksInYearString(const QDate &pDate, StringFormat format = LongFormat) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString daysInYearString(const QDate &pDate, StringFormat format = LongFormat) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString daysInMonthString(const QDate &pDate, StringFormat format = LongFormat) const;

    //KDE5 make virtual?
    KDE_DEPRECATED QString daysInWeekString(const QDate &date) const;

    //KDE5 make protected or remove?
    virtual int yearStringToInteger(const QString &sNum, int &iLength) const;

    //KDE5 make protected or remove?
    virtual int monthStringToInteger(const QString &sNum, int &iLength) const;

    //KDE5 make protected or remove?
    virtual int dayStringToInteger(const QString &sNum, int &iLength) const;

    virtual QString formatDate(const QDate &fromDate, KLocale::DateFormat toFormat = KLocale::LongDate) const;

    //KDE5 Make virtual
    QString formatDate(const QDate &fromDate, const QString &toFormat,
                       KLocale::DateTimeFormatStandard formatStandard = KLocale::KdeFormat) const;

    //KDE5 Make virtual
    QString formatDate(const QDate &fromDate, const QString &toFormat, KLocale::DigitSet digitSet,
                       KLocale::DateTimeFormatStandard formatStandard = KLocale::KdeFormat) const;

    //KDE5 Make virtual
    QString formatDate(const QDate &date, KLocale::DateTimeComponent component,
                       KLocale::DateTimeComponentFormat format = KLocale::DefaultComponentFormat,
                       KLocale::WeekNumberSystem weekNumberSystem = KLocale::DefaultWeekNumber) const;

    virtual QDate readDate(const QString &str, bool *ok = 0) const;

    virtual QDate readDate(const QString &str, KLocale::ReadDateFlags flags, bool *ok = 0) const;

    virtual QDate readDate(const QString &dateString, const QString &dateFormat, bool *ok = 0) const;

    //KDE5 Make virtual
    QDate readDate(const QString &dateString, const QString &dateFormat, bool *ok,
                   KLocale::DateTimeFormatStandard formatStandard) const;

    //KDE5 Make virtual
    int shortYearWindowStartYear() const;

    //KDE5 Make virtual
    int applyShortYearWindow(int inputYear) const;

    virtual int weekStartDay() const;

    KDE_DEPRECATED virtual int weekDayOfPray() const = 0;

    virtual bool isLunar() const = 0;

    virtual bool isLunisolar() const = 0;

    virtual bool isSolar() const = 0;

    virtual bool isProleptic() const = 0;

protected:

    virtual bool julianDayToDate(int jd, int &year, int &month, int &day) const = 0;

    virtual bool dateToJulianDay(int year, int month, int day, int &jd) const = 0;

    const KLocale *locale() const;

    KDE_DEPRECATED void setMaxMonthsInYear(int maxMonths);

    KDE_DEPRECATED void setMaxDaysInWeek(int maxDays);

    KDE_DEPRECATED void setHasYear0(bool hasYear0);

    KCalendarSystem(KCalendarSystemPrivate &dd,
                    const KSharedConfig::Ptr config = KSharedConfig::Ptr(),
                    const KLocale *locale = 0);

private:
    //Required for shared d-pointer as already private, remove in KDE5
    friend class KCalendarSystemCoptic;
    friend class KCalendarSystemEthiopian;
    friend class KCalendarSystemGregorian;
    friend class KCalendarSystemHebrew;
    friend class KCalendarSystemIndianNational;
    friend class KCalendarSystemIslamicCivil;
    friend class KCalendarSystemJalali;
    friend class KCalendarSystemJapanese;
    friend class KCalendarSystemJulian;
    friend class KCalendarSystemMinguo;
    friend class KCalendarSystemQDate;
    friend class KCalendarSystemThai;
    //Other friends that need access to protected/private functions
    friend class KLocalizedDate;
    friend class KLocalizedDatePrivate;
    friend class KDateTimeParser;
    friend class KDateTable;

    // Era functions needed by friends, may be made public later if needed in KCM
    QList<KCalendarEra> *eraList() const;
    KCalendarEra era(const QDate &eraDate) const;
    KCalendarEra era(const QString &eraName, int yearInEra) const;

    Q_DISABLE_COPY(KCalendarSystem)
    KCalendarSystemPrivate * const d_ptr; // KDE5 make protected
    Q_DECLARE_PRIVATE(KCalendarSystem)
};

#endif