KCalendarCore::FileStorage
#include <filestorage.h>
Public Types | |
typedef QSharedPointer< FileStorage > | Ptr |
Detailed Description
This class provides a calendar storage as a local file.
Definition at line 31 of file filestorage.h.
Member Typedef Documentation
◆ Ptr
A shared pointer to a FileStorage.
Definition at line 38 of file filestorage.h.
Constructor & Destructor Documentation
◆ FileStorage()
|
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 50 of file filestorage.cpp.
◆ ~FileStorage()
|
override |
Destructor.
Definition at line 56 of file filestorage.cpp.
Member Function Documentation
◆ close()
|
overridevirtual |
Closes the calendar storage.
- Returns
- true if the close was successful; false otherwise.
Implements KCalendarCore::CalStorage.
Definition at line 169 of file filestorage.cpp.
◆ fileName()
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 66 of file filestorage.cpp.
◆ load()
|
overridevirtual |
Loads the calendar into memory.
- Returns
- true if the load was successful; false otherwise.
Implements KCalendarCore::CalStorage.
Definition at line 87 of file filestorage.cpp.
◆ open()
|
overridevirtual |
Opens the calendar for storage.
- Returns
- true if the open was successful; false otherwise.
Implements KCalendarCore::CalStorage.
Definition at line 82 of file filestorage.cpp.
◆ save()
|
overridevirtual |
Saves the calendar.
- Returns
- true if the save was successful; false otherwise.
Implements KCalendarCore::CalStorage.
Definition at line 142 of file filestorage.cpp.
◆ saveFormat()
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 77 of file filestorage.cpp.
◆ setFileName()
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 61 of file filestorage.cpp.
◆ setSaveFormat()
void FileStorage::setSaveFormat | ( | KCalendarCore::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 71 of file filestorage.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:13:47 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.