#include <freebusy.h>

Public Member Functions | |
FreeBusy () | |
FreeBusy (const FreeBusy &other) | |
FreeBusy (const Period::List &busyPeriods) | |
FreeBusy (const FreeBusyPeriod::List &busyPeriods) | |
FreeBusy (const KDateTime &start, const KDateTime &end) | |
FreeBusy (Calendar *calendar, const KDateTime &start, const KDateTime &end) | |
FreeBusy (const Event::List &events, const KDateTime &start, const KDateTime &end) | |
~FreeBusy () | |
void | addPeriod (const KDateTime &start, const KDateTime &end) |
void | addPeriod (const KDateTime &start, const Duration &duration) |
void | addPeriods (const Period::List &list) |
void | addPeriods (const FreeBusyPeriod::List &list) |
Period::List | busyPeriods () const |
virtual KDateTime | dtEnd () const |
FreeBusyPeriod::List | fullBusyPeriods () const |
void | merge (FreeBusy *freebusy) |
FreeBusy & | operator= (const FreeBusy &other) |
bool | operator== (const FreeBusy &freebusy) const |
void | setDtEnd (const KDateTime &end) |
virtual void | setDtStart (const KDateTime &start) |
virtual void | shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec) |
void | sortList () |
QByteArray | type () const |
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 50 of file freebusy.h.
Constructor & Destructor Documentation
Constructs an free/busy without any periods.
Definition at line 76 of file freebusy.cpp.
FreeBusy::FreeBusy | ( | const FreeBusy & | other | ) |
Copy constructor.
- Parameters:
-
other is the free/busy to copy.
Definition at line 81 of file freebusy.cpp.
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 201 of file freebusy.cpp.
KCal::FreeBusy::FreeBusy | ( | const FreeBusyPeriod::List & | busyPeriods | ) | [explicit] |
Constructs a free/busy from a list of periods.
- Parameters:
-
busyPeriods is a QList of periods.
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 87 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 190 of file freebusy.cpp.
FreeBusy::FreeBusy | ( | const Event::List & | events, |
const KDateTime & | start, | ||
const KDateTime & | end | ||
) |
Constructs a freebusy for a specified list of events given a single period.
- Parameters:
-
events list of events. start is the start datetime of the period. end is the end datetime of the period.
- Since:
- 4.4
Definition at line 94 of file freebusy.cpp.
Destroys a free/busy.
Definition at line 212 of file freebusy.cpp.
Member Function Documentation
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 280 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 286 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 266 of file freebusy.cpp.
void KCal::FreeBusy::addPeriods | ( | const FreeBusyPeriod::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 FreeBusyPeriod objects.
Period::List FreeBusy::busyPeriods | ( | ) | const |
Returns the list of all periods within the free/busy.
Definition at line 244 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 239 of file freebusy.cpp.
Returns the list of all periods within the free/busy.
Definition at line 255 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 292 of file freebusy.cpp.
Assignment operator.
Definition at line 323 of file freebusy.cpp.
bool FreeBusy::operator== | ( | const FreeBusy & | freebusy | ) | const |
Compare this with freebusy
for equality.
- Parameters:
-
freebusy is the FreeBusy to compare.
Definition at line 335 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 234 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 228 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 310 of file freebusy.cpp.
void FreeBusy::sortList | ( | ) |
Sorts the list of free/busy periods into ascending order.
Definition at line 260 of file freebusy.cpp.
QByteArray FreeBusy::type | ( | ) | const [virtual] |
Prints the type of Incidence as a string.
Implements KCal::IncidenceBase.
Definition at line 217 of file freebusy.cpp.
The documentation for this class was generated from the following files: