KCalendarCore::ICalFormat
#include <icalformat.h>

Public Member Functions | |
ICalFormat () | |
~ICalFormat () override | |
QString | createScheduleMessage (const IncidenceBase::Ptr &incidence, iTIPMethod method) |
bool | fromRawString (const Calendar::Ptr &calendar, const QByteArray &string, bool deleted=false, const QString ¬ebook=QString()) override |
bool | fromString (const Calendar::Ptr &calendar, const QString &string, bool deleted=false, const QString ¬ebook=QString()) override |
Incidence::Ptr | fromString (const QString &string) |
bool | fromString (RecurrenceRule *rule, const QString &string) |
bool | load (const Calendar::Ptr &calendar, const QString &fileName) override |
FreeBusy::Ptr | parseFreeBusy (const QString &string) |
ScheduleMessage::Ptr | parseScheduleMessage (const Calendar::Ptr &calendar, const QString &string) |
Incidence::Ptr | readIncidence (const QByteArray &string) |
bool | save (const Calendar::Ptr &calendar, const QString &fileName) override |
void | setTimeZone (const QTimeZone &timeZone) |
QTimeZone | timeZone () const |
QByteArray | timeZoneId () const |
QString | toICalString (const Incidence::Ptr &incidence) |
QByteArray | toRawString (const Incidence::Ptr &incidence) |
QString | toString (const Calendar::Ptr &calendar, const QString ¬ebook=QString(), bool deleted=false) override |
QString | toString (const Incidence::Ptr &incidence) |
QString | toString (RecurrenceRule *rule) |
![]() | |
CalFormat () | |
virtual | ~CalFormat () |
void | clearException () |
Exception * | exception () const |
QString | loadedProductId () |
void | setException (Exception *error) |
Protected Member Functions | |
void | virtual_hook (int id, void *data) override |
![]() | |
void | setLoadedProductId (const QString &id) |
Additional Inherited Members | |
![]() | |
static const QString & | application () |
static QString | createUniqueId () |
static const QString & | productId () |
static void | setApplication (const QString &application, const QString &productID) |
Detailed Description
iCalendar format implementation.
This class implements the iCalendar format. It provides methods for loading/saving/converting iCalendar format data into the internal representation as Calendar and Incidences.
- Warning
- When importing/loading to a Calendar, there is only duplicate check if those Incidences are loaded into the Calendar. If they are not loaded it will create duplicates.
Definition at line 43 of file icalformat.h.
Constructor & Destructor Documentation
ICalFormat::ICalFormat | ( | ) |
Constructor a new iCalendar Format object.
Definition at line 58 of file icalformat.cpp.
|
override |
Destructor.
Definition at line 63 of file icalformat.cpp.
Member Function Documentation
QString ICalFormat::createScheduleMessage | ( | const IncidenceBase::Ptr & | incidence, |
iTIPMethod | method | ||
) |
Creates a scheduling message string for an Incidence.
- Parameters
-
incidence is a pointer to an IncidenceBase object to be scheduled. method is a Scheduler::Method
- Returns
- a QString containing the message if successful; 0 otherwise.
Definition at line 396 of file icalformat.cpp.
|
overridevirtual |
Implements KCalendarCore::CalFormat.
Definition at line 182 of file icalformat.cpp.
|
overridevirtual |
- Note
- The notebook is ignored and the default one is used
Implements KCalendarCore::CalFormat.
Definition at line 142 of file icalformat.cpp.
Incidence::Ptr ICalFormat::fromString | ( | const QString & | string | ) |
Parses a string, returning the first iCal component as an Incidence.
- Parameters
-
string is a QString containing the data to be parsed.
- Returns
- non-zero pointer if the parsing was successful; 0 otherwise.
- See also
- fromString(const Calendar::Ptr &, const QString &), fromRawString()
Definition at line 237 of file icalformat.cpp.
bool ICalFormat::fromString | ( | RecurrenceRule * | rule, |
const QString & | string | ||
) |
Parses a string and fills a RecurrenceRule object with the information.
- Parameters
-
rule is a pointer to a RecurrenceRule object. string is a QString containing the data to be parsed.
- Returns
- true if successful; false otherwise.
Definition at line 376 of file icalformat.cpp.
|
overridevirtual |
Implements KCalendarCore::CalFormat.
Definition at line 69 of file icalformat.cpp.
FreeBusy::Ptr ICalFormat::parseFreeBusy | ( | const QString & | string | ) |
ScheduleMessage::Ptr ICalFormat::parseScheduleMessage | ( | const Calendar::Ptr & | calendar, |
const QString & | string | ||
) |
Parses a Calendar scheduling message string into ScheduleMessage object.
- Parameters
-
calendar is a pointer to a Calendar object associated with the scheduling message. string is a QString containing the data to be parsed.
- Returns
- a pointer to a ScheduleMessage object if successful; 0 otherwise. The calling routine may later free the return memory.
Definition at line 474 of file icalformat.cpp.
Incidence::Ptr ICalFormat::readIncidence | ( | const QByteArray & | string | ) |
Parses a bytearray, returning the first iCal component as an Incidence, ignoring timezone information.
This function is significantly faster than fromString by avoiding the overhead of parsing timezone information. Timezones are instead solely interpreted by using system-timezones.
- Parameters
-
string is a utf8 QByteArray containing the data to be parsed.
- Returns
- non-zero pointer if the parsing was successful; 0 otherwise.
Definition at line 147 of file icalformat.cpp.
|
overridevirtual |
Implements KCalendarCore::CalFormat.
Definition at line 97 of file icalformat.cpp.
void ICalFormat::setTimeZone | ( | const QTimeZone & | timeZone | ) |
Sets the iCalendar time zone.
- Parameters
-
timeZone is the time zone to set.
- See also
- timeZone().
Definition at line 630 of file icalformat.cpp.
QTimeZone ICalFormat::timeZone | ( | ) | const |
Returns the iCalendar time zone.
- See also
- setTimeZone().
Definition at line 635 of file icalformat.cpp.
QByteArray ICalFormat::timeZoneId | ( | ) | const |
Returns the timezone id string used by the iCalendar; an empty string if the iCalendar does not have a timezone.
Definition at line 640 of file icalformat.cpp.
QString ICalFormat::toICalString | ( | const Incidence::Ptr & | incidence | ) |
Converts an Incidence to iCalendar formatted text.
- Parameters
-
incidence is a pointer to an Incidence object to be converted into iCal formatted text.
- Returns
- the QString will be Null if the conversion was unsuccessful.
Definition at line 325 of file icalformat.cpp.
QByteArray ICalFormat::toRawString | ( | const Incidence::Ptr & | incidence | ) |
Converts an Incidence to a QByteArray.
- Parameters
-
incidence is a pointer to an Incidence object to be converted into a QByteArray.
- Returns
- the QString will be Null if the conversion was unsuccessful.
- Since
- 4.7
Definition at line 337 of file icalformat.cpp.
|
overridevirtual |
Implements KCalendarCore::CalFormat.
Definition at line 246 of file icalformat.cpp.
QString ICalFormat::toString | ( | const Incidence::Ptr & | incidence | ) |
QString ICalFormat::toString | ( | RecurrenceRule * | rule | ) |
Converts a RecurrenceRule to a QString.
- Parameters
-
rule is a pointer to a RecurrenceRule object to be converted into a QString.
- Returns
- the QString will be Null if the conversion was unsuccessful.
Definition at line 368 of file icalformat.cpp.
|
overrideprotectedvirtual |
Reimplemented from KCalendarCore::CalFormat.
Definition at line 645 of file icalformat.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Apr 22 2021 22:51:07 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.