KCalendarCore::Calendar

#include <calendar.h>

Inheritance diagram for KCalendarCore::Calendar:

[legend]

Classes
class	CalendarObserver

Public Types
typedef QSharedPointer< Calendar >	Ptr

Properties
KCalendarCore::AccessMode	accessMode

QIcon	icon

QString	id

bool	isLoading

QString	name

KCalendarCore::Person	owner

QString	productId

Properties inherited from QObject
	objectName

Signals
void	accessModeChanged ()

void	filterChanged ()

void	iconChanged ()

void	idChanged ()

void	isLoadingChanged ()

void	nameChanged ()

void	ownerChanged ()

Public Member Functions
	Calendar (const QByteArray &timeZoneId)

	Calendar (const QTimeZone &timeZone)

	~Calendar () override

AccessMode	accessMode () const

virtual bool	addEvent (const Event::Ptr &event)=0

virtual bool	addIncidence (const Incidence::Ptr &incidence)

virtual bool	addJournal (const Journal::Ptr &journal)=0

bool	addNotebook (const QString &notebook, bool isVisible)

virtual bool	addTodo (const Todo::Ptr &todo)=0

virtual Alarm::List	alarms (const QDateTime &from, const QDateTime &to, bool excludeBlockedAlarms=false) const =0

Alarm::List	alarmsTo (const QDateTime &to) const

bool	batchAdding () const

virtual bool	beginChange (const Incidence::Ptr &incidence)

QStringList	categories () const

virtual void	clearNotebookAssociations ()

virtual void	close ()=0

QString	defaultNotebook () const

Incidence::Ptr	deleted (const QString &uid, const QDateTime &recurrenceId={}) const

virtual Event::Ptr	deletedEvent (const QString &uid, const QDateTime &recurrenceId={}) const =0

virtual Event::List	deletedEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual Journal::Ptr	deletedJournal (const QString &uid, const QDateTime &recurrenceId={}) const =0

virtual Journal::List	deletedJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual Todo::Ptr	deletedTodo (const QString &uid, const QDateTime &recurrenceId={}) const =0

virtual Todo::List	deletedTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual bool	deleteEvent (const Event::Ptr &event)=0

virtual bool	deleteEventInstances (const Event::Ptr &event)=0

virtual bool	deleteIncidence (const Incidence::Ptr &incidence)

virtual bool	deleteIncidenceInstances (const Incidence::Ptr &incidence)=0

virtual bool	deleteJournal (const Journal::Ptr &journal)=0

virtual bool	deleteJournalInstances (const Journal::Ptr &journal)=0

bool	deleteNotebook (const QString &notebook)

virtual bool	deleteTodo (const Todo::Ptr &todo)=0

virtual bool	deleteTodoInstances (const Todo::Ptr &todo)=0

virtual Incidence::List	duplicates (const Incidence::Ptr &incidence)

virtual void	endBatchAdding ()

virtual bool	endChange (const Incidence::Ptr &incidence)

virtual Event::Ptr	event (const QString &uid, const QDateTime &recurrenceId={}) const =0

virtual bool	event (QEvent *e)

virtual Event::List	eventInstances (const Incidence::Ptr &event, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

Event::List	events (const QDate &date, const QTimeZone &timeZone={}, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const

Event::List	events (const QDate &start, const QDate &end, const QTimeZone &timeZone={}, bool inclusive=false) const

Event::List	events (const QDateTime &dt) const

virtual Event::List	events (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const

CalFilter *	filter () const

bool	hasValidNotebook (const QString &notebook) const

QIcon	icon () const

QString	id () const

Incidence::Ptr	incidence (const QString &uid, const QDateTime &recurrenceId={}) const

virtual Incidence::Ptr	incidenceFromSchedulingID (const QString &sid) const

virtual Incidence::List	incidences () const

virtual Incidence::List	incidences (const QDate &date) const

virtual Incidence::List	incidences (const QString &notebook) const

virtual Incidence::List	incidencesFromSchedulingID (const QString &sid) const

virtual Incidence::List	instances (const Incidence::Ptr &incidence) const

bool	isAncestorOf (const Incidence::Ptr &ancestor, const Incidence::Ptr &incidence) const

bool	isLoading () const

bool	isModified () const

virtual bool	isSaving () const

bool	isVisible (const Incidence::Ptr &incidence) const

bool	isVisible (const QString &notebook) const

virtual Journal::Ptr	journal (const QString &uid, const QDateTime &recurrenceId={}) const =0

virtual Journal::List	journalInstances (const Incidence::Ptr &journal, JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual Journal::List	journals (const QDate &date) const

virtual Journal::List	journals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const

QString	name () const

virtual QString	notebook (const Incidence::Ptr &incidence) const

virtual QString	notebook (const QString &uid) const

virtual QStringList	notebooks () const

Person	owner () const

QString	productId () const

virtual Event::List	rawEvents (const QDate &start, const QDate &end, const QTimeZone &timeZone={}, bool inclusive=false) const =0

virtual Event::List	rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual Event::List	rawEventsForDate (const QDate &date, const QTimeZone &timeZone={}, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual Event::List	rawEventsForDate (const QDateTime &dt) const =0

virtual Incidence::List	rawIncidences () const

virtual Journal::List	rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual Journal::List	rawJournalsForDate (const QDate &date) const =0

virtual Todo::List	rawTodos (const QDate &start, const QDate &end, const QTimeZone &timeZone={}, bool inclusive=false) const =0

virtual Todo::List	rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual Todo::List	rawTodosForDate (const QDate &date) const =0

void	registerObserver (CalendarObserver *observer)

Incidence::List	relations (const QString &uid) const

virtual bool	reload ()

virtual void	removeRelations (const Incidence::Ptr &incidence)

virtual bool	save ()

void	setAccessMode (const AccessMode mode)

bool	setDefaultNotebook (const QString &notebook)

void	setFilter (CalFilter *filter)

void	setIcon (const QIcon &icon)

void	setId (const QString &id)

void	setModified (bool modified)

void	setName (const QString &name)

virtual bool	setNotebook (const Incidence::Ptr &incidence, const QString &notebook)

void	setOwner (const Person &owner)

void	setProductId (const QString &id)

void	setTimeZone (const QTimeZone &timeZone)

void	setTimeZoneId (const QByteArray &timeZoneId)

virtual void	setupRelations (const Incidence::Ptr &incidence)

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

virtual void	startBatchAdding ()

QTimeZone	timeZone () const

QByteArray	timeZoneId () const

virtual Todo::Ptr	todo (const QString &uid, const QDateTime &recurrenceId={}) const =0

virtual Todo::List	todoInstances (const Incidence::Ptr &todo, TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0

virtual Todo::List	todos (const QDate &date) const

virtual Todo::List	todos (const QDate &start, const QDate &end, const QTimeZone &timeZone={}, bool inclusive=false) const

virtual Todo::List	todos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const

void	unregisterObserver (CalendarObserver *observer)

bool	updateNotebook (const QString &notebook, bool isVisible)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const 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())

Public Member Functions inherited from KCalendarCore::IncidenceBase::IncidenceObserver
virtual	~IncidenceObserver ()

virtual void	incidenceUpdate (const QString &uid, const QDateTime &recurrenceId)=0

Static Public Member Functions
static Incidence::Ptr	createException (const Incidence::Ptr &incidence, const QDateTime &recurrenceId, bool thisAndFuture=false)

static Incidence::List	mergeIncidenceList (const Event::List &events, const Todo::List &todos, const Journal::List &journals)

static Event::List	sortEvents (const Event::List &eventList, EventSortField sortField, SortDirection sortDirection)

static Event::List	sortEvents (Event::List &&eventList, EventSortField sortField, SortDirection sortDirection)

static Journal::List	sortJournals (const Journal::List &journalList, JournalSortField sortField, SortDirection sortDirection)

static Journal::List	sortJournals (Journal::List &&journalList, JournalSortField sortField, SortDirection sortDirection)

static Todo::List	sortTodos (const Todo::List &todoList, TodoSortField sortField, SortDirection sortDirection)

static Todo::List	sortTodos (Todo::List &&todoList, TodoSortField sortField, SortDirection sortDirection)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from KCalendarCore::CustomProperties
static QByteArray	customPropertyName (const QByteArray &app, const QByteArray &key)

Protected Member Functions
void	appendAlarms (Alarm::List &alarms, const Incidence::Ptr &incidence, const QDateTime &from, const QDateTime &to) const

void	appendRecurringAlarms (Alarm::List &alarms, const Incidence::Ptr &incidence, const QDateTime &from, const QDateTime &to) const

void	customPropertyUpdated () override

bool	deletionTracking () const

virtual void	doSetTimeZone (const QTimeZone &timeZone)

void	incidenceUpdated (const QString &uid, const QDateTime &recurrenceId) override

void	notifyIncidenceAboutToBeDeleted (const Incidence::Ptr &incidence)

void	notifyIncidenceAdded (const Incidence::Ptr &incidence)

void	notifyIncidenceAdditionCanceled (const Incidence::Ptr &incidence)

void	notifyIncidenceChanged (const Incidence::Ptr &incidence)

void	notifyIncidenceDeleted (const Incidence::Ptr &incidence)

void	setDeletionTracking (bool enable)

void	setIsLoading (bool isLoading)

void	setObserversEnabled (bool enabled)

virtual void	virtual_hook (int id, void *data)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from KCalendarCore::CustomProperties
virtual void	customPropertyUpdate ()

Additional Inherited Members
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

Represents the main calendar class.

A calendar contains information like incidences (events, to-dos, journals), alarms, time zones, and other useful information.

This is an abstract base class defining the interface to a calendar. It is implemented by subclasses like MemoryCalendar, which use different methods to store and access the data.

Ownership of Incidences:

Incidence ownership is handled by the following policy: as soon as an incidence (or any other subclass of IncidenceBase) is added to the Calendar by an add...() method it is owned by the Calendar object. The Calendar takes care of deleting the incidence using the delete...() methods. All Incidences returned by the query functions are returned as pointers so that changes to the returned Incidences are immediately visible in the Calendar. Do Not attempt to 'delete' any Incidence object you get from Calendar – use the delete...() methods.

Definition at line 132 of file calendar.h.

Member Typedef Documentation

◆ Ptr

typedef QSharedPointer<Calendar> KCalendarCore::Calendar::Ptr

A shared pointer to a Calendar.

Definition at line 147 of file calendar.h.

Constructor & Destructor Documentation

◆ Calendar() [1/2]

Calendar::Calendar ( const QTimeZone & timeZone )

explicit

Constructs a calendar with a specified time zone timeZone.

The time zone is used as the default for creating or modifying incidences in the Calendar. The time zone does not alter existing incidences.

Parameters

timeZone time specification

Definition at line 143 of file calendar.cpp.

◆ Calendar() [2/2]

Calendar::Calendar ( const QByteArray & timeZoneId )

explicit

Construct Calendar object using a time zone ID.

The time zone ID is used as the default for creating or modifying incidences in the Calendar. The time zone does not alter existing incidences.

Parameters

timeZoneId is a string containing a time zone ID, which is assumed to be valid. If no time zone is found, the viewing time specification is set to local time zone. Example: "Europe/Berlin"

Definition at line 153 of file calendar.cpp.

◆ ~Calendar()

Calendar::~Calendar ( )

override

Destroys the calendar.

Definition at line 159 of file calendar.cpp.

Member Function Documentation

◆ accessMode()

AccessMode KCalendarCore::Calendar::accessMode ( ) const

This calendar's AccessMode, i.e.

whether it is writable or read-only. Defaults to ReadWrite.

Since: 5.85

See also: setAccessMode()

◆ accessModeChanged

void KCalendarCore::Calendar::accessModeChanged ( )

signal

Emitted when the AccessMode changes.

Since: 5.85

See also: accessMode()

◆ addEvent()

virtual bool KCalendarCore::Calendar::addEvent ( const Event::Ptr & event )

pure virtual

Inserts an Event into the calendar.

Parameters

event is a pointer to the Event to insert.

Returns: true if the Event was successfully inserted; false otherwise.

See also: deleteEvent()

Implemented in Akonadi::CalendarBase, and KCalendarCore::MemoryCalendar.

◆ addIncidence()

bool Calendar::addIncidence ( const Incidence::Ptr & incidence )

virtual

Inserts an Incidence into the calendar.

Parameters

incidence is a pointer to the Incidence to insert.

Returns: true if the Incidence was successfully inserted; false otherwise.

See also: deleteIncidence()

Reimplemented in Akonadi::CalendarBase, and KCalendarCore::MemoryCalendar.

Definition at line 553 of file calendar.cpp.

◆ addJournal()

virtual bool KCalendarCore::Calendar::addJournal ( const Journal::Ptr & journal )

pure virtual

Inserts a Journal into the calendar.

Parameters

journal is a pointer to the Journal to insert.

Returns: true if the Journal was successfully inserted; false otherwise.

See also: deleteJournal()

Implemented in Akonadi::CalendarBase, and KCalendarCore::MemoryCalendar.

◆ addNotebook()

bool Calendar::addNotebook	(	const QString &	notebook,
		bool	isVisible
	)

Add notebook information into calendar.

Is usually called by storages only.

Parameters

notebook	notebook uid
isVisible	notebook visibility

Returns: true if operation succeeded

See also: isVisible()

Definition at line 325 of file calendar.cpp.

◆ addTodo()

virtual bool KCalendarCore::Calendar::addTodo ( const Todo::Ptr & todo )

pure virtual

Inserts a Todo into the calendar.

Parameters

todo	is a pointer to the Todo to insert.

Returns: true if the Todo was successfully inserted; false otherwise.

See also: deleteTodo()

Implemented in KCalendarCore::MemoryCalendar, and Akonadi::CalendarBase.

◆ alarms()

virtual Alarm::List KCalendarCore::Calendar::alarms	(	const QDateTime &	from,
		const QDateTime &	to,
		bool	excludeBlockedAlarms = `false`
	)		const

pure virtual

Returns a list of Alarms within a time range for this Calendar.

Parameters

from	is the starting timestamp.
to	is the ending timestamp.
excludeBlockedAlarms	if true, alarms belonging to blocked collections aren't returned.

Returns: the list of Alarms for the for the specified time range.

Implemented in KCalendarCore::MemoryCalendar, and Akonadi::ETMCalendar.

◆ alarmsTo()

Alarm::List Calendar::alarmsTo ( const QDateTime & to ) const

Return a list of Alarms that occur before the specified timestamp.

Parameters

to	is the ending timestamp.

Returns: the list of Alarms occurring before the specified QDateTime.

Since: 5.77

Definition at line 1343 of file calendar.cpp.

◆ appendAlarms()

void Calendar::appendAlarms	(	Alarm::List &	alarms,
		const Incidence::Ptr &	incidence,
		const QDateTime &	from,
		const QDateTime &	to
	)		const

protected

Appends alarms of incidence in interval to list of alarms.

Parameters

alarms	is a List of Alarms to be appended onto.
incidence	is a pointer to an Incidence containing the Alarm to be appended.
from	is the lower range of the next Alarm repetition.
to	is the upper range of the next Alarm repetition.

Definition at line 1203 of file calendar.cpp.

◆ appendRecurringAlarms()

void Calendar::appendRecurringAlarms	(	Alarm::List &	alarms,
		const Incidence::Ptr &	incidence,
		const QDateTime &	from,
		const QDateTime &	to
	)		const

protected

Appends alarms of recurring events in interval to list of alarms.

Parameters

alarms	is a List of Alarms to be appended onto.
incidence	is a pointer to an Incidence containing the Alarm to be appended.
from	is the lower range of the next Alarm repetition.
to	is the upper range of the next Alarm repetition.

Definition at line 1219 of file calendar.cpp.

◆ batchAdding()

bool Calendar::batchAdding ( ) const

Returns: true if batch adding is in progress

Definition at line 1328 of file calendar.cpp.

◆ beginChange()

bool Calendar::beginChange ( const Incidence::Ptr & incidence )

virtual

Flag that a change to a Calendar Incidence is starting.

Parameters

incidence is a pointer to the Incidence that will be changing.

Definition at line 1186 of file calendar.cpp.

◆ categories()

QStringList Calendar::categories ( ) const

Returns a list of all categories used by Incidences in this Calendar.

Returns: a QStringList containing all the categories.

Definition at line 257 of file calendar.cpp.

◆ clearNotebookAssociations()

void Calendar::clearNotebookAssociations ( )

virtual

Clears notebook associations from hash-tables for incidences.

Called when in-memory content of the calendar is cleared.

Definition at line 404 of file calendar.cpp.

◆ close()

virtual void KCalendarCore::Calendar::close ( )

pure virtual

Clears out the current calendar, freeing all used memory etc.

Implemented in KCalendarCore::MemoryCalendar.

◆ createException()

Incidence::Ptr Calendar::createException	(	const Incidence::Ptr &	incidence,
		const QDateTime &	recurrenceId,
		bool	thisAndFuture = `false`
	)

static

Creates an exception for an occurrence from a recurring Incidence.

The returned exception is not automatically inserted into the calendar.

Parameters

incidence	is a pointer to a recurring Incidence.
recurrenceId	specifies the specific occurrence for which the exception applies.
thisAndFuture	specifies if the exception applies only this specific occcurrence or also to all future occurrences.

Returns: a pointer to a new exception incidence with

Parameters

recurrenceId set.

Since: 4.11

Definition at line 579 of file calendar.cpp.

◆ customPropertyUpdated()

void Calendar::customPropertyUpdated ( )

overrideprotectedvirtual

CustomProperties::customPropertyUpdated()

Reimplemented from KCalendarCore::CustomProperties.

Definition at line 1148 of file calendar.cpp.

◆ defaultNotebook()

QString Calendar::defaultNotebook ( ) const

Get uid of default notebook.

Returns: notebook uid

Definition at line 371 of file calendar.cpp.

◆ deleted()

Incidence::Ptr Calendar::deleted	(	const QString &	uid,
		const QDateTime &	recurrenceId = `{}`
	)		const

Returns the deleted Incidence associated with the given unique identifier.

Parameters

uid	is a unique identifier string.
recurrenceId	is possible recurrenceid of incidence, default is null

Returns: a pointer to the Incidence. A null pointer is returned if no such Incidence exists.

Definition at line 630 of file calendar.cpp.

◆ deletedEvent()

virtual Event::Ptr KCalendarCore::Calendar::deletedEvent	(	const QString &	uid,
		const QDateTime &	recurrenceId = `{}`
	)		const

pure virtual

Returns the deleted Event associated with the given unique identifier.

Parameters

uid	is a unique identifier string.
recurrenceId	is possible recurrenceId of event, default is null

Returns: a pointer to the deleted Event. A null pointer is returned if no such deleted Event exists, or if deletion tracking is disabled.

See also: deletionTracking()

Implemented in KCalendarCore::MemoryCalendar.

◆ deletedEvents()

virtual Event::List KCalendarCore::Calendar::deletedEvents	(	EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all deleted Events for this Calendar.

Parameters

sortField	specifies the EventSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered deleted Events sorted as specified. An empty list is returned if deletion tracking is disabled.

See also: deletionTracking()

Implemented in KCalendarCore::MemoryCalendar.

◆ deletedJournal()

virtual Journal::Ptr KCalendarCore::Calendar::deletedJournal	(	const QString &	uid,
		const QDateTime &	recurrenceId = `{}`
	)		const

pure virtual

Returns the deleted Journal associated with the given unique identifier.

Parameters

uid	is a unique identifier string.
recurrenceId	is possible recurrenceId of journal, default is null

Returns: a pointer to the deleted Journal. A null pointer is returned if no such deleted Journal exists or if deletion tracking is disabled.

See also: deletionTracking()

Implemented in KCalendarCore::MemoryCalendar.

◆ deletedJournals()

virtual Journal::List KCalendarCore::Calendar::deletedJournals	(	JournalSortField	sortField = `JournalSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all deleted Journals for this Calendar.

Parameters

sortField	specifies the JournalSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered deleted Journals sorted as specified. An empty list is returned if deletion tracking is disabled.

See also: deletionTracking()

Implemented in KCalendarCore::MemoryCalendar.

◆ deletedTodo()

virtual Todo::Ptr KCalendarCore::Calendar::deletedTodo	(	const QString &	uid,
		const QDateTime &	recurrenceId = `{}`
	)		const

pure virtual

Returns the deleted Todo associated with the given unique identifier.

Parameters

uid	is a unique identifier string.
recurrenceId	is possible recurrenceId of todo, default is null

Returns: a pointer to the deleted Todo. A null pointer is returned if no such deleted Todo exists or if deletion tracking is disabled.

See also: deletionTracking()

Implemented in KCalendarCore::MemoryCalendar.

◆ deletedTodos()

virtual Todo::List KCalendarCore::Calendar::deletedTodos	(	TodoSortField	sortField = `TodoSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all deleted Todos for this Calendar.

Parameters

sortField	specifies the TodoSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered deleted Todos sorted as specified. An empty list is returned if deletion tracking is disabled.

See also: deletionTracking()

Implemented in KCalendarCore::MemoryCalendar.

◆ deleteEvent()

virtual bool KCalendarCore::Calendar::deleteEvent ( const Event::Ptr & event )

pure virtual

Removes an Event from the calendar.

Parameters

event is a pointer to the Event to remove.

Returns: true if the Event was successfully remove; false otherwise.

See also: addEvent()

Implemented in Akonadi::CalendarBase, and KCalendarCore::MemoryCalendar.

◆ deleteEventInstances()

virtual bool KCalendarCore::Calendar::deleteEventInstances ( const Event::Ptr & event )

pure virtual

Delete all events that are instances of recurring event event.

Parameters

event is a pointer to a deleted Event

Returns: true if delete was successful; false otherwise

Implemented in KCalendarCore::MemoryCalendar.

◆ deleteIncidence()

bool Calendar::deleteIncidence ( const Incidence::Ptr & incidence )

virtual

Removes an Incidence from the calendar.

Parameters

incidence is a pointer to the Incidence to remove.

Returns: true if the Incidence was successfully removed; false otherwise.

See also: addIncidence()

Reimplemented in Akonadi::CalendarBase, and KCalendarCore::MemoryCalendar.

Definition at line 563 of file calendar.cpp.

◆ deleteIncidenceInstances()

virtual bool KCalendarCore::Calendar::deleteIncidenceInstances ( const Incidence::Ptr & incidence )

pure virtual

Delete all incidences that are instances of recurring incidence incidence.

Parameters

incidence is a pointer to a deleted Incidence

Returns: true if delete was successful; false otherwise

Implemented in KCalendarCore::MemoryCalendar.

◆ deleteJournal()

virtual bool KCalendarCore::Calendar::deleteJournal ( const Journal::Ptr & journal )

pure virtual

Removes a Journal from the calendar.

Parameters

journal is a pointer to the Journal to remove.

Returns: true if the Journal was successfully removed; false otherwise.

See also: addJournal()

Implemented in Akonadi::CalendarBase, and KCalendarCore::MemoryCalendar.

◆ deleteJournalInstances()

virtual bool KCalendarCore::Calendar::deleteJournalInstances ( const Journal::Ptr & journal )

pure virtual

Delete all journals that are instances of recurring journal journal.

Parameters

journal is a pointer to a deleted Journal

Returns: true if delete was successful; false otherwise

Implemented in KCalendarCore::MemoryCalendar.

◆ deleteNotebook()

bool Calendar::deleteNotebook ( const QString & notebook )

Delete notebook information from calendar.

Is usually called by storages only.

Parameters

notebook notebook uid

Returns: true if operation succeeded

See also: isVisible()

Definition at line 352 of file calendar.cpp.

◆ deleteTodo()

virtual bool KCalendarCore::Calendar::deleteTodo ( const Todo::Ptr & todo )

pure virtual

Removes a Todo from the calendar.

Parameters

todo	is a pointer to the Todo to remove.

Returns: true if the Todo was successfully removed; false otherwise.

See also: addTodo()

Implemented in KCalendarCore::MemoryCalendar, and Akonadi::CalendarBase.

◆ deleteTodoInstances()

virtual bool KCalendarCore::Calendar::deleteTodoInstances ( const Todo::Ptr & todo )

pure virtual

Delete all to-dos that are instances of recurring to-do todo.

Parameters

todo	is a pointer to a deleted Todo

Returns: true if delete was successful; false otherwise

Implemented in KCalendarCore::MemoryCalendar.

◆ deletionTracking()

bool Calendar::deletionTracking ( ) const

protected

Returns if deletion tracking is enabled.

Default is true.

Since: 4.11

Definition at line 1338 of file calendar.cpp.

◆ doSetTimeZone()

void Calendar::doSetTimeZone ( const QTimeZone & timeZone )

protectedvirtual

Let Calendar subclasses set the time specification.

Parameters

timeZone is the time specification (time zone, etc.) for viewing Incidence dates.

Reimplemented in KCalendarCore::MemoryCalendar.

Definition at line 1059 of file calendar.cpp.

◆ duplicates()

Incidence::List Calendar::duplicates ( const Incidence::Ptr & incidence )

virtual

List all possible duplicate incidences.

Parameters

incidence is the incidence to check.

Returns: a list of duplicate incidences.

Definition at line 310 of file calendar.cpp.

◆ endBatchAdding()

void Calendar::endBatchAdding ( )

virtual

Tells the Calendar that you stopped adding a batch of incidences.

See also: startBatchAdding()

Reimplemented in Akonadi::CalendarBase.

Definition at line 1323 of file calendar.cpp.

◆ endChange()

bool Calendar::endChange ( const Incidence::Ptr & incidence )

virtual

Flag that a change to a Calendar Incidence has completed.

Parameters

incidence is a pointer to the Incidence that was changed.

Definition at line 1192 of file calendar.cpp.

◆ event()

virtual Event::Ptr KCalendarCore::Calendar::event	(	const QString &	uid,
		const QDateTime &	recurrenceId = `{}`
	)		const

pure virtual

Returns the Event associated with the given unique identifier.

Parameters

uid	is a unique identifier string.
recurrenceId	is possible recurrenceId of event, default is null

Returns: a pointer to the Event. A null pointer is returned if no such Event exists.

Implemented in KCalendarCore::MemoryCalendar.

◆ eventInstances()

virtual Event::List KCalendarCore::Calendar::eventInstances	(	const Incidence::Ptr &	event,
		EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all possible instances for this recurring Event.

Parameters

event	event to check for. Caller guarantees it's of type Event.
sortField	specifies the EventSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered event instances sorted as specified.

Implemented in KCalendarCore::MemoryCalendar.

◆ events() [1/4]

Event::List Calendar::events	(	const QDate &	date,
		const QTimeZone &	timeZone = `{}`,
		EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

Returns a sorted, filtered list of all Events which occur on the given date.

The Events are sorted according to sortField and sortDirection.

Parameters

date	request filtered Event list for this QDate only.
timeZone	time zone to interpret `start` and `end`, or the calendar's default time zone if none is specified
sortField	specifies the EventSortField.
sortDirection	specifies the SortDirection.

Returns: the list of sorted, filtered Events occurring on date.

Definition at line 525 of file calendar.cpp.

◆ events() [2/4]

Event::List Calendar::events	(	const QDate &	start,
		const QDate &	end,
		const QTimeZone &	timeZone = `{}`,
		bool	inclusive = `false`
	)		const

Returns a filtered list of all Events occurring within a date range.

Parameters

start	is the starting date.
end	is the ending date.
timeZone	time zone to interpret `start` and `end`, or the calendar's default time zone if none is specified
inclusive	if true only Events which are completely included within the date range are returned.

Returns: the list of filtered Events occurring within the specified date range.

Definition at line 539 of file calendar.cpp.

◆ events() [3/4]

Event::List Calendar::events ( const QDateTime & dt ) const

Returns a filtered list of all Events which occur on the given timestamp.

Parameters

dt	request filtered Event list for this QDateTime only.

Returns: the list of filtered Events occurring on the specified timestamp.

Definition at line 532 of file calendar.cpp.

◆ events() [4/4]

Event::List Calendar::events	(	EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

virtual

Returns a sorted, filtered list of all Events for this Calendar.

Parameters

sortField	specifies the EventSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all filtered Events sorted as specified.

Definition at line 546 of file calendar.cpp.

◆ filter()

CalFilter * Calendar::filter ( ) const

Returns the calendar filter.

Returns: a pointer to the calendar CalFilter. A null pointer is returned if no such CalFilter exists.

See also: setFilter()

Definition at line 252 of file calendar.cpp.

◆ filterChanged

void KCalendarCore::Calendar::filterChanged ( )

signal

Emitted when setFilter() is called.

Since: 4.11

◆ hasValidNotebook()

bool Calendar::hasValidNotebook ( const QString & notebook ) const

Check if calendar knows about the given notebook.

This means that it will be saved by one of the attached storages.

Parameters

notebook notebook uid

Returns: true if calendar has valid notebook

Definition at line 376 of file calendar.cpp.

◆ icon()

QIcon KCalendarCore::Calendar::icon ( ) const

This calendar's icon.

Since: 5.85

See also: setIconName()

◆ iconChanged

void KCalendarCore::Calendar::iconChanged ( )

signal

Emitted when the icon name changes.

Since: 5.85

See also: icon()

◆ id()

QString KCalendarCore::Calendar::id ( ) const

A unique identifier for this calendar.

Since: 5.85

See also: setId()

◆ idChanged

void KCalendarCore::Calendar::idChanged ( )

signal

Emitted when the id changes.

Since: 5.85

See also: id()

◆ incidence()

Incidence::Ptr Calendar::incidence	(	const QString &	uid,
		const QDateTime &	recurrenceId = `{}`
	)		const

Returns the Incidence associated with the given unique identifier.

Parameters

uid	is a unique identifier string.
recurrenceId	is possible recurrenceid of incidence, default is null

Returns: a pointer to the Incidence. A null pointer is returned if no such Incidence exists.

Definition at line 614 of file calendar.cpp.

◆ incidenceFromSchedulingID()

Incidence::Ptr Calendar::incidenceFromSchedulingID ( const QString & sid ) const

virtual

Returns the Incidence associated with the given scheduling identifier.

Parameters

sid	is a unique scheduling identifier string.

Returns: a pointer to the Incidence. A null pointer is returned if no such Incidence exists.

Definition at line 656 of file calendar.cpp.

◆ incidences() [1/3]

Incidence::List Calendar::incidences ( ) const

virtual

Returns a filtered list of all Incidences for this Calendar.

Returns: the list of all filtered Incidences.

Definition at line 280 of file calendar.cpp.

◆ incidences() [2/3]

Incidence::List Calendar::incidences ( const QDate & date ) const

virtual

Returns a filtered list of all Incidences which occur on the given date.

Parameters

date	request filtered Incidence list for this QDate only.

Returns: the list of filtered Incidences occurring on the specified date.

Definition at line 275 of file calendar.cpp.

◆ incidences() [3/3]

Incidence::List Calendar::incidences ( const QString & notebook ) const

virtual

List all notebook incidences in the memory.

Parameters

notebook is the notebook uid.

Returns: a list of incidences for the notebook.

Definition at line 473 of file calendar.cpp.

◆ incidencesFromSchedulingID()

Incidence::List Calendar::incidencesFromSchedulingID ( const QString & sid ) const

virtual

Searches all events and todos for an incidence with this scheduling identifier.

Returns a list of matching results.

Parameters

sid	is a unique scheduling identifier string.

Definition at line 646 of file calendar.cpp.

◆ incidenceUpdated()

void Calendar::incidenceUpdated	(	const QString &	uid,
		const QDateTime &	recurrenceId
	)

overrideprotectedvirtual

The Observer interface.

So far not implemented.

Parameters

uid	is the UID for the Incidence that has been updated.
recurrenceId	is possible recurrenceid of incidence.

Implements KCalendarCore::IncidenceBase::IncidenceObserver.

Reimplemented in KCalendarCore::MemoryCalendar.

Definition at line 1041 of file calendar.cpp.

◆ instances()

Incidence::List Calendar::instances ( const Incidence::Ptr & incidence ) const

virtual

Returns an unfiltered list of all exceptions of this recurring incidence.

Parameters

incidence incidence to check

Returns: the list of all unfiltered exceptions.

Definition at line 290 of file calendar.cpp.

◆ isAncestorOf()

bool Calendar::isAncestorOf	(	const Incidence::Ptr &	ancestor,
		const Incidence::Ptr &	incidence
	)		const

Checks if ancestor is an ancestor of incidence.

Parameters

ancestor	is the incidence we are testing to be an ancestor.
incidence	is the incidence we are testing to be descended from `ancestor`.

Definition at line 936 of file calendar.cpp.

◆ isLoading()

bool KCalendarCore::Calendar::isLoading ( ) const

Returns true if the calendar is still loading its data and thus read access will not return complete (or even any) results.

Since: 5.96

◆ isLoadingChanged

void KCalendarCore::Calendar::isLoadingChanged ( )

signal

Emitted when the loading state changed.

Since: 5.96

See also: isLoading()

◆ isModified()

bool Calendar::isModified ( ) const

Determine the calendar's modification status.

Returns: true if the calendar has been modified since open or last save.

See also: setModified()

Definition at line 1026 of file calendar.cpp.

◆ isSaving()

bool Calendar::isSaving ( ) const

virtual

Determine if the calendar is currently being saved.

Returns: true if the calendar is currently being saved; false otherwise.

Definition at line 1010 of file calendar.cpp.

◆ isVisible() [1/2]

bool Calendar::isVisible ( const Incidence::Ptr & incidence ) const

Check if incidence is visible.

Parameters

incidence is a pointer to the Incidence to check for visibility.

Returns: true if incidence is visible, false otherwise

Definition at line 381 of file calendar.cpp.

◆ isVisible() [2/2]

bool Calendar::isVisible ( const QString & notebook ) const

Check if notebook is visible.

Parameters

notebook notebook uid.

Returns: true if notebook is visible, false otherwise

Definition at line 398 of file calendar.cpp.

◆ journal()

virtual Journal::Ptr KCalendarCore::Calendar::journal	(	const QString &	uid,
		const QDateTime &	recurrenceId = `{}`
	)		const

pure virtual

Returns the Journal associated with the given unique identifier.

Parameters

uid	is a unique identifier string.
recurrenceId	is possible recurrenceId of journal, default is null

Returns: a pointer to the Journal. A null pointer is returned if no such Journal exists.

Implemented in KCalendarCore::MemoryCalendar.

◆ journalInstances()

virtual Journal::List KCalendarCore::Calendar::journalInstances	(	const Incidence::Ptr &	journal,
		JournalSortField	sortField = `JournalSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all instances for this recurring Journal.

Parameters

journal	journal to check for. Caller guarantees it's of type Journal.
sortField	specifies the JournalSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered journal instances sorted as specified.

Implemented in KCalendarCore::MemoryCalendar.

◆ journals() [1/2]

Journal::List Calendar::journals ( const QDate & date ) const

virtual

Returns a filtered list of all Journals for on the specified date.

Parameters

date	request filtered Journals for this QDate only.

Returns: the list of filtered Journals for the specified date.

Definition at line 806 of file calendar.cpp.

◆ journals() [2/2]

Journal::List Calendar::journals	(	JournalSortField	sortField = `JournalSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

virtual

Returns a sorted, filtered list of all Journals for this Calendar.

Parameters

sortField	specifies the JournalSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all filtered Journals sorted as specified.

Definition at line 799 of file calendar.cpp.

◆ mergeIncidenceList()

Incidence::List Calendar::mergeIncidenceList	(	const Event::List &	events,
		const Todo::List &	todos,
		const Journal::List &	journals
	)

static

Create a merged list of Events, Todos, and Journals.

static

Parameters

events	is an Event list to merge.
todos	is a Todo list to merge.
journals	is a Journal list to merge.

Returns: a list of merged Incidences.

Definition at line 1164 of file calendar.cpp.

◆ name()

QString KCalendarCore::Calendar::name ( ) const

The user-visible name for this calendar.

Since: 5.85

See also: setName()

◆ nameChanged

void KCalendarCore::Calendar::nameChanged ( )

signal

Emitted when the name changes.

Since: 5.85

See also: name()

◆ notebook() [1/2]

QString Calendar::notebook ( const Incidence::Ptr & incidence ) const

virtual

Get incidence's notebook.

Parameters

incidence incidence

Returns: notebook uid

Definition at line 454 of file calendar.cpp.

◆ notebook() [2/2]

QString Calendar::notebook ( const QString & uid ) const

virtual

Get incidence's notebook.

Parameters

uid	is a unique identifier string

Returns: notebook uid

Definition at line 463 of file calendar.cpp.

◆ notebooks()

QStringList Calendar::notebooks ( ) const

virtual

List all uids of notebooks currently in the memory.

Returns: list of uids of notebooks

Definition at line 468 of file calendar.cpp.

◆ notifyIncidenceAboutToBeDeleted()

void Calendar::notifyIncidenceAboutToBeDeleted ( const Incidence::Ptr & incidence )

protected

Let Calendar subclasses notify that they will remove an Incidence.

Parameters

incidence is a pointer to the Incidence object that will be removed.

Definition at line 1103 of file calendar.cpp.

◆ notifyIncidenceAdded()

void Calendar::notifyIncidenceAdded ( const Incidence::Ptr & incidence )

protected

Let Calendar subclasses notify that they inserted an Incidence.

Parameters

incidence is a pointer to the Incidence object that was inserted.

Definition at line 1064 of file calendar.cpp.

◆ notifyIncidenceAdditionCanceled()

void Calendar::notifyIncidenceAdditionCanceled ( const Incidence::Ptr & incidence )

protected

Let Calendar subclasses notify that they canceled addition of an Incidence.

Parameters

incidence is a pointer to the Incidence object that addition as canceled.

Definition at line 1133 of file calendar.cpp.

◆ notifyIncidenceChanged()

void Calendar::notifyIncidenceChanged ( const Incidence::Ptr & incidence )

protected

Let Calendar subclasses notify that they modified an Incidence.

Parameters

incidence is a pointer to the Incidence object that was modified.

Definition at line 1088 of file calendar.cpp.

◆ notifyIncidenceDeleted()

void Calendar::notifyIncidenceDeleted ( const Incidence::Ptr & incidence )

protected

Let Calendar subclasses notify that they removed an Incidence.

Parameters

incidence is a pointer to the Incidence object that has been removed.

Definition at line 1118 of file calendar.cpp.

◆ owner()

Person KCalendarCore::Calendar::owner ( ) const

Returns the owner of the calendar.

Returns: the owner Person object.

See also: setOwner()

◆ ownerChanged

void KCalendarCore::Calendar::ownerChanged ( )

signal

Emitted when the owner changes.

Since: 5.85

See also: owner()

◆ productId()

QString KCalendarCore::Calendar::productId ( ) const

Returns the calendar's Product ID.

See also: setProductId()

◆ rawEvents() [1/2]

virtual Event::List KCalendarCore::Calendar::rawEvents	(	const QDate &	start,
		const QDate &	end,
		const QTimeZone &	timeZone = `{}`,
		bool	inclusive = `false`
	)		const

pure virtual

Returns an unfiltered list of all Events occurring within a date range.

Parameters

start	is the starting date
end	is the ending date
timeZone	time zone to interpret `start` and `end`, or the calendar's default time zone if none is specified
inclusive	if true only Events which are completely included within the date range are returned.

Returns: the list of unfiltered Events occurring within the specified date range.

Implemented in KCalendarCore::MemoryCalendar.

◆ rawEvents() [2/2]

virtual Event::List KCalendarCore::Calendar::rawEvents	(	EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all Events for this Calendar.

Parameters

sortField	specifies the EventSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered Events sorted as specified.

Implemented in KCalendarCore::MemoryCalendar.

◆ rawEventsForDate() [1/2]

virtual Event::List KCalendarCore::Calendar::rawEventsForDate	(	const QDate &	date,
		const QTimeZone &	timeZone = `{}`,
		EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all Events which occur on the given date.

The Events are sorted according to sortField and sortDirection.

Parameters

date	request unfiltered Event list for this QDate only
timeZone	time zone to interpret `date`, or the calendar's default time zone if none is specified
sortField	specifies the EventSortField
sortDirection	specifies the SortDirection

Returns: the list of sorted, unfiltered Events occurring on date

Implemented in KCalendarCore::MemoryCalendar.

◆ rawEventsForDate() [2/2]

virtual Event::List KCalendarCore::Calendar::rawEventsForDate ( const QDateTime & dt ) const

pure virtual

Returns an unfiltered list of all Events which occur on the given timestamp.

Parameters

dt	request unfiltered Event list for this QDateTime only.

Returns: the list of unfiltered Events occurring on the specified timestamp.

Deprecated:: since 5.95 use rawEventsForDate(dt.date(), dt.timeZone()) overload instead.

Implemented in KCalendarCore::MemoryCalendar.

◆ rawIncidences()

Incidence::List Calendar::rawIncidences ( ) const

virtual

Returns an unfiltered list of all Incidences for this Calendar.

Returns: the list of all unfiltered Incidences.

Definition at line 285 of file calendar.cpp.

◆ rawJournals()

virtual Journal::List KCalendarCore::Calendar::rawJournals	(	JournalSortField	sortField = `JournalSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all Journals for this Calendar.

Parameters

sortField	specifies the JournalSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered Journals sorted as specified.

Implemented in KCalendarCore::MemoryCalendar.

◆ rawJournalsForDate()

virtual Journal::List KCalendarCore::Calendar::rawJournalsForDate ( const QDate & date ) const

pure virtual

Returns an unfiltered list of all Journals for on the specified date.

Parameters

date	request unfiltered Journals for this QDate only.

Returns: the list of unfiltered Journals for the specified date.

Implemented in KCalendarCore::MemoryCalendar.

◆ rawTodos() [1/2]

virtual Todo::List KCalendarCore::Calendar::rawTodos	(	const QDate &	start,
		const QDate &	end,
		const QTimeZone &	timeZone = `{}`,
		bool	inclusive = `false`
	)		const

pure virtual

Returns an unfiltered list of all Todos occurring within a date range.

Parameters

start	is the starting date
end	is the ending date
timeZone	time zone to interpret `start` and `end`, or the calendar's default time zone if none is specified
inclusive	if true only Todos which are completely included within the date range are returned.

Returns: the list of unfiltered Todos occurring within the specified date range.

Implemented in KCalendarCore::MemoryCalendar.

◆ rawTodos() [2/2]

virtual Todo::List KCalendarCore::Calendar::rawTodos	(	TodoSortField	sortField = `TodoSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all Todos for this Calendar.

Parameters

sortField	specifies the TodoSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered Todos sorted as specified.

Implemented in KCalendarCore::MemoryCalendar.

◆ rawTodosForDate()

virtual Todo::List KCalendarCore::Calendar::rawTodosForDate ( const QDate & date ) const

pure virtual

Returns an unfiltered list of all Todos which due on the specified date.

Parameters

date	request unfiltered Todos due on this QDate.

Returns: the list of unfiltered Todos due on the specified date.

Implemented in KCalendarCore::MemoryCalendar.

◆ registerObserver()

void Calendar::registerObserver ( CalendarObserver * observer )

Registers an Observer for this Calendar.

Parameters

observer is a pointer to an Observer object that will be watching this Calendar.

See also: unregisterObserver()

Definition at line 988 of file calendar.cpp.

◆ relations()

Incidence::List Calendar::relations ( const QString & uid ) const

Returns a list of incidences that have a relation of RELTYPE parent to incidence uid.

Parameters

uid	The parent identifier whose children we want to obtain.

Definition at line 947 of file calendar.cpp.

◆ reload()

bool Calendar::reload ( )

virtual

Loads the calendar contents from storage.

This requires that the calendar has been previously loaded (initialized).

Returns: true if the reload was successful; otherwise false. Base implementation returns true.

Definition at line 1036 of file calendar.cpp.

◆ removeRelations()

void Calendar::removeRelations ( const Incidence::Ptr & incidence )

virtual

Removes all Relations from an Incidence.

Parameters

incidence is a pointer to the Incidence to have a Relation removed.

Definition at line 862 of file calendar.cpp.

◆ save()

bool Calendar::save ( )

virtual

Syncs changes in memory to persistent storage.

Returns: true if the save was successful; false otherwise. Base implementation returns true.

Definition at line 1031 of file calendar.cpp.

◆ setAccessMode()

void Calendar::setAccessMode ( const AccessMode mode )

Set this calendar's AccessMode, i.e.

whether it is writable or read-only.

Since: 5.85

See also: accessMode()

Definition at line 1397 of file calendar.cpp.

◆ setDefaultNotebook()

bool Calendar::setDefaultNotebook ( const QString & notebook )

set DefaultNotebook information to calendar.

Parameters

notebook notebook uid

Returns: true if operation was successful; false otherwise.

Definition at line 361 of file calendar.cpp.

◆ setDeletionTracking()

void Calendar::setDeletionTracking ( bool enable )

protected

Enables or disabled deletion tracking.

Default is true.

See also: deletedEvent(); deletedTodo(); deletedJournal()

Since: 4.11

Definition at line 1333 of file calendar.cpp.

◆ setFilter()

void Calendar::setFilter ( CalFilter * filter )

Sets the calendar filter.

Parameters

filter a pointer to a CalFilter object which will be used to filter Calendar Incidences. The Calendar takes ownership of filter.

See also: filter()

Definition at line 242 of file calendar.cpp.

◆ setIcon()

void Calendar::setIcon ( const QIcon & icon )

Set this calendar's icon.

Since: 5.85

See also: icon()

Definition at line 1386 of file calendar.cpp.

◆ setId()

void Calendar::setId ( const QString & id )

set a unique identifier for this calendar.

Since: 5.85

See also: id()

Definition at line 1360 of file calendar.cpp.

◆ setIsLoading()

void Calendar::setIsLoading ( bool isLoading )

protected

Sets the loading state of this calendar.

This is false by default and only needs to be called for calendars that implement asynchronous loading.

Since: 5.96

See also: isLoading()

Definition at line 1410 of file calendar.cpp.

◆ setModified()

void Calendar::setModified ( bool modified )

Sets if the calendar has been modified.

Parameters

modified is true if the calendar has been modified since open or last save.

See also: isModified()

Definition at line 1015 of file calendar.cpp.

◆ setName()

void Calendar::setName ( const QString & name )

Set the user-visible name for this calendar.

Since: 5.85

See also: name()

Definition at line 1373 of file calendar.cpp.

◆ setNotebook()

bool Calendar::setNotebook	(	const Incidence::Ptr &	incidence,
		const QString &	notebook
	)

virtual

Associate notebook for an incidence.

Parameters

incidence	incidence
notebook	notebook uid

Returns: true if the operation was successful; false otherwise.

Definition at line 411 of file calendar.cpp.

◆ setObserversEnabled()

void Calendar::setObserversEnabled ( bool enabled )

protected

Let Calendar subclasses notify that they enabled an Observer.

Parameters

enabled if true tells the calendar that a subclass has enabled an Observer.

Definition at line 1198 of file calendar.cpp.

◆ setOwner()

void Calendar::setOwner ( const Person & owner )

Sets the owner of the calendar to owner.

Parameters

owner is a Person object. Must be a non-null pointer.

See also: owner()

Definition at line 169 of file calendar.cpp.

◆ setProductId()

void Calendar::setProductId ( const QString & id )

Sets the calendar Product ID to id.

Parameters

id	is a string containing the Product ID.

See also: productId() const

Definition at line 1153 of file calendar.cpp.

◆ setTimeZone()

void Calendar::setTimeZone ( const QTimeZone & timeZone )

Sets the default time specification zone used for creating or modifying incidences in the Calendar.

Parameters

timeZone The time zone

Definition at line 178 of file calendar.cpp.

◆ setTimeZoneId()

void Calendar::setTimeZoneId ( const QByteArray & timeZoneId )

Sets the time zone ID used for creating or modifying incidences in the Calendar.

This method has no effect on existing incidences.

Parameters

timeZoneId is a string containing a time zone ID, which is assumed to be valid. The time zone ID is used to set the time zone for viewing Incidence date/times. If no time zone is found, the viewing time specification is set to local time zone. Example: "Europe/Berlin"

See also: setTimeZone()

Definition at line 194 of file calendar.cpp.

◆ setupRelations()

void Calendar::setupRelations ( const Incidence::Ptr & incidence )

virtual

Setup Relations for an Incidence.

Parameters

incidence is a pointer to the Incidence to have a Relation setup.

Definition at line 815 of file calendar.cpp.

◆ shiftTimes()

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

Shifts the times of all incidences 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

oldZone	the time zone which provides the clock times
newZone	the new time zone

Definition at line 220 of file calendar.cpp.

◆ sortEvents() [1/2]

Event::List Calendar::sortEvents	(	const Event::List &	eventList,
		EventSortField	sortField,
		SortDirection	sortDirection
	)

static

Sort a list of Events.

static

Parameters

eventList	is a pointer to a list of Events.
sortField	specifies the EventSortField.
sortDirection	specifies the SortDirection.

Returns: a list of Events sorted as specified.

Deprecated:: since 5.95 Use the sortEvents(Event::List &&eventList, EventSortField sortField, SortDirection sortDirection) overload instead. In the common case that you are sorting a list in-place, wrapping the eventList argument with std::move will be all that's needed. In the less common case you actually want a copy, create that explicitly first.

Definition at line 484 of file calendar.cpp.

◆ sortEvents() [2/2]

Event::List Calendar::sortEvents	(	Event::List &&	eventList,
		EventSortField	sortField,
		SortDirection	sortDirection
	)

static

Sort a list of Events.

Parameters

eventList	the list of events that should be sorted. The list is sorted in place and returned.
sortField	specifies the EventSortField.
sortDirection	specifies the SortDirection.

Returns: a list of Events sorted as specified.

Since: 5.95

Definition at line 491 of file calendar.cpp.

◆ sortJournals() [1/2]

Journal::List Calendar::sortJournals	(	const Journal::List &	journalList,
		JournalSortField	sortField,
		SortDirection	sortDirection
	)

static

Sort a list of Journals.

static

Parameters

journalList	is a pointer to a list of Journals.
sortField	specifies the JournalSortField.
sortDirection	specifies the SortDirection.

Returns: a list of Journals sorted as specified.

Deprecated:: since 5.95 Use the sortJournals(Journal::List &&journalList, JournalSortField sortField, SortDirection sortDirection) overload instead. In the common case that you are sorting a list in-place, wrapping the journalList argument with std::move will be all that's needed. In the less common case you actually want a copy, create that explicitly first.

Definition at line 766 of file calendar.cpp.

◆ sortJournals() [2/2]

Journal::List Calendar::sortJournals	(	Journal::List &&	journalList,
		JournalSortField	sortField,
		SortDirection	sortDirection
	)

static

Sort a list of Journals.

Parameters

journalList	the list of journals that should be sorted. The list is sorted in place and returned.
sortField	specifies the JournalSortField.
sortDirection	specifies the SortDirection.

Returns: a list of Journals sorted as specified.

Since: 5.95

Definition at line 773 of file calendar.cpp.

◆ sortTodos() [1/2]

Todo::List Calendar::sortTodos	(	const Todo::List &	todoList,
		TodoSortField	sortField,
		SortDirection	sortDirection
	)

static

Sort a list of Todos.

static

Parameters

todoList	is a pointer to a list of Todos.
sortField	specifies the TodoSortField.
sortDirection	specifies the SortDirection.

Returns: a list of Todos sorted as specified.

Deprecated:: since 5.95 Use the sortTodos(Todo::List &&todoList, TodoSortField sortField, SortDirection sortDirection) overload instead. In the common case that you are sorting a list in-place, wrapping the todoList argument with std::move will be all that's needed. In the less common case you actually want a copy, create that explicitly first.

Definition at line 669 of file calendar.cpp.

◆ sortTodos() [2/2]

Todo::List Calendar::sortTodos	(	Todo::List &&	todoList,
		TodoSortField	sortField,
		SortDirection	sortDirection
	)

static

Sort a list of Todos.

Parameters

todoList	the list of todos that should be sorted. The list is sorted in place and returned.
sortField	specifies the TodoSortField.
sortDirection	specifies the SortDirection.

Returns: a list of Todos sorted as specified.

Since: 5.95

Definition at line 676 of file calendar.cpp.

◆ startBatchAdding()

void Calendar::startBatchAdding ( )

virtual

Call this to tell the calendar that you're adding a batch of incidences.

So it doesn't, for example, ask the destination for each incidence.

See also: endBatchAdding()

Reimplemented in Akonadi::CalendarBase.

Definition at line 1318 of file calendar.cpp.

◆ timeZone()

QTimeZone Calendar::timeZone ( ) const

Get the time zone used for creating or modifying incidences in the Calendar.

Returns: time specification

Definition at line 189 of file calendar.cpp.

◆ timeZoneId()

QByteArray Calendar::timeZoneId ( ) const

Returns the time zone ID used for creating or modifying incidences in the calendar.

Returns: the string containing the time zone ID, or empty string if the creation/modification time specification is not a time zone.

Definition at line 215 of file calendar.cpp.

◆ todo()

virtual Todo::Ptr KCalendarCore::Calendar::todo	(	const QString &	uid,
		const QDateTime &	recurrenceId = `{}`
	)		const

pure virtual

Returns the Todo associated with the given unique identifier.

Parameters

uid	is a unique identifier string.
recurrenceId	is possible recurrenceId of todo, default is null

Returns: a pointer to the Todo. A null pointer is returned if no such Todo exists.

Implemented in KCalendarCore::MemoryCalendar.

◆ todoInstances()

virtual Todo::List KCalendarCore::Calendar::todoInstances	(	const Incidence::Ptr &	todo,
		TodoSortField	sortField = `TodoSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

pure virtual

Returns a sorted, unfiltered list of all possible instances for this recurring Todo.

Parameters

todo	todo to check for. Caller guarantees it's of type Todo.
sortField	specifies the TodoSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all unfiltered todo instances sorted as specified.

Implemented in KCalendarCore::MemoryCalendar.

◆ todos() [1/3]

Todo::List Calendar::todos ( const QDate & date ) const

virtual

Returns a filtered list of all Todos which are due on the specified date.

Parameters

date	request filtered Todos due on this QDate.

Returns: the list of filtered Todos due on the specified date.

Definition at line 750 of file calendar.cpp.

◆ todos() [2/3]

Todo::List Calendar::todos	(	const QDate &	start,
		const QDate &	end,
		const QTimeZone &	timeZone = `{}`,
		bool	inclusive = `false`
	)		const

virtual

Returns a filtered list of all Todos occurring within a date range.

Parameters

start	is the starting date
end	is the ending date
timeZone	time zone to interpret `start` and `end`, or the calendar's default time zone if none is specified
inclusive	if true only Todos which are completely included within the date range are returned.

Returns: the list of filtered Todos occurring within the specified date range.

Definition at line 757 of file calendar.cpp.

◆ todos() [3/3]

Todo::List Calendar::todos	(	TodoSortField	sortField = `TodoSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)		const

virtual

Returns a sorted, filtered list of all Todos for this Calendar.

Parameters

sortField	specifies the TodoSortField.
sortDirection	specifies the SortDirection.

Returns: the list of all filtered Todos sorted as specified.

Definition at line 743 of file calendar.cpp.

◆ unregisterObserver()

void Calendar::unregisterObserver ( CalendarObserver * observer )

Unregisters an Observer for this Calendar.

Parameters

observer is a pointer to an Observer object that has been watching this Calendar.

See also: registerObserver()

Definition at line 1001 of file calendar.cpp.

◆ updateNotebook()

bool Calendar::updateNotebook	(	const QString &	notebook,
		bool	isVisible
	)

Update notebook information in calendar.

Is usually called by storages only.

Parameters

notebook	notebook uid
isVisible	notebook visibility

Returns: true if operation succeeded

See also: isVisible()

Definition at line 335 of file calendar.cpp.

◆ virtual_hook()

void Calendar::virtual_hook	(	int	id,
		void *	data
	)

protectedvirtual

IncidenceBase::virtual_hook()

Reimplemented in KCalendarCore::MemoryCalendar.

Definition at line 1348 of file calendar.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KCalendarCore

KCalendarCore::Calendar

Classes

Public Types

Properties

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ Calendar() [1/2]

◆ Calendar() [2/2]

◆ ~Calendar()

Member Function Documentation

◆ accessMode()

◆ accessModeChanged

◆ addEvent()

◆ addIncidence()

◆ addJournal()

◆ addNotebook()

◆ addTodo()

◆ alarms()

◆ alarmsTo()

◆ appendAlarms()

◆ appendRecurringAlarms()

◆ batchAdding()

◆ beginChange()

◆ categories()

◆ clearNotebookAssociations()

◆ close()

◆ createException()

◆ customPropertyUpdated()

◆ defaultNotebook()

◆ deleted()

◆ deletedEvent()

◆ deletedEvents()

◆ deletedJournal()

◆ deletedJournals()

◆ deletedTodo()

◆ deletedTodos()

◆ deleteEvent()

◆ deleteEventInstances()

◆ deleteIncidence()

◆ deleteIncidenceInstances()

◆ deleteJournal()

◆ deleteJournalInstances()

◆ deleteNotebook()

◆ deleteTodo()

◆ deleteTodoInstances()

◆ deletionTracking()

◆ doSetTimeZone()

◆ duplicates()

◆ endBatchAdding()

◆ endChange()

◆ event()

◆ eventInstances()

◆ events() [1/4]

◆ events() [2/4]

◆ events() [3/4]

◆ events() [4/4]

◆ filter()

◆ filterChanged

◆ hasValidNotebook()

◆ icon()

◆ iconChanged

◆ id()

◆ idChanged

◆ incidence()

◆ incidenceFromSchedulingID()

◆ incidences() [1/3]

◆ incidences() [2/3]

◆ incidences() [3/3]

◆ incidencesFromSchedulingID()

◆ incidenceUpdated()