libkcal Library API Documentation

KCal::CalFormat Class Reference

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

#include <calformat.h>

Inheritance diagram for KCal::CalFormat:

Inheritance graph
[legend]
Collaboration diagram for KCal::CalFormat:

Collaboration graph
[legend]
List of all members.

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 QStringloadedProductId ()
void setException (ErrorFormat *error)

Static Public Member Functions

static void setApplication (const QString &app, const QString &productID)
static const QStringapplication ()
static const QStringproductId ()
static int calendarVersion (const char *prodId)
static QString createUniqueId ()

Protected Attributes

QString mLoadedProductId

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 42 of file calformat.h.


Constructor & Destructor Documentation

CalFormat::CalFormat  ) 
 

Constructs a new format.

Definition at line 47 of file calformat.cpp.

CalFormat::~CalFormat  )  [virtual]
 

Destruct calendar format.

Definition at line 52 of file calformat.cpp.


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.

Definition at line 57 of file calformat.cpp.

Referenced by KCal::VCalFormat::load(), KCal::QtopiaFormat::load(), KCal::ICalFormat::load(), KCal::ICalFormat::parseFreeBusy(), KCal::ICalFormat::parseScheduleMessage(), KCal::QtopiaFormat::save(), and KCal::ICalFormat::save().

ErrorFormat * CalFormat::exception  ) 
 

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

Definition at line 69 of file calformat.cpp.

Referenced by KCal::ICalFormat::fromString().

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 74 of file calformat.cpp.

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

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

Definition at line 84 of file calformat.h.

Referenced by KCal::Exception::message().

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

Return the PRODID string to write into calendar files.

Definition at line 86 of file calformat.h.

Referenced by KCal::VCalFormat::populate(), KCal::VCalFormat::save(), and KCal::VCalFormat::toString().

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

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

Definition at line 92 of file calformat.cpp.

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

Return the PRODID string loaded from calendar file.

Definition at line 90 of file calformat.h.

QString CalFormat::createUniqueId  )  [static]
 

Create a unique id string.

Definition at line 80 of file calformat.cpp.

Referenced by KCal::Incidence::recreate().

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 63 of file calformat.cpp.

Referenced by KCal::ICalFormat::fromString(), KCal::VCalFormat::load(), KCal::ICalFormat::load(), KCal::ICalFormat::parseScheduleMessage(), KCal::QtopiaFormat::save(), KCal::ICalFormat::save(), and KCal::ICalFormat::toString().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu May 3 20:18:08 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003