libkcal
KCal::CalFormat Class Reference
This is the base class for calendar formats. More...
#include <calformat.h>
Public Member Functions | |
| CalFormat () | |
| void | clearException () |
| ErrorFormat * | exception () |
| virtual bool | fromString (Calendar *, const QString &)=0 |
| virtual bool | load (Calendar *, const QString &fileName)=0 |
| const QString & | loadedProductId () |
| virtual bool | save (Calendar *, const QString &fileName)=0 |
| void | setException (ErrorFormat *error) |
| virtual QString | toString (Calendar *)=0 |
| virtual | ~CalFormat () |
Static Public Member Functions | |
| static const QString & | application () |
| static QString | createUniqueId () |
| static const QString & | productId () |
| static void | setApplication (const QString &app, const QString &productID) |
Protected Attributes | |
| QString | mLoadedProductId |
Detailed Description
This is the base class for calendar formats.It provides an interface for the generation/interpretation of a textual representation of a calendar.
Class providing in interface to a calendar format
Definition at line 43 of file calformat.h.
Constructor & Destructor Documentation
| CalFormat::CalFormat | ( | ) |
| CalFormat::~CalFormat | ( | ) | [virtual] |
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 | ( | ) |
| QString CalFormat::createUniqueId | ( | ) | [static] |
| 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.
Parse string and populate calendar with that information.
Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.
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] |
| static const QString& KCal::CalFormat::productId | ( | ) | [inline, static] |
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.
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.
Return calendar information as string.
Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.
Member Data Documentation
QString KCal::CalFormat::mLoadedProductId [protected] |
Definition at line 101 of file calformat.h.
The documentation for this class was generated from the following files:
