KCal::ResourceLocalDir Class Reference

#include <resourcelocaldir.h>

Inheritance diagram for KCal::ResourceLocalDir:

Public Member Functions
	ResourceLocalDir (const KConfigGroup &group)
	ResourceLocalDir (const QString &fileName)
void	deleteAllEvents ()
void	deleteAllJournals ()
void	deleteAllTodos ()
bool	deleteEvent (Event *event)
bool	deleteJournal (Journal *journal)
bool	deleteTodo (Todo *todo)
void	dump () const
KABC::Lock *	lock ()
void	readConfig (const KConfigGroup &group)
void	writeConfig (KConfigGroup &group)
Public Member Functions inherited from KCal::ResourceCached
	ResourceCached (const KConfigGroup &group)
Incidence::List	addedIncidences () const
bool	addEvent (Event *event)
virtual KCAL_DEPRECATED bool	addJournal (Journal *journal)
bool	addTodo (Todo *todo)
Alarm::List	alarms (const KDateTime &from, const KDateTime &to)
Alarm::List	alarmsTo (const KDateTime &to)
Incidence::List	allChanges () const
Incidence::List	changedIncidences () const
void	cleanUpEventCache (const KCal::Event::List &eventList)
void	cleanUpTodoCache (const KCal::Todo::List &todoList)
void	clearCache ()
void	clearChange (Incidence *incidence)
void	clearChange (const QString &uid)
void	clearChanges ()
bool	defaultReloadInhibited () const
Incidence::List	deletedIncidences () const
void	disableChangeNotification ()
void	enableChangeNotification ()
Event *	event (const QString &UniqueStr)
Event::List	events ()
bool	hasChanges () const
KRES::IdMapper &	idMapper ()
bool	inhibitDefaultReload (bool inhibit)
virtual Journal *	journal (const QString &uid)
KDateTime	lastLoad () const
KDateTime	lastSave () const
bool	load (CacheAction action)
virtual bool	load ()
bool	loadFromCache ()
Person	owner () const
Event::List	rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Event::List	rawEvents (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)
Event::List	rawEventsForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Event::List	rawEventsForDate (const KDateTime &dt)
Journal::List	rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Journal::List	rawJournalsForDate (const QDate &date)
Todo::List	rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Todo::List	rawTodosForDate (const QDate &date)
void	readConfig (const KConfigGroup &group)
bool	reloaded () const
int	reloadInterval () const
int	reloadPolicy () const
bool	save (CacheAction action, Incidence *incidence=0)
virtual bool	save (Incidence *incidence=0)
int	saveInterval () const
int	savePolicy () const
void	saveToCache ()
void	setOwner (const Person &owner)
void	setReloadInterval (int minutes)
void	setReloadPolicy (int policy)
void	setSaveInterval (int minutes)
void	setSavePolicy (int policy)
void	setTimeSpec (const KDateTime::Spec &timeSpec)
void	setTimeZoneId (const QString &timeZoneId)
virtual void	shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
KDateTime::Spec	timeSpec () const
QString	timeZoneId () const
Todo *	todo (const QString &uid)
Public Member Functions inherited from KCal::ResourceCalendar
	ResourceCalendar (const KConfigGroup &group)
virtual bool	addIncidence (Incidence *)
virtual bool	canHaveSubresources () const
virtual bool	deleteIncidence (Incidence *)
Incidence *	incidence (const QString &uid)
virtual QString	infoText () const
bool	isResolveConflictSet () const
virtual bool	isSaving ()
virtual QString	labelForSubresource (const QString &resource) const
Incidence::List	rawIncidences ()
bool	save (Incidence *incidence=0)
bool	save (QString &err, Incidence *incidence=0)
bool	saveInhibited () const
void	setInhibitSave (bool inhibit)
void	setResolveConflict (bool b)
virtual bool	setValue (const QString &key, const QString &value)
virtual bool	subresourceActive (const QString &resource) const
virtual QString	subresourceIdentifier (Incidence *incidence)
virtual QStringList	subresources () const
Public Member Functions inherited from KRES::Resource
	Resource (const KConfigGroup &group)
void	close ()
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 KCal::Calendar::CalendarObserver
virtual	~CalendarObserver ()
virtual void	calendarModified (bool modified, Calendar *calendar)

Protected Slots
void	reload (const QString &file)
Protected Slots inherited from KCal::ResourceCached
void	setIdMapperIdentifier ()
void	slotReload ()
void	slotSave ()

