KCalCore Library
#include <filestorage.h>

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) |
Detailed Description
This class provides a calendar storage as a local file.
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 59 of file filestorage.cpp.
FileStorage::~FileStorage | ( | ) | [virtual] |
Destructor.
Definition at line 66 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 173 of file filestorage.cpp.
QString FileStorage::fileName | ( | ) | const |
Returns a string containing the name of the calendar file.
- See also:
- setFileName().
Definition at line 76 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 97 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 92 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 145 of file filestorage.cpp.
CalFormat * FileStorage::saveFormat | ( | ) | const |
Returns a pointer to the CalFormat object used by this storage.
- See also:
- setSaveFormat().
Definition at line 87 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 71 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 81 of file filestorage.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon May 14 2012 04:35:43 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.