KCalendarCore::FreeBusy
#include <freebusy.h>

Static Public Member Functions | |
static QLatin1String | freeBusyMimeType () |
![]() | |
static quint32 | magicSerializationIdentifier () |
![]() | |
static QByteArray | customPropertyName (const QByteArray &app, const QByteArray &key) |
Protected Member Functions | |
IncidenceBase & | assign (const IncidenceBase &other) override |
bool | equals (const IncidenceBase &freebusy) const override |
void | virtual_hook (VirtualHook id, void *data) override |
![]() | |
IncidenceBase (const IncidenceBase &ib) | |
void | customPropertyUpdate () override |
void | customPropertyUpdated () override |
virtual void | deserialize (QDataStream &in) |
virtual void | serialize (QDataStream &out) const |
void | setFieldDirty (IncidenceBase::Field field) |
Friends | |
KCALENDARCORE_EXPORT QDataStream & | operator<< (QDataStream &s, const KCalendarCore::FreeBusy::Ptr &freebusy) |
KCALENDARCORE_EXPORT QDataStream & | operator>> (QDataStream &s, KCalendarCore::FreeBusy::Ptr &freebusy) |
Additional Inherited Members | |
![]() | |
bool | allDay |
QVariantList | attendees |
QDateTime | dtStart |
QDateTime | lastModified |
KCalendarCore::Person | organizer |
QString | uid |
![]() | |
enum | VirtualHook |
![]() | |
bool | mReadOnly |
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 40 of file freebusy.h.
Member Typedef Documentation
typedef QVector<Ptr> KCalendarCore::FreeBusy::List |
List of FreeBusy objects.
Definition at line 57 of file freebusy.h.
A shared pointer to a FreeBusy object.
Definition at line 52 of file freebusy.h.
Constructor & Destructor Documentation
FreeBusy::FreeBusy | ( | ) |
Constructs an free/busy without any periods.
Definition at line 66 of file freebusy.cpp.
FreeBusy::FreeBusy | ( | const FreeBusy & | other | ) |
Copy constructor.
- Parameters
-
other is the free/busy to copy.
Definition at line 71 of file freebusy.cpp.
|
explicit |
Constructs a free/busy from a list of periods.
- Parameters
-
busyPeriods is a list of periods.
Definition at line 178 of file freebusy.cpp.
|
explicit |
Constructs a free/busy from a list of periods.
- Parameters
-
busyPeriods is a list of periods.
Definition at line 184 of file freebusy.cpp.
Constructs a free/busy from a single period.
- Parameters
-
start is the start date/time of the period. end is the end date/time of the period.
Definition at line 77 of file freebusy.cpp.
FreeBusy::FreeBusy | ( | const Event::List & | events, |
const QDateTime & | start, | ||
const QDateTime & | end | ||
) |
Constructs a freebusy for a specified list of events given a single period.
- Parameters
-
events list of events. start is the start date/time of the period. end is the end date/time of the period.
Definition at line 84 of file freebusy.cpp.
|
override |
Destroys a free/busy.
Definition at line 189 of file freebusy.cpp.
Member Function Documentation
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 257 of file freebusy.cpp.
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 263 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 list of Period objects.
Definition at line 242 of file freebusy.cpp.
void 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 list of FreeBusyPeriod objects.
Definition at line 251 of file freebusy.cpp.
|
overrideprotectedvirtual |
Reimplemented from KCalendarCore::IncidenceBase.
Definition at line 300 of file freebusy.cpp.
Period::List FreeBusy::busyPeriods | ( | ) | const |
Returns the list of all periods within the free/busy.
Definition at line 220 of file freebusy.cpp.
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 328 of file freebusy.cpp.
|
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 215 of file freebusy.cpp.
|
overrideprotectedvirtual |
Compare this with freebusy
for equality.
- Parameters
-
freebusy is the FreeBusy to compare.
Reimplemented from KCalendarCore::IncidenceBase.
Definition at line 310 of file freebusy.cpp.
|
static |
Returns the Akonadi specific sub MIME type of a KCalendarCore::FreeBusy.
Definition at line 390 of file freebusy.cpp.
FreeBusyPeriod::List FreeBusy::fullBusyPeriods | ( | ) | const |
Returns the list of all periods within the free/busy.
Definition at line 232 of file freebusy.cpp.
void FreeBusy::merge | ( | const FreeBusy::Ptr & | freebusy | ) |
Merges another free/busy into this free/busy.
- Parameters
-
freebusy is a pointer to a valid FreeBusy object.
Definition at line 269 of file freebusy.cpp.
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 385 of file freebusy.cpp.
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 335 of file freebusy.cpp.
void FreeBusy::setDtEnd | ( | const QDateTime & | 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 QDateTime specifying an end datetime.
- See also
- dtEnd(), setDtStart().
Definition at line 210 of file freebusy.cpp.
|
overridevirtual |
Sets the start date/time for the free/busy.
Note that this date/time may be later or earlier than all periods within the free/busy.
- Parameters
-
start is a QDateTime specifying an start datetime.
- See also
- IncidenceBase::dtStart(), setDtEnd().
Reimplemented from KCalendarCore::IncidenceBase.
Definition at line 204 of file freebusy.cpp.
Reimplemented from KCalendarCore::IncidenceBase.
Definition at line 288 of file freebusy.cpp.
void FreeBusy::sortList | ( | ) |
Sorts the list of free/busy periods into ascending order.
Definition at line 237 of file freebusy.cpp.
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 194 of file freebusy.cpp.
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 199 of file freebusy.cpp.
|
overrideprotectedvirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 341 of file freebusy.cpp.
Friends And Related Function Documentation
|
friend |
Serializes the freebusy
object into the stream
.
|
friend |
Initializes the freebusy
object from the stream
.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Jan 21 2021 22:53:13 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.