calsystem.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2014-11-03
 * Description : calendar system.
 *
 * Copyright (C) 2014      by John Layt <john at layt dot net>
 * Copyright (C) 2016-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * 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, or (at your option) any later version.
 *
 * 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_CAL_SYSTEM_H
#define DIGIKAM_CAL_SYSTEM_H
 
// Qt includes
 
#include <QSharedPointer>
#include <QDate>
 
namespace DigikamGenericCalendarPlugin
{
 
class CalSystemPrivate;
 
class CalSystem
{
public:
 
    enum CalendarSystem
    {
        DefaultCalendar           = 0,
        GregorianCalendar         = 1,
        ChineseCalendar           = 2,
        CopticCalendar            = 3,
        EthiopicCalendar          = 4,
        EthiopicAmeteAlemCalendar = 5,
        HebrewCalendar            = 6,
        IndianNationalCalendar    = 7,
        IslamicCalendar           = 8,
        IslamicCivilCalendar      = 9,
        ISO8601Calendar           = 10,
        JapaneseCalendar          = 11,
        JulianCalendar            = 12,
        PersianCalendar           = 13,
        ROCCalendar               = 14,
        ThaiCalendar              = 15,
        LastCalendar              = ThaiCalendar
    };
 
public:
 
    explicit CalSystem(CalSystem::CalendarSystem calendar = CalSystem::DefaultCalendar);
    ~CalSystem();
 
    CalSystem& operator=(const CalSystem& other);
 
public:
 
    CalSystem::CalendarSystem calendarSystem()                              const;
 
    QDate epoch()                                                           const;
    QDate earliestValidDate()                                               const;
    QDate latestValidDate()                                                 const;
    int maximumMonthsInYear()                                               const;
    int maximumDaysInYear()                                                 const;
    int maximumDaysInMonth()                                                const;
 
    bool isValid(const QDate& date)                                         const;
    bool isValid(int year, int month, int day)                              const;
    bool isValid(int year, int dayOfYear)                                   const;
 
    QDate date(int year, int month, int day)                                const;
    QDate date(int year, int dayOfYear)                                     const;
 
    void getDate(const QDate& date, int* year, int* month, int* day)        const;
 
    int year(const QDate& date)                                             const;
    int month(const QDate& date)                                            const;
    int day(const QDate& date)                                              const;
 
    int quarter(const QDate& date)                                          const;
    int quarter(int year, int month, int day)                               const;
 
    int dayOfYear(const QDate& date)                                        const;
    int dayOfYear(int year, int month, int day)                             const;
 
    int dayOfWeek(const QDate& date)                                        const;
    int dayOfWeek(int year, int month, int day)                             const;
 
    int weekNumber(const QDate& date, int* yearNum = nullptr)               const;
    int weekNumber(int year, int month, int day, int* yearNum = nullptr)    const;
 
    int monthsInYear(const QDate& date)                                     const;
    int monthsInYear(int year)                                              const;
 
    int weeksInYear(const QDate& date)                                      const;
    int weeksInYear(int year)                                               const;
 
    int daysInYear(const QDate& date)                                       const;
    int daysInYear(int year)                                                const;
 
    int daysInMonth(const QDate& date)                                      const;
    int daysInMonth(int year, int month)                                    const;
 
    int daysInWeek()                                                        const;
 
    bool isLeapYear(const QDate& date)                                      const;
    bool isLeapYear(int year)                                               const;
 
    QDate addYears(const QDate& date, int years)                            const;
    QDate addMonths(const QDate& date, int months)                          const;
    QDate addDays(const QDate& date, int days)                              const;
 
    int    yearsDifference(const QDate& fromDate, const QDate& toDate)      const;
    int    monthsDifference(const QDate& fromDate, const QDate& toDate)     const;
    qint64 daysDifference(const QDate& fromDate, const QDate& toDate)       const;
 
    bool dateDifference(const QDate& fromDate, const QDate& toDate,
                        int* years, int* months, int* days, int* direction) const;
 
    QDate firstDayOfYear(const QDate& date)                                 const;
    QDate firstDayOfYear(int year)                                          const;
    QDate lastDayOfYear(const QDate& date)                                  const;
    QDate lastDayOfYear(int year)                                           const;
 
    QDate firstDayOfMonth(const QDate& date)                                const;
    QDate firstDayOfMonth(int year, int month)                              const;
    QDate lastDayOfMonth(const QDate& date)                                 const;
    QDate lastDayOfMonth(int year, int month)                               const;
 
private:
 
    QSharedDataPointer<CalSystemPrivate> d;
};
 
} // Namespace Digikam
 
#endif // DIGIKAM_CAL_SYSTEM_H