.TH "KCalendarSystemJalali" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KCalendarSystemJalali \- Jalali calendar type implementation.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kcalendarsystemjalali.h>\fP
.PP
Inherits \fBKCalendarSystem\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKCalendarSystemJalali\fP (const \fBKLocale\fP *locale=0)"
.br
.ti -1c
.RI "virtual int \fByear\fP (const \fBQDate\fP &date) const "
.br
.ti -1c
.RI "virtual int \fBmonth\fP (const \fBQDate\fP &date) const "
.br
.ti -1c
.RI "virtual int \fBday\fP (const \fBQDate\fP &date) const "
.br
.ti -1c
.RI "virtual int \fBdayOfWeek\fP (const \fBQDate\fP &date) const "
.br
.ti -1c
.RI "virtual int \fBdayOfYear\fP (const \fBQDate\fP &date) const "
.br
.ti -1c
.RI "virtual bool \fBsetYMD\fP (\fBQDate\fP &date, int y, int m, int d) const "
.br
.ti -1c
.RI "virtual \fBQDate\fP \fBaddYears\fP (const \fBQDate\fP &date, int nyears) const "
.br
.ti -1c
.RI "virtual \fBQDate\fP \fBaddMonths\fP (const \fBQDate\fP &date, int nmonths) const "
.br
.ti -1c
.RI "virtual \fBQDate\fP \fBaddDays\fP (const \fBQDate\fP &date, int ndays) const "
.br
.ti -1c
.RI "virtual int \fBmonthsInYear\fP (const \fBQDate\fP &date) const "
.br
.ti -1c
.RI "virtual int \fBdaysInYear\fP (const \fBQDate\fP &date) const "
.br
.ti -1c
.RI "virtual int \fBdaysInMonth\fP (const \fBQDate\fP &date) const "
.br
.ti -1c
.RI "virtual int \fBweeksInYear\fP (int year) const "
.br
.ti -1c
.RI "virtual int \fBweekNumber\fP (const \fBQDate\fP &date, int *yearNum=0) const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthName\fP (const \fBQDate\fP &date, bool shortName=false) const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthNamePossessive\fP (const \fBQDate\fP &date, bool shortName=false) const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBweekDayName\fP (int weekDay, bool shortName=false) const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBweekDayName\fP (const \fBQDate\fP &date, bool shortName=false) const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthNamePossessive\fP (int month, int year, bool shortName=false) const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBmonthName\fP (int month, int year, bool shortName=false) const "
.br
.ti -1c
.RI "virtual int \fBminValidYear\fP () const "
.br
.ti -1c
.RI "virtual int \fBmaxValidYear\fP () const "
.br
.ti -1c
.RI "virtual int \fBweekDayOfPray\fP () const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBcalendarName\fP () const "
.br
.ti -1c
.RI "virtual bool \fBisLunar\fP () const "
.br
.ti -1c
.RI "virtual bool \fBisLunisolar\fP () const "
.br
.ti -1c
.RI "virtual bool \fBisSolar\fP () const "
.br
.in -1c
.SH "Detailed Description"
.PP 
Jalali calendar type implementation. 
.PP
Definition at line 36 of file kcalendarsystemjalali.h.
.SH "Member Function Documentation"
.PP 
.SS "int KCalendarSystemJalali::year (const \fBQDate\fP & date) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 212 of file kcalendarsystemjalali.cpp.
.PP
References endl().
.PP
Referenced by addMonths(), addYears(), dayOfYear(), minValidYear(), and weekNumber().
.SS "int KCalendarSystemJalali::month (const \fBQDate\fP & date) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 221 of file kcalendarsystemjalali.cpp.
.PP
References endl().
.PP
Referenced by addMonths(), and addYears().
.SS "int KCalendarSystemJalali::day (const \fBQDate\fP & date) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 230 of file kcalendarsystemjalali.cpp.
.PP
References endl().
.PP
Referenced by addMonths(), and addYears().
.SS "int KCalendarSystemJalali::dayOfWeek (const \fBQDate\fP & date) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 239 of file kcalendarsystemjalali.cpp.
.PP
Referenced by weekDayName(), and weekNumber().
.SS "int KCalendarSystemJalali::dayOfYear (const \fBQDate\fP & date) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 247 of file kcalendarsystemjalali.cpp.
.PP
References QDate::daysTo(), setYMD(), and year().
.PP
Referenced by weekNumber().
.SS "bool KCalendarSystemJalali::setYMD (\fBQDate\fP & date, int y, int m, int d) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 256 of file kcalendarsystemjalali.cpp.
.PP
References maxValidYear(), and QDate::setYMD().
.PP
Referenced by addMonths(), addYears(), dayOfYear(), and weekNumber().
.SS "\fBQDate\fP KCalendarSystemJalali::addYears (const \fBQDate\fP & date, int nyears) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 273 of file kcalendarsystemjalali.cpp.
.PP
References day(), month(), setYMD(), and year().
.SS "\fBQDate\fP KCalendarSystemJalali::addMonths (const \fBQDate\fP & date, int nmonths) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 282 of file kcalendarsystemjalali.cpp.
.PP
References day(), month(), setYMD(), and year().
.SS "\fBQDate\fP KCalendarSystemJalali::addDays (const \fBQDate\fP & date, int ndays) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 305 of file kcalendarsystemjalali.cpp.
.PP
References QDate::addDays().
.PP
Referenced by weekNumber().
.SS "int KCalendarSystemJalali::monthsInYear (const \fBQDate\fP & date) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 310 of file kcalendarsystemjalali.cpp.
.SS "int KCalendarSystemJalali::daysInYear (const \fBQDate\fP & date) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 317 of file kcalendarsystemjalali.cpp.
.PP
Referenced by weekNumber().
.SS "int KCalendarSystemJalali::daysInMonth (const \fBQDate\fP & date) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 329 of file kcalendarsystemjalali.cpp.
.SS "int KCalendarSystemJalali::weeksInYear (int year) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 335 of file kcalendarsystemjalali.cpp.
.PP
Referenced by weekNumber().
.SS "int KCalendarSystemJalali::weekNumber (const \fBQDate\fP & date, int * yearNum = \fC0\fP) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 343 of file kcalendarsystemjalali.cpp.
.PP
References addDays(), dayOfWeek(), dayOfYear(), daysInYear(), QDate::daysTo(), setYMD(), weeksInYear(), and year().
.SS "\fBQString\fP KCalendarSystemJalali::monthName (const \fBQDate\fP & date, bool shortName = \fCfalse\fP) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 448 of file kcalendarsystemjalali.cpp.
.PP
Referenced by monthNamePossessive().
.SS "\fBQString\fP KCalendarSystemJalali::monthNamePossessive (const \fBQDate\fP & date, bool shortName = \fCfalse\fP) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 457 of file kcalendarsystemjalali.cpp.
.PP
References monthName().
.SS "\fBQString\fP KCalendarSystemJalali::weekDayName (int weekDay, bool shortName = \fCfalse\fP) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 470 of file kcalendarsystemjalali.cpp.
.PP
References KLocale::translate().
.PP
Referenced by weekDayName().
.SS "\fBQString\fP KCalendarSystemJalali::weekDayName (const \fBQDate\fP & date, bool shortName = \fCfalse\fP) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 512 of file kcalendarsystemjalali.cpp.
.PP
References dayOfWeek(), and weekDayName().
.SS "\fBQString\fP KCalendarSystemJalali::monthNamePossessive (int month, int year, bool shortName = \fCfalse\fP) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 463 of file kcalendarsystemjalali.cpp.
.PP
References monthName().
.SS "\fBQString\fP KCalendarSystemJalali::monthName (int month, int year, bool shortName = \fCfalse\fP) const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 383 of file kcalendarsystemjalali.cpp.
.PP
References KLocale::translate().
.SS "int KCalendarSystemJalali::minValidYear () const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 519 of file kcalendarsystemjalali.cpp.
.PP
References year().
.SS "int KCalendarSystemJalali::maxValidYear () const\fC [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
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 527 of file kcalendarsystemjalali.cpp.
.PP
Referenced by setYMD().
.SS "int KCalendarSystemJalali::weekDayOfPray () const\fC [virtual]\fP"
.PP
Gets the day of the week traditionaly associated with pray. 
.PP
\fBReturns:\fP
.RS 4
day number 
.RE
.PP

.PP
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 538 of file kcalendarsystemjalali.cpp.
.SS "\fBQString\fP KCalendarSystemJalali::calendarName () const\fC [virtual]\fP"
.PP
Gets the string representing the calendar. 
.PP
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 542 of file kcalendarsystemjalali.cpp.
.PP
References QString::fromLatin1().
.SS "bool KCalendarSystemJalali::isLunar () const\fC [virtual]\fP"
.PP
Gets if the calendar is lunar based. 
.PP
\fBReturns:\fP
.RS 4
if the calendar is lunar based 
.RE
.PP

.PP
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 547 of file kcalendarsystemjalali.cpp.
.SS "bool KCalendarSystemJalali::isLunisolar () const\fC [virtual]\fP"
.PP
Gets if the calendar is lunisolar based. 
.PP
\fBReturns:\fP
.RS 4
if the calendar is lunisolar based 
.RE
.PP

.PP
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 552 of file kcalendarsystemjalali.cpp.
.SS "bool KCalendarSystemJalali::isSolar () const\fC [virtual]\fP"
.PP
Gets if the calendar is solar based. 
.PP
\fBReturns:\fP
.RS 4
if the calendar is solar based 
.RE
.PP

.PP
Implements \fBKCalendarSystem\fP.
.PP
Definition at line 557 of file kcalendarsystemjalali.cpp.

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