KCal Library
#include <resourcecalendar.h>
Public Slots | |
virtual bool | addSubresource (const QString &resource, const QString &parent) |
virtual bool | removeSubresource (const QString &resource) |
virtual void | setSubresourceActive (const QString &resource, bool active) |
virtual QString | subresourceType (const QString &resource) |
Signals | |
void | resourceChanged (ResourceCalendar *) |
void | resourceLoaded (ResourceCalendar *) |
void | resourceLoadError (ResourceCalendar *, const QString &error) |
void | resourceSaved (ResourceCalendar *) |
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) | |
virtual bool | addEvent (Event *event)=0 |
virtual bool | addIncidence (Incidence *) |
virtual bool | addJournal (Journal *)=0 |
virtual bool | addTodo (Todo *todo)=0 |
virtual Alarm::List | alarms (const KDateTime &from, const KDateTime &to)=0 |
virtual Alarm::List | alarmsTo (const KDateTime &to)=0 |
virtual bool | canHaveSubresources () const |
virtual void | deleteAllEvents ()=0 |
virtual void | deleteAllJournals ()=0 |
virtual void | deleteAllTodos ()=0 |
virtual bool | deleteEvent (Event *)=0 |
virtual bool | deleteIncidence (Incidence *) |
virtual bool | deleteJournal (Journal *)=0 |
virtual bool | deleteTodo (Todo *)=0 |
virtual Event * | event (const QString &uid)=0 |
Incidence * | incidence (const QString &uid) |
virtual QString | infoText () const |
bool | isResolveConflictSet () const |
virtual bool | isSaving () |
virtual Journal * | journal (const QString &uid)=0 |
virtual QString | labelForSubresource (const QString &resource) const |
virtual bool | load () |
virtual KABC::Lock * | lock ()=0 |
virtual Event::List | rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0 |
virtual Event::List | rawEvents (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)=0 |
virtual Event::List | rawEventsForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0 |
virtual Event::List | rawEventsForDate (const KDateTime &dt)=0 |
Incidence::List | rawIncidences () |
virtual Journal::List | rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0 |
virtual Journal::List | rawJournalsForDate (const QDate &date)=0 |
virtual Todo::List | rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0 |
virtual Todo::List | rawTodosForDate (const QDate &date)=0 |
bool | save (Incidence *incidence=0) |
bool | save (QString &err, Incidence *incidence=0) |
bool | saveInhibited () const |
void | setInhibitSave (bool inhibit) |
void | setResolveConflict (bool b) |
virtual void | setTimeSpec (const KDateTime::Spec &timeSpec)=0 |
virtual void | setTimeZoneId (const QString &timeZoneId)=0 |
virtual bool | setValue (const QString &key, const QString &value) |
virtual void | shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)=0 |
virtual bool | subresourceActive (const QString &resource) const |
virtual QString | subresourceIdentifier (Incidence *incidence) |
virtual QStringList | subresources () const |
virtual KDateTime::Spec | timeSpec () const =0 |
virtual QString | timeZoneId () const =0 |
virtual Todo * | todo (const QString &uid)=0 |
virtual void | writeConfig (KConfigGroup &group) |
Public Member Functions inherited from KRES::Resource | |
Resource (const KConfigGroup &group) | |
void | close () |
virtual void | dump () const |
QString | identifier () const |
bool | isActive () const |
bool | isOpen () const |
bool | open () |
virtual bool | readOnly () const |
virtual QString | resourceName () const |
void | setActive (bool active) |
void | setIdentifier (const QString &identifier) |
virtual void | setReadOnly (bool value) |
virtual void | setResourceName (const QString &name) |
void | setType (const QString &type) |
QString | type () const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
bool | blockSignals (bool block) |
QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
const QObjectList & | children () const |
const char * | className () const |
bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const QObject *receiver, const char *method) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
void | dumpObjectInfo () |
void | dumpObjectTree () |
QList< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) const |
QList< T > | findChildren (const QString &name) const |
bool | inherits (const char *className) const |
void | insertChild (QObject *object) |
void | installEventFilter (QObject *filterObj) |
bool | isA (const char *className) const |
bool | isWidgetType () const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () const |
QVariant | property (const char *name) const |
void | removeChild (QObject *object) |
void | removeEventFilter (QObject *obj) |
void | setName (const char *name) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const |
int | startTimer (int interval) |
QThread * | thread () const |
Protected Member Functions | |
virtual void | addInfoText (QString &) const |
virtual bool | doLoad (bool syncCache)=0 |
virtual bool | doSave (bool syncCache)=0 |
virtual bool | doSave (bool syncCache, Incidence *) |
void | loadError (const QString &errorMessage=QString()) |
bool | noReadOnlyOnLoad () const |
bool | receivedLoadError () const |
bool | receivedSaveError () const |
void | saveError (const QString &errorMessage=QString()) |
void | setNoReadOnlyOnLoad (bool noReadOnly) |
void | setReceivedLoadError (bool b) |
void | setReceivedSaveError (bool b) |
Protected Member Functions inherited from KRES::Resource | |
virtual void | doClose () |
virtual bool | doOpen () |
Protected Member Functions inherited from QObject | |
bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const char *signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const char *signal) |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Additional Inherited Members | |
Static Public Member Functions inherited from QObject | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Properties inherited from QObject | |
objectName | |
Detailed Description
This class provides the interfaces for a calendar resource.
It makes use of the kresources framework.
Definition at line 50 of file resourcecalendar.h.
Member Function Documentation
|
pure virtual |
Add event to resource.
Implemented in KCal::ResourceCached.
|
virtual |
Add incidence to resource.
Definition at line 115 of file resourcecalendar.cpp.
|
inlineprotectedvirtual |
Add info text for concrete resources.
Called by infoText().
Reimplemented in KCal::ResourceCached.
Definition at line 506 of file resourcecalendar.h.
|
pure virtual |
Add a Journal entry to the resource.
Implemented in KCal::ResourceCached.
|
virtualslot |
Add a subresource with the id.
- Parameters
-
resource and the parent id parent
Definition at line 142 of file resourcecalendar.cpp.
|
pure virtual |
Add a todo to the todolist.
Implemented in KCal::ResourceCached.
|
pure virtual |
Return all alarms which occur in the given time interval.
Implemented in KCal::ResourceCached.
|
pure virtual |
Return all alarms which occur before given date.
Implemented in KCal::ResourceCached.
|
virtual |
Is this resource capable of having subresources or not?
Definition at line 275 of file resourcecalendar.cpp.
|
pure virtual |
Removes all Events from the calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
|
pure virtual |
Removes all Journals from the calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
|
pure virtual |
Removes all To-dos from the calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
|
pure virtual |
Delete event from this resource.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
|
virtual |
Delete incidence from resource.
Definition at line 121 of file resourcecalendar.cpp.
|
pure virtual |
Remove a Journal entry from calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
|
pure virtual |
Remove a todo from the todolist.
Implemented in KCal::ResourceCached, and KCal::ResourceLocalDir.
|
protectedpure virtual |
Do the actual loading of the resource data.
Called by load().
Implemented in KCal::ResourceCached, KCal::ResourceLocal, and KCal::ResourceLocalDir.
|
protectedpure virtual |
Do the actual saving of the resource data.
Called by save().
Implemented in KCal::ResourceCached, KCal::ResourceLocal, and KCal::ResourceLocalDir.
|
protectedvirtual |
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 251 of file resourcecalendar.cpp.
Retrieves an event on the basis of the unique string ID.
Implemented in KCal::ResourceCached.
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 99 of file resourcecalendar.cpp.
|
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 78 of file resourcecalendar.cpp.
|
virtual |
Return true if a save operation is still in progress, otherwise return false.
Definition at line 246 of file resourcecalendar.cpp.
Return Journal with given unique id.
Implemented in KCal::ResourceCached.
What is the label for this subresource?
Definition at line 286 of file resourcecalendar.cpp.
|
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 155 of file resourcecalendar.cpp.
A resource should call this function if a load error happens.
Definition at line 188 of file resourcecalendar.cpp.
|
pure virtual |
Return object for locking the resource.
Implemented in KCal::ResourceLocal, and KCal::ResourceLocalDir.
|
protected |
Return whether individual incidences are inhibited from being set read-only when a read-only resources is loaded.
Definition at line 330 of file resourcecalendar.cpp.
|
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.
|
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.
|
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.
|
pure virtual |
Get unfiltered events for date dt.
Implemented in KCal::ResourceCached.
Incidence::List ResourceCalendar::rawIncidences | ( | ) |
Returns a list of all incideces.
Definition at line 127 of file resourcecalendar.cpp.
|
pure virtual |
Return list of all journals.
Implemented in KCal::ResourceCached.
|
pure virtual |
Returns list of journals for the given date.
Implemented in KCal::ResourceCached.
|
pure virtual |
Return list of all todos.
Implemented in KCal::ResourceCached.
|
pure virtual |
Returns list of todos due on the specified date.
Implemented in KCal::ResourceCached.
|
virtualslot |
Remove a subresource with the id.
- Parameters
-
resource
Definition at line 136 of file resourcecalendar.cpp.
|
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.
|
signal |
This signal is emitted when loading data into the resource has been finished.
|
signal |
This signal is emitted when an error occurs during loading.
|
signal |
This signal is emitted when saving the data of the resource has been finished.
|
signal |
This signal is emitted when an error occurs during saving.
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.
Definition at line 211 of file resourcecalendar.cpp.
Save resource data and deliver error message.
This function calls save() and delivers the latest error msg.
- Parameters
-
err reference QString to hand over the error msg to the caller. incidence if given as 0, doSave() is called to save all incidences, else doSave(incidence) is called to save only the given one.
Definition at line 238 of file resourcecalendar.cpp.
A resource should call this function if a save error happens.
Definition at line 257 of file resourcecalendar.cpp.
bool ResourceCalendar::saveInhibited | ( | ) | const |
Return whether saves have been inhibited by setInhibitSave().
Definition at line 313 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 308 of file resourcecalendar.cpp.
|
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 325 of file resourcecalendar.cpp.
|
virtualslot |
(De-)activate a subresource.
Definition at line 132 of file resourcecalendar.cpp.
|
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.
|
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.
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 318 of file resourcecalendar.cpp.
|
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.
|
signal |
This signal is emitted when a subresource is added.
|
signal |
This signal is emitted when a subresource is removed.
|
virtual |
Is this subresource active or not?
Definition at line 280 of file resourcecalendar.cpp.
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 292 of file resourcecalendar.cpp.
|
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 270 of file resourcecalendar.cpp.
Returns the type of the subresource: "event", "todo", or "journal", QString if unknown/mixed.
Definition at line 149 of file resourcecalendar.cpp.
|
pure virtual |
Get the viewing time specification (time zone etc.) for the calendar.
- Returns
- time specification
Implemented in KCal::ResourceCached.
|
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.
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.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:30 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.