KCalendarCore::Calendar Class

Member Function Documentation

[explicit] Calendar::Calendar(const QByteArray &timeZoneId)

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.

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"

[explicit] Calendar::Calendar(const QTimeZone &timeZone)

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.

timeZone is the time specification

[override virtual noexcept] Calendar::~Calendar()

Destroys the calendar.

[since 5.85] KCalendarCore::AccessMode Calendar::accessMode() const

Returns this calendar's AccessMode, i.e. whether it is writable or read-only. Defaults to ReadWrite.

This function was introduced in 5.85.

See also setAccessMode().

[signal, since 5.85] void Calendar::accessModeChanged()

Emitted when the AccessMode changes.

This function was introduced in 5.85.

See also accessMode().

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

Inserts an Event into the calendar.

event is a pointer to the Event to insert.

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

See also deleteEvent().

[virtual] bool Calendar::addIncidence(const KCalendarCore::Incidence::Ptr &incidence)

Inserts an Incidence into the calendar.

incidence is a pointer to the Incidence to insert.

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

See also deleteIncidence().

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

Inserts a Journal into the calendar.

journal is a pointer to the Journal to insert.

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

See also deleteJournal().

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

Inserts a Todo into the calendar.

todo is a pointer to the Todo to insert.

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

See also deleteTodo().

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

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

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.

[since 5.77] KCalendarCore::Alarm::List Calendar::alarmsTo(const QDateTime &to) const

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

to is the ending timestamp.

Returns the list of Alarms occurring before the specified QDateTime.

This function was introduced in 5.77.

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

Appends alarms of incidence in interval to list of alarms.

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.

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

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

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.

bool Calendar::batchAdding() const

Returns true if batch adding is in progress

[virtual] bool Calendar::beginChange(const KCalendarCore::Incidence::Ptr &incidence)

Flag that a change to a Calendar Incidence is starting.

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

QStringList Calendar::categories() const

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

Returns a QStringList containing all the categories.

[static, since 4.11] KCalendarCore::Incidence::Ptr Calendar::createException(const KCalendarCore::Incidence::Ptr &incidence, const QDateTime &recurrenceId, bool thisAndFuture = false)

Creates an exception for an occurrence from a recurring Incidence.

The returned exception is not automatically inserted into the calendar.

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 recurrenceId set.

This function was introduced in 4.11.

[override virtual protected] void Calendar::customPropertyUpdated()

Reimplements: CustomProperties::customPropertyUpdated().

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

Removes an Event from the calendar.

event is a pointer to the Event to remove.

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

See also addEvent().

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

Delete all events that are instances of recurring event event.

event is a pointer to a deleted Event

Returns true if delete was successful; false otherwise

[virtual] bool Calendar::deleteIncidence(const KCalendarCore::Incidence::Ptr &incidence)

Removes an Incidence from the calendar.

incidence is a pointer to the Incidence to remove.

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

See also addIncidence().

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

Delete all incidences that are instances of recurring incidence incidence.

incidence is a pointer to a deleted Incidence

Returns true if delete was successful; false otherwise

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

Removes a Journal from the calendar.

journal is a pointer to the Journal to remove.

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

See also addJournal().

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

Delete all journals that are instances of recurring journal journal.

journal is a pointer to a deleted Journal

Returns true if delete was successful; false otherwise

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

Removes a Todo from the calendar.

todo is a pointer to the Todo to remove.

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

See also addTodo().

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

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

todo is a pointer to a deleted Todo

Returns true if delete was successful; false otherwise

[virtual protected] void Calendar::doSetTimeZone(const QTimeZone &timeZone)

Let Calendar subclasses set the time specification.

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

[virtual] void Calendar::endBatchAdding()

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

See also startBatchAdding().

[virtual] bool Calendar::endChange(const KCalendarCore::Incidence::Ptr &incidence)

Flag that a change to a Calendar Incidence has completed.

incidence is a pointer to the Incidence that was changed.

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

Returns the Event associated with the given unique identifier.

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.

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

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

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.

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

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

dt request filtered Event list for this QDateTime only.

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

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

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

sortField specifies the EventSortField.

sortDirection specifies the SortDirection.

Returns the list of all filtered Events sorted as specified.

KCalendarCore::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.

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.

KCalendarCore::Event::List Calendar::events(const QDate &date, const QTimeZone &timeZone = {}, KCalendarCore::EventSortField sortField = EventSortUnsorted, KCalendarCore::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.

date request filtered 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, filtered Events occurring on date.

KCalendarCore::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().

[signal, since 4.11] void Calendar::filterChanged()

Emitted when setFilter() is called.

This function was introduced in 4.11.

[since 5.85] QIcon Calendar::icon() const

Returns this calendar's icon.

This function was introduced in 5.85.

See also setIcon().

[signal, since 5.85] void Calendar::iconChanged()

Emitted when the icon name changes.

This function was introduced in 5.85.

See also icon().

[since 5.85] QString Calendar::id() const

Returns a unique identifier for this calendar.

This function was introduced in 5.85.

See also setId().

[signal, since 5.85] void Calendar::idChanged()

Emitted when the id changes.

This function was introduced in 5.85.

See also id().

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

Returns the Incidence associated with the given unique identifier.

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.

[virtual] KCalendarCore::Incidence::Ptr Calendar::incidenceFromSchedulingID(const QString &sid) const

Returns the Incidence associated with the given scheduling identifier.

sid is a unique scheduling identifier string.

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

[override virtual protected] void Calendar::incidenceUpdated(const QString &uid, const QDateTime &recurrenceId)

Reimplements: IncidenceObserver::incidenceUpdated(const QString &uid, const QDateTime &recurrenceId).

The Observer interface. So far not implemented.

uid is the UID for the Incidence that has been updated.

recurrenceId is possible recurrenceid of incidence.

[virtual] KCalendarCore::Incidence::List Calendar::incidences() const

Returns a filtered list of all Incidences for this Calendar.

Returns the list of all filtered Incidences.

[virtual] KCalendarCore::Incidence::List Calendar::incidences(const QDate &date) const

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

date request filtered Incidence list for this QDate only.

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

[virtual] KCalendarCore::Incidence::List Calendar::incidencesFromSchedulingID(const QString &sid) const

Searches all events and todos for an incidence with this scheduling identifier. Returns a list of matching results.

sid is a unique scheduling identifier string.

[virtual] KCalendarCore::Incidence::List Calendar::instances(const KCalendarCore::Incidence::Ptr &incidence) const

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

incidence incidence to check

Returns the list of all unfiltered exceptions.

[since 5.96] bool 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.

This function was introduced in 5.96.

See also setIsLoading().

[signal, since 5.96] void Calendar::isLoadingChanged()

Emitted when the loading state changed.

This function was introduced in 5.96.

See also isLoading().

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().

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

Returns the Journal associated with the given unique identifier.

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.

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

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

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.

[virtual] KCalendarCore::Journal::List Calendar::journals(const QDate &date) const

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

date request filtered Journals for this QDate only.

Returns the list of filtered Journals for the specified date.

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

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

sortField specifies the JournalSortField.

sortDirection specifies the SortDirection.

Returns the list of all filtered Journals sorted as specified.

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

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

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.

[since 5.85] QString Calendar::name() const

Returns the user-visible name for this calendar.

This function was introduced in 5.85.

See also setName().

[signal, since 5.85] void Calendar::nameChanged()

Emitted when the name changes.

This function was introduced in 5.85.

See also name().

[protected] void Calendar::notifyIncidenceAboutToBeDeleted(const KCalendarCore::Incidence::Ptr &incidence)

Let Calendar subclasses notify that they will remove an Incidence.

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

[protected] void Calendar::notifyIncidenceAdded(const KCalendarCore::Incidence::Ptr &incidence)

Let Calendar subclasses notify that they inserted an Incidence.

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

[protected] void Calendar::notifyIncidenceAdditionCanceled(const KCalendarCore::Incidence::Ptr &incidence)

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

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

[protected] void Calendar::notifyIncidenceChanged(const KCalendarCore::Incidence::Ptr &incidence)

Let Calendar subclasses notify that they modified an Incidence.

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

[protected] void Calendar::notifyIncidenceDeleted(const KCalendarCore::Incidence::Ptr &incidence)

Let Calendar subclasses notify that they removed an Incidence.

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

KCalendarCore::Person Calendar::owner() const

Returns the owner of the calendar.

Returns the owner Person object.

See also setOwner().

[signal, since 5.85] void Calendar::ownerChanged()

Emitted when the owner changes.

This function was introduced in 5.85.

See also owner().

QString Calendar::productId() const

Returns the calendar's Product ID.

See also setProductId().

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

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

sortField specifies the EventSortField.

sortDirection specifies the SortDirection.

Returns the list of all unfiltered Events sorted as specified.

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

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

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.

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

Returns a sorted, unfiltered list of all Events which occur on the given date. The Events are sorted according to sortField and sortDirection.

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

[virtual] KCalendarCore::Incidence::List Calendar::rawIncidences() const

Returns an unfiltered list of all Incidences for this Calendar.

Returns the list of all unfiltered Incidences.

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

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

sortField specifies the JournalSortField.

sortDirection specifies the SortDirection.

Returns the list of all unfiltered Journals sorted as specified.

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

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

date request unfiltered Journals for this QDate only.

Returns the list of unfiltered Journals for the specified date.

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

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

sortField specifies the TodoSortField.

sortDirection specifies the SortDirection.

Returns the list of all unfiltered Todos sorted as specified.

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

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

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.

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

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

date request unfiltered Todos due on this QDate.

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

void Calendar::registerObserver(KCalendarCore::Calendar::CalendarObserver *observer)

Registers an Observer for this Calendar.

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

See also unregisterObserver().

[since 5.85] void Calendar::setAccessMode(const KCalendarCore::AccessMode mode)

Sets this calendar's AccessMode to mode, i.e. whether it is writable or read-only.

This function was introduced in 5.85.

See also accessMode().

void Calendar::setFilter(KCalendarCore::CalFilter *filter)

Sets the calendar filter.

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

See also filter().

[since 5.85] void Calendar::setIcon(const QIcon &icon)

Sets this calendar's icon.

This function was introduced in 5.85.

See also icon().

[since 5.85] void Calendar::setId(const QString &id)

Sets a unique identifier id for this calendar.

This function was introduced in 5.85.

See also id().

[protected, since 5.96] void Calendar::setIsLoading(bool isLoading)

Sets the loading state of this calendar to isLoading. This is false by default and only needs to be called for calendars that implement asynchronous loading.

This function was introduced in 5.96.

See also isLoading().

void Calendar::setModified(bool modified)

Sets if the calendar has been modified.

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

See also isModified().

[since 5.85] void Calendar::setName(const QString &name)

Sets the user-visible name for this calendar.

This function was introduced in 5.85.

See also name().

[protected] void Calendar::setObserversEnabled(bool enabled)

Let Calendar subclasses notify that they enabled an Observer.

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

void Calendar::setOwner(const KCalendarCore::Person &owner)

Sets the owner of the calendar to owner.

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

See also owner().

void Calendar::setProductId(const QString &id)

Sets the calendar Product ID to id.

id is a string containing the Product ID.

See also productId().

void Calendar::setTimeZone(const QTimeZone &timeZone)

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

timeZone The time zone

See also timeZone().

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.

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 timeZoneId() and setTimeZone().

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 (oldZone) of Europe/London, to a new time zone (newZone) 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.

oldZone the time zone which provides the clock times

newZone the new time zone

[static, since 5.95] KCalendarCore::Event::List Calendar::sortEvents(KCalendarCore::Event::List &&eventList, KCalendarCore::EventSortField sortField, KCalendarCore::SortDirection sortDirection)

Sort a list of Events.

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.

This function was introduced in 5.95.

[static, since 5.95] KCalendarCore::Journal::List Calendar::sortJournals(KCalendarCore::Journal::List &&journalList, KCalendarCore::JournalSortField sortField, KCalendarCore::SortDirection sortDirection)

Sort a list of Journals.

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.

This function was introduced in 5.95.

[static, since 5.95] KCalendarCore::Todo::List Calendar::sortTodos(KCalendarCore::Todo::List &&todoList, KCalendarCore::TodoSortField sortField, KCalendarCore::SortDirection sortDirection)

Sort a list of Todos.

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.

This function was introduced in 5.95.

[virtual] void Calendar::startBatchAdding()

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().

QTimeZone Calendar::timeZone() const

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

Returns time specification

See also setTimeZone().

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.

See also setTimeZoneId().

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

Returns the Todo associated with the given unique identifier.

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.

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

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

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.

[virtual] KCalendarCore::Todo::List Calendar::todos(const QDate &date) const

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

date request filtered Todos due on this QDate.

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

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

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

sortField specifies the TodoSortField.

sortDirection specifies the SortDirection.

Returns the list of all filtered Todos sorted as specified.

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

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

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.

void Calendar::unregisterObserver(KCalendarCore::Calendar::CalendarObserver *observer)

Unregisters an Observer for this Calendar.

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

See also registerObserver().