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

KCalCore Library

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

#include <filestorage.h>

Inheritance diagram for KCalCore::FileStorage:
KCalCore::CalStorage

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)
 
- Public Member Functions inherited from KCalCore::CalStorage
 CalStorage (const Calendar::Ptr &calendar)
 
virtual ~CalStorage ()
 
Calendar::Ptr calendar () const
 

Detailed Description

This class provides a calendar storage as a local file.

Definition at line 44 of file filestorage.h.

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
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 59 of file filestorage.cpp.

FileStorage::~FileStorage ( )
virtual

Destructor.

Definition at line 66 of file filestorage.cpp.

Member Function Documentation

bool FileStorage::close ( )
virtual

Returns
true if the close was successful; false otherwise.

Implements KCalCore::CalStorage.

Definition at line 172 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

Returns
true if the load was successful; false otherwise.

Implements KCalCore::CalStorage.

Definition at line 97 of file filestorage.cpp.

bool FileStorage::open ( )
virtual

Returns
true if the open was successful; false otherwise.

Implements KCalCore::CalStorage.

Definition at line 92 of file filestorage.cpp.

bool FileStorage::save ( )
virtual

Returns
true if the save was successful; false otherwise.

Implements KCalCore::CalStorage.

Definition at line 144 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
fileNameis 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
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 81 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-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:24:54 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalCore Library

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

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 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