KCalCore Library
calendar.h
Go to the documentation of this file.
82};
95};
104};
virtual Todo::List deletedTodos(TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all deleted Todos for this Calendar.
virtual Event::Ptr event(const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
Returns the Event associated with the given unique identifier.
virtual bool addEvent(const Event::Ptr &event)=0
Inserts an Event into the calendar.
bool hasValidNotebook(const QString ¬ebook) const
Check if calendar knows about the given notebook.
virtual Incidence::List instances(const Incidence::Ptr &incidence) const
Returns an unfiltered list of all exceptions of this recurring incidence.
bool isVisible(const Incidence::Ptr &incidence) const
Check if incidence is visible.
bool setDefaultNotebook(const QString ¬ebook)
set DefaultNotebook information to calendar.
virtual Alarm::List alarms(const KDateTime &from, const KDateTime &to) const =0
Returns a list of Alarms within a time range for this Calendar.
virtual Journal::Ptr journal(const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
Returns the Journal associated with the given unique identifier.
virtual Journal::List rawJournalsForDate(const QDate &date) const =0
Returns an unfiltered list of all Journals for on the specified date.
QString timeZoneId() const
Returns the time zone ID used for creating or modifying incidences in the calendar.
virtual Incidence::List incidences() const
Returns a filtered list of all Incidences for this Calendar.
void setViewTimeSpec(const KDateTime::Spec &timeSpec) const
Notes the time specification which the client application intends to use for viewing the incidences i...
virtual bool deleteEvent(const Event::Ptr &event)=0
Removes an Event from the calendar.
virtual Incidence::List duplicates(const Incidence::Ptr &incidence)
List all possible duplicate incidences.
void setTimeSpec(const KDateTime::Spec &timeSpec)
Sets the default time specification (time zone, etc.) used for creating or modifying incidences in th...
virtual bool deleteJournal(const Journal::Ptr &journal)=0
Removes a Journal from the calendar.
bool updateNotebook(const QString ¬ebook, bool isVisible)
Update notebook information in calendar.
virtual bool addTodo(const Todo::Ptr &todo)=0
Inserts a Todo into the calendar.
Calendar(const QString &timeZoneId)
Construct Calendar object using a time zone ID.
QString viewTimeZoneId() const
Returns the time zone Id used for viewing the incidences in this calendar.
virtual Incidence::List rawIncidences() const
Returns an unfiltered list of all Incidences for this Calendar.
QStringList categories() const
Returns a list of all categories used by Incidences in this Calendar.
void setTimeZones(ICalTimeZones *zones)
Set the time zone collection used by the calendar.
virtual Todo::List rawTodos(const QDate &start, const QDate &end, const KDateTime::Spec ×pec=KDateTime::Spec(), bool inclusive=false) const =0
Returns an unfiltered list of all Todos occurring within a date range.
void setOwner(const Person::Ptr &owner)
Sets the owner of the calendar to owner.
virtual void deleteAllEvents()=0
Removes all Events from the calendar.
virtual Incidence::List incidences(const QDate &date) const
Returns a filtered list of all Incidences which occur on the given date.
virtual Event::List deletedEvents(EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all deleted Events for this Calendar.
virtual Event::List eventInstances(const Incidence::Ptr &event, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all possible instances for this recurring Event.
virtual Todo::List rawTodosForDate(const QDate &date) const =0
Returns an unfiltered list of all Todos which due on the specified date.
virtual QString notebook(const Incidence::Ptr &incidence) const
Get incidence's notebook.
virtual Event::List rawEventsForDate(const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all Events which occur on the given date.
virtual Todo::Ptr todo(const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
Returns the Todo associated with the given unique identifier.
virtual Todo::List todoInstances(const Incidence::Ptr &todo, TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all possible instances for this recurring Todo.
ICalTimeZones * timeZones() const
Returns the time zone collection used by the calendar.
virtual Journal::List journalInstances(const Incidence::Ptr &journal, JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all instances for this recurring Journal.
void setViewTimeZoneId(const QString &timeZoneId) const
Notes the time zone Id which the client application intends to use for viewing the incidences in this...
virtual bool deleteEventInstances(const Event::Ptr &event)=0
Delete all events that are instances of recurring event event.
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 ...
Calendar(const KDateTime::Spec &timeSpec)
Constructs a calendar with a specified time zone timeZoneid.
virtual Journal::List rawJournals(JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all Journals for this Calendar.
virtual QString notebook(const QString &uid) const
Get incidence's notebook.
virtual Event::List rawEvents(EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all Events for this Calendar.
virtual bool deleteTodoInstances(const Todo::Ptr &todo)=0
Delete all to-dos that are instances of recurring to-do todo.
virtual void clearNotebookAssociations()
Clears notebook associations from hash-tables for incidences.
virtual void close()=0
Clears out the current calendar, freeing all used memory etc.
virtual bool deleteJournalInstances(const Journal::Ptr &journal)=0
Delete all journals that are instances of recurring journal journal.
virtual Event::List rawEvents(const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false) const =0
Returns an unfiltered list of all Events occurring within a date range.
virtual Event::List rawEventsForDate(const KDateTime &dt) const =0
Returns an unfiltered list of all Events which occur on the given timestamp.
KDateTime::Spec viewTimeSpec() const
Returns the time specification used for viewing the incidences in this calendar.
virtual QStringList notebooks() const
List all uids of notebooks currently in the memory.
virtual Todo::Ptr deletedTodo(const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
Returns the deleted Todo associated with the given unique identifier.
virtual void deleteAllTodos()=0
Removes all To-dos from the calendar.
virtual bool deleteTodo(const Todo::Ptr &todo)=0
Removes a Todo from the calendar.
virtual Todo::List rawTodos(TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all Todos for this Calendar.
bool addNotebook(const QString ¬ebook, bool isVisible)
Add notebook information into calendar.
virtual bool setNotebook(const Incidence::Ptr &incidence, const QString ¬ebook)
Associate notebook for an incidence.
virtual void deleteAllJournals()=0
Removes all Journals from the calendar.
virtual Event::Ptr deletedEvent(const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
Returns the deleted Event associated with the given unique identifier.
KDateTime::Spec timeSpec() const
Get the time specification (time zone etc.) used for creating or modifying incidences in the Calendar...
virtual bool deleteIncidenceInstances(const Incidence::Ptr &incidence)=0
Delete all incidences that are instances of recurring incidence incidence.
virtual bool addJournal(const Journal::Ptr &journal)=0
Inserts a Journal into the calendar.
bool deleteNotebook(const QString ¬ebook)
Delete notebook information from calendar.
virtual Journal::List deletedJournals(JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Returns a sorted, unfiltered list of all deleted Journals for this Calendar.
void setTimeZoneId(const QString &timeZoneId)
Sets the time zone ID used for creating or modifying incidences in the Calendar.
virtual Journal::Ptr deletedJournal(const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
Returns the deleted Journal associated with the given unique identifier.
virtual Incidence::List incidences(const QString ¬ebook) const
List all notebook incidences in the memory.
A class to manage custom calendar properties.
Definition customproperties.h:52
The ICalTimeZones class represents a time zone database which consists of a collection of individual ...
Definition icaltimezones.h:66
The IncidenceObserver class.
Definition incidencebase.h:200
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 Incidence class.
This file is part of the API for handling calendar data and defines the Journal class.
static uint qHash(const KDateTime &dt)
Private class that helps to provide binary compatibility between releases.
Definition occurrenceiterator.cpp:157
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-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.