• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KCal Library

KCal::FileStorage

KCal::FileStorage Class Reference

This class provides a calendar storage as a local file. More...

#include <filestorage.h>

Inheritance diagram for KCal::FileStorage:

Inheritance graph
[legend]

List of all members.


Public Member Functions

bool close ()
QString fileName () const
 FileStorage (Calendar *calendar, const QString &fileName=QString(), CalFormat *format=0)
bool load ()
bool open ()
bool save ()
CalFormat * saveFormat () const
void setFileName (const QString &fileName)
void setSaveFormat (CalFormat *format)
virtual ~FileStorage ()

Detailed Description

This class provides a calendar storage as a local file.

Definition at line 43 of file filestorage.h.


Constructor & Destructor Documentation

FileStorage::FileStorage ( Calendar *  cal,
const QString &  fileName = QString(),
CalFormat *  format = 0 
) [explicit]

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

Private class that helps to provide binary compatibility between releases.

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.

For internal use only.

Definition at line 64 of file filestorage.cpp.

FileStorage::~FileStorage (  )  [virtual]

Destructor.

Definition at line 71 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 KCal::CalStorage.

Definition at line 174 of file filestorage.cpp.

QString FileStorage::fileName (  )  const

Returns a string containing the name of the calendar file.

See also:
setFileName().

Definition at line 81 of file filestorage.cpp.

bool FileStorage::load (  )  [virtual]

Loads the calendar into memory.

Returns:
true if the load was successful; false otherwise.

Implements KCal::CalStorage.

Definition at line 102 of file filestorage.cpp.

bool FileStorage::open (  )  [virtual]

Opens the calendar for storage.

Returns:
true if the open was successful; false otherwise.

Implements KCal::CalStorage.

Definition at line 97 of file filestorage.cpp.

bool FileStorage::save (  )  [virtual]

Saves the calendar.

Returns:
true if the save was successful; false otherwise.

Implements KCal::CalStorage.

Definition at line 146 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 92 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 76 of file filestorage.cpp.

void FileStorage::setSaveFormat ( 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 86 of file filestorage.cpp.


The documentation for this class was generated from the following files:
  • filestorage.h
  • filestorage.cpp

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal