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.
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 ()
- ErrorFormat * exception ()
- 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 int calendarVersion (const char *prodId)
- static QString createUniqueId ()
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
|
Constructs a new format.
|
|
Destruct calendar format.
|
Member Function Documentation
|
loads a calendar on disk into the calendar associated with this format. Returns TRUE if successful,else returns FALSE.
Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat. |
|
writes out the calendar to disk. Returns true if successful and false on error.
Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat. |
|
Parse string and populate calendar with that information.
Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat. |
|
Return calendar information as string.
Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat. |
|
Clear exception status of this format object.
|
|
Return exception, if there is any, containing information about the last error that occurred.
|
|
Set the application name for use in unique IDs and error messages, and product ID for incidence PRODID property.
|
|
Return the application name used in unique IDs and error messages.
|
|
Return the PRODID string to write into calendar files.
|
|
Return the KDE calendar format version indicated by a PRODID property.
|
|
Return the PRODID string loaded from calendar file.
|
|
Create a unique id string.
|
|
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:
- calformat.h
- calformat.cpp