KCalCore::FileStorage Class Reference

#include <filestorage.h>

Inheritance diagram for KCalCore::FileStorage:

Public Types
typedef QSharedPointer < FileStorage >	Ptr

Public Member Functions
	FileStorage (const Calendar::Ptr &calendar, const QString &fileName=QString(), KCalCore::CalFormat *format=0)
virtual	~FileStorage ()
bool	close ()
QString	fileName () const
bool	load ()
bool	open ()
bool	save ()
CalFormat *	saveFormat () const
void	setFileName (const QString &fileName)
void	setSaveFormat (KCalCore::CalFormat *format)
Public Member Functions inherited from KCalCore::CalStorage
	CalStorage (const Calendar::Ptr &calendar)
virtual	~CalStorage ()
Calendar::Ptr	calendar () 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 &regExp) 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

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)
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)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

This class provides a calendar storage as a local file.

Definition at line 44 of file filestorage.h.

Member Typedef Documentation

typedef QSharedPointer<FileStorage> KCalCore::FileStorage::Ptr

A shared pointer to a FileStorage.

Definition at line 51 of file filestorage.h.

Constructor & Destructor Documentation

FileStorage::FileStorage ( const Calendar::Ptr &  calendar, const QString &  fileName = QString(), KCalCore::CalFormat *  format = 0  )

explicit

Constructs a new FileStorage object for Calendar calendar with format format, and storage to file fileName.

Parameters

calendar	is a pointer to a valid Calendar object.
fileName	is the name of the disk file containing the calendar data.
format	is a pointer to a valid CalFormat object that specifies the calendar format to be used. FileStorage takes ownership; i.e., the memory for format is deleted by this destructor. If no format is specified, then iCalendar format is assumed.

Definition at line 61 of file filestorage.cpp.

FileStorage::~FileStorage ( )

virtual

Destructor.

Definition at line 68 of file filestorage.cpp.

Member Function Documentation

bool FileStorage::close ( )

virtual

Closes the calendar storage.

Returns

true if the close was successful; false otherwise.

Implements KCalCore::CalStorage.

Definition at line 180 of file filestorage.cpp.

QString FileStorage::fileName

(

)

const

Returns the calendar file name.

Returns

A QString with the name of the calendar file for this storge.

See also

setFileName().

Definition at line 78 of file filestorage.cpp.

bool FileStorage::load ( )

virtual

Loads the calendar into memory.

Returns

true if the load was successful; false otherwise.

Implements KCalCore::CalStorage.

Definition at line 99 of file filestorage.cpp.

bool FileStorage::open ( )

virtual

Opens the calendar for storage.

Returns

true if the open was successful; false otherwise.

Implements KCalCore::CalStorage.

Definition at line 94 of file filestorage.cpp.

bool FileStorage::save ( )

virtual

Saves the calendar.

Returns

true if the save was successful; false otherwise.

Implements KCalCore::CalStorage.

Definition at line 152 of file filestorage.cpp.

CalFormat * FileStorage::saveFormat

(

)

const

Returns the CalFormat object used by this storage.

Returns

A pointer to the CalFormat object used by this storage.

See also

setSaveFormat().

Definition at line 89 of file filestorage.cpp.

void FileStorage::setFileName

(

const QString &

fileName

)

Sets the name of the file that contains the calendar data.

Parameters

fileName

is the name of the disk file containing the calendar data.

See also

fileName().

Definition at line 73 of file filestorage.cpp.

void FileStorage::setSaveFormat

(

KCalCore::CalFormat *

format

)

Sets the CalFormat object to use for this storage.

Parameters

format

is a pointer to a valid CalFormat object that specifies the calendar format to be used. FileStorage takes ownership.

See also

saveFormat().

Definition at line 83 of file filestorage.cpp.

---

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

• filestorage.h
• filestorage.cpp