KCal Library
resourcecached.h
This class provides a calendar stored as a local file.
Definition calendarlocal.h:44
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition incidence.h:70
This class provides a calendar resource using a local CalendarLocal object to cache the calendar data...
Definition resourcecached.h:45
void setTimeZoneId(const QString &timeZoneId)
Set id of timezone, e.g.
Definition resourcecached.cpp:360
virtual QString changesCacheFile(const QString &type) const
Functions for keeping the changes persistent.
Definition resourcecached.cpp:605
void setTimeSpec(const KDateTime::Spec &timeSpec)
Set the time specification (time zone, etc.).
Definition resourcecached.cpp:350
void addInfoText(QString &) const
Add info text for concrete resources.
Definition resourcecached.cpp:853
virtual bool deleteJournal(Journal *)
Remove a Journal from the calendar.
Definition resourcecached.cpp:295
@ ReloadInterval
reload at regular intervals set by setReloadInterval()
Definition resourcecached.h:55
Event::List rawEventsForDate(const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Builds and then returns a list of all events that match for the date specified.
Definition resourcecached.cpp:255
void calendarIncidenceChanged(KCal::Incidence *incidence)
Notify the Observer that an Incidence has been modified.
Definition resourcecached.cpp:677
CacheAction
Whether to update the cache file when loading a resource, or whether to upload the cache file after s...
Definition resourcecached.h:75
@ DefaultCache
use the default action set by setReloadPolicy() or setSavePolicy()
Definition resourcecached.h:76
@ SyncCache
update the cache file before loading, or upload cache after saving
Definition resourcecached.h:78
@ NoSyncCache
perform a cache-only operation, without downloading or uploading
Definition resourcecached.h:77
void calendarIncidenceAdded(KCal::Incidence *incidence)
Notify the Observer that an Incidence has been inserted.
Definition resourcecached.cpp:664
virtual void deleteAllJournals()
Removes all Journals from this calendar.
Definition resourcecached.cpp:300
Alarm::List alarms(const KDateTime &from, const KDateTime &to)
Return all alarms, which occur in the given time interval.
Definition resourcecached.cpp:345
virtual Journal * journal(const QString &uid)
Return Journal with given unique id.
Definition resourcecached.cpp:325
Event::List rawEvents(EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Return unfiltered list of all events in calendar.
Definition resourcecached.cpp:275
Journal::List rawJournals(JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Return list of all journals.
Definition resourcecached.cpp:330
KDateTime::Spec timeSpec() const
Get the viewing time specification (time zone etc.) for the calendar.
Definition resourcecached.cpp:355
virtual bool doLoad(bool syncCache)=0
Do the actual loading of the resource data.
virtual void doClose()
Virtual method from KRES::Resource, called when the last instace of the resource is closed.
Definition resourcecached.cpp:867
Alarm::List alarmsTo(const KDateTime &to)
Return all alarms, which occur before given date.
Definition resourcecached.cpp:340
Event * event(const QString &UniqueStr)
Retrieves an event on the basis of the unique string ID.
Definition resourcecached.cpp:250
Journal::List rawJournalsForDate(const QDate &date)
Return list of journals for the given date.
Definition resourcecached.cpp:335
void calendarIncidenceDeleted(KCal::Incidence *incidence)
Notify the Observer that an Incidence has been removed.
Definition resourcecached.cpp:691
virtual bool doSave(bool syncCache)=0
Do the actual saving of the resource data.
virtual void shiftTimes(const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
Definition resourcecached.cpp:370
virtual KCAL_DEPRECATED bool addJournal(Journal *journal)
Add a Journal entry to calendar.
Definition resourcecached.cpp:320
Todo::List rawTodosForDate(const QDate &date)
Returns list of todos due on the specified date.
Definition resourcecached.cpp:315
bool load(CacheAction action)
Load resource data, specifying whether to refresh the cache file first.
Definition resourcecached.cpp:382
Todo * todo(const QString &uid)
Searches todolist for an event with this unique string identifier, returns a pointer or null.
Definition resourcecached.cpp:310
bool save(CacheAction action, Incidence *incidence=0)
Save the resource data to cache, and optionally upload the cache file afterwards.
Definition resourcecached.cpp:456
bool checkForSave()
Check if save required according to save policy.
Definition resourcecached.cpp:845
bool checkForReload()
Check if reload required according to reload policy.
Definition resourcecached.cpp:834
virtual QString cacheFile() const
This method is used by loadFromCache() and saveToCache(), reimplement it to change the location of th...
Definition resourcecached.cpp:600
Todo::List rawTodos(TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Return list of all todos.
Definition resourcecached.cpp:305
QString timeZoneId() const
Returns the viewing time zone ID for the resource.
Definition resourcecached.cpp:365
Incidence * incidence(const QString &uid)
Return incidence with given unique id.
Definition resourcecalendar.cpp:99
QString type() const
This file is part of the API for handling calendar data and defines the Incidence 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.