KCalendarCore::FreeBusy
#include <freebusy.h>
Static Public Member Functions | |
static QLatin1String | freeBusyMimeType () |
Static Public Member Functions inherited from KCalendarCore::IncidenceBase | |
static quint32 | magicSerializationIdentifier () |
Static Public Member Functions inherited from KCalendarCore::CustomProperties | |
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 |
Protected Member Functions inherited from KCalendarCore::IncidenceBase | |
IncidenceBase (const IncidenceBase &)=delete | |
KCALENDARCORE_NO_EXPORT | IncidenceBase (const IncidenceBase &ib, IncidenceBasePrivate *p) |
void | customPropertyUpdate () override |
void | customPropertyUpdated () override |
virtual void | deserialize (QDataStream &in) |
virtual void | serialize (QDataStream &out) const |
void | setFieldDirty (IncidenceBase::Field field) |
Protected Member Functions inherited from KCalendarCore::CustomProperties |
Additional Inherited Members | |
Properties inherited from KCalendarCore::IncidenceBase | |
bool | allDay |
QList< KCalendarCore::Attendee > | attendees |
QDateTime | dtStart |
QDateTime | lastModified |
KCalendarCore::Person | organizer |
QString | uid |
QUrl | url |
Protected Types inherited from KCalendarCore::IncidenceBase | |
enum | VirtualHook |
Protected Attributes inherited from KCalendarCore::IncidenceBase | |
IncidenceBasePrivate *const | d_ptr |
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 42 of file freebusy.h.
Member Typedef Documentation
◆ List
List of FreeBusy objects.
Definition at line 56 of file freebusy.h.
◆ Ptr
A shared pointer to a FreeBusy object.
Definition at line 51 of file freebusy.h.
Constructor & Destructor Documentation
◆ FreeBusy() [1/6]
FreeBusy::FreeBusy | ( | ) |
Constructs an free/busy without any periods.
Definition at line 67 of file freebusy.cpp.
◆ FreeBusy() [2/6]
FreeBusy::FreeBusy | ( | const FreeBusy & | other | ) |
Copy constructor.
- Parameters
-
other is the free/busy to copy.
Definition at line 72 of file freebusy.cpp.
◆ FreeBusy() [3/6]
|
explicit |
Constructs a free/busy from a list of periods.
- Parameters
-
busyPeriods is a list of periods.
Definition at line 175 of file freebusy.cpp.
◆ FreeBusy() [4/6]
|
explicit |
Constructs a free/busy from a list of periods.
- Parameters
-
busyPeriods is a list of periods.
Definition at line 181 of file freebusy.cpp.
◆ FreeBusy() [5/6]
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() [6/6]
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.
◆ ~FreeBusy()
|
overridedefault |
Destroys a free/busy.
Member Function Documentation
◆ addPeriod() [1/2]
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 267 of file freebusy.cpp.
◆ addPeriod() [2/2]
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 260 of file freebusy.cpp.
◆ addPeriods() [1/2]
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 253 of file freebusy.cpp.
◆ addPeriods() [2/2]
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 243 of file freebusy.cpp.
◆ assign()
|
overrideprotectedvirtual |
Reimplemented from KCalendarCore::IncidenceBase.
Definition at line 309 of file freebusy.cpp.
◆ busyPeriods()
Period::List FreeBusy::busyPeriods | ( | ) | const |
Returns the list of all periods within the free/busy.
Definition at line 218 of file freebusy.cpp.
◆ dateTime()
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 337 of file freebusy.cpp.
◆ dtEnd()
|
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 212 of file freebusy.cpp.
◆ equals()
|
overrideprotectedvirtual |
Compare this with freebusy
for equality.
- Parameters
-
freebusy is the FreeBusy to compare.
Reimplemented from KCalendarCore::IncidenceBase.
Definition at line 320 of file freebusy.cpp.
◆ freeBusyMimeType()
|
static |
Returns the Akonadi specific sub MIME type of a KCalendarCore::FreeBusy.
Definition at line 394 of file freebusy.cpp.
◆ fullBusyPeriods()
FreeBusyPeriod::List FreeBusy::fullBusyPeriods | ( | ) | const |
Returns the list of all periods within the free/busy.
Definition at line 231 of file freebusy.cpp.
◆ merge()
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 274 of file freebusy.cpp.
◆ mimeType()
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 389 of file freebusy.cpp.
◆ setDateTime()
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 344 of file freebusy.cpp.
◆ setDtEnd()
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 203 of file freebusy.cpp.
◆ setDtStart()
|
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 198 of file freebusy.cpp.
◆ shiftTimes()
Reimplemented from KCalendarCore::IncidenceBase.
Definition at line 293 of file freebusy.cpp.
◆ sortList()
void FreeBusy::sortList | ( | ) |
Sorts the list of free/busy periods into ascending order.
Definition at line 237 of file freebusy.cpp.
◆ type()
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 188 of file freebusy.cpp.
◆ typeStr()
|
overridevirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 193 of file freebusy.cpp.
◆ virtual_hook()
|
overrideprotectedvirtual |
Implements KCalendarCore::IncidenceBase.
Definition at line 350 of file freebusy.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 4 2024 12:01:42 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.