libkcal

KCal::CalFormat Class Reference

#include <calformat.h>

Inheritance diagram for KCal::CalFormat:

KCal::ICalFormat KCal::QtopiaFormat KCal::VCalFormat List of all members.

Detailed Description

This is the base class for calendar formats.Class providing in interface to a calendar format.

It provides an interface for the generation/interpretation of a textual representation of a calendar.

Definition at line 43 of file calformat.h.


Public Member Functions

 CalFormat ()
virtual ~CalFormat ()
virtual bool load (Calendar *, const QString &fileName)=0
virtual bool save (Calendar *, const QString &fileName)=0
virtual bool fromString (Calendar *, const QString &)=0
virtual QString toString (Calendar *)=0
void clearException ()
ErrorFormatexception ()
const QString & loadedProductId ()
void setException (ErrorFormat *error)

Static Public Member Functions

static void setApplication (const QString &app, const QString &productID)
static const QString & application ()
static const QString & productId ()
static QString createUniqueId ()

Protected Attributes

QString mLoadedProductId

Constructor & Destructor Documentation

CalFormat::CalFormat (  ) 

Constructs a new format.

Definition at line 34 of file calformat.cpp.

CalFormat::~CalFormat (  )  [virtual]

Destruct calendar format.

Definition at line 39 of file calformat.cpp.


Member Function Documentation

static const QString& KCal::CalFormat::application (  )  [inline, static]

Return the application name used in unique IDs and error messages.

Definition at line 85 of file calformat.h.

void CalFormat::clearException (  ) 

Clear exception status of this format object.

Definition at line 44 of file calformat.cpp.

QString CalFormat::createUniqueId (  )  [static]

Create a unique id string.

Definition at line 67 of file calformat.cpp.

ErrorFormat * CalFormat::exception (  ) 

Return exception, if there is any, containing information about the last error that occurred.

Definition at line 56 of file calformat.cpp.

virtual bool KCal::CalFormat::fromString ( Calendar ,
const QString &   
) [pure virtual]

Parse string and populate calendar with that information.

Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.

virtual bool KCal::CalFormat::load ( Calendar ,
const QString &  fileName 
) [pure virtual]

loads a calendar on disk into the calendar associated with this format.

Returns TRUE if successful,else returns FALSE.

Parameters:
fileName the name of the calendar on disk.

Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.

const QString& KCal::CalFormat::loadedProductId (  )  [inline]

Return the PRODID string loaded from calendar file.

Definition at line 89 of file calformat.h.

static const QString& KCal::CalFormat::productId (  )  [inline, static]

Return the PRODID string to write into calendar files.

Definition at line 87 of file calformat.h.

virtual bool KCal::CalFormat::save ( Calendar ,
const QString &  fileName 
) [pure virtual]

writes out the calendar to disk.

Returns true if successful and false on error.

Parameters:
fileName the name of the file

Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.

void CalFormat::setApplication ( const QString &  app,
const QString &  productID 
) [static]

Set the application name for use in unique IDs and error messages, and product ID for incidence PRODID property.

Definition at line 61 of file calformat.cpp.

void CalFormat::setException ( ErrorFormat error  ) 

Set exception for this object.

This is used by the functions of this class to report errors.

Definition at line 50 of file calformat.cpp.

virtual QString KCal::CalFormat::toString ( Calendar  )  [pure virtual]

Return calendar information as string.

Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys