KCalendarCore::ICalFormat Class
class KCalendarCore::ICalFormatiCalendar format implementation. More...
| Header: | #include <KCalendarCore/ICalFormat> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS CalendarCore)target_link_libraries(mytarget PRIVATE KF6::CalendarCore) |
| Inherits: | KCalendarCore::CalFormat |
Public Functions
| ICalFormat() | |
| virtual | ~ICalFormat() override |
| QString | createScheduleMessage(const KCalendarCore::IncidenceBase::Ptr &incidence, KCalendarCore::iTIPMethod method) |
(since 5.95) KCalendarCore::Duration | durationFromString(const QString &duration) const |
| KCalendarCore::Incidence::Ptr | fromString(const QString &string) |
| bool | fromString(KCalendarCore::RecurrenceRule *rule, const QString &string) |
| KCalendarCore::FreeBusy::Ptr | parseFreeBusy(const QString &string) |
| KCalendarCore::ScheduleMessage::Ptr | parseScheduleMessage(const KCalendarCore::Calendar::Ptr &calendar, const QString &string) |
| KCalendarCore::Incidence::Ptr | readIncidence(const QByteArray &string) |
| void | setTimeZone(const QTimeZone &timeZone) |
| QTimeZone | timeZone() const |
| QByteArray | timeZoneId() const |
| QString | toICalString(const KCalendarCore::Incidence::Ptr &incidence) |
(since 4.7) QByteArray | toRawString(const KCalendarCore::Incidence::Ptr &incidence) |
| QString | toString(KCalendarCore::RecurrenceRule *rule) |
| QString | toString(const KCalendarCore::Incidence::Ptr &incidence) |
(since 5.95) QString | toString(const KCalendarCore::Duration &duration) const |
Reimplemented Public Functions
| virtual bool | fromRawString(const KCalendarCore::Calendar::Ptr &calendar, const QByteArray &string) override |
| virtual bool | load(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName) override |
| virtual bool | save(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName) override |
| virtual QString | toString(const KCalendarCore::Calendar::Ptr &calendar) override |
Detailed Description
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.
Member Function Documentation
ICalFormat::ICalFormat()
Constructor a new iCalendar Format object.
[override virtual noexcept] ICalFormat::~ICalFormat()
Destructor.
QString ICalFormat::createScheduleMessage(const KCalendarCore::IncidenceBase::Ptr &incidence, KCalendarCore::iTIPMethod method)
Creates a scheduling message string for an Incidence.
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.
[since 5.95] KCalendarCore::Duration ICalFormat::durationFromString(const QString &duration) const
Parses a string representation of a duration.
duration iCal representation of a duration.
This function was introduced in 5.95.
[override virtual] bool ICalFormat::fromRawString(const KCalendarCore::Calendar::Ptr &calendar, const QByteArray &string)
Reimplements: CalFormat::fromRawString(const KCalendarCore::Calendar::Ptr &calendar, const QByteArray &string).
KCalendarCore::Incidence::Ptr ICalFormat::fromString(const QString &string)
Parses a string, returning the first iCal component as an Incidence.
string is a QString containing the data to be parsed.
Returns non-zero pointer if the parsing was successful; 0 otherwise.
See also CalFormat::fromString() and fromRawString().
bool ICalFormat::fromString(KCalendarCore::RecurrenceRule *rule, const QString &string)
Parses a string and fills a RecurrenceRule object with the information.
rule is a pointer to a RecurrenceRule object.
string is a QString containing the data to be parsed.
Returns true if successful; false otherwise.
[override virtual] bool ICalFormat::load(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName)
Reimplements: CalFormat::load(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName).
KCalendarCore::FreeBusy::Ptr ICalFormat::parseFreeBusy(const QString &string)
Converts a QString into a FreeBusy object.
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.
KCalendarCore::ScheduleMessage::Ptr ICalFormat::parseScheduleMessage(const KCalendarCore::Calendar::Ptr &calendar, const QString &string)
Parses a Calendar scheduling message string into ScheduleMessage object.
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.
KCalendarCore::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.
string is a utf8 QByteArray containing the data to be parsed.
Returns non-zero pointer if the parsing was successful; 0 otherwise.
See also fromString(const QString &) and fromRawString().
[override virtual] bool ICalFormat::save(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName)
Reimplements: CalFormat::save(const KCalendarCore::Calendar::Ptr &calendar, const QString &fileName).
void ICalFormat::setTimeZone(const QTimeZone &timeZone)
Sets the iCalendar time zone.
timeZone is the time zone to set.
See also timeZone().
QTimeZone ICalFormat::timeZone() const
Returns the iCalendar time zone.
See also setTimeZone().
QByteArray ICalFormat::timeZoneId() const
Returns the timezone id string used by the iCalendar; an empty string if the iCalendar does not have a timezone.
QString ICalFormat::toICalString(const KCalendarCore::Incidence::Ptr &incidence)
Converts an Incidence to iCalendar formatted text.
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.
[since 4.7] QByteArray ICalFormat::toRawString(const KCalendarCore::Incidence::Ptr &incidence)
Converts an Incidence to a QByteArray.
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.
This function was introduced in 4.7.
QString ICalFormat::toString(KCalendarCore::RecurrenceRule *rule)
Converts a RecurrenceRule to a QString.
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.
[override virtual] QString ICalFormat::toString(const KCalendarCore::Calendar::Ptr &calendar)
Reimplements: CalFormat::toString(const KCalendarCore::Calendar::Ptr &calendar).
QString ICalFormat::toString(const KCalendarCore::Incidence::Ptr &incidence)
Converts an Incidence to a QString.
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.
[since 5.95] QString ICalFormat::toString(const KCalendarCore::Duration &duration) const
Converts a Duration to an iCal string.
duration a Duration object.
Returns iCal formatted duration
This function was introduced in 5.95.