KCal::ICalFormat Class Reference

#include <icalformat.h>

Inheritance diagram for KCal::ICalFormat:

Public Member Functions
bool	load (Calendar *calendar, const TQString &fileName)
bool	save (Calendar *calendar, const TQString &fileName)
bool	fromString (Calendar *calendar, const TQString &)
Incidence *	fromString (const TQString &)
TQString	toString (Calendar *)
TQString	toICalString (Incidence *)
TQString	toString (Incidence *)
TQString	toString (Incidence *, Calendar *)
TQString	toString (RecurrenceRule *)
bool	fromString (RecurrenceRule *, const TQString &)
TQString	createScheduleMessage (IncidenceBase *e, Scheduler::Method m)
ScheduleMessage *	parseScheduleMessage (Calendar *, const TQString &s)
FreeBusy *	parseFreeBusy (const TQString &)
void	setTimeZone (const TQString &id, bool utc)
TQString	timeZoneId () const
bool	utc () const
Public Member Functions inherited from KCal::CalFormat
	CalFormat ()
virtual	~CalFormat ()
virtual bool	load (Calendar *, const TQString &fileName)=0
virtual bool	save (Calendar *, const TQString &fileName)=0
virtual bool	fromString (Calendar *, const TQString &)=0
virtual TQString	toString (Calendar *)=0
void	clearException ()
ErrorFormat *	exception ()
const TQString &	loadedProductId ()
void	setException (ErrorFormat *error)

Protected Member Functions
bool	fromRawString (Calendar *calendar, const TQCString &)
void	setImplementation (ICalFormatImpl *impl)

Additional Inherited Members
Static Public Member Functions inherited from KCal::CalFormat
static void	setApplication (const TQString &app, const TQString &productID)
static const TQString &	application ()
static const TQString &	productId ()
static TQString	createUniqueId ()
Protected Attributes inherited from KCal::CalFormat
TQString	mLoadedProductId

Detailed Description

This class implements the iCalendar format.

It provides methods for loading/saving/converting iCalendar format data into the internal KOrganizer representation as Calendar and Events.

iCalendar format implementation

Definition at line 43 of file icalformat.h.

Constructor & Destructor Documentation

ICalFormat()

ICalFormat::ICalFormat

(

)

Definition at line 55 of file icalformat.cpp.

~ICalFormat()

ICalFormat::~ICalFormat ( )

virtual

Definition at line 63 of file icalformat.cpp.

Member Function Documentation

createScheduleMessage()

TQString ICalFormat::createScheduleMessage	(	IncidenceBase *	e,
		Scheduler::Method	m
	)

Create a scheduling message for event e using method m.

Definition at line 369 of file icalformat.cpp.

fromRawString()

bool ICalFormat::fromRawString ( Calendar *  calendar, const TQCString &  text  )

protected

Parse string and return first ical component of a raw byte array of a utf8 encoded string.

This is an overload used for efficiency reading to avoid utf8 conversions, which are expensive, when reading from disk.

Definition at line 144 of file icalformat.cpp.

fromString() [1/3]

bool ICalFormat::fromString ( Calendar *  calendar, const TQString &  text  )

virtual

Parse string and populate calendar with that information.

Implements KCal::CalFormat.

Definition at line 139 of file icalformat.cpp.

fromString() [2/3]

Incidence * ICalFormat::fromString

(

const TQString &

text

)

Parse string and return first ical component.

Definition at line 201 of file icalformat.cpp.

fromString() [3/3]

bool ICalFormat::fromString	(	RecurrenceRule *	recurrence,
		const TQString &	rrule
	)

Parse string and fill recurrence object with that information.

Definition at line 350 of file icalformat.cpp.

load()

bool ICalFormat::load ( Calendar *  calendar, const TQString &  fileName  )

virtual

Loads a calendar on disk in iCalendar format into calendar.

Returns true if successful, else returns false. Provides more error information by exception().

Parameters

calendar	Calendar object to be filled.
fileName	The name of the calendar file on disk.

Implements KCal::CalFormat.

Definition at line 78 of file icalformat.cpp.

parseFreeBusy()

FreeBusy * ICalFormat::parseFreeBusy

(

const TQString &

str

)

Parse FREEBUSY object.

Definition at line 406 of file icalformat.cpp.

parseScheduleMessage()

ScheduleMessage * ICalFormat::parseScheduleMessage	(	Calendar *	cal,
		const TQString &	s
	)

Parse scheduling message provided as string s.

Definition at line 436 of file icalformat.cpp.

save()

bool ICalFormat::save ( Calendar *  calendar, const TQString &  fileName  )

virtual

Writes out the calendar to disk in iCalendar format.

Returns true if successful and false on error.

Parameters

calendar	The Calendar object to be written.
fileName	The name of the calendar file on disk.

Implements KCal::CalFormat.

Definition at line 102 of file icalformat.cpp.

setImplementation()

void ICalFormat::setImplementation ( ICalFormatImpl *  impl )

protected

Definition at line 68 of file icalformat.cpp.

setTimeZone()

void ICalFormat::setTimeZone	(	const TQString &	id,
		bool	utc
	)

Set id of used time zone and whether this time zone is UTC or not.

Definition at line 611 of file icalformat.cpp.

timeZoneId()

TQString ICalFormat::timeZoneId

(

)

const

Return id string of timezone used.

Definition at line 617 of file icalformat.cpp.

toICalString()

TQString ICalFormat::toICalString

(

Incidence *

incidence

)

Return incidence as full iCalendar formatted text.

Definition at line 277 of file icalformat.cpp.

toString() [1/4]

TQString ICalFormat::toString ( Calendar *  cal )

virtual

Return calendar information as string.

Implements KCal::CalFormat.

Definition at line 225 of file icalformat.cpp.

toString() [2/4]

TQString ICalFormat::toString

(

Incidence *

incidence

)

Return incidence as iCalendar formatted text.

Definition at line 284 of file icalformat.cpp.

toString() [3/4]

TQString ICalFormat::toString	(	Incidence *	incidence,
		Calendar *	calendar
	)

Return incidence as iCalendar formatted text.

This function includes all RECURRENCE-ID related incidences.

Returns

TQString of iCalendar formatted text.

Since

3.5.12

Definition at line 297 of file icalformat.cpp.

toString() [4/4]

TQString ICalFormat::toString

(

RecurrenceRule *

recurrence

)

Return recurrence rule as iCalendar formatted text.

Definition at line 341 of file icalformat.cpp.

utc()

bool ICalFormat::utc

(

)

const

Return true if timezone used is UTC, otherwise return false.

Definition at line 622 of file icalformat.cpp.

---

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

• icalformat.h
• icalformat.cpp