KCalendarCore::CalFormat
#include <calformat.h>
Public Member Functions | |
virtual | ~CalFormat () |
void | clearException () |
Exception * | exception () const |
virtual bool | fromRawString (const Calendar::Ptr &calendar, const QByteArray &string)=0 |
bool | fromString (const Calendar::Ptr &calendar, const QString &string) |
virtual bool | load (const Calendar::Ptr &calendar, const QString &fileName)=0 |
QString | loadedProductId () |
virtual bool | save (const Calendar::Ptr &calendar, const QString &fileName)=0 |
void | setException (Exception *error) |
virtual QString | toString (const Calendar::Ptr &calendar)=0 |
Static Public Member Functions | |
static const QString & | application () |
static QString | createUniqueId () |
static const QString & | productId () |
static void | setApplication (const QString &application, const QString &productID) |
Protected Member Functions | |
void | setLoadedProductId (const QString &id) |
Detailed Description
An abstract base class that provides an interface to various calendar formats.
This is the base class for calendar formats. It provides an interface for the generation/interpretation of a textual representation of a calendar.
Definition at line 38 of file calformat.h.
Constructor & Destructor Documentation
◆ ~CalFormat()
|
virtual |
Destructor.
Definition at line 37 of file calformat.cpp.
Member Function Documentation
◆ application()
|
static |
Returns the application name used in unique IDs and error messages.
Definition at line 68 of file calformat.cpp.
◆ clearException()
void CalFormat::clearException | ( | ) |
Clears the exception status.
Definition at line 47 of file calformat.cpp.
◆ createUniqueId()
|
static |
Creates a unique id string.
Definition at line 88 of file calformat.cpp.
◆ exception()
Exception * CalFormat::exception | ( | ) | const |
Returns an exception, if there is any, containing information about the last error that occurred.
Definition at line 57 of file calformat.cpp.
◆ fromRawString()
|
pure virtual |
Parses a utf8 encoded string, returning the first iCal component encountered in that string.
This is an overload used for efficient reading to avoid utf8 conversions, which are expensive when reading from disk.
- Parameters
-
calendar is the Calendar to be loaded. string is the QByteArray containing the Calendar data.
- Returns
- true if successful; false otherwise.
- See also
- fromString(), toString().
Implemented in KCalendarCore::ICalFormat, KCalendarCore::VCalFormat, and KCalendarCore::XCalFormat.
◆ fromString()
bool CalFormat::fromString | ( | const Calendar::Ptr & | calendar, |
const QString & | string ) |
Loads a calendar from a string.
- Returns
- true if successful; false otherwise.
- See also
- fromRawString(), toString().
- Since
- 5.97
Definition at line 42 of file calformat.cpp.
◆ load()
|
pure virtual |
Loads a calendar on disk into the calendar associated with this format.
- Parameters
-
calendar is the Calendar to be loaded. fileName is the name of the disk file containing the Calendar data.
- Returns
- true if successful; false otherwise.
Implemented in KCalendarCore::ICalFormat, KCalendarCore::VCalFormat, and KCalendarCore::XCalFormat.
◆ loadedProductId()
QString CalFormat::loadedProductId | ( | ) |
Returns the PRODID string loaded from calendar file.
- See also
- setLoadedProductId()
Definition at line 78 of file calformat.cpp.
◆ productId()
|
static |
Returns the our library's PRODID string to write into calendar files.
Definition at line 73 of file calformat.cpp.
◆ save()
|
pure virtual |
Writes the calendar to disk.
- Parameters
-
calendar is the Calendar containing the data to be saved. fileName is the name of the file to write the calendar data.
- Returns
- true if successful; false otherwise.
Implemented in KCalendarCore::ICalFormat, KCalendarCore::VCalFormat, and KCalendarCore::XCalFormat.
◆ setApplication()
Sets the application name for use in unique IDs and error messages, and product ID for incidence PRODID property.
- Parameters
-
application is a string containing the application name. productID is a string containing the product identifier.
Definition at line 62 of file calformat.cpp.
◆ setException()
void CalFormat::setException | ( | Exception * | error | ) |
Sets an exception that is to be used by the functions of this class to report errors.
- Parameters
-
error is a pointer to an Exception which contains the exception.
Definition at line 52 of file calformat.cpp.
◆ setLoadedProductId()
|
protected |
Sets the PRODID string loaded from calendar file.
- Parameters
-
id is a pruduct Id string to set for the calendar file.
- See also
- loadedProductId()
Definition at line 83 of file calformat.cpp.
◆ toString()
|
pure virtual |
Returns the calendar as a string.
- Parameters
-
calendar is the Calendar containing the data to be saved.
- See also
- fromString(), fromRawString().
Implemented in KCalendarCore::ICalFormat, KCalendarCore::VCalFormat, and KCalendarCore::XCalFormat.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 4 2024 12:01:42 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.