Protected Member Functions
virtual bool	doFileLoad (CalendarLocal &cal, const QString &fileName)
virtual bool	doLoad (bool syncCache)
bool	doOpen ()
virtual bool	doSave (bool syncCache)
bool	doSave (bool syncCache, Incidence *incidence)
Protected Member Functions inherited from KCal::ResourceCached
void	addInfoText (QString &) const
virtual QString	cacheFile () const
CalendarLocal *	calendar () const
void	calendarIncidenceAdded (KCal::Incidence *incidence)
void	calendarIncidenceChanged (KCal::Incidence *incidence)
void	calendarIncidenceDeleted (KCal::Incidence *incidence)
virtual QString	changesCacheFile (const QString &type) const
void	checkForAutomaticSave ()
bool	checkForReload ()
bool	checkForSave ()
virtual void	doClose ()
void	loadChangesCache (QMap< Incidence *, bool > &map, const QString &type)
void	loadChangesCache ()
void	saveChangesCache (const QMap< Incidence *, bool > &map, const QString &type)
void	saveChangesCache ()
void	setReloaded (bool done)
void	setupReloadTimer ()
void	setupSaveTimer ()
Protected Member Functions inherited from KCal::ResourceCalendar
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)

Additional Inherited Members
Public Types inherited from KCal::ResourceCached
enum	{ ReloadNever, ReloadOnStartup, ReloadInterval }
enum	{   SaveNever, SaveOnExit, SaveInterval, SaveDelayed,   SaveAlways }
enum	CacheAction { DefaultCache, NoSyncCache, SyncCache }
Public Slots inherited from KCal::ResourceCalendar
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 inherited from KCal::ResourceCalendar
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 &)

Detailed Description

This class provides a calendar stored as a file per incidence in a directory.

Definition at line 33 of file resourcelocaldir.h.

Member Function Documentation

void ResourceLocalDir::deleteAllEvents ( )

virtual

Removes all Events from this calendar.

Reimplemented from KCal::ResourceCached.

Definition at line 240 of file resourcelocaldir.cpp.

void ResourceLocalDir::deleteAllJournals ( )

virtual

Removes all journals from this calendar.

Reimplemented from KCal::ResourceCached.

Definition at line 278 of file resourcelocaldir.cpp.

void ResourceLocalDir::deleteAllTodos ( )

virtual

Removes all todos from this calendar.

Reimplemented from KCal::ResourceCached.

Definition at line 259 of file resourcelocaldir.cpp.

bool ResourceLocalDir::deleteEvent ( Event *  event )

virtual

deletes an event from this calendar.

Reimplemented from KCal::ResourceCached.

Definition at line 225 of file resourcelocaldir.cpp.

bool ResourceLocalDir::deleteJournal ( Journal *  journal )

virtual

Remove a journal from the journallist.

Reimplemented from KCal::ResourceCached.

Definition at line 264 of file resourcelocaldir.cpp.

bool ResourceLocalDir::deleteTodo ( Todo *  todo )

virtual

Remove a todo from the todolist.

Reimplemented from KCal::ResourceCached.

Definition at line 245 of file resourcelocaldir.cpp.

bool ResourceLocalDir::doLoad ( bool  syncCache )

protectedvirtual

Do the actual loading of the resource data.

Called by load(CacheAction).

Implements KCal::ResourceCached.

Definition at line 126 of file resourcelocaldir.cpp.

bool ResourceLocalDir::doOpen ( )

protectedvirtual

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

Reimplemented from KCal::ResourceCached.

Definition at line 119 of file resourcelocaldir.cpp.

bool ResourceLocalDir::doSave ( bool  syncCache )

protectedvirtual

Do the actual saving of the resource data.

Called by save(CacheAction). Saves the resource data to the cache and optionally uploads (if a remote resource).

Parameters

syncCache

if true, the cache will be uploaded to the remote resource. If false, only the cache will be updated.

Implements KCal::ResourceCached.

Definition at line 176 of file resourcelocaldir.cpp.

bool ResourceLocalDir::doSave ( bool  syncCache, Incidence *  incidence  )

protectedvirtual

Do the actual saving of the resource data.

Called by save(CacheAction). Save one Incidence. The default implementation calls doSave(bool) to save everything.

Parameters

syncCache	if true, the cache will be uploaded to the remote resource. If false, only the cache will be updated
incidence	The incidence to be saved.

Reimplemented from KCal::ResourceCached.

Definition at line 194 of file resourcelocaldir.cpp.

KABC::Lock * ResourceLocalDir::lock ( )

virtual

Return object for locking the resource.

Implements KCal::ResourceCalendar.

Definition at line 215 of file resourcelocaldir.cpp.

---

The documentation for this class was generated from the following files:

• resourcelocaldir.h
• resourcelocaldir.cpp