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

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