KCal Library
resourcecalendar.h
This file is part of the API for handling calendar data and defines the Alarm class.
This file is part of the API for handling calendar data and defines the Calendar class.
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition incidence.h:70
This class provides the interfaces for a calendar resource.
Definition resourcecalendar.h:51
void setInhibitSave(bool inhibit)
Inhibit or allow saves, overriding the save policy set by setSavePolicy().
Definition resourcecalendar.cpp:308
virtual void deleteAllJournals()=0
Removes all Journals from the calendar.
void resourceSaveError(ResourceCalendar *, const QString &error)
This signal is emitted when an error occurs during saving.
bool saveInhibited() const
Return whether saves have been inhibited by setInhibitSave().
Definition resourcecalendar.cpp:313
virtual QStringList subresources() const
If this resource has subresources, return a QStringList of them.
Definition resourcecalendar.cpp:270
virtual bool doLoad(bool syncCache)=0
Do the actual loading of the resource data.
virtual void setSubresourceActive(const QString &resource, bool active)
(De-)activate a subresource.
Definition resourcecalendar.cpp:132
virtual Event::List rawEventsForDate(const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
Builds and then returns a list of all events that match the date specified.
virtual Event::List rawEvents(const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)=0
Get unfiltered events in a range of dates.
virtual QString labelForSubresource(const QString &resource) const
What is the label for this subresource?
Definition resourcecalendar.cpp:286
virtual QString subresourceIdentifier(Incidence *incidence)
Get the identifier of the subresource associated with a specified incidence.
Definition resourcecalendar.cpp:292
virtual QString infoText() const
Return rich text with info about the resource.
Definition resourcecalendar.cpp:78
void resourceLoadError(ResourceCalendar *, const QString &error)
This signal is emitted when an error occurs during loading.
void resourceLoaded(ResourceCalendar *)
This signal is emitted when loading data into the resource has been finished.
virtual bool deleteJournal(Journal *)=0
Remove a Journal entry from calendar.
virtual void deleteAllEvents()=0
Removes all Events from the calendar.
virtual Event::List rawEvents(EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
Return unfiltered list of all events in calendar.
virtual Journal * journal(const QString &uid)=0
Return Journal with given unique id.
virtual bool removeSubresource(const QString &resource)
Remove a subresource with the id.
Definition resourcecalendar.cpp:136
Incidence * incidence(const QString &uid)
Return incidence with given unique id.
Definition resourcecalendar.cpp:99
virtual void shiftTimes(const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)=0
Shifts the times of all incidences so that they appear at the same clock time as before but in a new ...
virtual void addInfoText(QString &) const
Add info text for concrete resources.
Definition resourcecalendar.h:506
virtual bool addJournal(Journal *)=0
Add a Journal entry to the resource.
virtual QString subresourceType(const QString &resource)
Returns the type of the subresource: "event", "todo", or "journal", QString if unknown/mixed.
Definition resourcecalendar.cpp:149
virtual bool deleteEvent(Event *)=0
Delete event from this resource.
virtual Todo::List rawTodos(TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
Return list of all todos.
void resourceSaved(ResourceCalendar *)
This signal is emitted when saving the data of the resource has been finished.
virtual void setTimeSpec(const KDateTime::Spec &timeSpec)=0
Sets the default and viewing time specification for the calendar.
virtual void deleteAllTodos()=0
Removes all To-dos from the calendar.
virtual void setTimeZoneId(const QString &timeZoneId)=0
Sets the time zone ID for the Calendar.
virtual bool canHaveSubresources() const
Is this resource capable of having subresources or not?
Definition resourcecalendar.cpp:275
void resourceChanged(ResourceCalendar *)
This signal is emitted when the data in the resource has changed.
virtual Todo * todo(const QString &uid)=0
Searches todolist for an event with this unique id.
virtual Journal::List rawJournalsForDate(const QDate &date)=0
Returns list of journals for the given date.
void signalSubresourceRemoved(ResourceCalendar *, const QString &, const QString &)
This signal is emitted when a subresource is removed.
virtual Journal::List rawJournals(JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
Return list of all journals.
virtual bool deleteIncidence(Incidence *)
Delete incidence from resource.
Definition resourcecalendar.cpp:121
virtual bool subresourceActive(const QString &resource) const
Is this subresource active or not?
Definition resourcecalendar.cpp:280
virtual Todo::List rawTodosForDate(const QDate &date)=0
Returns list of todos due on the specified date.
void signalSubresourceAdded(ResourceCalendar *, const QString &type, const QString &subresource, const QString &label)
This signal is emitted when a subresource is added.
virtual bool addSubresource(const QString &resource, const QString &parent)
Add a subresource with the id.
Definition resourcecalendar.cpp:142
virtual QString timeZoneId() const =0
Returns the time zone ID used for creating or modifying incidences in the calendar.
virtual KDateTime::Spec timeSpec() const =0
Get the viewing time specification (time zone etc.) for the calendar.
virtual bool setValue(const QString &key, const QString &value)
Sets a particular value of the resource's configuration.
Definition resourcecalendar.cpp:318
virtual bool doSave(bool syncCache)=0
Do the actual saving of the resource data.
virtual Event::List rawEventsForDate(const KDateTime &dt)=0
Get unfiltered events for date dt.
virtual Event * event(const QString &uid)=0
Retrieves an event on the basis of the unique string ID.
virtual Alarm::List alarms(const KDateTime &from, const KDateTime &to)=0
Return all alarms which occur in the given time interval.
virtual Alarm::List alarmsTo(const KDateTime &to)=0
Return all alarms which occur before given date.
virtual bool isSaving()
Return true if a save operation is still in progress, otherwise return false.
Definition resourcecalendar.cpp:246
QString type() const
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 Exception and ErrorFormat cla...
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.