.TH "KCalendarSystem" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KCalendarSystem \- CalendarSystem abstract class, default derived kde gregorian class and factory class.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kcalendarsystem.h>\fP
.PP
Inherited by KCalendarSystemGregorian, KCalendarSystemHebrew, KCalendarSystemHijri, and \fBKCalendarSystemJalali\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKCalendarSystem\fP (const \fBKLocale\fP *locale=0)"
.br
.ti -1c
.RI "virtual \fB~KCalendarSystem\fP ()"
.br
.ti -1c
.RI "virtual int \fByear\fP (const \fBQDate\fP &date) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fByearString\fP (const \fBQDate\fP &pDate, bool bShort) const "
.br
.ti -1c
.RI "virtual int \fByearStringToInteger\fP (const \fBQString\fP &sNum, int &iLength) const "
.br
.ti -1c
.RI "virtual int \fBmonth\fP (const \fBQDate\fP &date) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthString\fP (const \fBQDate\fP &pDate, bool bShort) const "
.br
.ti -1c
.RI "virtual int \fBmonthStringToInteger\fP (const \fBQString\fP &sNum, int &iLength) const "
.br
.ti -1c
.RI "virtual int \fBday\fP (const \fBQDate\fP &date) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBdayString\fP (const \fBQDate\fP &pDate, bool bShort) const "
.br
.ti -1c
.RI "virtual int \fBdayStringToInteger\fP (const \fBQString\fP &sNum, int &iLength) const "
.br
.ti -1c
.RI "virtual int \fBdayOfWeek\fP (const \fBQDate\fP &date) const =0"
.br
.ti -1c
.RI "virtual int \fBdayOfYear\fP (const \fBQDate\fP &date) const =0"
.br
.ti -1c
.RI "virtual bool \fBsetYMD\fP (\fBQDate\fP &date, int y, int m, int d) const =0"
.br
.ti -1c
.RI "virtual \fBQDate\fP \fBaddYears\fP (const \fBQDate\fP &date, int nyears) const =0"
.br
.ti -1c
.RI "virtual \fBQDate\fP \fBaddMonths\fP (const \fBQDate\fP &date, int nmonths) const =0"
.br
.ti -1c
.RI "virtual \fBQDate\fP \fBaddDays\fP (const \fBQDate\fP &date, int ndays) const =0"
.br
.ti -1c
.RI "virtual int \fBmonthsInYear\fP (const \fBQDate\fP &date) const =0"
.br
.ti -1c
.RI "virtual int \fBdaysInYear\fP (const \fBQDate\fP &date) const =0"
.br
.ti -1c
.RI "virtual int \fBdaysInMonth\fP (const \fBQDate\fP &date) const =0"
.br
.ti -1c
.RI "virtual int \fBweeksInYear\fP (int year) const =0"
.br
.ti -1c
.RI "virtual int \fBweekNumber\fP (const \fBQDate\fP &date, int *yearNum=0) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthName\fP (int month, int year, bool shortName=false) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthName\fP (const \fBQDate\fP &date, bool shortName=false) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthNamePossessive\fP (int month, int year, bool shortName=false) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthNamePossessive\fP (const \fBQDate\fP &date, bool shortName=false) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBweekDayName\fP (int weekDay, bool shortName=false) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBweekDayName\fP (const \fBQDate\fP &date, bool shortName=false) const =0"
.br
.ti -1c
.RI "virtual int \fBminValidYear\fP () const =0"
.br
.ti -1c
.RI "virtual int \fBmaxValidYear\fP () const =0"
.br
.ti -1c
.RI "virtual int \fBweekDayOfPray\fP () const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBcalendarName\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisLunar\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisLunisolar\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisSolar\fP () const =0"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "const \fBKLocale\fP * \fBlocale\fP () const "
.br
.in -1c
.SH "Detailed Description"
.PP 
CalendarSystem abstract class, default derived kde gregorian class and factory class. 

Provides support for different calendar types for kde calendar widget and related stuff.
.PP
Derived classes must be created through KCalendarFactory class
.PP
\fBAuthor:\fP
.RS 4
Carlos Moro <cfmoro@correo.uniovi.es> 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 42 of file kcalendarsystem.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KCalendarSystem::KCalendarSystem (const \fBKLocale\fP * locale = \fC0\fP)"
.PP
Constructor of abstract calendar class. 
.PP
This will be called by the derived classes.
.PP
\fBParameters:\fP
.RS 4
\fIlocale\fP It will use this locale for translations, 0 means global. 
.RE
.PP

.PP
Definition at line 36 of file kcalendarsystem.cpp.
.SS "KCalendarSystem::~\fBKCalendarSystem\fP ()\fC [virtual]\fP"
.PP
Descructor. 
.PP
Definition at line 42 of file kcalendarsystem.cpp.
.SH "Member Function Documentation"
.PP 
.SS "virtual int KCalendarSystem::year (const \fBQDate\fP & date) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type year for a given gregorian date. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP gregorian date 
.RE
.PP
\fBReturns:\fP
.RS 4
year 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.PP
Referenced by KLocale::formatDate(), KLocale::readDate(), and yearString().
.SS "\fBQString\fP KCalendarSystem::yearString (const \fBQDate\fP & pDate, bool bShort) const\fC [virtual]\fP"
.PP
Converts a date into a year literal. 
.PP
\fBParameters:\fP
.RS 4
\fIpDate\fP The date to convert 
.br
\fIbShort\fP If the short version of should be used 
.RE
.PP
\fBReturns:\fP
.RS 4
The year literal of the date 
.RE
.PP

.PP
Definition at line 77 of file kcalendarsystem.cpp.
.PP
References QString::length(), QString::right(), QString::setNum(), and year().
.SS "int KCalendarSystem::yearStringToInteger (const \fBQString\fP & sNum, int & iLength) const\fC [virtual]\fP"
.PP
Converts a year literal of a part of a string into a integer starting at the beginning of the string. 
.PP
\fBParameters:\fP
.RS 4
\fIsNum\fP The string to parse 
.br
\fIiLength\fP The number of QChars used, and 0 if no valid symbols was found in the string 
.RE
.PP
\fBReturns:\fP
.RS 4
An integer corresponding to the year 
.RE
.PP

.PP
Definition at line 114 of file kcalendarsystem.cpp.
.PP
Referenced by KLocale::readDate().
.SS "virtual int KCalendarSystem::month (const \fBQDate\fP & date) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type month for a given gregorian date. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP gregorian date 
.RE
.PP
\fBReturns:\fP
.RS 4
month number 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.PP
Referenced by KLocale::formatDate(), and monthString().
.SS "\fBQString\fP KCalendarSystem::monthString (const \fBQDate\fP & pDate, bool bShort) const\fC [virtual]\fP"
.PP
Converts a date into a month literal. 
.PP
\fBParameters:\fP
.RS 4
\fIpDate\fP The date to convert 
.br
\fIbShort\fP If the short version of should be used 
.RE
.PP
\fBReturns:\fP
.RS 4
The month literal of the date 
.RE
.PP

.PP
Definition at line 66 of file kcalendarsystem.cpp.
.PP
References QString::length(), month(), QString::prepend(), and QString::setNum().
.SS "int KCalendarSystem::monthStringToInteger (const \fBQString\fP & sNum, int & iLength) const\fC [virtual]\fP"
.PP
Converts a month literal of a part of a string into a integer starting at the beginning of the string. 
.PP
\fBParameters:\fP
.RS 4
\fIsNum\fP The string to parse 
.br
\fIiLength\fP The number of QChars used, and 0 if no valid symbols was found in the string 
.RE
.PP
\fBReturns:\fP
.RS 4
An integer corresponding to the month 
.RE
.PP

.PP
Definition at line 109 of file kcalendarsystem.cpp.
.PP
Referenced by KLocale::readDate().
.SS "virtual int KCalendarSystem::day (const \fBQDate\fP & date) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type day number of month for a given date. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP gregorian date equivalent to the specific one 
.RE
.PP
\fBReturns:\fP
.RS 4
day of the month 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.PP
Referenced by dayString().
.SS "\fBQString\fP KCalendarSystem::dayString (const \fBQDate\fP & pDate, bool bShort) const\fC [virtual]\fP"
.PP
Converts a date into a day literal. 
.PP
\fBParameters:\fP
.RS 4
\fIpDate\fP The date to convert 
.br
\fIbShort\fP If the short version of should be used 
.RE
.PP
\fBReturns:\fP
.RS 4
The day literal of the date 
.RE
.PP

.PP
Definition at line 55 of file kcalendarsystem.cpp.
.PP
References day(), QString::length(), QString::prepend(), and QString::setNum().
.SS "int KCalendarSystem::dayStringToInteger (const \fBQString\fP & sNum, int & iLength) const\fC [virtual]\fP"
.PP
Converts a day literal of a part of a string into a integer starting at the beginning of the string. 
.PP
\fBParameters:\fP
.RS 4
\fIsNum\fP The string to parse 
.br
\fIiLength\fP The number of QChars used, and 0 if no valid symbols was found in the string 
.RE
.PP
\fBReturns:\fP
.RS 4
An integer corresponding to the day 
.RE
.PP

.PP
Definition at line 104 of file kcalendarsystem.cpp.
.PP
Referenced by KLocale::readDate().
.SS "virtual int KCalendarSystem::dayOfWeek (const \fBQDate\fP & date) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type number of day of week number for a given date. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP gregorian date 
.RE
.PP
\fBReturns:\fP
.RS 4
day of week 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::dayOfYear (const \fBQDate\fP & date) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type day number of year for a given date. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP gregorian date equivalent to the specific one 
.RE
.PP
\fBReturns:\fP
.RS 4
day number 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual bool KCalendarSystem::setYMD (\fBQDate\fP & date, int y, int m, int d) const\fC [pure virtual]\fP"
.PP
Changes the date's year, month and day. 
.PP
The range of the year, month and day depends on which calendar is being used.
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP Date to change 
.br
\fIy\fP Year 
.br
\fIm\fP Month number 
.br
\fId\fP Day of month 
.RE
.PP
\fBReturns:\fP
.RS 4
true if the date is valid; otherwise returns false. 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.PP
Referenced by KLocale::readDate().
.SS "virtual \fBQDate\fP KCalendarSystem::addYears (const \fBQDate\fP & date, int nyears) const\fC [pure virtual]\fP"
.PP
Returns a \fBQDate\fP object containing a date nyears later. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP The old date 
.br
\fInyears\fP The number of years to add 
.RE
.PP
\fBReturns:\fP
.RS 4
The new date 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual \fBQDate\fP KCalendarSystem::addMonths (const \fBQDate\fP & date, int nmonths) const\fC [pure virtual]\fP"
.PP
Returns a \fBQDate\fP object containing a date nmonths later. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP The old date 
.br
\fInmonths\fP The number of months to add 
.RE
.PP
\fBReturns:\fP
.RS 4
The new date 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual \fBQDate\fP KCalendarSystem::addDays (const \fBQDate\fP & date, int ndays) const\fC [pure virtual]\fP"
.PP
Returns a \fBQDate\fP object containing a date ndays later. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP The old date 
.br
\fIndays\fP The number of days to add 
.RE
.PP
\fBReturns:\fP
.RS 4
The new date 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::monthsInYear (const \fBQDate\fP & date) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type number of month for a given year. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP The date whose year to use 
.RE
.PP
\fBReturns:\fP
.RS 4
The number of months in that year 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::daysInYear (const \fBQDate\fP & date) const\fC [pure virtual]\fP"
.PP
Gets the number of days in date whose years specified. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP Gregorian date equivalent to the specific one 
.RE
.PP
\fBReturns:\fP
.RS 4
The number of days in year 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::daysInMonth (const \fBQDate\fP & date) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type number of days in month for a given date. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP gregorian date 
.RE
.PP
\fBReturns:\fP
.RS 4
number of days for month in date 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::weeksInYear (int year) const\fC [pure virtual]\fP"
.PP
Gets the number of weeks in a specified year. 
.PP
\fBParameters:\fP
.RS 4
\fIyear\fP the year 
.RE
.PP
\fBReturns:\fP
.RS 4
number of weeks in year 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::weekNumber (const \fBQDate\fP & date, int * yearNum = \fC0\fP) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type week number for a given date. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP gregorian date 
.br
\fIyearNum\fP The year the date belongs to 
.RE
.PP
\fBReturns:\fP
.RS 4
week number 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual \fBQString\fP KCalendarSystem::monthName (int month, int year, bool shortName = \fCfalse\fP) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type month name for a given month number If an invalid month is specified, QString::null is returned. 
.PP
\fBParameters:\fP
.RS 4
\fImonth\fP The month number 
.br
\fIyear\fP The year the month belongs to 
.br
\fIshortName\fP Specifies if the short month name should be used 
.RE
.PP
\fBReturns:\fP
.RS 4
The name of the month 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.PP
Referenced by KLocale::readDate().
.SS "virtual \fBQString\fP KCalendarSystem::monthName (const \fBQDate\fP & date, bool shortName = \fCfalse\fP) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type month name for a given gregorian date. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP Gregorian date 
.br
\fIshortName\fP Specifies if the short month name should be used 
.RE
.PP
\fBReturns:\fP
.RS 4
The name of the month 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual \fBQString\fP KCalendarSystem::monthNamePossessive (int month, int year, bool shortName = \fCfalse\fP) const\fC [pure virtual]\fP"
.PP
Returns a string containing the possessive form of the month name. 
.PP
('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.
.PP
\fBParameters:\fP
.RS 4
\fImonth\fP The month number 
.br
\fIyear\fP The year the month belongs to 
.br
\fIshortName\fP Specifies if the short month name should be used
.RE
.PP
\fBReturns:\fP
.RS 4
The possessive form of the name of the month 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.PP
Referenced by KLocale::readDate().
.SS "virtual \fBQString\fP KCalendarSystem::monthNamePossessive (const \fBQDate\fP & date, bool shortName = \fCfalse\fP) const\fC [pure virtual]\fP"
.PP
Returns a string containing the possessive form of the month name. 
.PP
('of January', 'of February', etc.) It's needed in long format dates in some languages.
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP Gregorian date 
.br
\fIshortName\fP Specifies if the short month name should be used
.RE
.PP
\fBReturns:\fP
.RS 4
The possessive form of the name of the month 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "\fBQString\fP KCalendarSystem::weekDayName (int weekDay, bool shortName = \fCfalse\fP) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type week day name If an invalid week day is specified, QString::null is returned. 
.PP
\fBParameters:\fP
.RS 4
\fIweekDay\fP number of day in week (1 -> Monday) 
.br
\fIshortName\fP short or complete day name 
.RE
.PP
\fBReturns:\fP
.RS 4
day name 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.PP
Definition at line 119 of file kcalendarsystem.cpp.
.PP
References KLocale::translate().
.PP
Referenced by KLocale::readDate(), and KLocale::weekDayName().
.SS "virtual \fBQString\fP KCalendarSystem::weekDayName (const \fBQDate\fP & date, bool shortName = \fCfalse\fP) const\fC [pure virtual]\fP"
.PP
Gets specific calendar type week day name. 
.PP
\fBParameters:\fP
.RS 4
\fIdate\fP the date 
.br
\fIshortName\fP short or complete day name 
.RE
.PP
\fBReturns:\fP
.RS 4
day name 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::minValidYear () const\fC [pure virtual]\fP"
.PP
Gets the first year value supported by specific calendar type algorithms. 
.PP
\fBReturns:\fP
.RS 4
first year supported 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::maxValidYear () const\fC [pure virtual]\fP"
.PP
Gets the maximum year value supported by specific calendar type algorithms (\fBQDate\fP, 8000). 
.PP
\fBReturns:\fP
.RS 4
maximum year supported 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual int KCalendarSystem::weekDayOfPray () const\fC [pure virtual]\fP"
.PP
Gets the day of the week traditionaly associated with pray. 
.PP
\fBReturns:\fP
.RS 4
day number 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual \fBQString\fP KCalendarSystem::calendarName () const\fC [pure virtual]\fP"
.PP
Gets the string representing the calendar. 
.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual bool KCalendarSystem::isLunar () const\fC [pure virtual]\fP"
.PP
Gets if the calendar is lunar based. 
.PP
\fBReturns:\fP
.RS 4
if the calendar is lunar based 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual bool KCalendarSystem::isLunisolar () const\fC [pure virtual]\fP"
.PP
Gets if the calendar is lunisolar based. 
.PP
\fBReturns:\fP
.RS 4
if the calendar is lunisolar based 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.
.SS "virtual bool KCalendarSystem::isSolar () const\fC [pure virtual]\fP"
.PP
Gets if the calendar is solar based. 
.PP
\fBReturns:\fP
.RS 4
if the calendar is solar based 
.RE
.PP

.PP
Implemented in \fBKCalendarSystemJalali\fP.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
