• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KCal Library

  • KCal
  • FileStorage
Public Member Functions | List of all members
KCal::FileStorage Class Reference

#include <filestorage.h>

Inheritance diagram for KCal::FileStorage:
KCal::CalStorage

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)
 
- Public Member Functions inherited from KCal::CalStorage
 CalStorage (Calendar *calendar)
 
virtual ~CalStorage ()
 
Calendar * calendar () const
 
virtual bool close ()=0
 
virtual bool load ()=0
 
virtual bool open ()=0
 
virtual bool save ()=0
 

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::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
calendaris a pointer to a valid Calendar object.
fileNameis the name of the disk file containing the Calendar data.
formatis 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::~FileStorage ( )
virtual

Destructor.

Definition at line 70 of file filestorage.cpp.

Member Function Documentation

◆ close()

bool FileStorage::close ( )
virtual

CalStorage::close()

Implements KCal::CalStorage.

Definition at line 177 of file filestorage.cpp.

◆ fileName()

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.

◆ load()

bool FileStorage::load ( )
virtual

CalStorage::load()

Implements KCal::CalStorage.

Definition at line 101 of file filestorage.cpp.

◆ open()

bool FileStorage::open ( )
virtual

CalStorage::open()

Implements KCal::CalStorage.

Definition at line 96 of file filestorage.cpp.

◆ save()

bool FileStorage::save ( )
virtual

CalStorage::save()

Implements KCal::CalStorage.

Definition at line 149 of file filestorage.cpp.

◆ saveFormat()

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.

◆ setFileName()

void FileStorage::setFileName ( const QString &  fileName)

Sets the name of the file that contains the calendar data.

Parameters
fileNameis the name of the disk file containing the Calendar data.
See also
fileName().

Definition at line 75 of file filestorage.cpp.

◆ setSaveFormat()

void FileStorage::setSaveFormat ( CalFormat *  format)

Sets the CalFormat object to use for this storage.

Parameters
formatis 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCal Library

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

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal