KCal Library
calendar.h
Go to the documentation of this file.
void setTimeZoneId(const QString &timeZoneId)
Sets the time zone ID used for creating or modifying incidences in the Calendar.
Definition calendar.cpp:150
void setViewTimeZoneId(const QString &timeZoneId) const
Notes the time zone Id which the client application intends to use for viewing the incidences in this...
Definition calendar.cpp:201
static Todo::List sortTodos(Todo::List *todoList, TodoSortField sortField, SortDirection sortDirection)
Sort a list of Todos.
Definition calendar.cpp:712
void calendarLoaded()
Signals that the calendar has been loaded into memory.
virtual Todo::List rawTodosForDate(const QDate &date)=0
Returns an unfiltered list of all Todos which due on the specified date.
void appendRecurringAlarms(Alarm::List &alarms, Incidence *incidence, const KDateTime &from, const KDateTime &to)
Appends alarms of recurring events in interval to list of alarms.
Definition calendar.cpp:1263
virtual Journal::List rawJournals(JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
Returns a sorted, unfiltered list of all Journals for this Calendar.
virtual bool addJournal(Journal *journal)=0
Inserts a Journal into the calendar.
virtual bool isSaving()
Determine if the calendar is currently being saved.
Definition calendar.cpp:1120
void setTimeSpec(const KDateTime::Spec &timeSpec)
Sets the default time specification (time zone, etc.) used for creating or modifying incidences in th...
Definition calendar.cpp:136
void appendAlarms(Alarm::List &alarms, Incidence *incidence, const KDateTime &from, const KDateTime &to)
Appends alarms of incidence in interval to list of alarms.
Definition calendar.cpp:1246
virtual bool addIncidence(Incidence *incidence)
Inserts an Incidence into the calendar.
Definition calendar.cpp:573
virtual Event * event(const QString &uid)=0
Returns the Event associated with the given unique identifier.
virtual bool beginChange(Incidence *incidence)
Flag that a change to a Calendar Incidence is starting.
Definition calendar.cpp:1229
virtual Incidence::List rawIncidences()
Returns an unfiltered list of all Incidences for this Calendar.
Definition calendar.cpp:287
void incidenceUpdated(IncidenceBase *incidenceBase)
The Observer interface.
Definition calendar.cpp:1141
QString viewTimeZoneId() const
Returns the time zone Id used for viewing the incidences in this calendar.
Definition calendar.cpp:211
ICalTimeZones * timeZones() const
Returns the time zone collection used by the calendar.
Definition calendar.cpp:217
virtual Incidence::List incidences()
Returns a filtered list of all Incidences for this Calendar.
Definition calendar.cpp:282
static Incidence::List mergeIncidenceList(const Event::List &events, const Todo::List &todos, const Journal::List &journals)
Create a merged list of Events, Todos, and Journals.
Definition calendar.cpp:1207
virtual void setupRelations(Incidence *incidence)
Setup Relations for an Incidence.
Definition calendar.cpp:951
Incidence * dissociateOccurrence(Incidence *incidence, const QDate &date, const KDateTime::Spec &spec, bool single=true)
Dissociate an Incidence from a recurring Incidence.
Definition calendar.cpp:595
void notifyIncidenceDeleted(Incidence *incidence)
Let Calendar subclasses notify that they removed an Incidence.
Definition calendar.cpp:1181
virtual Event::List rawEventsForDate(const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
Returns a sorted, unfiltered list of all Events which occur on the given date.
virtual bool deleteIncidence(Incidence *incidence)
Removes an Incidence from the calendar.
Definition calendar.cpp:580
static Event::List sortEvents(Event::List *eventList, EventSortField sortField, SortDirection sortDirection)
Sort a list of Events.
Definition calendar.cpp:292
virtual Event::List rawEventsForDate(const KDateTime &dt)=0
Returns an unfiltered list of all Events which occur on the given timestamp.
QStringList categories()
Returns a list of all categories used by Incidences in this Calendar.
Definition calendar.cpp:258
Calendar(const KDateTime::Spec &timeSpec)
Constructs a calendar with a specified time zone timeZoneid.
Definition calendar.cpp:106
void notifyIncidenceChanged(Incidence *incidence)
Let Calendar subclasses notify that they modified an Incidence.
Definition calendar.cpp:1170
virtual void doSetTimeSpec(const KDateTime::Spec &timeSpec)
Let Calendar subclasses set the time specification.
Definition calendar.cpp:1154
virtual void customPropertyUpdated()
Definition calendar.cpp:1192
KDateTime::Spec viewTimeSpec() const
Returns the time specification used for viewing the incidences in this calendar.
Definition calendar.cpp:206
virtual void removeRelations(Incidence *incidence)
Removes all Relations from an Incidence.
Definition calendar.cpp:997
virtual Todo * todo(const QString &uid)=0
Returns the Todo associated with the given unique identifier.
QString timeZoneId() const
Returns the time zone ID used for creating or modifying incidences in the calendar.
Definition calendar.cpp:189
virtual bool endChange(Incidence *incidence)
Flag that a change to a Calendar Incidence has completed.
Definition calendar.cpp:1235
void shiftTimes(const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
Shifts the times of all incidences so that they appear at the same clock time as before but in a new ...
Definition calendar.cpp:222
static Event::List sortEventsForDate(Event::List *eventList, const QDate &date, const KDateTime::Spec &timeSpec, EventSortField sortField, SortDirection sortDirection)
Sort a list of Events that occur on a specified date.
Definition calendar.cpp:395
virtual Event::List rawEvents(const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)=0
Returns an unfiltered list of all Events occurring within a date range.
virtual void deleteAllEvents()=0
Removes all Events from the calendar.
virtual bool deleteEvent(Event *event)=0
Removes an Event from the calendar.
void setOwner(const Person &owner)
Sets the owner of the calendar to owner.
Definition calendar.cpp:129
void setObserversEnabled(bool enabled)
Let Calendar subclasses notify that they enabled an Observer.
Definition calendar.cpp:1241
virtual Event::List rawEvents(EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
Returns a sorted, unfiltered list of all Events for this Calendar.
virtual Journal * journal(const QString &uid)=0
Returns the Journal associated with the given unique identifier.
virtual Event::List events(EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Returns a sorted, filtered list of all Events for this Calendar.
Definition calendar.cpp:565
Incidence::List incidencesFromSchedulingID(const QString &sid)
Searches all events and todos for an incidence with this scheduling identifiere.
Definition calendar.cpp:685
void notifyIncidenceAdded(Incidence *incidence)
Let Calendar subclasses notify that they inserted an Incidence.
Definition calendar.cpp:1159
virtual bool deleteJournal(Journal *journal)=0
Removes a Journal from the calendar.
void setViewTimeSpec(const KDateTime::Spec &timeSpec) const
Notes the time specification which the client application intends to use for viewing the incidences i...
Definition calendar.cpp:195
virtual Journal::List journals(JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Returns a sorted, filtered list of all Journals for this Calendar.
Definition calendar.cpp:924
virtual Todo::List rawTodos(TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
Returns a sorted, unfiltered list of all Todos for this Calendar.
void batchAddingEnds()
Incidence * incidenceFromSchedulingID(const QString &sid)
Returns the Incidence associated with the given scheduling identifier.
Definition calendar.cpp:698
virtual void deleteAllJournals()=0
Removes all Journals from the calendar.
Incidence * incidence(const QString &uid)
Returns the Incidence associated with the given unique identifier.
Definition calendar.cpp:669
void batchAddingBegins()
virtual void close()=0
Clears out the current calendar, freeing all used memory etc.
virtual Journal::List rawJournalsForDate(const QDate &date)=0
Returns an unfiltered list of all Journals for on the specified date.
bool isAncestorOf(Incidence *ancestor, Incidence *incidence)
Checks if ancestor is an ancestor of incidence.
Definition calendar.cpp:1075
KDateTime::Spec timeSpec() const
Get the time specification (time zone etc.) used for creating or modifying incidences in the Calendar...
Definition calendar.cpp:145
virtual Alarm::List alarms(const KDateTime &from, const KDateTime &to)=0
Returns a list of Alarms within a time range for this Calendar.
virtual Todo::List todos(TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Returns a sorted, filtered list of all Todos for this Calendar.
Definition calendar.cpp:856
static Journal::List sortJournals(Journal::List *journalList, JournalSortField sortField, SortDirection sortDirection)
Sort a list of Journals.
Definition calendar.cpp:871
void setTimeZones(const ICalTimeZones &zones)
Set the time zone collection used by the calendar.
The ICalTimeZone class represents an iCalendar VTIMEZONE component.
Definition icaltimezones.h:144
The ICalTimeZones class represents a time zone database which consists of a collection of individual ...
Definition icaltimezones.h:65
An abstract class that provides a common base for all calendar incidence classes.
Definition incidencebase.h:103
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition incidence.h:70
This file is part of the API for handling calendar data and defines the CustomProperties class.
This file is part of the API for handling calendar data and defines the Event class.
This file is part of the API for handling calendar data and defines the Journal class.
This file is part of the API for handling calendar data and defines the Todo class.
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.