KHolidays::Holiday Class Reference

#include <holiday.h>

Public Types
enum	DayType { Workday , NonWorkday }
typedef QList< Holiday >	List

Public Member Functions
	Holiday ()
	Holiday (const Holiday &other)
	~Holiday ()
QStringList	categoryList () const
DayType	dayType () const
QString	description () const
int	duration () const
QString	name () const
QDate	observedEndDate () const
QDate	observedStartDate () const
bool	operator< (const Holiday &rhs) const
Holiday &	operator= (const Holiday &other)
bool	operator> (const Holiday &rhs) const

Detailed Description

Represents a holiday event.

Definition at line 29 of file holiday.h.

Member Typedef Documentation

List

QList<Holiday> KHolidays::Holiday::List

A list of holiday descriptions.

Definition at line 40 of file holiday.h.

Member Enumeration Documentation

DayType

enum KHolidays::Holiday::DayType

Describes the date type of the holiday.

If any of the holidays on a date are non-workdays types, then the entire day is non-working.

Enumerator
Workday	The holiday is a workday.
NonWorkday	The holiday is a real holiday.

Definition at line 46 of file holiday.h.

Constructor & Destructor Documentation

Holiday() [1/2]

Holiday::Holiday

(

)

Creates an empty holiday.

Definition at line 19 of file holiday.cpp.

Holiday() [2/2]

Holiday::Holiday

(

const Holiday &

other

)

Creates a holiday from an other holiday.

Definition at line 24 of file holiday.cpp.

~Holiday()

Holiday::~Holiday

(

)

Destroys the holiday object.

Definition at line 29 of file holiday.cpp.

Member Function Documentation

categoryList()

QStringList Holiday::categoryList

(

)

const

Since

5.8

Returns a QStringList of categories for the Holiday. If the Holiday has no categories then an empty list is returned.

Definition at line 82 of file holiday.cpp.

dayType()

Holiday::DayType Holiday::dayType

(

)

const

Returns the day type of the holiday.

Definition at line 77 of file holiday.cpp.

description()

QString Holiday::description

(

)

const

Since

5.0

Returns the description of the Holiday if available

Returns

the description of the Holiday

Definition at line 72 of file holiday.cpp.

duration()

int Holiday::duration

(

)

const

Since

4.6

Returns the duration of the holiday in days.

Definition at line 62 of file holiday.cpp.

name()

QString Holiday::name

(

)

const

Since

5.0

Returns the name of the Holiday.

Returns

the name of the Holiday

Definition at line 67 of file holiday.cpp.

observedEndDate()

QDate Holiday::observedEndDate

(

)

const

Since

4.6

Returns the observed end date of the holiday.

Definition at line 57 of file holiday.cpp.

observedStartDate()

QDate Holiday::observedStartDate

(

)

const

Since

4.6

Returns the observed start date of the holiday.

Definition at line 52 of file holiday.cpp.

operator<()

bool Holiday::operator<

(

const Holiday &

rhs

)

const

Definition at line 42 of file holiday.cpp.

operator=()

Holiday & Holiday::operator=

(

const Holiday &

other

)

Definition at line 33 of file holiday.cpp.

operator>()

bool Holiday::operator>

(

const Holiday &

rhs

)

const

Definition at line 47 of file holiday.cpp.

---

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

• holiday.h
• holiday.cpp