KCal Library
KCal::ResourceCalendar Class Reference
#include <resourcecalendar.h>

Detailed Description
This class provides the interfaces for a calendar resource.It makes use of the kresources framework.
Definition at line 49 of file resourcecalendar.h.
Public Slots | |
virtual void | setSubresourceActive (const QString &resource, bool active) |
virtual bool | removeSubresource (const QString &resource) |
virtual bool | addSubresource (const QString &resource, const QString &parent) |
virtual QString | subresourceType (const QString &resource) |
Signals | |
void | resourceChanged (ResourceCalendar *) |
void | resourceLoaded (ResourceCalendar *) |
void | resourceSaved (ResourceCalendar *) |
void | resourceLoadError (ResourceCalendar *, const QString &error) |
void | resourceSaveError (ResourceCalendar *, const QString &error) |
void | signalSubresourceAdded (ResourceCalendar *, const QString &type, const QString &subresource, const QString &label) |
void | signalSubresourceRemoved (ResourceCalendar *, const QString &, const QString &) |
Public Member Functions | |
ResourceCalendar (const KConfigGroup &group) | |
bool | isResolveConflictSet () const |
void | setResolveConflict (bool b) |
virtual void | writeConfig (KConfigGroup &group) |
virtual QString | infoText () const |
virtual bool | load () |
bool | save (Incidence *incidence=0) |
virtual bool | isSaving () |
void | setInhibitSave (bool inhibit) |
bool | saveInhibited () const |
virtual KABC::Lock * | lock ()=0 |
virtual bool | addIncidence (Incidence *) |
virtual bool | deleteIncidence (Incidence *) |
Incidence * | incidence (const QString &uid) |
virtual bool | addEvent (Event *event)=0 |
virtual bool | deleteEvent (Event *)=0 |
virtual void | deleteAllEvents ()=0 |
virtual Event * | event (const QString &uid)=0 |
virtual Event::List | rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0 |
virtual Event::List | rawEventsForDate (const QDate &date, const KDateTime::Spec ×pec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0 |
virtual Event::List | rawEventsForDate (const KDateTime &dt)=0 |
virtual Event::List | rawEvents (const QDate &start, const QDate &end, const KDateTime::Spec ×pec=KDateTime::Spec(), bool inclusive=false)=0 |
virtual bool | setValue (const QString &key, const QString &value) |
virtual bool | addTodo (Todo *todo)=0 |
virtual bool | deleteTodo (Todo *)=0 |
virtual void | deleteAllTodos ()=0 |
virtual Todo * | todo (const QString &uid)=0 |
virtual Todo::List | rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0 |
virtual Todo::List | rawTodosForDate (const QDate &date)=0 |
virtual bool | addJournal (Journal *)=0 |
virtual bool | deleteJournal (Journal *)=0 |
virtual void | deleteAllJournals ()=0 |
virtual Journal * | journal (const QString &uid)=0 |
virtual Journal::List | rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0 |
virtual Journal::List | rawJournalsForDate (const QDate &date)=0 |
virtual Alarm::List | alarms (const KDateTime &from, const KDateTime &to)=0 |
virtual Alarm::List | alarmsTo (const KDateTime &to)=0 |
Incidence::List | rawIncidences () |
virtual void | setTimeSpec (const KDateTime::Spec &timeSpec)=0 |
virtual KDateTime::Spec | timeSpec () const =0 |
virtual void | setTimeZoneId (const QString &timeZoneId)=0 |
virtual QString | timeZoneId () const =0 |
virtual void | shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)=0 |
virtual QStringList | subresources () const |
virtual bool | canHaveSubresources () const |
virtual bool | subresourceActive (const QString &resource) const |
virtual QString | labelForSubresource (const QString &resource) const |
virtual QString | subresourceIdentifier (Incidence *incidence) |
Protected Member Functions | |
virtual bool | doLoad (bool syncCache)=0 |
virtual bool | doSave (bool syncCache)=0 |
virtual bool | doSave (bool syncCache, Incidence *) |
virtual void | addInfoText (QString &) const |
void | loadError (const QString &errorMessage=QString()) |
void | saveError (const QString &errorMessage=QString()) |
bool | receivedLoadError () const |
void | setReceivedLoadError (bool b) |
bool | receivedSaveError () const |
void | setReceivedSaveError (bool b) |
void | setNoReadOnlyOnLoad (bool noReadOnly) |
bool | noReadOnlyOnLoad () const |
Member Function Documentation
QString ResourceCalendar::infoText | ( | ) | const [virtual] |
Return rich text with info about the resource.
Adds standard info and then calls addInfoText() to add info about concrete resources.
Definition at line 79 of file resourcecalendar.cpp.
bool ResourceCalendar::load | ( | ) | [virtual] |
Load resource data.
After calling this function all data is accessible by calling the incidence/event/todo/etc. accessor functions.
Whether data is actually loaded within this function or the loading is delayed until it is accessed by another function depends on the implementation of the resource.
If loading the data takes significant time, the resource should return cached values if available, and return the results via the resourceChanged signal. When the resource has finished loading, the resourceLoaded() signal is emitted.
Calling this function multiple times should have the same effect as calling it once, given that the data isn't changed between calls.
This function calls doLoad() which has to be reimplented by the resource to do the actual loading.
Reimplemented in KCal::ResourceCached.
Definition at line 156 of file resourcecalendar.cpp.
bool ResourceCalendar::save | ( | Incidence * | incidence = 0 |
) |
Save resource data.
After calling this function it is safe to close the resource without losing data.
Whether data is actually saved within this function or saving is delayed depends on the implementation of the resource.
If saving the data takes significant time, the resource should return from the function, do the saving in the background and notify the end of the save by emitting the signal resourceSaved().
This function calls doSave() which has to be reimplented by the resource to do the actual saving.
- Parameters:
-
incidence if given as 0, doSave() is called to save all incidences, else doSave(incidence) is called to save only the given one
Reimplemented in KCal::ResourceCached.
Definition at line 212 of file resourcecalendar.cpp.
bool ResourceCalendar::isSaving | ( | ) | [virtual] |
Return true if a save operation is still in progress, otherwise return false.
Definition at line 239 of file resourcecalendar.cpp.
void ResourceCalendar::setInhibitSave | ( | bool | inhibit | ) |
Inhibit or allow saves, overriding the save policy set by setSavePolicy().
Inhibiting saves has the same effect as making all resources read-only, except that the inhibit status is not stored in the resource configuration.
- Parameters:
-
inhibit true to inhibit saves, false to allow them
Definition at line 299 of file resourcecalendar.cpp.
bool ResourceCalendar::saveInhibited | ( | ) | const |
Return whether saves have been inhibited by setInhibitSave().
Definition at line 304 of file resourcecalendar.cpp.
virtual KABC::Lock* KCal::ResourceCalendar::lock | ( | ) | [pure virtual] |
Return object for locking the resource.
Implemented in KCal::ResourceLocal, and KCal::ResourceLocalDir.
bool ResourceCalendar::addIncidence | ( | Incidence * | incidence | ) | [virtual] |
bool ResourceCalendar::deleteIncidence | ( | Incidence * | incidence | ) | [virtual] |
Incidence * ResourceCalendar::incidence | ( | const QString & | uid | ) |
Return incidence with given unique id.
If there is no incidence with that uid, return 0.
- Parameters:
-
uid the identifier of the Incidence to look for
Definition at line 100 of file resourcecalendar.cpp.
virtual bool KCal::ResourceCalendar::addEvent | ( | Event * | event | ) | [pure virtual] |
virtual bool KCal::ResourceCalendar::deleteEvent | ( | Event * | ) | [pure virtual] |
virtual void KCal::ResourceCalendar::deleteAllEvents | ( | ) | [pure virtual] |
Removes all Events from the calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
virtual Event* KCal::ResourceCalendar::event | ( | const QString & | uid | ) | [pure virtual] |
virtual Event::List KCal::ResourceCalendar::rawEvents | ( | EventSortField | sortField = EventSortUnsorted , |
|
SortDirection | sortDirection = SortDirectionAscending | |||
) | [pure virtual] |
Return unfiltered list of all events in calendar.
Use with care, this can be a bad idea for server-based calendars.
- Parameters:
-
sortField field used as the sort key for the result list sortDirection direction of sorting according to sortField
Implemented in KCal::ResourceCached.
virtual Event::List KCal::ResourceCalendar::rawEventsForDate | ( | const QDate & | date, | |
const KDateTime::Spec & | timespec = KDateTime::Spec() , |
|||
EventSortField | sortField = EventSortUnsorted , |
|||
SortDirection | sortDirection = SortDirectionAscending | |||
) | [pure virtual] |
Builds and then returns a list of all events that match the date specified.
Useful for dayView, etc. etc.
- Parameters:
-
date date for which to get the events timespec the time specification of the date sortField field used as the sort key for the result list sortDirection direction of sorting according to sortField
Implemented in KCal::ResourceCached.
virtual Event::List KCal::ResourceCalendar::rawEventsForDate | ( | const KDateTime & | dt | ) | [pure virtual] |
virtual Event::List KCal::ResourceCalendar::rawEvents | ( | const QDate & | start, | |
const QDate & | end, | |||
const KDateTime::Spec & | timespec = KDateTime::Spec() , |
|||
bool | inclusive = false | |||
) | [pure virtual] |
Get unfiltered events in a range of dates.
If inclusive is set to true, only events which are completely included in the range are returned.
- Parameters:
-
start date at the begin of the searching range end date at the end of the searching range timeSpec timeSpec of the searching range inclusive if true
, only match events which are completely within the specified range
Implemented in KCal::ResourceCached.
bool ResourceCalendar::setValue | ( | const QString & | key, | |
const QString & | value | |||
) | [virtual] |
Sets a particular value of the resource's configuration.
The possible keys are resource specific.
This method is provided to make it possible to set resource-type specific settings without actually linking to the resource's library. Its use is discouraged, but in some situations the only possibility to avoid unwanted compiling and linking dependencies. E.g. if you don't want to link to the remote resource, but need to create a remote resource at the URL given in yourURL, you can use code like the following: KCal::ResourceCalendar *res = manager->createResource( "remote" ); if ( res ) { res->setTimeZoneId( timezone ); res->setResourceName( i18n("Test resource") ); res->setValue( "DownloadURL", yourURL ); manager->add( res ); }
- Parameters:
-
key the key of the resource configuration option value the value to set for the given option
Reimplemented in KCal::ResourceLocal.
Definition at line 309 of file resourcecalendar.cpp.
void KCal::ResourceCalendar::resourceChanged | ( | ResourceCalendar * | ) | [signal] |
This signal is emitted when the data in the resource has changed.
The resource has to make sure that this signal is emitted whenever any pointers to incidences which the resource has previously given to the calling code, become invalid.
void KCal::ResourceCalendar::resourceLoaded | ( | ResourceCalendar * | ) | [signal] |
This signal is emitted when loading data into the resource has been finished.
void KCal::ResourceCalendar::resourceSaved | ( | ResourceCalendar * | ) | [signal] |
This signal is emitted when saving the data of the resource has been finished.
void KCal::ResourceCalendar::resourceLoadError | ( | ResourceCalendar * | , | |
const QString & | error | |||
) | [signal] |
This signal is emitted when an error occurs during loading.
void KCal::ResourceCalendar::resourceSaveError | ( | ResourceCalendar * | , | |
const QString & | error | |||
) | [signal] |
This signal is emitted when an error occurs during saving.
void KCal::ResourceCalendar::signalSubresourceAdded | ( | ResourceCalendar * | , | |
const QString & | type, | |||
const QString & | subresource, | |||
const QString & | label | |||
) | [signal] |
This signal is emitted when a subresource is added.
void KCal::ResourceCalendar::signalSubresourceRemoved | ( | ResourceCalendar * | , | |
const QString & | , | |||
const QString & | ||||
) | [signal] |
This signal is emitted when a subresource is removed.
virtual bool KCal::ResourceCalendar::addTodo | ( | Todo * | todo | ) | [pure virtual] |
virtual bool KCal::ResourceCalendar::deleteTodo | ( | Todo * | ) | [pure virtual] |
virtual void KCal::ResourceCalendar::deleteAllTodos | ( | ) | [pure virtual] |
Removes all To-dos from the calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
virtual Todo* KCal::ResourceCalendar::todo | ( | const QString & | uid | ) | [pure virtual] |
Searches todolist for an event with this unique id.
- Parameters:
-
uid the identifier of the todo to look for
- Returns:
- pointer to todo or 0 if todo wasn't found
Implemented in KCal::ResourceCached.
virtual Todo::List KCal::ResourceCalendar::rawTodos | ( | TodoSortField | sortField = TodoSortUnsorted , |
|
SortDirection | sortDirection = SortDirectionAscending | |||
) | [pure virtual] |
virtual Todo::List KCal::ResourceCalendar::rawTodosForDate | ( | const QDate & | date | ) | [pure virtual] |
virtual bool KCal::ResourceCalendar::addJournal | ( | Journal * | ) | [pure virtual] |
virtual bool KCal::ResourceCalendar::deleteJournal | ( | Journal * | ) | [pure virtual] |
Remove a Journal entry from calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
virtual void KCal::ResourceCalendar::deleteAllJournals | ( | ) | [pure virtual] |
Removes all Journals from the calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
virtual Journal* KCal::ResourceCalendar::journal | ( | const QString & | uid | ) | [pure virtual] |
virtual Journal::List KCal::ResourceCalendar::rawJournals | ( | JournalSortField | sortField = JournalSortUnsorted , |
|
SortDirection | sortDirection = SortDirectionAscending | |||
) | [pure virtual] |
virtual Journal::List KCal::ResourceCalendar::rawJournalsForDate | ( | const QDate & | date | ) | [pure virtual] |
virtual Alarm::List KCal::ResourceCalendar::alarms | ( | const KDateTime & | from, | |
const KDateTime & | to | |||
) | [pure virtual] |
virtual Alarm::List KCal::ResourceCalendar::alarmsTo | ( | const KDateTime & | to | ) | [pure virtual] |
Incidence::List ResourceCalendar::rawIncidences | ( | ) |
virtual void KCal::ResourceCalendar::setTimeSpec | ( | const KDateTime::Spec & | timeSpec | ) | [pure virtual] |
Sets the default and viewing time specification for the calendar.
- Parameters:
-
timeSpec is the time specification (time zone, etc.) for viewing Incidence dates.
Implemented in KCal::ResourceCached.
virtual KDateTime::Spec KCal::ResourceCalendar::timeSpec | ( | ) | const [pure virtual] |
Get the viewing time specification (time zone etc.
) for the calendar.
- Returns:
- time specification
Implemented in KCal::ResourceCached.
virtual void KCal::ResourceCalendar::setTimeZoneId | ( | const QString & | timeZoneId | ) | [pure virtual] |
Sets the time zone ID for the Calendar.
- Parameters:
-
timeZoneId is a string containing a time zone ID, which is assumed to be valid. The time zone ID is used to set the time zone for viewing Incidence date/times. If no time zone is found, the viewing time specification is set to local clock time. Example: "Europe/Berlin"
Implemented in KCal::ResourceCached.
virtual QString KCal::ResourceCalendar::timeZoneId | ( | ) | const [pure virtual] |
Returns the time zone ID used for creating or modifying incidences in the calendar.
- Returns:
- the string containing the time zone ID, or empty string if the creation/modification time specification is not a time zone.
Implemented in KCal::ResourceCached.
virtual void KCal::ResourceCalendar::shiftTimes | ( | const KDateTime::Spec & | oldSpec, | |
const KDateTime::Spec & | newSpec | |||
) | [pure virtual] |
Shifts the times of all incidences so that they appear at the same clock time as before but in a new time zone.
The shift is done from a viewing time zone rather than from the actual incidence time zone.
For example, shifting an incidence whose start time is 09:00 America/New York, using an old viewing time zone (oldSpec
) of Europe/London, to a new time zone (newSpec
) of Europe/Paris, will result in the time being shifted from 14:00 (which is the London time of the incidence start) to 14:00 Paris time.
- Parameters:
-
oldSpec the time specification which provides the clock times newSpec the new time specification
Implemented in KCal::ResourceCached.
QStringList ResourceCalendar::subresources | ( | ) | const [virtual] |
If this resource has subresources, return a QStringList of them.
In most cases, resources do not have subresources, so this is by default just empty.
Definition at line 261 of file resourcecalendar.cpp.
bool ResourceCalendar::canHaveSubresources | ( | ) | const [virtual] |
Is this resource capable of having subresources or not?
Definition at line 266 of file resourcecalendar.cpp.
bool ResourceCalendar::subresourceActive | ( | const QString & | resource | ) | const [virtual] |
QString ResourceCalendar::labelForSubresource | ( | const QString & | resource | ) | const [virtual] |
QString ResourceCalendar::subresourceIdentifier | ( | Incidence * | incidence | ) | [virtual] |
Get the identifier of the subresource associated with a specified incidence.
- Parameters:
-
incidence the incidence to get the identifier for
- Returns:
- the identifier of the subresource or an empty string.
Definition at line 283 of file resourcecalendar.cpp.
void ResourceCalendar::setSubresourceActive | ( | const QString & | resource, | |
bool | active | |||
) | [virtual, slot] |
bool ResourceCalendar::removeSubresource | ( | const QString & | resource | ) | [virtual, slot] |
Remove a subresource with the id.
- Parameters:
-
resource
Definition at line 137 of file resourcecalendar.cpp.
bool ResourceCalendar::addSubresource | ( | const QString & | resource, | |
const QString & | parent | |||
) | [virtual, slot] |
Add a subresource with the id.
- Parameters:
-
resource and the parent id parent
Definition at line 143 of file resourcecalendar.cpp.
QString ResourceCalendar::subresourceType | ( | const QString & | resource | ) | [virtual, slot] |
Returns the type of the subresource: "event", "todo", or "journal", QString if unknown/mixed.
Definition at line 150 of file resourcecalendar.cpp.
virtual bool KCal::ResourceCalendar::doLoad | ( | bool | syncCache | ) | [protected, pure virtual] |
Do the actual loading of the resource data.
Called by load().
Implemented in KCal::ResourceCached, KCal::ResourceLocal, and KCal::ResourceLocalDir.
virtual bool KCal::ResourceCalendar::doSave | ( | bool | syncCache | ) | [protected, pure virtual] |
Do the actual saving of the resource data.
Called by save().
Implemented in KCal::ResourceCached, KCal::ResourceLocal, and KCal::ResourceLocalDir.
bool ResourceCalendar::doSave | ( | bool | syncCache, | |
Incidence * | incidence | |||
) | [protected, virtual] |
Do the actual saving of the resource data.
Called by save(). Save one Incidence. The default implementation calls doSave() to save everything.
Reimplemented in KCal::ResourceCached, KCal::ResourceLocal, and KCal::ResourceLocalDir.
Definition at line 244 of file resourcecalendar.cpp.
virtual void KCal::ResourceCalendar::addInfoText | ( | QString & | ) | const [inline, protected, virtual] |
Add info text for concrete resources.
Called by infoText().
Reimplemented in KCal::ResourceCached.
Definition at line 494 of file resourcecalendar.h.
void ResourceCalendar::loadError | ( | const QString & | errorMessage = QString() |
) | [protected] |
A resource should call this function if a load error happens.
Definition at line 189 of file resourcecalendar.cpp.
void ResourceCalendar::saveError | ( | const QString & | errorMessage = QString() |
) | [protected] |
A resource should call this function if a save error happens.
Definition at line 249 of file resourcecalendar.cpp.
void ResourceCalendar::setNoReadOnlyOnLoad | ( | bool | noReadOnly | ) | [protected] |
Specify whether individual incidences should be set read-only when a read-only resource is loaded.
- Parameters:
-
noReadOnly true to inhibit setting incidences read-only, false to allow incidences to be set read-only
Definition at line 316 of file resourcecalendar.cpp.
bool ResourceCalendar::noReadOnlyOnLoad | ( | ) | const [protected] |
Return whether individual incidences are inhibited from being set read-only when a read-only resources is loaded.
Definition at line 321 of file resourcecalendar.cpp.
The documentation for this class was generated from the following files: