• Skip to content
  • Skip to link menu
KDE 4.4 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

 FileStorage (Calendar *calendar, const QString &fileName=QString(), 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 (CalFormat *format)

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 *  calendar,
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.

Definition at line 63 of file filestorage.cpp.

FileStorage::~FileStorage (  )  [virtual]

Destructor.

Definition at line 70 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 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 80 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 101 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 96 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 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 91 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 75 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 85 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
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.1
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