mKCal::SqliteStorage Class Reference

This class provides a calendar storage as an sqlite database. More...

#include <sqlitestorage.h>

Inheritance diagram for mKCal::SqliteStorage:

Public Types
typedef QSharedPointer< SqliteStorage >	Ptr
	A shared pointer to a SqliteStorage.
Public Types inherited from mKCal::ExtendedStorage
enum	DeleteAction { MarkDeleted , PurgeDeleted }
	Action to be performed on save for deleted incidences. More...
typedef QSharedPointer< ExtendedStorage >	Ptr
	A shared pointer to a ExtendedStorage.

Public Slots
void	fileChanged (const QString &path)

Public Member Functions
	SqliteStorage (const ExtendedCalendar::Ptr &cal, const QString &databaseName, bool validateNotebooks=true)
	Constructs a new SqliteStorage object for Calendar calendar with storage to file databaseName.
	SqliteStorage (const ExtendedCalendar::Ptr &cal, bool validateNotebooks=true)
	Constructs a new SqliteStorage object for Calendar calendar.
virtual	~SqliteStorage ()
	Destructor.
QString	databaseName () const
	Returns a string containing the name of the calendar database.
bool	open ()
bool	load ()
bool	load (const QString &uid)
bool	load (const QDate &start, const QDate &end)
bool	loadNotebookIncidences (const QString &notebookUid)
bool	purgeDeletedIncidences (const KCalendarCore::Incidence::List &list, const QString &notebookUid=QString())
bool	save ()
bool	save (ExtendedStorage::DeleteAction deleteAction)
bool	close ()
void	calendarModified (bool modified, KCalendarCore::Calendar *calendar)
void	calendarIncidenceCreated (const KCalendarCore::Incidence::Ptr &incidence)
void	calendarIncidenceAdded (const KCalendarCore::Incidence::Ptr &incidence)
void	calendarIncidenceChanged (const KCalendarCore::Incidence::Ptr &incidence)
void	calendarIncidenceDeleted (const KCalendarCore::Incidence::Ptr &incidence, const KCalendarCore::Calendar *calendar)
void	calendarIncidenceAdditionCanceled (const KCalendarCore::Incidence::Ptr &incidence)
bool	insertedIncidences (KCalendarCore::Incidence::List *list, const QDateTime &after, const QString &notebookUid=QString())
bool	modifiedIncidences (KCalendarCore::Incidence::List *list, const QDateTime &after, const QString &notebookUid=QString())
bool	deletedIncidences (KCalendarCore::Incidence::List *list, const QDateTime &after=QDateTime(), const QString &notebookUid=QString())
bool	allIncidences (KCalendarCore::Incidence::List *list, const QString &notebookUid=QString())
bool	search (const QString &key, QStringList *identifiers, int limit=0)
QDateTime	incidenceDeletedDate (const KCalendarCore::Incidence::Ptr &incidence)
virtual void	virtual_hook (int id, void *data)
Public Member Functions inherited from mKCal::ExtendedStorage
	ExtendedStorage (const ExtendedCalendar::Ptr &cal, bool validateNotebooks=true)
	Constructs a new ExtendedStorage object.
virtual	~ExtendedStorage ()
	Destructor.
ExtendedCalendar::Ptr	calendar () const
bool	loadSeries (const QString &uid)
	Load all incidences sharing the same uid into the memory.
bool	load (const QString &uid, const QDateTime &recurrenceId)
	Load incidence by uid/recid into the memory.
virtual bool	load (const QDate &date)
	Load incidences at given date into the memory.
virtual bool	loadIncidenceInstance (const QString &instanceIdentifier)
	Load the incidence matching the given identifier.
void	registerObserver (ExtendedStorageObserver *observer)
	Registers an Observer for this Storage.
void	unregisterObserver (ExtendedStorageObserver *observer)
	Unregisters an Observer for this Storage.
bool	addNotebook (const Notebook::Ptr &nb)
	Add new notebook to the storage.
bool	updateNotebook (const Notebook::Ptr &nb)
	Update notebook parameters.
bool	deleteNotebook (const Notebook::Ptr &nb)
	Delete notebook from storage.
bool	setDefaultNotebook (const Notebook::Ptr &nb)
	setDefaultNotebook to the storage.
Notebook::Ptr	defaultNotebook ()
	defaultNotebook.
Notebook::Ptr	notebook (const QString &uid) const
	Search for notebook.
Notebook::List	notebooks ()
	List all notebooks.
void	setValidateNotebooks (bool validateNotebooks)
	Determine if notebooks should be validated in saves and loads.
bool	validateNotebooks () const
	Returns true if notebooks should be validated in saves and loads.
bool	isValidNotebook (const QString &notebookUid) const
	Returns true if the given notebook is valid for the storage.
Notebook::Ptr	createDefaultNotebook (QString name=QString(), QString color=QString())
	Creates and sets a default notebook.

Protected Member Functions
bool	loadNotebooks ()
bool	insertNotebook (const Notebook::Ptr &nb)
bool	modifyNotebook (const Notebook::Ptr &nb)
bool	eraseNotebook (const Notebook::Ptr &nb)
Protected Member Functions inherited from mKCal::ExtendedStorage
bool	getLoadDates (const QDate &start, const QDate &end, QDateTime *loadStart, QDateTime *loadEnd) const
void	addLoadedRange (const QDate &start, const QDate &end) const
bool	isRecurrenceLoaded () const
void	setIsRecurrenceLoaded (bool loaded)
void	emitStorageModified (const QString &info)
void	emitStorageFinished (bool error, const QString &info)
void	emitStorageUpdated (const KCalendarCore::Incidence::List &added, const KCalendarCore::Incidence::List &modified, const KCalendarCore::Incidence::List &deleted)

Detailed Description

This class provides a calendar storage as an sqlite database.

Warning

When saving Attendees, the CustomProperties are not saved.

Member Typedef Documentation

Ptr

typedef QSharedPointer<SqliteStorage> mKCal::SqliteStorage::Ptr

A shared pointer to a SqliteStorage.

Constructor & Destructor Documentation

SqliteStorage() [1/2]

SqliteStorage::SqliteStorage ( const ExtendedCalendar::Ptr & cal, const QString & databaseName, bool validateNotebooks = true )

explicit

Constructs a new SqliteStorage object for Calendar calendar with storage to file databaseName.

Private class that helps to provide binary compatibility between releases.

Parameters

calendar	is a pointer to a valid Calendar object.
databaseName	is the name of the database containing the Calendar data.
validateNotebooks	set to true for saving only those incidences that belong to an existing notebook of this storage

SqliteStorage() [2/2]

SqliteStorage::SqliteStorage ( const ExtendedCalendar::Ptr & cal, bool validateNotebooks = true )

explicit

Constructs a new SqliteStorage object for Calendar calendar.

Location of the database is using default location, or is taken from SQLITESTORAGEDB enivronment variable.

Parameters

calendar	is a pointer to a valid Calendar object.
validateNotebooks	set to true for saving only those incidences that belong to an existing notebook of this storage

~SqliteStorage()

SqliteStorage::~SqliteStorage ( )

virtual

Destructor.

Member Function Documentation

allIncidences()

bool SqliteStorage::allIncidences ( KCalendarCore::Incidence::List * list, const QString & notebookUid = QString() )

virtual

ExtendedStorage::allIncidences()

Implements mKCal::ExtendedStorage.

calendarIncidenceAdded()

void SqliteStorage::calendarIncidenceAdded ( const KCalendarCore::Incidence::Ptr & incidence )

virtual

Calendar::CalendarObserver::calendarIncidenceAdded()

Implements mKCal::ExtendedStorage.

calendarIncidenceAdditionCanceled()

void SqliteStorage::calendarIncidenceAdditionCanceled ( const KCalendarCore::Incidence::Ptr & incidence )

virtual

Calendar::CalendarObserver::calendarIncidenceAdditionCanceled()

Implements mKCal::ExtendedStorage.

calendarIncidenceChanged()

void SqliteStorage::calendarIncidenceChanged ( const KCalendarCore::Incidence::Ptr & incidence )

virtual

Calendar::CalendarObserver::calendarIncidenceChanged()

Implements mKCal::ExtendedStorage.

calendarIncidenceCreated()

void mKCal::SqliteStorage::calendarIncidenceCreated

(

const KCalendarCore::Incidence::Ptr &

incidence

)

Calendar::CalendarObserver::calendarIncidenceCreated()

calendarIncidenceDeleted()

void SqliteStorage::calendarIncidenceDeleted ( const KCalendarCore::Incidence::Ptr & incidence, const KCalendarCore::Calendar * calendar )

virtual

Calendar::CalendarObserver::calendarIncidenceDeleted()

Implements mKCal::ExtendedStorage.

calendarModified()

void SqliteStorage::calendarModified ( bool modified, KCalendarCore::Calendar * calendar )

virtual

Calendar::CalendarObserver::calendarModified()

Implements mKCal::ExtendedStorage.

close()

bool SqliteStorage::close ( )

virtual

CalStorage::close()

Reimplemented from mKCal::ExtendedStorage.

databaseName()

QString SqliteStorage::databaseName

(

)

const

Returns a string containing the name of the calendar database.

deletedIncidences()

bool SqliteStorage::deletedIncidences ( KCalendarCore::Incidence::List * list, const QDateTime & after = QDateTime(), const QString & notebookUid = QString() )

virtual

ExtendedStorage::deletedIncidences()

Implements mKCal::ExtendedStorage.

eraseNotebook()

bool SqliteStorage::eraseNotebook ( const Notebook::Ptr & nb )

protectedvirtual

Implements mKCal::ExtendedStorage.

fileChanged

void SqliteStorage::fileChanged ( const QString & path )

slot

incidenceDeletedDate()

QDateTime SqliteStorage::incidenceDeletedDate ( const KCalendarCore::Incidence::Ptr & incidence )

virtual

ExtendedStorage::incidenceDeletedDate()

Implements mKCal::ExtendedStorage.

insertedIncidences()

bool SqliteStorage::insertedIncidences ( KCalendarCore::Incidence::List * list, const QDateTime & after, const QString & notebookUid = QString() )

virtual

ExtendedStorage::insertedIncidences()

Implements mKCal::ExtendedStorage.

insertNotebook()

bool SqliteStorage::insertNotebook ( const Notebook::Ptr & nb )

protectedvirtual

Implements mKCal::ExtendedStorage.

load() [1/3]

bool SqliteStorage::load ( )

virtual

CalStorage::load()

Implements mKCal::ExtendedStorage.

load() [2/3]

bool SqliteStorage::load ( const QDate & start, const QDate & end )

virtual

ExtendedStorage::load(const QDate &, const QDate &)

Implements mKCal::ExtendedStorage.

load() [3/3]

bool SqliteStorage::load ( const QString & uid )

virtual

ExtendedStorage::load(const QString &)

Implements mKCal::ExtendedStorage.

loadNotebookIncidences()

bool SqliteStorage::loadNotebookIncidences ( const QString & notebookUid )

virtual

ExtendedStorage::loadNotebookIncidences(const QString &)

Implements mKCal::ExtendedStorage.

loadNotebooks()

bool SqliteStorage::loadNotebooks ( )

protectedvirtual

Implements mKCal::ExtendedStorage.

modifiedIncidences()

bool SqliteStorage::modifiedIncidences ( KCalendarCore::Incidence::List * list, const QDateTime & after, const QString & notebookUid = QString() )

virtual

ExtendedStorage::modifiedIncidences()

Implements mKCal::ExtendedStorage.

modifyNotebook()

bool SqliteStorage::modifyNotebook ( const Notebook::Ptr & nb )

protectedvirtual

Implements mKCal::ExtendedStorage.

open()

bool SqliteStorage::open ( )

virtual

CalStorage::open()

Implements mKCal::ExtendedStorage.

purgeDeletedIncidences()

bool SqliteStorage::purgeDeletedIncidences ( const KCalendarCore::Incidence::List & list, const QString & notebookUid = QString() )

virtual

ExtendedStorage::purgeDeletedIncidences(const KCalCore::Incidence::List &, const QString &)

Implements mKCal::ExtendedStorage.

save() [1/2]

bool SqliteStorage::save ( )

virtual

CalStorage::save()

Implements mKCal::ExtendedStorage.

save() [2/2]

bool SqliteStorage::save ( ExtendedStorage::DeleteAction deleteAction )

virtual

ExtendedStorage::save(ExtendedStorage::DeleteAction deleteAction)

Implements mKCal::ExtendedStorage.

search()

bool SqliteStorage::search ( const QString & key, QStringList * identifiers, int limit = 0 )

virtual

ExtendedStorage::search()

Implements mKCal::ExtendedStorage.

virtual_hook()

void SqliteStorage::virtual_hook ( int id, void * data )

virtual

ExtendedStorage::virtual_hook()

Implements mKCal::ExtendedStorage.

---

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

• sqlitestorage.h
• sqlitestorage.cpp