KCalCore Library
#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 | |
virtual IncidenceBase & | assign (const IncidenceBase &other) |
virtual bool | equals (const IncidenceBase &freebusy) const |
virtual void | virtual_hook (int id, void *data) |
![]() | |
IncidenceBase (const IncidenceBase &ib) | |
virtual void | customPropertyUpdate () |
virtual void | customPropertyUpdated () |
void | setFieldDirty (IncidenceBase::Field field) |
Additional Inherited Members | |
![]() | |
enum | VirtualHook { SerializerHook , DeserializerHook } |
![]() | |
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 52 of file freebusy.h.
Member Typedef Documentation
◆ List
List of FreeBusy objects.
Definition at line 69 of file freebusy.h.
◆ Ptr
A shared pointer to a FreeBusy object.
Definition at line 64 of file freebusy.h.
Constructor & Destructor Documentation
◆ FreeBusy() [1/6]
FreeBusy::FreeBusy | ( | ) |
Constructs an free/busy without any periods.
Definition at line 78 of file freebusy.cpp.
◆ FreeBusy() [2/6]
Copy constructor.
- Parameters
-
other is the free/busy to copy.
Definition at line 83 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 191 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 197 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 89 of file freebusy.cpp.
◆ FreeBusy() [6/6]
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 96 of file freebusy.cpp.
◆ ~FreeBusy()
FreeBusy::~FreeBusy | ( | ) |
Destroys a free/busy.
Definition at line 202 of file freebusy.cpp.
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 275 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 269 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 263 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 255 of file freebusy.cpp.
◆ assign()
|
protectedvirtual |
Reimplemented from KCalCore::IncidenceBase.
Definition at line 312 of file freebusy.cpp.
◆ busyPeriods()
Period::List FreeBusy::busyPeriods | ( | ) | const |
Returns the list of all periods within the free/busy.
Definition at line 233 of file freebusy.cpp.
◆ dateTime()
|
virtual |
Implements KCalCore::IncidenceBase.
Definition at line 340 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 228 of file freebusy.cpp.
◆ equals()
|
protectedvirtual |
Compare this with freebusy
for equality.
- Parameters
-
freebusy is the FreeBusy to compare.
Reimplemented from KCalCore::IncidenceBase.
Definition at line 322 of file freebusy.cpp.
◆ freeBusyMimeType()
|
static |
Returns the Akonadi specific sub MIME type of a KCalCore::FreeBusy.
Definition at line 402 of file freebusy.cpp.
◆ fullBusyPeriods()
FreeBusyPeriod::List FreeBusy::fullBusyPeriods | ( | ) | const |
Returns the list of all periods within the free/busy.
Definition at line 244 of file freebusy.cpp.
◆ merge()
void FreeBusy::merge | ( | FreeBusy::Ptr | freebusy | ) |
Merges another free/busy into this free/busy.
- Parameters
-
freebusy is a pointer to a valid FreeBusy object.
Definition at line 281 of file freebusy.cpp.
◆ mimeType()
|
virtual |
Implements KCalCore::IncidenceBase.
Definition at line 397 of file freebusy.cpp.
◆ setDateTime()
|
virtual |
Implements KCalCore::IncidenceBase.
Definition at line 347 of file freebusy.cpp.
◆ setDtEnd()
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 223 of file freebusy.cpp.
◆ setDtStart()
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 KDateTime specifying an start datetime.
- See also
- IncidenceBase::dtStart(), setDtEnd().
Reimplemented from KCalCore::IncidenceBase.
Definition at line 217 of file freebusy.cpp.
◆ shiftTimes()
|
virtual |
Reimplemented from KCalCore::IncidenceBase.
Definition at line 299 of file freebusy.cpp.
◆ sortList()
void FreeBusy::sortList | ( | ) |
Sorts the list of free/busy periods into ascending order.
Definition at line 249 of file freebusy.cpp.
◆ type()
|
virtual |
Implements KCalCore::IncidenceBase.
Definition at line 207 of file freebusy.cpp.
◆ typeStr()
|
virtual |
Implements KCalCore::IncidenceBase.
Definition at line 212 of file freebusy.cpp.
◆ virtual_hook()
Implements KCalCore::IncidenceBase.
Definition at line 353 of file freebusy.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.