KCalendarCore - KCalendarCore::FreeBusy Class Reference

View on LXR

#include <freebusy.h>

Inheritance diagram for KCalendarCore::FreeBusy:

Public Types
typedef QVector< Ptr >	List

typedef QSharedPointer< FreeBusy >	Ptr

Public Types inherited from KCalendarCore::IncidenceBase
enum	DateTimeRole { RoleAlarmStartOffset = 0, RoleAlarmEndOffset, RoleSort, RoleCalendarHashing, RoleStartTimeZone, RoleEndTimeZone, RoleEndRecurrenceBase, RoleEnd, RoleDisplayEnd, RoleAlarm, RoleRecurrenceStart, RoleDisplayStart, RoleDnD }

enum	Field { FieldDtStart, FieldDtEnd, FieldLastModified, FieldDescription, FieldSummary, FieldLocation, FieldCompleted, FieldPercentComplete, FieldDtDue, FieldCategories, FieldRelatedTo, FieldRecurrence, FieldAttachment, FieldSecrecy, FieldStatus, FieldTransparency, FieldResources, FieldPriority, FieldGeoLatitude, FieldGeoLongitude, FieldRecurrenceId, FieldAlarms, FieldSchedulingId, FieldAttendees, FieldOrganizer, FieldCreated, FieldRevision, FieldDuration, FieldContact, FieldComment, FieldUid, FieldUnknown, FieldUrl }

enum	IncidenceType { TypeEvent = 0, TypeTodo, TypeJournal, TypeFreeBusy, TypeUnknown }

typedef QSharedPointer< IncidenceBase >	Ptr

Public Member Functions
	FreeBusy ()

	FreeBusy (const FreeBusy &other)

	FreeBusy (const Period::List &busyPeriods)

	FreeBusy (const FreeBusyPeriod::List &busyPeriods)

	FreeBusy (const QDateTime &start, const QDateTime &end)

	FreeBusy (const Event::List &events, const QDateTime &start, const QDateTime &end)

	~FreeBusy () override

void	addPeriod (const QDateTime &start, const QDateTime &end)

void	addPeriod (const QDateTime &start, const Duration &duration)

void	addPeriods (const Period::List &list)

void	addPeriods (const FreeBusyPeriod::List &list)

Period::List	busyPeriods () const

QDateTime	dateTime (DateTimeRole role) const override

virtual QDateTime	dtEnd () const

FreeBusyPeriod::List	fullBusyPeriods () const

void	merge (const FreeBusy::Ptr &freebusy)

QLatin1String	mimeType () const override

void	setDateTime (const QDateTime &dateTime, DateTimeRole role) override

void	setDtEnd (const QDateTime &end)

void	setDtStart (const QDateTime &start) override

void	shiftTimes (const QTimeZone &oldZone, const QTimeZone &newZone) override

void	sortList ()

IncidenceType	type () const override

QByteArray	typeStr () const override

Public Member Functions inherited from KCalendarCore::IncidenceBase
	IncidenceBase ()

	~IncidenceBase () override

void	addAttendee (const Attendee &attendee, bool doUpdate=true)

void	addComment (const QString &comment)

void	addContact (const QString &contact)

bool	allDay () const

Attendee	attendeeByMail (const QString &email) const

Attendee	attendeeByMails (const QStringList &emails, const QString &email=QString()) const

Attendee	attendeeByUid (const QString &uid) const

int	attendeeCount () const

Attendee::List	attendees () const

void	clearAttendees ()

void	clearComments ()

void	clearContacts ()

QStringList	comments () const

QStringList	contacts () const

QSet< IncidenceBase::Field >	dirtyFields () const

virtual QDateTime	dtStart () const

Duration	duration () const

void	endUpdates ()

bool	hasDuration () const

bool	isReadOnly () const

QDateTime	lastModified () const

bool	operator!= (const IncidenceBase &ib) const

IncidenceBase &	operator= (const IncidenceBase &other)

bool	operator== (const IncidenceBase &ib) const

Person	organizer () const

virtual QDateTime	recurrenceId () const

void	registerObserver (IncidenceObserver *observer)

bool	removeComment (const QString &comment)

bool	removeContact (const QString &contact)

void	resetDirtyFields ()

virtual void	setAllDay (bool allDay)

void	setAttendees (const Attendee::List &attendees, bool doUpdate=true)

void	setDirtyFields (const QSet< IncidenceBase::Field > &)

virtual void	setDuration (const Duration &duration)

void	setHasDuration (bool hasDuration)

virtual void	setLastModified (const QDateTime &lm)

void	setOrganizer (const Person &organizer)

void	setOrganizer (const QString &organizer)

virtual void	setReadOnly (bool readOnly)

void	setUid (const QString &uid)

void	setUrl (const QUrl &url)

void	startUpdates ()

QString	uid () const

void	unRegisterObserver (IncidenceObserver *observer)

void	update ()

void	updated ()

QUrl	uri () const

QUrl	url () const

Public Member Functions inherited from KCalendarCore::CustomProperties
	CustomProperties ()

	CustomProperties (const CustomProperties &other)

virtual	~CustomProperties ()

QMap< QByteArray, QString >	customProperties () const

QString	customProperty (const QByteArray &app, const QByteArray &key) const

QString	nonKDECustomProperty (const QByteArray &name) const

QString	nonKDECustomPropertyParameters (const QByteArray &name) const

CustomProperties &	operator= (const CustomProperties &other)

bool	operator== (const CustomProperties &properties) const

void	removeCustomProperty (const QByteArray &app, const QByteArray &key)

void	removeNonKDECustomProperty (const QByteArray &name)

void	setCustomProperties (const QMap< QByteArray, QString > &properties)

void	setCustomProperty (const QByteArray &app, const QByteArray &key, const QString &value)

void	setNonKDECustomProperty (const QByteArray &name, const QString &value, const QString &parameters=QString())

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 &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
Properties inherited from KCalendarCore::IncidenceBase
bool	allDay

QVariantList	attendees

QDateTime	dtStart

QDateTime	lastModified

KCalendarCore::Person	organizer

QString	uid

Protected Types inherited from KCalendarCore::IncidenceBase
enum	VirtualHook

Protected Attributes inherited from KCalendarCore::IncidenceBase
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 53 of file freebusy.h.

Member Typedef Documentation

typedef QVector<Ptr> KCalendarCore::FreeBusy::List

List of FreeBusy objects.

Definition at line 70 of file freebusy.h.

typedef QSharedPointer<FreeBusy> KCalendarCore::FreeBusy::Ptr

A shared pointer to a FreeBusy object.

Definition at line 65 of file freebusy.h.

Constructor & Destructor Documentation

FreeBusy::FreeBusy ( )

Constructs an free/busy without any periods.

Definition at line 79 of file freebusy.cpp.

FreeBusy::FreeBusy ( const FreeBusy & other )

Copy constructor.

Parameters

other is the free/busy to copy.

Definition at line 84 of file freebusy.cpp.

FreeBusy::FreeBusy ( const Period::List & busyPeriods )

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::FreeBusy ( const FreeBusyPeriod::List & busyPeriods )

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::FreeBusy	(	const QDateTime &	start,
		const QDateTime &	end
	)

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 90 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 97 of file freebusy.cpp.

FreeBusy::~FreeBusy ( )

override

Destroys a free/busy.

Definition at line 202 of file freebusy.cpp.

Member Function Documentation

void FreeBusy::addPeriod	(	const QDateTime &	start,
		const QDateTime &	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 270 of file freebusy.cpp.

void FreeBusy::addPeriod	(	const QDateTime &	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 276 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 255 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 264 of file freebusy.cpp.

IncidenceBase & FreeBusy::assign ( const IncidenceBase & other )

overrideprotectedvirtual

IncidenceBase::assign()

Reimplemented from KCalendarCore::IncidenceBase.

Definition at line 313 of file freebusy.cpp.

Period::List FreeBusy::busyPeriods ( ) const

Returns the list of all periods within the free/busy.

Definition at line 233 of file freebusy.cpp.

QDateTime FreeBusy::dateTime ( DateTimeRole role ) const

overridevirtual

IncidenceBase::dateTime()

Implements KCalendarCore::IncidenceBase.

Definition at line 341 of file freebusy.cpp.

QDateTime 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 228 of file freebusy.cpp.

bool FreeBusy::equals ( const IncidenceBase & freebusy ) const

overrideprotectedvirtual

Compare this with freebusy for equality.

Parameters

freebusy is the FreeBusy to compare.

Reimplemented from KCalendarCore::IncidenceBase.

Definition at line 323 of file freebusy.cpp.

QLatin1String KCalendarCore::FreeBusy::freeBusyMimeType ( )

static

Returns the Akonadi specific sub MIME type of a KCalendarCore::FreeBusy.

Definition at line 403 of file freebusy.cpp.

FreeBusyPeriod::List FreeBusy::fullBusyPeriods ( ) const

Returns the list of all periods within the free/busy.

Definition at line 245 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 282 of file freebusy.cpp.

QLatin1String FreeBusy::mimeType ( ) const

overridevirtual

IncidenceBase::mimeType()

Implements KCalendarCore::IncidenceBase.

Definition at line 398 of file freebusy.cpp.

void FreeBusy::setDateTime	(	const QDateTime &	dateTime,
		DateTimeRole	role
	)

overridevirtual

IncidenceBase::setDateTime()

Implements KCalendarCore::IncidenceBase.

Definition at line 348 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 223 of file freebusy.cpp.

void FreeBusy::setDtStart ( const QDateTime & start )

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 217 of file freebusy.cpp.

void FreeBusy::shiftTimes	(	const QTimeZone &	oldZone,
		const QTimeZone &	newZone
	)

overridevirtual

IncidenceBase::shiftTimes()

Reimplemented from KCalendarCore::IncidenceBase.

Definition at line 301 of file freebusy.cpp.

void FreeBusy::sortList ( )

Sorts the list of free/busy periods into ascending order.

Definition at line 250 of file freebusy.cpp.

IncidenceBase::IncidenceType FreeBusy::type ( ) const

overridevirtual

IncidenceBase::type()

Implements KCalendarCore::IncidenceBase.

Definition at line 207 of file freebusy.cpp.

QByteArray FreeBusy::typeStr ( ) const

overridevirtual

IncidenceBase::typeStr()

Implements KCalendarCore::IncidenceBase.

Definition at line 212 of file freebusy.cpp.

void FreeBusy::virtual_hook	(	VirtualHook	id,
		void *	data
	)

overrideprotectedvirtual

IncidenceBase::virtual_hook()

Implements KCalendarCore::IncidenceBase.

Definition at line 354 of file freebusy.cpp.

Friends And Related Function Documentation

KCALENDARCORE_EXPORT QDataStream& operator<<	(	QDataStream &	s,
		const KCalendarCore::FreeBusy::Ptr &	freebusy
	)

friend

Serializes the freebusy object into the stream.

KCALENDARCORE_EXPORT QDataStream& operator>>	(	QDataStream &	s,
		KCalendarCore::FreeBusy::Ptr &	freebusy
	)

friend

Initializes the freebusy object from the stream.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

KCalendarCore::FreeBusy

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation