KDE PIM / Developers / API Docs / libkcal
KCal::CalFormat

KCal::CalFormat Class Reference

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

#include <calformat.h>

Inherited by KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.

List of all members.

Public Member Functions

Static Public Member Functions

Protected Attributes

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.

Constructor & Destructor Documentation

CalFormat::CalFormat (   ) 
 

Constructs a new format.

CalFormat::~CalFormat (   )  [virtual]
 

Destruct calendar format.

Member Function Documentation

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.

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.

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 QString KCal::CalFormat::toString (  Calendar *   )  [pure virtual]
 

Return calendar information as string.

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

void CalFormat::clearException (   ) 
 

Clear exception status of this format object.

ErrorFormat * CalFormat::exception (   ) 
 

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

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.

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

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

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

Return the PRODID string to write into calendar files.

int CalFormat::calendarVersion (  const char *  prodId  )  [static]
 

Return the KDE calendar format version indicated by a PRODID property.

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

Return the PRODID string loaded from calendar file.

QString CalFormat::createUniqueId (   )  [static]
 

Create a unique id string.

void CalFormat::setException (  ErrorFormat *  error  ) 
 

Set exception for this object.

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

The documentation for this class was generated from the following files: