• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KCalendarSystemGregorian Class Reference

#include <kcalendarsystemgregorian.h>

Inheritance diagram for KCalendarSystemGregorian:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual QDate addDays (const QDate &date, int ndays) const
virtual QDate addMonths (const QDate &date, int nmonths) const
virtual QDate addYears (const QDate &date, int nyears) const
virtual QString calendarType () const
virtual int day (const QDate &date) const
virtual int dayOfWeek (const QDate &date) const
virtual int dayOfYear (const QDate &date) const
virtual int daysInMonth (const QDate &date) const
virtual int daysInWeek (const QDate &date) const
virtual int daysInYear (const QDate &date) const
virtual QString dayString (const QDate &pDate, StringFormat format=LongFormat) const
virtual int dayStringToInteger (const QString &sNum, int &iLength) const
virtual QDate earliestValidDate () const
virtual QDate epoch () const
virtual QString formatDate (const QDate &date, KLocale::DateFormat format=KLocale::LongDate) const
virtual bool isLeapYear (const QDate &date) const
virtual bool isLeapYear (int year) const
virtual bool isLunar () const
virtual bool isLunisolar () const
virtual bool isProleptic () const
virtual bool isSolar () const
virtual bool isValid (const QDate &date) const
virtual bool isValid (int year, int month, int day) const
 KCalendarSystemGregorian (const KLocale *locale=0)
virtual QDate latestValidDate () const
virtual int month (const QDate &date) const
virtual QString monthName (const QDate &date, MonthNameFormat format=LongName) const
virtual QString monthName (int month, int year, MonthNameFormat format=LongName) const
virtual int monthsInYear (const QDate &date) const
virtual QString monthString (const QDate &pDate, StringFormat format=LongFormat) const
virtual int monthStringToInteger (const QString &sNum, int &iLength) const
virtual QDate readDate (const QString &str, KLocale::ReadDateFlags flags, bool *ok=0) const
virtual QDate readDate (const QString &intstr, const QString &fmt, bool *ok=0) const
virtual QDate readDate (const QString &str, bool *ok=0) const
virtual bool setDate (QDate &date, int year, int month, int day) const
virtual bool setYMD (QDate &date, int year, int month, int day) const
virtual QString weekDayName (const QDate &date, WeekDayNameFormat format=LongDayName) const
virtual QString weekDayName (int weekDay, WeekDayNameFormat format=LongDayName) const
virtual int weekDayOfPray () const
virtual int weekNumber (const QDate &date, int *yearNum=0) const
virtual int weeksInYear (int year) const
virtual int weeksInYear (const QDate &date) const
virtual int weekStartDay () const
virtual int year (const QDate &date) const
virtual QString yearString (const QDate &pDate, StringFormat format=LongFormat) const
virtual int yearStringToInteger (const QString &sNum, int &iLength) const
virtual ~KCalendarSystemGregorian ()

Protected Member Functions

virtual bool dateToJulianDay (int year, int month, int day, int &jd) const
virtual bool julianDayToDate (int jd, int &year, int &month, int &day) const

Detailed Description

For internal use only.

This is the Gregorian calendar implementation.

The Gregorian calendar is the most used calendar today. The first year in the calendar is set to the birth of Christ.

WARNING: This is not a pure Gregorian calendar, it copies the QDate method of using the Julian Calendar for dates before 15 October 1582.

license GNU-GPL v.2

See also:
KLocale,KCalendarSystem
Author:
Carlos Moro <cfmoro@correo.uniovi.es>

Definition at line 45 of file kcalendarsystemgregorian.h.


Constructor & Destructor Documentation

KCalendarSystemGregorian::KCalendarSystemGregorian ( const KLocale *  locale = 0  )  [explicit]

Definition at line 32 of file kcalendarsystemgregorian.cpp.

KCalendarSystemGregorian::~KCalendarSystemGregorian (  )  [virtual]

Definition at line 37 of file kcalendarsystemgregorian.cpp.


Member Function Documentation

QDate KCalendarSystemGregorian::addDays ( const QDate &  date,
int  ndays 
) const [virtual]

Returns a QDate containing a date ndays days later.

Parameters:
date The old date
ndays number of days to add
Returns:
The new date, null date if any errors

Reimplemented from KCalendarSystem.

Definition at line 115 of file kcalendarsystemgregorian.cpp.

QDate KCalendarSystemGregorian::addMonths ( const QDate &  date,
int  nmonths 
) const [virtual]

Returns a QDate containing a date nmonths months later.

Parameters:
date The old date
nmonths number of months to add
Returns:
The new date, null date if any errors

Reimplemented from KCalendarSystem.

Definition at line 110 of file kcalendarsystemgregorian.cpp.

QDate KCalendarSystemGregorian::addYears ( const QDate &  date,
int  nyears 
) const [virtual]

Returns a QDate containing a date nyears years later.

Parameters:
date The old date
nyears The number of years to add
Returns:
The new date, null date if any errors

Reimplemented from KCalendarSystem.

Definition at line 105 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::calendarType (  )  const [virtual]

Returns the calendar system type.

Returns:
type of calendar system

Implements KCalendarSystem.

Definition at line 41 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::dateToJulianDay ( int  year,
int  month,
int  day,
int &  jd 
) const [protected, virtual]

Internal method to convert YMD values for this calendar system into a Julian Day number.

All calendar system implementations MUST implement julianDayToDate and dateToJulianDay methods as all other methods can be expressed as functions of these. Does no internal validity checking.

See also:
KCalendarSystem::julianDayToDate
Parameters:
year year number
month month number
day day of month
jd Julian day number returned in this variable
Returns:
true if the date is valid, false otherwise

Implements KCalendarSystem.

Definition at line 450 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::day ( const QDate &  date  )  const [virtual]

Returns the day portion of a given date in the current calendar system.

Parameters:
date date to return day for
Returns:
day of the month, 0 if input date is invalid

Reimplemented from KCalendarSystem.

Definition at line 100 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::dayOfWeek ( const QDate &  date  )  const [virtual]

Returns the weekday number for the given date.

Parameters:
date the date to obtain day from
Returns:
day of week number, -1 if input date not valid

Reimplemented from KCalendarSystem.

Definition at line 170 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::dayOfYear ( const QDate &  date  )  const [virtual]

Returns the day number of year for the given date.

Parameters:
date the date to obtain day from
Returns:
day of year number, -1 if input date not valid

Reimplemented from KCalendarSystem.

Definition at line 152 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::daysInMonth ( const QDate &  date  )  const [virtual]

Returns the number of days in the given month.

Parameters:
date the date to obtain month from
Returns:
number of days in month, -1 if input date invalid

Reimplemented from KCalendarSystem.

Definition at line 141 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::daysInWeek ( const QDate &  date  )  const [virtual]

Returns the number of days in the given week.

Parameters:
date the date to obtain week from
Returns:
number of days in week, -1 if input date invalid

Reimplemented from KCalendarSystem.

Definition at line 146 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::daysInYear ( const QDate &  date  )  const [virtual]

Returns the number of days in the given year.

Parameters:
date the date to obtain year from
Returns:
number of days in year, -1 if input date invalid

Reimplemented from KCalendarSystem.

Definition at line 136 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::dayString ( const QDate &  pDate,
StringFormat  format = LongFormat 
) const [virtual]

Converts a date into a day literal.

Parameters:
pDate The date to convert
format The format to return, either short or long
Returns:
The day literal of the date, empty string if any error

Reimplemented from KCalendarSystem.

Definition at line 367 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::dayStringToInteger ( const QString &  sNum,
int &  iLength 
) const [virtual]

Converts a day literal of a part of a string into a integer starting at the beginning of the string.

Parameters:
sNum The string to parse
iLength The number of QChars used, and 0 if no valid symbols was found in the string
Returns:
An integer corresponding to the day

Reimplemented from KCalendarSystem.

Definition at line 382 of file kcalendarsystemgregorian.cpp.

QDate KCalendarSystemGregorian::earliestValidDate (  )  const [virtual]

Returns the earliest date valid in this calendar system implementation.

If the calendar system is proleptic then this may be before epoch.

See also:
KCalendarSystem::epoch

KCalendarSystem::latestValidDate

Returns:
date the earliest valid date

Reimplemented from KCalendarSystem.

Definition at line 51 of file kcalendarsystemgregorian.cpp.

QDate KCalendarSystemGregorian::epoch (  )  const [virtual]

Returns a QDate holding the epoch of the calendar system.

Usually YMD of 1/1/1, access the returned QDates method toJulianDay() if you require the actual Julian day number. Note: a particular calendar system implementation may not include the epoch in its supported range, or the calendar system may be proleptic in which case it supports dates before the epoch.

See also:
KCalendarSystem::earliestValidDate

KCalendarSystem::latestValidDate

KCalendarSystem::isProleptic

KCalendarSystem::isValid

Returns:
epoch of calendar system

Reimplemented from KCalendarSystem.

Definition at line 46 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::formatDate ( const QDate &  date,
KLocale::DateFormat  format = KLocale::LongDate 
) const [virtual]

Returns a string formatted to the current locale's conventions regarding dates.

Uses the calendar system's internal locale set when the instance was created, which ensures that the correct calendar system and locale settings are respected, which would not occur in some cases if using the global locale. Defaults to global locale.

See also:
KLocale::formatDate
Parameters:
date the date to be formatted
format category of date format to use
Returns:
The date as a string

Reimplemented from KCalendarSystem.

Definition at line 387 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::isLeapYear ( const QDate &  date  )  const [virtual]

Returns whether a given date falls in a leap year.

Input date must be checked for validity in current Calendar System prior to calling, no validity checking performed in this routine, behaviour is undefined in invalid case.

Parameters:
date the date to check
Returns:
true if the date falls in a leap year, false otherwise

Reimplemented from KCalendarSystem.

Definition at line 186 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::isLeapYear ( int  year  )  const [virtual]

Returns whether a given year is a leap year.

Input year must be checked for validity in current Calendar System prior to calling, no validity checking performed in this routine, behaviour is undefined in invalid case.

Parameters:
year the year to check
Returns:
true if the year is a leap year, false otherwise

Implements KCalendarSystem.

Definition at line 180 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::isLunar (  )  const [virtual]

Returns whether the calendar is lunar based.

Returns:
true if the calendar is lunar based, false if not

Implements KCalendarSystem.

Definition at line 417 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::isLunisolar (  )  const [virtual]

Returns whether the calendar is lunisolar based.

Returns:
true if the calendar is lunisolar based, false if not

Implements KCalendarSystem.

Definition at line 422 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::isProleptic (  )  const [virtual]

Returns whether the calendar system is proleptic, i.e.

whether dates before the epoch are supported.

See also:
KCalendarSystem::epoch
Returns:
true if the calendar system is proleptic, false if not

Implements KCalendarSystem.

Definition at line 432 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::isSolar (  )  const [virtual]

Returns whether the calendar is solar based.

Returns:
true if the calendar is solar based, false if not

Implements KCalendarSystem.

Definition at line 427 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::isValid ( const QDate &  date  )  const [virtual]

Returns whether a given date is valid in this calendar system.

Parameters:
date the date to check
Returns:
true if the date is valid, false otherwise

Reimplemented from KCalendarSystem.

Definition at line 74 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::isValid ( int  year,
int  month,
int  day 
) const [virtual]

Returns whether a given date is valid in this calendar system.

Parameters:
year the year portion of the date to check
month the month portion of the date to check
day the day portion of the date to check
Returns:
true if the date is valid, false otherwise

Implements KCalendarSystem.

Definition at line 64 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::julianDayToDate ( int  jd,
int &  year,
int &  month,
int &  day 
) const [protected, virtual]

Internal method to convert a Julian Day number into the YMD values for this calendar system.

All calendar system implementations MUST implement julianDayToDate and dateToJulianDay methods as all other methods can be expressed as functions of these. Does no internal validity checking.

See also:
KCalendarSystem::dateToJulianDay
Parameters:
jd Julian day number to convert to date
year year number returned in this variable
month month number returned in this variable
day day of month returned in this variable
Returns:
true if the date is valid, false otherwise

Implements KCalendarSystem.

Definition at line 437 of file kcalendarsystemgregorian.cpp.

QDate KCalendarSystemGregorian::latestValidDate (  )  const [virtual]

Returns the latest date valid in this calendar system implementation.

See also:
KCalendarSystem::epoch

KCalendarSystem::earliestValidDate

Returns:
date the latest valid date

Reimplemented from KCalendarSystem.

Definition at line 56 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::month ( const QDate &  date  )  const [virtual]

Returns the month portion of a given date in the current calendar system.

Parameters:
date date to return month for
Returns:
month of year, 0 if input date is invalid

Reimplemented from KCalendarSystem.

Definition at line 95 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::monthName ( const QDate &  date,
MonthNameFormat  format = LongName 
) const [virtual]

Gets specific calendar type month name for a given date.

Parameters:
date date to obtain month from
format specifies whether the short month name or long month name should be used
Returns:
name of the month, empty string if any error

Reimplemented from KCalendarSystem.

Definition at line 319 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::monthName ( int  month,
int  year,
MonthNameFormat  format = LongName 
) const [virtual]

Gets specific calendar type month name for a given month number If an invalid month is specified, QString() is returned.

Parameters:
month the month number
year the year the month belongs to
format specifies whether the short month name or long month name should be used
Returns:
name of the month, empty string if any error

Implements KCalendarSystem.

Definition at line 191 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::monthsInYear ( const QDate &  date  )  const [virtual]

Returns number of months in the given year.

Parameters:
date the date to obtain year from
Returns:
number of months in the year, -1 if input date invalid

Reimplemented from KCalendarSystem.

Definition at line 120 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::monthString ( const QDate &  pDate,
StringFormat  format = LongFormat 
) const [virtual]

Converts a date into a month literal.

Parameters:
pDate The date to convert
format The format to return, either short or long
Returns:
The month literal of the date, empty string if any error

Reimplemented from KCalendarSystem.

Definition at line 362 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::monthStringToInteger ( const QString &  sNum,
int &  iLength 
) const [virtual]

Converts a month literal of a part of a string into a integer starting at the beginning of the string.

Parameters:
sNum The string to parse
iLength The number of QChars used, and 0 if no valid symbols was found in the string
Returns:
An integer corresponding to the month

Reimplemented from KCalendarSystem.

Definition at line 377 of file kcalendarsystemgregorian.cpp.

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

Converts a localized date string to a QDate.

This method is stricter than readDate(str,&ok): it will either accept a date in full format or a date in short format, depending on flags.

Uses the calendar system's internal locale set when the instance was created, which ensures that the correct calendar system and locale settings are respected, which would not occur in some cases if using the global locale. Defaults to global locale.

See also:
KLocale::readDate
Parameters:
str the string to convert
flags whether the date string is to be in full format or in short format
ok if non-null, will be set to true if the date is valid, false if invalid
Returns:
the string converted to a QDate

Reimplemented from KCalendarSystem.

Definition at line 402 of file kcalendarsystemgregorian.cpp.

QDate KCalendarSystemGregorian::readDate ( const QString &  intstr,
const QString &  format,
bool *  ok = 0 
) const [virtual]

Converts a localized date string to a QDate, using the specified format.

You will usually not want to use this method.

See also:
KLocale::readDate

Reimplemented from KCalendarSystem.

Definition at line 397 of file kcalendarsystemgregorian.cpp.

QDate KCalendarSystemGregorian::readDate ( const QString &  str,
bool *  ok = 0 
) const [virtual]

Converts a localized date string to a QDate.

The bool pointed by ok will be false if the date entered was invalid.

Uses the calendar system's internal locale set when the instance was created, which ensures that the correct calendar system and locale settings are respected, which would not occur in some cases if using the global locale. Defaults to global locale.

See also:
KLocale::readDate
Parameters:
str the string to convert
ok if non-null, will be set to true if the date is valid, false if invalid
Returns:
the string converted to a QDate

Reimplemented from KCalendarSystem.

Definition at line 392 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::setDate ( QDate &  date,
int  year,
int  month,
int  day 
) const [virtual]

Changes the date's year, month and day.

The range of the year, month and day depends on which calendar is being used. All years entered are treated literally, i.e. no Y2K translation is applied to years entered in the range 00 to 99. Replaces setYMD.

Parameters:
date date to change
year year
month month number
day day of month
Returns:
true if the date is valid, false otherwise

Reimplemented from KCalendarSystem.

Definition at line 79 of file kcalendarsystemgregorian.cpp.

bool KCalendarSystemGregorian::setYMD ( QDate &  date,
int  year,
int  month,
int  day 
) const [virtual]

Deprecated:

Reimplemented from KCalendarSystem.

Definition at line 85 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::weekDayName ( const QDate &  date,
WeekDayNameFormat  format = LongDayName 
) const [virtual]

Gets specific calendar type week day name.

Parameters:
date the date
format specifies whether the short month name or long month name should be used
Returns:
day name, empty string if any error

Reimplemented from KCalendarSystem.

Definition at line 352 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::weekDayName ( int  weekDay,
WeekDayNameFormat  format = LongDayName 
) const [virtual]

Gets specific calendar type week day name.

If an invalid week day is specified, QString() is returned.

Parameters:
weekDay number of day in week (Monday = 1, ..., Sunday = 7)
format specifies whether the short month name or long month name should be used
Returns:
day name, empty string if any error

Implements KCalendarSystem.

Definition at line 325 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::weekDayOfPray (  )  const [virtual]

Returns the day of the week traditionally associated with religious observance for this calendar system.

Note this may not be accurate for the users locale, e.g. Gregorian calendar used in non-Christian countries, in use cases where this could be an issue it is recommended to use KLocale::weekDayOfPray() instead.

Returns:
day number (None = 0, Monday = 1, ..., Sunday = 7)

Implements KCalendarSystem.

Definition at line 412 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::weekNumber ( const QDate &  date,
int *  yearNum = 0 
) const [virtual]

Returns the ISO week number for the given date.

ISO 8601 defines the first week of the year as the week containing the first Thursday. See http://en.wikipedia.org/wiki/ISO_8601 and http://en.wikipedia.org/wiki/ISO_week_date

If the date falls in the last week of the previous year or the first week of the following year, then the yearNum returned will be set to the appropriate year.

Parameters:
date the date to obtain week from
yearNum returns the year the date belongs to
Returns:
ISO week number, -1 if input date invalid

Reimplemented from KCalendarSystem.

Definition at line 175 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::weeksInYear ( int  year  )  const [virtual]

Returns the number of ISO weeks in the given year.

ISO 8601 defines the first week of the year as the week containing the first Thursday. See http://en.wikipedia.org/wiki/ISO_8601 and http://en.wikipedia.org/wiki/ISO_week_date

Parameters:
year the year
Returns:
number of weeks in the year, -1 if input date invalid

Reimplemented from KCalendarSystem.

Definition at line 131 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::weeksInYear ( const QDate &  date  )  const [virtual]

Returns the number of ISO weeks in the given year.

Parameters:
date the date to obtain year from
Returns:
number of weeks in the year, -1 if input date invalid

Reimplemented from KCalendarSystem.

Definition at line 126 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::weekStartDay (  )  const [virtual]

Use this to determine which day is the first day of the week.

Uses the calendar system's internal locale set when the instance was created, which ensures that the correct calendar system and locale settings are respected, which would not occur in some cases if using the global locale. Defaults to global locale.

See also:
KLocale::weekStartDay
Returns:
an integer (Monday = 1, ..., Sunday = 7)

Reimplemented from KCalendarSystem.

Definition at line 407 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::year ( const QDate &  date  )  const [virtual]

Returns the year portion of a given date in the current calendar system.

Parameters:
date date to return year for
Returns:
year, 0 if input date is invalid

Reimplemented from KCalendarSystem.

Definition at line 90 of file kcalendarsystemgregorian.cpp.

QString KCalendarSystemGregorian::yearString ( const QDate &  date,
StringFormat  format = LongFormat 
) const [virtual]

Converts a date into a year literal.

Parameters:
date date to convert
format format to return, either short or long
Returns:
year literal of the date, empty string if any error

Reimplemented from KCalendarSystem.

Definition at line 357 of file kcalendarsystemgregorian.cpp.

int KCalendarSystemGregorian::yearStringToInteger ( const QString &  sNum,
int &  iLength 
) const [virtual]

Converts a year literal of a part of a string into a integer starting at the beginning of the string.

Parameters:
sNum The string to parse
iLength The number of QChars used, and 0 if no valid symbols was found in the string
Returns:
An integer corresponding to the year

Reimplemented from KCalendarSystem.

Definition at line 372 of file kcalendarsystemgregorian.cpp.


The documentation for this class was generated from the following files:
  • kcalendarsystemgregorian.h
  • kcalendarsystemgregorian.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal