libkcal
KCal::ResourceCached Class Reference
#include <resourcecached.h>
Inheritance diagram for KCal::ResourceCached:

Detailed Description
This class provides a calendar resource using a local CalendarLocal object to cache the calendar data.
Definition at line 45 of file resourcecached.h.
Public Types | |
enum | { ReloadNever, ReloadOnStartup, ReloadInterval } |
enum | { SaveNever, SaveOnExit, SaveInterval, SaveDelayed, SaveAlways } |
Public Member Functions | |
ResourceCached (const KConfig *) | |
virtual | ~ResourceCached () |
void | readConfig (const KConfig *config) |
void | writeConfig (KConfig *config) |
void | setReloadPolicy (int policy) |
int | reloadPolicy () const |
void | setReloadInterval (int minutes) |
int | reloadInterval () const |
void | setSavePolicy (int policy) |
int | savePolicy () const |
void | setSaveInterval (int minutes) |
int | saveInterval () const |
QDateTime | lastLoad () const |
QDateTime | lastSave () const |
bool | addEvent (Event *anEvent) |
bool | deleteEvent (Event *) |
Event * | event (const QString &UniqueStr) |
Event::List | events () |
Event::List | rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) |
Event::List | rawEventsForDate (const QDate &date, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) |
Event::List | rawEventsForDate (const QDateTime &qdt) |
Event::List | rawEvents (const QDate &start, const QDate &end, bool inclusive=false) |
bool | addTodo (Todo *todo) |
bool | deleteTodo (Todo *) |
Todo * | todo (const QString &uid) |
Todo::List | rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) |
Todo::List | rawTodosForDate (const QDate &date) |
virtual bool | addJournal (Journal *) |
virtual bool | deleteJournal (Journal *) |
virtual Journal * | journal (const QString &uid) |
Journal::List | rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) |
Journal::List | rawJournalsForDate (const QDate &date) |
Alarm::List | alarms (const QDateTime &from, const QDateTime &to) |
Alarm::List | alarmsTo (const QDateTime &to) |
void | setTimeZoneId (const QString &timeZoneId) |
QString | timeZoneId () const |
const Person & | getOwner () const |
void | setOwner (const Person &owner) |
void | enableChangeNotification () |
void | disableChangeNotification () |
void | clearChange (Incidence *) |
void | clearChange (const QString &uid) |
void | clearChanges () |
bool | hasChanges () const |
Incidence::List | allChanges () const |
Incidence::List | addedIncidences () const |
Incidence::List | changedIncidences () const |
Incidence::List | deletedIncidences () const |
void | loadCache () |
void | saveCache () |
void | clearCache () |
void | cleanUpEventCache (const KCal::Event::List &eventList) |
void | cleanUpTodoCache (const KCal::Todo::List &todoList) |
KPIM::IdMapper & | idMapper () |
Protected Slots | |
void | slotReload () |
void | slotSave () |
void | setIdMapperIdentifier () |
Protected Member Functions | |
void | calendarIncidenceAdded (KCal::Incidence *incidence) |
void | calendarIncidenceChanged (KCal::Incidence *incidence) |
void | calendarIncidenceDeleted (KCal::Incidence *incidence) |
virtual void | doClose () |
virtual bool | doOpen () |
bool | checkForReload () |
bool | checkForSave () |
void | checkForAutomaticSave () |
void | addInfoText (QString &) const |
void | setupSaveTimer () |
void | setupReloadTimer () |
virtual QString | cacheFile () const |
virtual QString | changesCacheFile (const QString &) const |
void | loadChangesCache (QMap< Incidence *, bool > &, const QString &) |
void | loadChangesCache () |
void | saveChangesCache (const QMap< Incidence *, bool > &, const QString &) |
void | saveChangesCache () |
Protected Attributes | |
CalendarLocal | mCalendar |
Member Enumeration Documentation
anonymous enum |
Reload policy.
- See also:
- setReloadPolicy(), reloadPolicy()
Definition at line 55 of file resourcecached.h.
anonymous enum |
Member Function Documentation
void ResourceCached::setReloadPolicy | ( | int | policy | ) |
Set reload policy.
This controls when the cache is refreshed.
ReloadNever never reload ReloadOnStartup reload when resource is started ReloadInterval reload regularly after given interval
Definition at line 59 of file resourcecached.cpp.
int ResourceCached::reloadPolicy | ( | ) | const |
void ResourceCached::setReloadInterval | ( | int | minutes | ) |
Set reload interval in minutes which is used when reload policy is ReloadInterval.
Definition at line 71 of file resourcecached.cpp.
int ResourceCached::reloadInterval | ( | ) | const |
void ResourceCached::setSavePolicy | ( | int | policy | ) |
Set save policy.
This controls when the cache is refreshed.
SaveNever never save SaveOnExit save when resource is exited SaveInterval save regularly after given interval SaveDelayed save after small delay SaveAlways save on every change
Definition at line 81 of file resourcecached.cpp.
int ResourceCached::savePolicy | ( | ) | const |
void ResourceCached::setSaveInterval | ( | int | minutes | ) |
Set save interval in minutes which is used when save policy is SaveInterval.
Definition at line 93 of file resourcecached.cpp.
int ResourceCached::saveInterval | ( | ) | const |
QDateTime KCal::ResourceCached::lastLoad | ( | ) | const |
Return time of last load.
QDateTime KCal::ResourceCached::lastSave | ( | ) | const |
Return time of last save.
bool ResourceCached::addEvent | ( | Event * | anEvent | ) | [virtual] |
Add event to calendar.
Implements KCal::ResourceCalendar.
Definition at line 152 of file resourcecached.cpp.
bool ResourceCached::deleteEvent | ( | Event * | ) | [virtual] |
Deletes an event from this calendar.
Implements KCal::ResourceCalendar.
Reimplemented in KCal::ResourceLocalDir.
Definition at line 158 of file resourcecached.cpp.
Event * ResourceCached::event | ( | const QString & | UniqueStr | ) | [virtual] |
Retrieves an event on the basis of the unique string ID.
Implements KCal::ResourceCalendar.
Definition at line 166 of file resourcecached.cpp.
Event::List KCal::ResourceCached::events | ( | ) |
Return filtered list of all events in calendar.
Event::List ResourceCached::rawEvents | ( | EventSortField | sortField = EventSortUnsorted , |
|
SortDirection | sortDirection = SortDirectionAscending | |||
) | [virtual] |
Return unfiltered list of all events in calendar.
Implements KCal::ResourceCalendar.
Definition at line 191 of file resourcecached.cpp.
Event::List ResourceCached::rawEventsForDate | ( | const QDate & | date, | |
EventSortField | sortField = EventSortUnsorted , |
|||
SortDirection | sortDirection = SortDirectionAscending | |||
) | [virtual] |
Builds and then returns a list of all events that match for the date specified.
useful for dayView, etc. etc.
Implements KCal::ResourceCalendar.
Definition at line 171 of file resourcecached.cpp.
Event::List ResourceCached::rawEventsForDate | ( | const QDateTime & | qdt | ) | [virtual] |
Get unfiltered events for date qdt.
Implements KCal::ResourceCalendar.
Definition at line 186 of file resourcecached.cpp.
Event::List ResourceCached::rawEvents | ( | const QDate & | start, | |
const QDate & | end, | |||
bool | inclusive = false | |||
) | [virtual] |
Get unfiltered events in a range of dates.
If inclusive is set to true, only events are returned, which are completely included in the range.
Implements KCal::ResourceCalendar.
Definition at line 180 of file resourcecached.cpp.
bool ResourceCached::addTodo | ( | Todo * | todo | ) | [virtual] |
Add a todo to the todolist.
Implements KCal::ResourceCalendar.
Definition at line 196 of file resourcecached.cpp.
bool ResourceCached::deleteTodo | ( | Todo * | ) | [virtual] |
Remove a todo from the todolist.
Implements KCal::ResourceCalendar.
Reimplemented in KCal::ResourceLocalDir.
Definition at line 201 of file resourcecached.cpp.
Todo * ResourceCached::todo | ( | const QString & | uid | ) | [virtual] |
Searches todolist for an event with this unique string identifier, returns a pointer or null.
Implements KCal::ResourceCalendar.
Definition at line 217 of file resourcecached.cpp.
Todo::List ResourceCached::rawTodos | ( | TodoSortField | sortField = TodoSortUnsorted , |
|
SortDirection | sortDirection = SortDirectionAscending | |||
) | [virtual] |
Return list of all todos.
Implements KCal::ResourceCalendar.
Definition at line 212 of file resourcecached.cpp.
Todo::List ResourceCached::rawTodosForDate | ( | const QDate & | date | ) | [virtual] |
Returns list of todos due on the specified date.
Implements KCal::ResourceCalendar.
Definition at line 222 of file resourcecached.cpp.
bool ResourceCached::addJournal | ( | Journal * | ) | [virtual] |
Add a Journal entry to calendar.
Implements KCal::ResourceCalendar.
Definition at line 228 of file resourcecached.cpp.
bool ResourceCached::deleteJournal | ( | Journal * | ) | [virtual] |
Remove a Journal from the calendar.
Implements KCal::ResourceCalendar.
Reimplemented in KCal::ResourceLocalDir.
Definition at line 206 of file resourcecached.cpp.
Journal * ResourceCached::journal | ( | const QString & | uid | ) | [virtual] |
Return Journal with given unique id.
Implements KCal::ResourceCalendar.
Definition at line 235 of file resourcecached.cpp.
Journal::List ResourceCached::rawJournals | ( | JournalSortField | sortField = JournalSortUnsorted , |
|
SortDirection | sortDirection = SortDirectionAscending | |||
) | [virtual] |
Return list of all journals.
Implements KCal::ResourceCalendar.
Definition at line 240 of file resourcecached.cpp.
Journal::List ResourceCached::rawJournalsForDate | ( | const QDate & | date | ) | [virtual] |
Return list of journals for the given date.
Implements KCal::ResourceCalendar.
Definition at line 245 of file resourcecached.cpp.
Alarm::List ResourceCached::alarms | ( | const QDateTime & | from, | |
const QDateTime & | to | |||
) | [virtual] |
Return all alarms, which ocur in the given time interval.
Implements KCal::ResourceCalendar.
Definition at line 256 of file resourcecached.cpp.
Alarm::List ResourceCached::alarmsTo | ( | const QDateTime & | to | ) | [virtual] |
Return all alarms, which ocur before given date.
Implements KCal::ResourceCalendar.
Definition at line 251 of file resourcecached.cpp.
void ResourceCached::setTimeZoneId | ( | const QString & | timeZoneId | ) | [virtual] |
Set id of timezone, e.g.
"Europe/Berlin"
Implements KCal::ResourceCalendar.
Definition at line 263 of file resourcecached.cpp.
const Person & KCal::ResourceCached::getOwner | ( | ) | const |
void KCal::ResourceCached::setOwner | ( | const Person & | owner | ) |
Set the owner of the calendar.
Should be owner's full name.
Definition at line 650 of file resourcecached.cpp.
void ResourceCached::loadCache | ( | ) |
Loads the cache, this method should be called on load.
Definition at line 280 of file resourcecached.cpp.
void ResourceCached::saveCache | ( | ) |
void ResourceCached::clearCache | ( | ) |
KPIM::IdMapper & ResourceCached::idMapper | ( | ) |
void ResourceCached::calendarIncidenceAdded | ( | KCal::Incidence * | incidence | ) | [protected, virtual] |
Notify the Observer that an Incidence has been inserted.
First parameter is a pointer to the Incidence that was inserted.
Reimplemented from KCal::Calendar::Observer.
Definition at line 443 of file resourcecached.cpp.
void ResourceCached::calendarIncidenceChanged | ( | KCal::Incidence * | incidence | ) | [protected, virtual] |
Notify the Observer that an Incidence has been modified.
First parameter is a pointer to the Incidence that was modified.
Reimplemented from KCal::Calendar::Observer.
Definition at line 459 of file resourcecached.cpp.
void ResourceCached::calendarIncidenceDeleted | ( | KCal::Incidence * | incidence | ) | [protected, virtual] |
Notify the Observer that an Incidence has been removed.
First parameter is a pointer to the Incidence that was removed.
Reimplemented from KCal::Calendar::Observer.
Definition at line 476 of file resourcecached.cpp.
void ResourceCached::doClose | ( | ) | [protected, virtual] |
Virtual method from KRES::Resource, called when the last instace of the resource is closed.
Definition at line 639 of file resourcecached.cpp.
bool ResourceCached::doOpen | ( | ) | [protected, virtual] |
Opens the resource.
Dummy implementation, so child classes don't have to reimplement this method. By default, this does not do anything, but can be reimplemented in child classes
Definition at line 644 of file resourcecached.cpp.
bool ResourceCached::checkForReload | ( | ) | [protected] |
Check if reload required according to reload policy.
Definition at line 612 of file resourcecached.cpp.
bool ResourceCached::checkForSave | ( | ) | [protected] |
void ResourceCached::addInfoText | ( | QString & | txt | ) | const [protected, virtual] |
Add info text for concrete resources.
Called by infoText().
Reimplemented from KCal::ResourceCalendar.
Definition at line 625 of file resourcecached.cpp.
QString ResourceCached::cacheFile | ( | ) | const [protected, virtual] |
This method is used by loadCache() and saveCache(), reimplement it to change the location of the cache.
Definition at line 381 of file resourcecached.cpp.
QString ResourceCached::changesCacheFile | ( | const QString & | ) | const [protected, virtual] |
The documentation for this class was generated from the following files: