kdecore Library API Documentation

KCalendarSystem Class Reference

CalendarSystem abstract class, default derived kde gregorian class and factory class. More...

#include <kcalendarsystem.h>

Inheritance diagram for KCalendarSystem:

KCalendarSystemJalali List of all members.

Public Methods

 KCalendarSystem (const KLocale *locale=0)
virtual ~KCalendarSystem ()
virtual int year (const QDate &date) const=0
virtual QString yearString (const QDate &pDate, bool bShort) const
virtual int yearStringToInteger (const QString &sNum, int &iLength) const
virtual int month (const QDate &date) const=0
virtual QString monthString (const QDate &pDate, bool bShort) const
virtual int monthStringToInteger (const QString &sNum, int &iLength) const
virtual int day (const QDate &date) const=0
virtual QString dayString (const QDate &pDate, bool bShort) const
virtual int dayStringToInteger (const QString &sNum, int &iLength) const
virtual int dayOfWeek (const QDate &date) const=0
virtual int dayOfYear (const QDate &date) const=0
virtual bool setYMD (QDate &date, int y, int m, int d) const=0
virtual QDate addYears (const QDate &date, int nyears) const=0
virtual QDate addMonths (const QDate &date, int nmonths) const=0
virtual QDate addDays (const QDate &date, int ndays) const=0
virtual int monthsInYear (const QDate &date) const=0
virtual int daysInYear (const QDate &date) const=0
virtual int daysInMonth (const QDate &date) const=0
virtual int weeksInYear (int year) const=0
virtual int weekNumber (const QDate &date, int *yearNum=0) const=0
virtual QString monthName (int month, int year, bool shortName=false) const=0
virtual QString monthName (const QDate &date, bool shortName=false) const=0
virtual QString monthNamePossessive (int month, int year, bool shortName=false) const=0
virtual QString monthNamePossessive (const QDate &date, bool shortName=false) const=0
virtual QString weekDayName (int weekDay, bool shortName=false) const=0
virtual QString weekDayName (const QDate &date, bool shortName=false) const=0
virtual int minValidYear () const=0
virtual int maxValidYear () const=0
virtual int weekDayOfPray () const=0
virtual QString calendarName () const=0
virtual bool isLunar () const=0
virtual bool isLunisolar () const=0
virtual bool isSolar () const=0

Detailed Description

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>
Version:
Id:
kcalendarsystem.h,v 1.11 2003/10/07 22:09:16 mueller Exp
Since:
3.2

Definition at line 42 of file kcalendarsystem.h.


Constructor & Destructor Documentation

KCalendarSystem::KCalendarSystem const KLocale   locale = 0
 

Constructor of abstract calendar class.

This will be called by the derived classes.

Parameters:
locale  It will use this locale for translations, 0 means global.

Definition at line 35 of file kcalendarsystem.cpp.

KCalendarSystem::~KCalendarSystem   [virtual]
 

Descructor.

Definition at line 41 of file kcalendarsystem.cpp.


Member Function Documentation

virtual int KCalendarSystem::year const QDate   date const [pure virtual]
 

Gets specific calendar type year for a given gregorian date.

Parameters:
date  gregorian date
Returns:
year

Implemented in KCalendarSystemJalali.

Referenced by KLocale::formatDate(), KLocale::readDate(), and yearString().

QString KCalendarSystem::yearString const QDate   pDate,
bool    bShort
const [virtual]
 

Converts a date into a year literal.

Parameters:
pDate  The date to convert
bShort  If the short version of should be used
Returns:
The year literal of the date

Definition at line 76 of file kcalendarsystem.cpp.

References QString::length(), QString::prepend(), QString::setNum(), and year().

int KCalendarSystem::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

Definition at line 113 of file kcalendarsystem.cpp.

Referenced by KLocale::readDate().

virtual int KCalendarSystem::month const QDate   date const [pure virtual]
 

Gets specific calendar type month for a given gregorian date.

Parameters:
date  gregorian date
Returns:
month number

Implemented in KCalendarSystemJalali.

Referenced by KLocale::formatDate(), and monthString().

QString KCalendarSystem::monthString const QDate   pDate,
bool    bShort
const [virtual]
 

Converts a date into a month literal.

Parameters:
pDate  The date to convert
bShort  If the short version of should be used
Returns:
The month literal of the date

Definition at line 65 of file kcalendarsystem.cpp.

References QString::length(), month(), QString::prepend(), and QString::setNum().

int KCalendarSystem::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

Definition at line 108 of file kcalendarsystem.cpp.

Referenced by KLocale::readDate().

virtual int KCalendarSystem::day const QDate   date const [pure virtual]
 

Gets specific calendar type day number of month for a given date.

Parameters:
date  gregorian date equivalent to the specific one
Returns:
day of the month

Implemented in KCalendarSystemJalali.

Referenced by dayString().

QString KCalendarSystem::dayString const QDate   pDate,
bool    bShort
const [virtual]
 

Converts a date into a day literal.

Parameters:
pDate  The date to convert
bShort  If the short version of should be used
Returns:
The day literal of the date

Definition at line 54 of file kcalendarsystem.cpp.

References day(), QString::length(), QString::prepend(), and QString::setNum().

int KCalendarSystem::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

Definition at line 103 of file kcalendarsystem.cpp.

Referenced by KLocale::readDate().

virtual int KCalendarSystem::dayOfWeek const QDate   date const [pure virtual]
 

Gets specific calendar type number of day of week number for a given date.

Parameters:
date  gregorian date
Returns:
day of week

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::dayOfYear const QDate   date const [pure virtual]
 

Gets specific calendar type day number of year for a given date.

Parameters:
date  gregorian date equivalent to the specific one
Returns:
day number

Implemented in KCalendarSystemJalali.

virtual bool KCalendarSystem::setYMD QDate   date,
int    y,
int    m,
int    d
const [pure virtual]
 

Changes the date's year, month and day.

The range of the year, month and day depends on which calendar is being used.

Parameters:
date  Date to change
y  Year
m  Month number
d  Day of month
Returns:
true if the date is valid; otherwise returns false.

Implemented in KCalendarSystemJalali.

Referenced by KLocale::readDate().

virtual QDate KCalendarSystem::addYears const QDate   date,
int    nyears
const [pure virtual]
 

Returns a QDate object containing a date nyears later.

Parameters:
date  The old date
nyears  The number of years to add
Returns:
The new date

Implemented in KCalendarSystemJalali.

virtual QDate KCalendarSystem::addMonths const QDate   date,
int    nmonths
const [pure virtual]
 

Returns a QDate object containing a date nmonths later.

Parameters:
date  The old date
nmonths  The number of months to add
Returns:
The new date

Implemented in KCalendarSystemJalali.

virtual QDate KCalendarSystem::addDays const QDate   date,
int    ndays
const [pure virtual]
 

Returns a QDate object containing a date ndays later.

Parameters:
date  The old date
ndays  The number of days to add
Returns:
The new date

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::monthsInYear const QDate   date const [pure virtual]
 

Gets specific calendar type number of month for a given year.

Parameters:
date  The date whose year to use
Returns:
The number of months in that year

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::daysInYear const QDate   date const [pure virtual]
 

Gets the number of days in date whose years specified.

Parameters:
date  Gregorian date equivalent to the specific one
Returns:
The number of days in year

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::daysInMonth const QDate   date const [pure virtual]
 

Gets specific calendar type number of days in month for a given date.

Parameters:
date  gregorian date
Returns:
number of days for month in date

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::weeksInYear int    year const [pure virtual]
 

Gets the number of weeks in a specified year.

Parameters:
year  the year
Returns:
number of weeks in year

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::weekNumber const QDate   date,
int *    yearNum = 0
const [pure virtual]
 

Gets specific calendar type week number for a given date.

Parameters:
date  gregorian date
yearNum  The year the date belongs to
Returns:
week number

Implemented in KCalendarSystemJalali.

virtual QString KCalendarSystem::monthName int    month,
int    year,
bool    shortName = false
const [pure virtual]
 

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

Parameters:
month  The month number
year  The year the month belongs to
shortName  Specifies if the short month name should be used
Returns:
The name of the month

Implemented in KCalendarSystemJalali.

Referenced by KLocale::readDate().

virtual QString KCalendarSystem::monthName const QDate   date,
bool    shortName = false
const [pure virtual]
 

Gets specific calendar type month name for a given gregorian date.

Parameters:
date  Gregorian date
shortName  Specifies if the short month name should be used
Returns:
The name of the month

Implemented in KCalendarSystemJalali.

virtual QString KCalendarSystem::monthNamePossessive int    month,
int    year,
bool    shortName = false
const [pure virtual]
 

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, QString::null is returned.

Parameters:
month  The month number
year  The year the month belongs to
shortName  Specifies if the short month name should be used
Returns:
The possessive form of the name of the month

Implemented in KCalendarSystemJalali.

Referenced by KLocale::readDate().

virtual QString KCalendarSystem::monthNamePossessive const QDate   date,
bool    shortName = false
const [pure virtual]
 

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.

Parameters:
date  Gregorian date
shortName  Specifies if the short month name should be used
Returns:
The possessive form of the name of the month

Implemented in KCalendarSystemJalali.

virtual QString KCalendarSystem::weekDayName int    weekDay,
bool    shortName = false
const [pure virtual]
 

Gets specific calendar type week day name If an invalid week day is specified, QString::null is returned.

Parameters:
weekDay  number of day in week (1 -> Monday)
shortName  short or complete day name
Returns:
day name

Implemented in KCalendarSystemJalali.

Referenced by KLocale::readDate().

virtual QString KCalendarSystem::weekDayName const QDate   date,
bool    shortName = false
const [pure virtual]
 

Gets specific calendar type week day name.

Parameters:
date  the date
shortName  short or complete day name
Returns:
day name

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::minValidYear   [pure virtual]
 

Gets the first year value supported by specific calendar type algorithms.

Returns:
first year supported

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::maxValidYear   [pure virtual]
 

Gets the maximum year value supported by specific calendar type algorithms (QDate, 8000).

Returns:
maximum year supported

Implemented in KCalendarSystemJalali.

virtual int KCalendarSystem::weekDayOfPray   [pure virtual]
 

Gets the day of the week traditionaly associated with pray.

Returns:
day number

Implemented in KCalendarSystemJalali.

virtual QString KCalendarSystem::calendarName   [pure virtual]
 

Gets the string representing the calendar.

Implemented in KCalendarSystemJalali.

virtual bool KCalendarSystem::isLunar   [pure virtual]
 

Gets if the calendar is lunar based.

Returns:
if the calendar is lunar based

Implemented in KCalendarSystemJalali.

virtual bool KCalendarSystem::isLunisolar   [pure virtual]
 

Gets if the calendar is lunisolar based.

Returns:
if the calendar is lunisolar based

Implemented in KCalendarSystemJalali.

virtual bool KCalendarSystem::isSolar   [pure virtual]
 

Gets if the calendar is solar based.

Returns:
if the calendar is solar based

Implemented in KCalendarSystemJalali.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdecore Library Version 3.2.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Feb 4 12:33:54 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003