KCalendarCore::ICalFormat Class Reference

#include <icalformat.h>

Inheritance diagram for KCalendarCore::ICalFormat:

Public Member Functions
	ICalFormat ()
	~ICalFormat () override
QString	createScheduleMessage (const IncidenceBase::Ptr &incidence, iTIPMethod method)
Duration	durationFromString (const QString &duration) const
bool	fromRawString (const Calendar::Ptr &calendar, const QByteArray &string, bool deleted=false, const QString &notebook=QString()) override
bool	fromString (const Calendar::Ptr &calendar, const QString &string, bool deleted, const QString &notebook) override
virtual bool	fromString (const Calendar::Ptr &calendar, const QString &string, bool deleted, const QString &notebook={})=0
bool	fromString (const Calendar::Ptr &calendar, const QString &string, const QString &notebook={})
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 &notebook=QString(), bool deleted=false) override
QString	toString (const Duration &duration) const
QString	toString (const Incidence::Ptr &incidence)
QString	toString (RecurrenceRule *rule)
Public Member Functions inherited from KCalendarCore::CalFormat
	CalFormat ()
virtual	~CalFormat ()
void	clearException ()
Exception *	exception () const
bool	fromString (const Calendar::Ptr &calendar, const QString &string, const QString &notebook={})
QString	loadedProductId ()
void	setException (Exception *error)

Protected Member Functions
void	virtual_hook (int id, void *data) override
Protected Member Functions inherited from KCalendarCore::CalFormat
void	setLoadedProductId (const QString &id)

Additional Inherited Members
Static Public Member Functions inherited from KCalendarCore::CalFormat
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 44 of file icalformat.h.

Constructor & Destructor Documentation

ICalFormat()

ICalFormat::ICalFormat

(

)

Constructor a new iCalendar Format object.

Definition at line 54 of file icalformat.cpp.

~ICalFormat()

ICalFormat::~ICalFormat ( )

override

Destructor.

Definition at line 59 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 429 of file icalformat.cpp.

durationFromString()

Duration ICalFormat::durationFromString

(

const QString &

duration

)

const

Parses a string representation of a duration.

Parameters

duration

iCal representation of a duration.

Since

5.95

Definition at line 417 of file icalformat.cpp.

fromRawString()

bool ICalFormat::fromRawString ( const Calendar::Ptr &  calendar, const QByteArray &  string, bool  deleted = false, const QString &  notebook = QString()  )

overridevirtual

CalFormat::fromRawString()

Implements KCalendarCore::CalFormat.

Definition at line 184 of file icalformat.cpp.

fromString() [1/5]

bool ICalFormat::fromString ( const Calendar::Ptr &  calendar, const QString &  string, bool  deleted, const QString &  notebook  )

overridevirtual

CalFormat::fromString()

Implements KCalendarCore::CalFormat.

Definition at line 141 of file icalformat.cpp.

fromString() [2/5]

virtual bool KCalendarCore::CalFormat::fromString

Loads a calendar from a string.

When a notebook is given, incidences are added to this notebook, otherwise no notebook is associated to loaded incidences. The notebook should already be added to the calendar, see Calendar::addNotebook().

Parameters

calendar	is the Calendar to be loaded.
string	is the QString containing the Calendar data.
deleted	use deleted incidences
notebook	notebook uid

Returns

true if successful; false otherwise.

See also

fromRawString(), toString().

Deprecated:

since 5.97, use fromString(const Calendar::Ptr &calendar, const QString &string, const QString &notebook) instead.

fromString() [3/5]

bool CalFormat::fromString

Loads a calendar from a string.

When a notebook is given, incidences are added to this notebook, otherwise no notebook is associated to loaded incidences. The notebook should already be added to the calendar, see Calendar::addNotebook().

Parameters

calendar	is the Calendar to be loaded.
string	is the QString containing the Calendar data.
notebook	notebook uid

Returns

true if successful; false otherwise.

See also

fromRawString(), toString().

Since

5.97

Definition at line 49 of file calformat.cpp.

fromString() [4/5]

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 240 of file icalformat.cpp.

fromString() [5/5]

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 396 of file icalformat.cpp.

load()

bool ICalFormat::load ( const Calendar::Ptr &  calendar, const QString &  fileName  )

overridevirtual

CalFormat::load()

Implements KCalendarCore::CalFormat.

Definition at line 64 of file icalformat.cpp.

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 475 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 509 of file icalformat.cpp.

readIncidence()

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.

See also

fromString(const QString &), fromRawString()

Definition at line 147 of file icalformat.cpp.

save()

bool ICalFormat::save ( const Calendar::Ptr &  calendar, const QString &  fileName  )

overridevirtual

CalFormat::save()

Implements KCalendarCore::CalFormat.

Definition at line 95 of file icalformat.cpp.

setTimeZone()

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 666 of file icalformat.cpp.

timeZone()

QTimeZone ICalFormat::timeZone

(

)

const

Returns the iCalendar time zone.

See also

setTimeZone().

Definition at line 672 of file icalformat.cpp.

timeZoneId()

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 678 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 332 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 346 of file icalformat.cpp.

toString() [1/4]

QString ICalFormat::toString ( const Calendar::Ptr &  calendar, const QString &  notebook = QString(), bool  deleted = false  )

overridevirtual

CalFormat::toString()

Implements KCalendarCore::CalFormat.

Definition at line 251 of file icalformat.cpp.

toString() [2/4]

QString KCalendarCore::ICalFormat::toString

(

const Duration &

duration

)

const

Converts a Duration to an iCal string.

Parameters

duration

a Duration object.

Returns

iCal formatted duration

Since

5.95

Definition at line 387 of file icalformat.cpp.

toString() [3/4]

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 341 of file icalformat.cpp.

toString() [4/4]

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 378 of file icalformat.cpp.

virtual_hook()

void ICalFormat::virtual_hook ( int  id, void *  data  )

overrideprotectedvirtual

IncidenceBase::virtual_hook()

Reimplemented from KCalendarCore::CalFormat.

Definition at line 685 of file icalformat.cpp.

---

The documentation for this class was generated from the following files:

• icalformat.h
• icalformat.cpp