KCal Library
KCal::FreeBusy Class Reference
#include <freebusy.h>

Detailed Description
Provides information about the free/busy time of a calendar.A free/busy is a collection of Periods (
- See also:
- Period).
Definition at line 49 of file freebusy.h.
Public Member Functions | |
FreeBusy () | |
FreeBusy (const Period::List &busyPeriods) | |
FreeBusy (const KDateTime &start, const KDateTime &end) | |
FreeBusy (Calendar *calendar, const KDateTime &start, const KDateTime &end) | |
~FreeBusy () | |
QByteArray | type () const |
virtual void | setDtStart (const KDateTime &start) |
void | setDtEnd (const KDateTime &end) |
virtual KDateTime | dtEnd () const |
virtual void | shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec) |
Period::List | busyPeriods () const |
void | addPeriod (const KDateTime &start, const KDateTime &end) |
void | addPeriod (const KDateTime &start, const Duration &duration) |
void | addPeriods (const Period::List &list) |
void | sortList () |
void | merge (FreeBusy *freebusy) |
Constructor & Destructor Documentation
FreeBusy::FreeBusy | ( | ) |
FreeBusy::FreeBusy | ( | const Period::List & | busyPeriods | ) | [explicit] |
Constructs a free/busy from a list of periods.
- Parameters:
-
busyPeriods is a QList of periods.
Definition at line 165 of file freebusy.cpp.
FreeBusy::FreeBusy | ( | const KDateTime & | start, | |
const KDateTime & | end | |||
) |
Constructs a free/busy from a single period.
- Parameters:
-
start is the start datetime of the period. end is the end datetime of the period.
Definition at line 61 of file freebusy.cpp.
FreeBusy::FreeBusy | ( | Calendar * | calendar, | |
const KDateTime & | start, | |||
const KDateTime & | end | |||
) |
Constructs a freebusy for a specified calendar give a single period.
- Parameters:
-
calendar is a pointer to a valid Calendar object. start is the start datetime of the period. end is the end datetime of the period.
Definition at line 68 of file freebusy.cpp.
FreeBusy::~FreeBusy | ( | ) |
Member Function Documentation
QByteArray FreeBusy::type | ( | ) | const [virtual] |
Prints the type of Incidence as a string.
Implements KCal::IncidenceBase.
Definition at line 176 of file freebusy.cpp.
void FreeBusy::setDtStart | ( | const KDateTime & | start | ) | [virtual] |
Sets the start datetime for the free/busy.
Note that this datetime may be later or earlier than all periods within the free/busy.
- Parameters:
-
start is a KDateTime specifying an start datetime.
- See also:
- IncidenceBase::dtStart(), setDtEnd().
Reimplemented from KCal::IncidenceBase.
Definition at line 181 of file freebusy.cpp.
void FreeBusy::setDtEnd | ( | const KDateTime & | end | ) |
Sets the end datetime for the free/busy.
Note that this datetime may be later or earlier than all periods within the free/busy.
- Parameters:
-
end is a KDateTime specifying an end datetime.
- See also:
- dtEnd(), setDtStart().
Definition at line 187 of file freebusy.cpp.
KDateTime FreeBusy::dtEnd | ( | ) | const [virtual] |
Returns the end datetime for the free/busy.
FIXME: calling addPeriod() does not change mDtEnd. Is that incorrect?
- See also:
- setDtEnd().
Definition at line 192 of file freebusy.cpp.
void FreeBusy::shiftTimes | ( | const KDateTime::Spec & | oldSpec, | |
const KDateTime::Spec & | newSpec | |||
) | [virtual] |
Shift the times of the incidence so that they appear at the same clock time as before but in a new time zone.
The shift is done from a viewing time zone rather than from the actual incidence time zone.
For example, shifting an incidence whose start time is 09:00 America/New York, using an old viewing time zone (oldSpec
) of Europe/London, to a new time zone (newSpec
) of Europe/Paris, will result in the time being shifted from 14:00 (which is the London time of the incidence start) to 14:00 Paris time.
- Parameters:
-
oldSpec the time specification which provides the clock times newSpec the new time specification
Reimplemented from KCal::IncidenceBase.
Definition at line 243 of file freebusy.cpp.
Period::List FreeBusy::busyPeriods | ( | ) | const |
void FreeBusy::addPeriod | ( | const KDateTime & | start, | |
const KDateTime & | end | |||
) |
Adds a period to the freebusy list and sorts the list.
- Parameters:
-
start is the start datetime of the period. end is the end datetime of the period.
Definition at line 214 of file freebusy.cpp.
void FreeBusy::addPeriod | ( | const KDateTime & | start, | |
const Duration & | duration | |||
) |
Adds a period to the freebusy list and sorts the list.
- Parameters:
-
start is the start datetime of the period. duration is the Duration of the period.
Definition at line 220 of file freebusy.cpp.
void FreeBusy::addPeriods | ( | const Period::List & | list | ) |
Adds a list of periods to the freebusy object and then sorts that list.
Use this if you are adding many items, instead of the addPeriod method, to avoid sorting repeatedly.
- Parameters:
-
list is a QList of Period objects.
Definition at line 208 of file freebusy.cpp.
void FreeBusy::sortList | ( | ) |
Sorts the list of free/busy periods into ascending order.
Definition at line 202 of file freebusy.cpp.
void FreeBusy::merge | ( | FreeBusy * | freebusy | ) |
Merges another free/busy into this free/busy.
- Parameters:
-
freebusy is a pointer to a valid FreeBusy object.
Definition at line 226 of file freebusy.cpp.
The documentation for this class was generated from the following files: