#include <icalformat.h>

Inheritance diagram for KCalCore::ICalFormat:

Public Member Functions
	ICalFormat ()

virtual	~ICalFormat ()

QString	createScheduleMessage (const IncidenceBase::Ptr &incidence, iTIPMethod method)

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

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

Incidence::Ptr	fromString (const QString &string)

bool	fromString (RecurrenceRule *rule, const QString &string)

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

FreeBusy::Ptr	parseFreeBusy (const QString &string)

ScheduleMessage::Ptr	parseScheduleMessage (const Calendar::Ptr &calendar, const QString &string)

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

void	setTimeSpec (const KDateTime::Spec &timeSpec)

KDateTime::Spec	timeSpec () const

QString	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)

QString	toString (const Incidence::Ptr &incidence)

QString	toString (RecurrenceRule *rule)

Public Member Functions inherited from KCalCore::CalFormat
	CalFormat ()

virtual	~CalFormat ()

void	clearException ()

Exception *	exception () const

QString	loadedProductId ()

void	setException (Exception *error)

Protected Member Functions
virtual void	virtual_hook (int id, void *data)

Protected Member Functions inherited from KCalCore::CalFormat
void	setLoadedProductId (const QString &id)

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

Constructor & Destructor Documentation

ICalFormat::ICalFormat ( )

Constructor a new iCalendar Format object.

Definition at line 68 of file icalformat.cpp.

ICalFormat::~ICalFormat ( )

virtual

Destructor.

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

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

virtual

CalFormat::fromRawString()

Implements KCalCore::CalFormat.

Definition at line 148 of file icalformat.cpp.

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

virtual

CalFormat::fromString()

Note: The notebook is ignored and the default one is used

Implements KCalCore::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 204 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 347 of file icalformat.cpp.

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

virtual

CalFormat::load()

Implements KCalCore::CalFormat.

Definition at line 79 of file icalformat.cpp.

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.

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.

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

virtual

CalFormat::save()

Implements KCalCore::CalFormat.

Definition at line 104 of file icalformat.cpp.

void ICalFormat::setTimeSpec ( const KDateTime::Spec & timeSpec )

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.

KDateTime::Spec ICalFormat::timeSpec ( ) const

Returns the iCalendar time specification.

See also: setTimeSpec().

Definition at line 625 of file icalformat.cpp.

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.

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.

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.

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

virtual

CalFormat::toString()

Implements KCalCore::CalFormat.

Definition at line 213 of file icalformat.cpp.

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.

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.

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

protectedvirtual

IncidenceBase::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:

KCalCore Library

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KCalCore Library

kdepimlibs API Reference

Search