KCalendarSystemJalali Class Reference

#include <kcalendarsystemjalali_p.h>

Inheritance diagram for KCalendarSystemJalali:

List of all members.

Public Member Functions
	KCalendarSystemJalali (const KLocale *locale=0)
	KCalendarSystemJalali (const KSharedConfig::Ptr config, const KLocale *locale=0)
virtual	~KCalendarSystemJalali ()
virtual QString	calendarType () const
virtual QDate	earliestValidDate () const
virtual QDate	epoch () const
virtual bool	isLeapYear (int year) const
virtual bool	isLeapYear (const QDate &date) const
virtual bool	isLunar () const
virtual bool	isLunisolar () const
virtual bool	isProleptic () const
virtual bool	isSolar () const
virtual bool	isValid (int year, int month, int day) const
virtual bool	isValid (const QDate &date) const
virtual QDate	latestValidDate () const
virtual QString	monthName (int month, int year, MonthNameFormat format=LongName) const
virtual QString	monthName (const QDate &date, MonthNameFormat format=LongName) const
virtual QString	weekDayName (int weekDay, WeekDayNameFormat format=LongDayName) const
virtual QString	weekDayName (const QDate &date, WeekDayNameFormat format=LongDayName) const
virtual int	weekDayOfPray () const
Protected Member Functions
	KCalendarSystemJalali (KCalendarSystemJalaliPrivate &dd, const KSharedConfig::Ptr config=KSharedConfig::Ptr(), const KLocale *locale=0)
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

Jalali calendar type implementation.

---

Constructor & Destructor Documentation

KCalendarSystemJalali::KCalendarSystemJalali

(

const KLocale *

locale = 0

)

[explicit]

Definition at line 402 of file kcalendarsystemjalali.cpp.

KCalendarSystemJalali::KCalendarSystemJalali	(	const KSharedConfig::Ptr	config,
		const KLocale *	locale = 0
	)		[explicit]

Definition at line 408 of file kcalendarsystemjalali.cpp.

KCalendarSystemJalali::~KCalendarSystemJalali

(

)

[virtual]

Definition at line 421 of file kcalendarsystemjalali.cpp.

KCalendarSystemJalali::KCalendarSystemJalali	(	KCalendarSystemJalaliPrivate &	dd,
		const KSharedConfig::Ptr	config = KSharedConfig::Ptr(),
		const KLocale *	locale = 0
	)		[protected]

Definition at line 414 of file kcalendarsystemjalali.cpp.

---

Member Function Documentation

QString KCalendarSystemJalali::calendarType

(

)

const [virtual]

Deprecated:

use calendarSystem() instead

Returns the calendar system type.

Returns:

type of calendar system

Implements KCalendarSystem.

Definition at line 425 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 573 of file kcalendarsystemjalali.cpp.

QDate KCalendarSystemJalali::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 436 of file kcalendarsystemjalali.cpp.

QDate KCalendarSystemJalali::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 430 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 460 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 465 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 495 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 500 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 510 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 505 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 450 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 455 of file kcalendarsystemjalali.cpp.

bool KCalendarSystemJalali::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 515 of file kcalendarsystemjalali.cpp.

QDate KCalendarSystemJalali::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 443 of file kcalendarsystemjalali.cpp.

QString KCalendarSystemJalali::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 470 of file kcalendarsystemjalali.cpp.

QString KCalendarSystemJalali::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 475 of file kcalendarsystemjalali.cpp.

QString KCalendarSystemJalali::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 480 of file kcalendarsystemjalali.cpp.

QString KCalendarSystemJalali::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 485 of file kcalendarsystemjalali.cpp.

int KCalendarSystemJalali::weekDayOfPray

(

)

const [virtual]

Deprecated:

use KLocale::weekDayOfPray() instead

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 490 of file kcalendarsystemjalali.cpp.

---

The documentation for this class was generated from the following files:

• kcalendarsystemjalali_p.h
• kcalendarsystemjalali.cpp