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:

Public Member Functions | |
CalFormat () | |
Constructs a new format. | |
virtual | ~CalFormat () |
Destruct calendar format. | |
virtual bool | load (Calendar *, const QString &fileName)=0 |
loads a calendar on disk into the calendar associated with this format. | |
virtual bool | save (Calendar *, const QString &fileName)=0 |
writes out the calendar to disk. | |
virtual bool | fromString (Calendar *, const QString &)=0 |
Parse string and populate calendar with that information. | |
virtual QString | toString (Calendar *)=0 |
Return calendar information as string. | |
void | clearException () |
Clear exception status of this format object. | |
ErrorFormat * | exception () |
Return exception, if there is any, containing information about the last error that occured. | |
const QString & | loadedProductId () |
Return the PRODID string loaded from calendar file. | |
void | setException (ErrorFormat *error) |
Set exception for this object. | |
Static Public Member Functions | |
void | setApplication (const QString &app, const QString &productID) |
Set the application name for use in unique IDs and error messages, and product ID for incidence PRODID property. | |
const QString & | application () |
Return the application name used in unique IDs and error messages. | |
const QString & | productId () |
Return the PRODID string to write into calendar files. | |
int | calendarVersion (const char *prodId) |
Return the KDE calendar format version indicated by a PRODID property. | |
QString | createUniqueId () |
Create a unique id string. | |
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 41 of file calformat.h.
Constructor & Destructor Documentation
|
Constructs a new format.
Definition at line 46 of file calformat.cpp. |
|
Destruct calendar format.
Definition at line 51 of file calformat.cpp. |
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, and KCal::VCalFormat. |
|
writes out the calendar to disk. Returns true if successful and false on error.
Implemented in KCal::ICalFormat, and KCal::VCalFormat. |
|
Parse string and populate calendar with that information.
Implemented in KCal::ICalFormat, and KCal::VCalFormat. |
|
Return calendar information as string.
Implemented in KCal::ICalFormat, and KCal::VCalFormat. |
|
Clear exception status of this format object.
Definition at line 56 of file calformat.cpp. Referenced by KCal::VCalFormat::load(), KCal::ICalFormat::load(), KCal::ICalFormat::parseScheduleMessage(), and KCal::ICalFormat::save(). |
|
Return exception, if there is any, containing information about the last error that occured.
Definition at line 68 of file calformat.cpp. Referenced by KCal::ICalFormat::fromString(), and KCal::DummyScheduler::retrieveTransactions(). |
|
Set the application name for use in unique IDs and error messages, and product ID for incidence PRODID property.
Definition at line 73 of file calformat.cpp. |
|
Return the application name used in unique IDs and error messages.
Definition at line 82 of file calformat.h. |
|
Return the PRODID string to write into calendar files.
Definition at line 84 of file calformat.h. Referenced by KCal::VCalFormat::populate(), and KCal::VCalFormat::save(). |
|
Return the KDE calendar format version indicated by a PRODID property.
Definition at line 91 of file calformat.cpp. |
|
Return the PRODID string loaded from calendar file.
Definition at line 88 of file calformat.h. |
|
Create a unique id string.
Definition at line 79 of file calformat.cpp. References QTime::currentTime(). |
|
Set exception for this object. This is used by the functions of this class to report errors. Definition at line 62 of file calformat.cpp. Referenced by KCal::ICalFormat::fromString(), KCal::VCalFormat::load(), KCal::ICalFormat::load(), KCal::ICalFormat::parseScheduleMessage(), KCal::ICalFormat::save(), and KCal::ICalFormat::toString(). |
The documentation for this class was generated from the following files: