KCalCore Library
#include <icalformat.h>

Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
![]() | |
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 58 of file icalformat.h.
Constructor & Destructor Documentation
◆ ICalFormat()
ICalFormat::ICalFormat | ( | ) |
Constructor a new iCalendar Format object.
Definition at line 68 of file icalformat.cpp.
◆ ~ICalFormat()
|
virtual |
Destructor.
Definition at line 73 of file icalformat.cpp.
Member Function Documentation
◆ createScheduleMessage()
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 367 of file icalformat.cpp.
◆ fromRawString()
|
virtual |
Implements KCalCore::CalFormat.
Definition at line 148 of file icalformat.cpp.
◆ fromString() [1/3]
|
virtual |
- Note
- The notebook is ignored and the default one is used
Implements KCalCore::CalFormat.
Definition at line 142 of file icalformat.cpp.
◆ fromString() [2/3]
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 204 of file icalformat.cpp.
◆ fromString() [3/3]
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 347 of file icalformat.cpp.
◆ load()
|
virtual |
◆ parseFreeBusy()
FreeBusy::Ptr ICalFormat::parseFreeBusy | ( | const QString & | string | ) |
Converts a QString into a FreeBusy object.
- Parameters
-
string is a QString containing the data to be parsed.
- Returns
- a pointer to a FreeBusy object if successful; 0 otherwise.
- Note
- Do not attempt to free the FreeBusy memory from the calling routine.
Definition at line 416 of file icalformat.cpp.
◆ parseScheduleMessage()
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 450 of file icalformat.cpp.
◆ save()
|
virtual |
◆ setTimeSpec()
Sets the iCalendar time specification (time zone, etc.).
- Parameters
-
timeSpec is the time specification to set.
- See also
- timeSpec().
Definition at line 620 of file icalformat.cpp.
◆ timeSpec()
KDateTime::Spec ICalFormat::timeSpec | ( | ) | const |
Returns the iCalendar time specification.
- See also
- setTimeSpec().
Definition at line 625 of file icalformat.cpp.
◆ timeZoneId()
QString 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 630 of file icalformat.cpp.
◆ toICalString()
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 296 of file icalformat.cpp.
◆ toRawString()
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 308 of file icalformat.cpp.
◆ toString() [1/3]
|
virtual |
Implements KCalCore::CalFormat.
Definition at line 213 of file icalformat.cpp.
◆ toString() [2/3]
QString ICalFormat::toString | ( | const Incidence::Ptr & | incidence | ) |
Converts an Incidence to a QString.
- Parameters
-
incidence is a pointer to an Incidence object to be converted into a QString.
- Returns
- the QString will be Null if the conversion was unsuccessful.
Definition at line 303 of file icalformat.cpp.
◆ toString() [3/3]
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 338 of file icalformat.cpp.
◆ virtual_hook()
Reimplemented from KCalCore::CalFormat.
Definition at line 636 of file icalformat.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.