KCal::ResourceCalendar Class Reference
This class provides the interfaces for a calendar resource. More...
#include <resourcecalendar.h>
Inherits Resource.
Inherited by KCal::ResourceCached, and KCal::ResourceKABC.
Public Slots
- virtual void setSubresourceActive (const QString &, bool active)
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 KConfig *)
- void setResolveConflict (bool b)
- virtual void writeConfig (KConfig *config)
- virtual QString infoText () const
- bool load ()
- bool save (Incidence *incidence=0)
- virtual bool isSaving ()
- 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 void deleteEvent (Event *)=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, bool sorted=false)=0
- virtual Event::List rawEventsForDate (const QDateTime &qdt)=0
- virtual Event::List rawEvents (const QDate &start, const QDate &end, bool inclusive=false)=0
- virtual bool addTodo (Todo *todo)=0
- virtual void deleteTodo (Todo *)=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 void deleteJournal (Journal *)=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 QDateTime &from, const QDateTime &to)=0
- virtual Alarm::List alarmsTo (const QDateTime &to)=0
- Incidence::List rawIncidences ()
- virtual void setTimeZoneId (const QString &tzid)=0
- virtual QStringList subresources () const
- virtual bool subresourceActive (const QString &) const
- virtual const QString labelForSubresource (const QString &resource) const
Protected Member Functions
- virtual bool doLoad ()=0
- virtual bool doSave ()=0
- virtual bool doSave (Incidence *)
- virtual void addInfoText (QString &) const
- void loadError (const QString &errorMessage=QString::null)
- void saveError (const QString &errorMessage=QString::null)
Protected Attributes
Detailed Description
This class provides the interfaces for a calendar resource.It makes use of the kresources framework.
- Warning:
- This code is still under heavy development. Don't expect source or binary compatibility in future versions.
Member Function Documentation
|
Return rich text with info about the resource. Adds standard info and then calls addInfoText() to add info about concrete resources. |
|
Load resource data. After calling this function all data is accessible by calling the incidence/event/todo/etc. accessor functions. If 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. |
|
Save resource data. After calling this function it is safe to close the resource without losing data. If 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.
|
|
Return true if a save operation is still in progress, otherwise return false.
Reimplemented in KCal::ResourceKABC. |
|
Return object for locking the resource.
Implemented in KCal::ResourceKABC, and KCal::ResourceLocal. |
|
Add incidence to resource.
|
|
Delete incidence from resource.
|
|
Return incidence with given unique id. If there is no incidence with that uid, return 0. |
|
Add event to resource.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Delete event from this resource.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Retrieves an event on the basis of the unique string ID.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Return unfiltered list of all events in calendar. Use with care, this can be a bad idea for server-based calendars. Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Builds and then returns a list of all events that match for the date specified. useful for dayView, etc. etc. Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Get unfiltered events for date qdt.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
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. Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
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 become invalid the resource has given to the calling code before. |
|
This signal is emitted when loading data into the resource has been finished.
|
|
This signal is emitted when saving the data of the resource has been finished.
|
|
This signal is emitted when an error occurs during loading.
|
|
This signal is emitted when an error occurs during saving.
|
|
This signal is emitted when a subresource is added.
|
|
This signal is emitted when a subresource is removed.
|
|
Add a todo to the todolist.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Remove a todo from the todolist.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Searches todolist for an event with this unique id.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Return list of all todos.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Returns list of todos due on the specified date.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Add a Journal entry to resource.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Remove a Journal entry from calendar.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Return Journal with given unique id.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Return list of all journals.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Returns list of journals for the given date.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Return all alarms, which ocur in the given time interval.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Return all alarms, which ocur before given date.
Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
Returns a list of all incideces.
|
|
Set time zone id used by this resource, e.g. "Europe/Berlin". Implemented in KCal::ResourceCached, and KCal::ResourceKABC. |
|
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. |
|
Is this subresource active or not?
|
|
What is the label for this subresource?
|
|
(De-)activate a subresource.
|
|
Do the actual loading of the resource data. Called by load(). Implemented in KCal::ResourceKABC, and KCal::ResourceLocal. |
|
Do the actual saving of the resource data. Called by save(). Implemented in KCal::ResourceKABC, and KCal::ResourceLocal. |
|
Do the actual saving of the resource data. Called by save(). Save one Incidence. The default implementation calls doSave() to save everything |
|
Add info text for concrete resources. Called by infoText(). Reimplemented in KCal::ResourceCached. |
|
A resource should call this function if a load error happens.
|
|
A resource should call this function if a save error happens.
|
The documentation for this class was generated from the following files:
- resourcecalendar.h
- resourcecalendar.cpp