libkcal
KCal::CalFormat Class Reference
This is the base class for calendar formats. More...
#include <calformat.h>

Public Member Functions | |
CalFormat () | |
virtual | ~CalFormat () |
virtual bool | load (Calendar *, const TQString &fileName)=0 |
virtual bool | save (Calendar *, const TQString &fileName)=0 |
virtual bool | fromString (Calendar *, const TQString &)=0 |
virtual TQString | toString (Calendar *)=0 |
void | clearException () |
ErrorFormat * | exception () |
const TQString & | loadedProductId () |
void | setException (ErrorFormat *error) |
Static Public Member Functions | |
static void | setApplication (const TQString &app, const TQString &productID) |
static const TQString & | application () |
static const TQString & | productId () |
static TQString | createUniqueId () |
Protected Attributes | |
TQString | 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
virtual bool KCal::CalFormat::load | ( | Calendar * | , | |
const TQString & | 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 TQString & | 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 TQString & | ||||
) | [pure virtual] |
Parse string and populate calendar with that information.
Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.
virtual TQString KCal::CalFormat::toString | ( | Calendar * | ) | [pure virtual] |
Return calendar information as string.
Implemented in KCal::ICalFormat, KCal::QtopiaFormat, and KCal::VCalFormat.
void CalFormat::clearException | ( | ) |
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.
void CalFormat::setApplication | ( | const TQString & | app, | |
const TQString & | productID | |||
) | [static] |
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.
static const TQString& KCal::CalFormat::application | ( | ) | [inline, static] |
Return the application name used in unique IDs and error messages.
Definition at line 85 of file calformat.h.
static const TQString& KCal::CalFormat::productId | ( | ) | [inline, static] |
const TQString& KCal::CalFormat::loadedProductId | ( | ) | [inline] |
TQString CalFormat::createUniqueId | ( | ) | [static] |
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.
The documentation for this class was generated from the following files: