KCalendarCore::CalFormat Class
class KCalendarCore::CalFormatAn abstract base class that provides an interface to various calendar formats. More...
| Header: | #include <KCalendarCore/CalFormat> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS CalendarCore)target_link_libraries(mytarget PRIVATE KF6::CalendarCore) |
| Inherited By: |
Public Functions
| virtual | ~CalFormat() |
| void | clearException() |
| KCalendarCore::Exception * | exception() const |
| virtual bool | fromRawString(const KCalendarCore::Calendar::Ptr &calendar, const QByteArray &string) = 0 |
(since 5.97) bool | fromString(const KCalendarCore::Calendar::Ptr &calendar, const QString &string) |
| virtual bool | load(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName) = 0 |
| QString | loadedProductId() |
| virtual bool | save(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName) = 0 |
| void | setException(KCalendarCore::Exception *error) |
| virtual QString | toString(const KCalendarCore::Calendar::Ptr &calendar) = 0 |
Static Public Members
| const QString & | application() |
| QString | createUniqueId() |
| const QString & | productId() |
| void | setApplication(const QString &application, const QString &productID) |
Protected Functions
| void | setLoadedProductId(const QString &id) |
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.
Member Function Documentation
[virtual noexcept] CalFormat::~CalFormat()
Destructor.
[static] const QString &CalFormat::application()
Returns the application name used in unique IDs and error messages.
See also setApplication().
void CalFormat::clearException()
Clears the exception status.
[static] QString CalFormat::createUniqueId()
Creates a unique id string.
KCalendarCore::Exception *CalFormat::exception() const
Returns an exception, if there is any, containing information about the last error that occurred.
See also setException().
[pure virtual] bool CalFormat::fromRawString(const KCalendarCore::Calendar::Ptr &calendar, const QByteArray &string)
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.
calendar is the Calendar to be loaded.
string is the QByteArray containing the Calendar data.
Returns true if successful; false otherwise.
See also fromString() and toString().
[since 5.97] bool CalFormat::fromString(const KCalendarCore::Calendar::Ptr &calendar, const QString &string)
Loads a calendar from a string.
calendar is the Calendar to be loaded.
string is the QString containing the Calendar data.
Returns true if successful; false otherwise.
This function was introduced in 5.97.
See also fromRawString() and toString().
[pure virtual] bool CalFormat::load(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName)
Loads a calendar on disk into the calendar associated with this format.
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.
QString CalFormat::loadedProductId()
Returns the PRODID string loaded from calendar file.
See also setLoadedProductId().
[static] const QString &CalFormat::productId()
Returns the our library's PRODID string to write into calendar files.
[pure virtual] bool CalFormat::save(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName)
Writes the calendar to disk.
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.
[static] void CalFormat::setApplication(const QString &application, const QString &productID)
Sets the application name for use in unique IDs and error messages, and product ID for incidence PRODID property
application is a string containing the application name.
productID is a string containing the product identifier.
See also application().
void CalFormat::setException(KCalendarCore::Exception *error)
Sets an exception that is to be used by the functions of this class to report errors.
error is a pointer to an Exception which contains the exception.
See also exception().
[protected] void CalFormat::setLoadedProductId(const QString &id)
Sets the PRODID string loaded from calendar file.
id is a product Id string to set for the calendar file.
See also loadedProductId().
[pure virtual] QString CalFormat::toString(const KCalendarCore::Calendar::Ptr &calendar)
Returns the calendar as a string.
calendar is the Calendar containing the data to be saved.
Returns a QString containing the Calendar data if successful; an empty string otherwise.
See also fromString() and fromRawString().