KCal::ICalFormat

KCal::ICalFormat Class Reference

This class implements the iCalendar format.iCalendar format implementation. More...

#include <icalformat.h>

Inheritance diagram for KCal::ICalFormat:

[legend]Collaboration diagram for KCal::ICalFormat:


Public Member Functions
bool	load (Calendar *calendar, const QString &fileName)
bool	save (Calendar *calendar, const QString &fileName)
bool	fromString (Calendar *calendar, const QString &)
Incidence *	fromString (const QString &)
QString	toString (Calendar *)
QString	toICalString (Incidence *)
QString	toString (Incidence *)
QString	toString (Recurrence *)
bool	fromString (Recurrence *, const QString &)
QString	createScheduleMessage (IncidenceBase *e, Scheduler::Method m)
ScheduleMessage *	parseScheduleMessage (Calendar *, const QString &s)
FreeBusy *	parseFreeBusy (const QString &)
void	setTimeZone (const QString &id, bool utc)
QString	timeZoneId () const
bool	utc () const

Detailed Description

This class implements the iCalendar format.iCalendar format implementation.

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

Definition at line 42 of file icalformat.h.

Member Function Documentation

bool ICalFormat::load ( Calendar * calendar,

const QString & 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 70 of file icalformat.cpp.
References KCal::CalFormat::clearException(), fromString(), and KCal::CalFormat::setException().

bool ICalFormat::save ( Calendar * calendar,

const QString & 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 99 of file icalformat.cpp.
References KCal::CalFormat::clearException(), KCal::CalFormat::setException(), and toString().

bool ICalFormat::fromString ( Calendar * calendar,

const QString &

) [virtual]

Parse string and populate calendar with that information.

Implements KCal::CalFormat.
Definition at line 134 of file icalformat.cpp.
References KCal::CalFormat::exception(), KCal::Calendar::isLocalTime(), KCal::CalFormat::setException(), setTimeZone(), and KCal::Calendar::timeZoneId().
Referenced by KCal::ICalDrag::decode(), fromString(), and load().

Incidence * ICalFormat::fromString ( const QString & )

Parse string and return first ical component.

Definition at line 187 of file icalformat.cpp.
References KCal::Incidence::clone(), KCal::Calendar::events(), fromString(), KCal::CalendarLocal::journals(), and KCal::Calendar::todos().

QString ICalFormat::toString ( Calendar * ) [virtual]

Return calendar information as string.

Implements KCal::CalFormat.
Definition at line 211 of file icalformat.cpp.
References KCal::Calendar::isLocalTime(), KCal::Calendar::journals(), KCal::Calendar::rawEvents(), KCal::Calendar::rawTodos(), KCal::CalFormat::setException(), setTimeZone(), and KCal::Calendar::timeZoneId().
Referenced by KCal::ICalDrag::ICalDrag(), save(), and toICalString().

QString ICalFormat::toICalString ( Incidence * )

Return incidence as full iCalendar formatted text.

Definition at line 262 of file icalformat.cpp.
References KCal::Calendar::addIncidence(), KCal::Incidence::clone(), and toString().

QString ICalFormat::toString ( Incidence * )

Return incidence as iCalendar formatted text.

Definition at line 269 of file icalformat.cpp.

QString ICalFormat::toString ( Recurrence * )

Return recurrence as iCalendar formatted text.

Definition at line 282 of file icalformat.cpp.

bool ICalFormat::fromString ( Recurrence * ,

const QString &

)

Parse string and fill recurrence object with that information.

Definition at line 291 of file icalformat.cpp.

QString ICalFormat::createScheduleMessage ( IncidenceBase * e,

Scheduler::Method m

)

Create a scheduling message for event e using method m.

Definition at line 309 of file icalformat.cpp.

ScheduleMessage * ICalFormat::parseScheduleMessage ( Calendar * ,

const QString & s

)

Parse scheduling message provided as string s.

Definition at line 345 of file icalformat.cpp.
References KCal::CalFormat::clearException(), KCal::Calendar::isLocalTime(), KCal::CalFormat::setException(), setTimeZone(), KCal::Calendar::timeZoneId(), KCal::Scheduler::translatedMethodName(), and KCal::IncidenceBase::uid().

FreeBusy * ICalFormat::parseFreeBusy ( const QString & )

Parse FREEBUSY object.

Definition at line 325 of file icalformat.cpp.
References KCal::CalFormat::clearException().

void ICalFormat::setTimeZone ( const QString & id,

bool utc

)

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

Definition at line 490 of file icalformat.cpp.
Referenced by fromString(), parseScheduleMessage(), and toString().

QString ICalFormat::timeZoneId ( ) const

Return id string of timezone used.

Definition at line 496 of file icalformat.cpp.

bool ICalFormat::utc ( ) const

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

Definition at line 501 of file icalformat.cpp.

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

libkcal Library API Documentation

KCal::ICalFormat Class Reference

Public Member Functions

Detailed Description

Member Function Documentation