summaryrefslogtreecommitdiffstats
path: root/tdecore/kcalendarsystem.h
diff options
context:
space:
mode:
Diffstat (limited to 'tdecore/kcalendarsystem.h')
-rw-r--r--tdecore/kcalendarsystem.h357
1 files changed, 357 insertions, 0 deletions
diff --git a/tdecore/kcalendarsystem.h b/tdecore/kcalendarsystem.h
new file mode 100644
index 000000000..826539a65
--- /dev/null
+++ b/tdecore/kcalendarsystem.h
@@ -0,0 +1,357 @@
+/*
+ Copyright (c) 2002 Carlos Moro <cfmoro@correo.uniovi.es>
+ Copyright (c) 2002-2003 Hans Petter Bieker <bieker@kde.org>
+
+ 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 <tqdatetime.h>
+#include <tqstring.h>
+#include "kdelibs_export.h"
+
+class KLocale;
+
+class KCalendarSystemPrivate;
+
+/**
+ * CalendarSystem abstract class, default derived kde gregorian class and
+ * factory class. Provides support for different calendar types for kde
+ * calendar widget and related stuff.
+ *
+ * Derived classes must be created through KCalendarFactory class
+ *
+ * @author Carlos Moro <cfmoro@correo.uniovi.es>
+ * @since 3.2
+ */
+class KDECORE_EXPORT KCalendarSystem
+{
+public:
+ /**
+ * Constructor of abstract calendar class. This will be called by the derived classes.
+ *
+ * @param locale It will use this locale for translations, 0 means global.
+ */
+ KCalendarSystem(const KLocale * locale = 0);
+
+ /**
+ * Descructor.
+ */
+ virtual ~KCalendarSystem();
+
+ /**
+ * Gets specific calendar type year for a given gregorian date
+ *
+ * @param date gregorian date
+ * @return year
+ */
+ virtual int year (const TQDate & date) const = 0;
+
+ /**
+ * Converts a date into a year literal
+ *
+ * @param pDate The date to convert
+ * @param bShort If the short version of should be used
+ * @return The year literal of the date
+ */
+ virtual TQString yearString(const TQDate & pDate, bool bShort) const;
+
+ /**
+ * Converts a year literal of a part of a string into a integer starting at the beginning of the string
+ *
+ * @param sNum The string to parse
+ * @param iLength The number of QChars used, and 0 if no valid symbols was found in the string
+ * @return An integer corresponding to the year
+ */
+ virtual int yearStringToInteger(const TQString & sNum, int & iLength) const;
+
+ /**
+ * Gets specific calendar type month for a given gregorian date
+ *
+ * @param date gregorian date
+ * @return month number
+ */
+ virtual int month (const TQDate & date) const = 0;
+
+ /**
+ * Converts a date into a month literal
+ *
+ * @param pDate The date to convert
+ * @param bShort If the short version of should be used
+ * @return The month literal of the date
+ */
+ virtual TQString monthString(const TQDate & pDate, bool bShort) const;
+
+ /**
+ * Converts a month literal of a part of a string into a integer starting at the beginning of the string
+ *
+ * @param sNum The string to parse
+ * @param iLength The number of QChars used, and 0 if no valid symbols was found in the string
+ * @return An integer corresponding to the month
+ */
+ virtual int monthStringToInteger(const TQString & sNum, int & iLength) const;
+
+ /**
+ * Gets specific calendar type day number of month for a given date
+ *
+ * @param date gregorian date equivalent to the specific one
+ * @return day of the month
+ */
+ virtual int day (const TQDate & date) const = 0;
+
+ /**
+ * Converts a date into a day literal
+ *
+ * @param pDate The date to convert
+ * @param bShort If the short version of should be used
+ * @return The day literal of the date
+ */
+ virtual TQString dayString(const TQDate & pDate, bool bShort) const;
+
+ /**
+ * Converts a day literal of a part of a string into a integer starting at the beginning of the string
+ *
+ * @param sNum The string to parse
+ * @param iLength The number of QChars used, and 0 if no valid symbols was found in the string
+ * @return An integer corresponding to the day
+ */
+ virtual int dayStringToInteger(const TQString & sNum, int & iLength) const;
+
+ /**
+ * Gets specific calendar type number of day of week number for a given
+ * date
+ *
+ * @param date gregorian date
+ * @return day of week
+ */
+ virtual int dayOfWeek (const TQDate & date) const = 0;
+
+ /**
+ * Gets specific calendar type day number of year for a given date
+ *
+ * @param date gregorian date equivalent to the specific one
+ * @return day number
+ */
+ virtual int dayOfYear (const TQDate & date) const = 0;
+
+ /**
+ * Changes the date's year, month and day. The range of the year, month
+ * and day depends on which calendar is being used.
+ *
+ * @param date Date to change
+ * @param y Year
+ * @param m Month number
+ * @param d Day of month
+ * @return true if the date is valid; otherwise returns false.
+ */
+ virtual bool setYMD(TQDate & date, int y, int m, int d) const = 0;
+
+ /**
+ * Returns a TQDate object containing a date nyears later.
+ *
+ * @param date The old date
+ * @param nyears The number of years to add
+ * @return The new date
+ */
+ virtual TQDate addYears(const TQDate & date, int nyears) const = 0;
+
+ /**
+ * Returns a TQDate object containing a date nmonths later.
+ *
+ * @param date The old date
+ * @param nmonths The number of months to add
+ * @return The new date
+ */
+ virtual TQDate addMonths(const TQDate & date, int nmonths) const = 0;
+
+ /**
+ * Returns a TQDate object containing a date ndays later.
+ *
+ * @param date The old date
+ * @param ndays The number of days to add
+ * @return The new date
+ */
+ virtual TQDate addDays(const TQDate & date, int ndays) const = 0;
+
+ /**
+ * Gets specific calendar type number of month for a given year
+ *
+ * @param date The date whose year to use
+ * @return The number of months in that year
+ */
+ virtual int monthsInYear (const TQDate & date) const = 0;
+
+ /**
+ * Gets the number of days in date whose years specified.
+ *
+ * @param date Gregorian date equivalent to the specific one
+ * @return The number of days in year
+ */
+ virtual int daysInYear (const TQDate & date) const = 0;
+
+ /**
+ * Gets specific calendar type number of days in month for a given date
+ *
+ * @param date gregorian date
+ * @return number of days for month in date
+ */
+ virtual int daysInMonth (const TQDate & date) const = 0;
+
+ /**
+ * Gets the number of weeks in a specified year
+ *
+ * @param year the year
+ * @return number of weeks in year
+ */
+ virtual int weeksInYear(int year) const = 0;
+
+ /**
+ * Gets specific calendar type week number for a given date
+ *
+ * @param date gregorian date
+ * @param yearNum The year the date belongs to
+ * @return week number
+ */
+ virtual int weekNumber(const TQDate& date, int * yearNum = 0) const = 0;
+
+ /**
+ * Gets specific calendar type month name for a given month number
+ * If an invalid month is specified, TQString::null is returned.
+ *
+ * @param month The month number
+ * @param year The year the month belongs to
+ * @param shortName Specifies if the short month name should be used
+ * @return The name of the month
+ */
+ virtual TQString monthName (int month, int year, bool shortName = false) const = 0;
+
+ /**
+ * Gets specific calendar type month name for a given gregorian date
+ *
+ * @param date Gregorian date
+ * @param shortName Specifies if the short month name should be used
+ * @return The name of the month
+ */
+ virtual TQString monthName (const TQDate & date, bool shortName = false ) const = 0;
+
+ /**
+ * Returns a string containing the possessive form of the month name.
+ * ("of January", "of February", etc.)
+ * It's needed in long format dates in some languages.
+ * If an invalid month is specified, TQString::null is returned.
+ *
+ * @param month The month number
+ * @param year The year the month belongs to
+ * @param shortName Specifies if the short month name should be used
+ *
+ * @return The possessive form of the name of the month
+ */
+ virtual TQString monthNamePossessive(int month, int year, bool shortName = false) const = 0;
+
+ /**
+ * Returns a string containing the possessive form of the month name.
+ * ("of January", "of February", etc.)
+ * It's needed in long format dates in some languages.
+ *
+ * @param date Gregorian date
+ * @param shortName Specifies if the short month name should be used
+ *
+ * @return The possessive form of the name of the month
+ */
+ virtual TQString monthNamePossessive(const TQDate & date, bool shortName = false) const = 0;
+
+ /**
+ * Gets specific calendar type week day name
+ * If an invalid week day is specified, TQString::null is returned.
+ *
+ * @param weekDay number of day in week (1 -> Monday)
+ * @param shortName short or complete day name
+ * @return day name
+ */
+ virtual TQString weekDayName (int weekDay, bool shortName = false) const = 0;
+
+ /**
+ * Gets specific calendar type week day name
+ *
+ * @param date the date
+ * @param shortName short or complete day name
+ * @return day name
+ */
+ virtual TQString weekDayName (const TQDate & date, bool shortName = false) const = 0;
+
+ /**
+ * Gets the first year value supported by specific calendar type
+ * algorithms.
+ *
+ * @return first year supported
+ */
+ virtual int minValidYear () const = 0;
+
+ /**
+ * Gets the maximum year value supported by specific calendar type
+ * algorithms (TQDate, 8000)
+ *
+ * @return maximum year supported
+ */
+ virtual int maxValidYear () const = 0;
+
+ /**
+ * Gets the day of the week traditionaly associated with pray
+ *
+ * @return day number
+ */
+ virtual int weekDayOfPray () const = 0;
+
+ /**
+ * Gets the string representing the calendar
+ */
+ virtual TQString calendarName() const = 0;
+
+ /**
+ * Gets if the calendar is lunar based
+ *
+ * @return if the calendar is lunar based
+ */
+ virtual bool isLunar() const = 0;
+
+ /**
+ * Gets if the calendar is lunisolar based
+ *
+ * @return if the calendar is lunisolar based
+ */
+ virtual bool isLunisolar() const = 0;
+
+ /**
+ * Gets if the calendar is solar based
+ *
+ * @return if the calendar is solar based
+ */
+ virtual bool isSolar() const = 0;
+
+protected:
+ /**
+ * Gets the locale the calendar uses for translations. Set in
+ * the constructor.
+ */
+ const KLocale * locale() const;
+
+private:
+ KCalendarSystemPrivate * d;
+};
+
+#endif