libkcal Library API Documentation

KCal::ICalFormat Class Reference

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

#include <icalformat.h>

Inheritance diagram for KCal::ICalFormat:

KCal::CalFormat List of all members.

Public Methods

 ICalFormat ()
virtual ~ICalFormat ()
bool load (Calendar *calendar, const QString &fileName)
bool save (Calendar *calendar, const QString &fileName)
bool fromString (Calendar *calendar, const QString &)
IncidencefromString (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)
ScheduleMessageparseScheduleMessage (Calendar *, const QString &s)
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 41 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 66 of file icalformat.cpp.

References KCal::CalFormat::clearException(), QFile::close(), fromString(), QString::fromUtf8(), QString::latin1(), QFile::open(), QTextStream::read(), QString::replace(), QTextStream::setEncoding(), KCal::CalFormat::setException(), and QString::stripWhiteSpace().

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

References KCal::CalFormat::clearException(), QString::isNull(), KCal::CalFormat::setException(), toString(), and QString::utf8().

bool ICalFormat::fromString Calendar   calendar,
const QString  
[virtual]
 

Parse string and populate calendar with that information.

Implements KCal::CalFormat.

Definition at line 130 of file icalformat.cpp.

References KCal::CalFormat::exception(), KCal::Calendar::isLocalTime(), KCal::CalFormat::setException(), setTimeZone(), KCal::Calendar::timeZoneId(), and QString::utf8().

Referenced by KCal::ICalDrag::decode(), fromString(), and load().

Incidence * ICalFormat::fromString const QString  
 

Parse string and return first ical component.

Definition at line 183 of file icalformat.cpp.

References KCal::Incidence::clone(), KCal::Calendar::events(), fromString(), KCal::CalendarLocal::journals(), and KCal::CalendarLocal::todos().

QString ICalFormat::toString Calendar   [virtual]
 

Return calendar information as string.

Implements KCal::CalFormat.

Definition at line 207 of file icalformat.cpp.

References QString::fromUtf8(), 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 258 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 265 of file icalformat.cpp.

References QString::fromUtf8().

QString ICalFormat::toString Recurrence  
 

Return recurrence as iCalendar formatted text.

Definition at line 278 of file icalformat.cpp.

References QString::fromUtf8().

bool ICalFormat::fromString Recurrence  ,
const QString  
 

Parse string and fill recurrence object with that information.

Definition at line 287 of file icalformat.cpp.

References QString::latin1().

QString ICalFormat::createScheduleMessage IncidenceBase   e,
Scheduler::Method    m
 

Create a scheduling message for event e using method m.

Definition at line 305 of file icalformat.cpp.

References QString::fromUtf8().

Referenced by KCal::ResourceIMAP::addEvent(), KCal::ResourceIMAP::addJournal(), KCal::ResourceIMAP::addTodo(), and KCal::ResourceIMAP::update().

ScheduleMessage * ICalFormat::parseScheduleMessage Calendar  ,
const QString   s
 

Parse scheduling message provided as string s.

Definition at line 321 of file icalformat.cpp.

References KCal::CalFormat::clearException(), KCal::Calendar::event(), QString::isEmpty(), KCal::Calendar::isLocalTime(), KCal::CalFormat::setException(), setTimeZone(), KCal::Calendar::timeZoneId(), KCal::IncidenceBase::type(), KCal::IncidenceBase::uid(), and QString::utf8().

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

References utc().

Referenced by fromString(), parseScheduleMessage(), KCal::Scheduler::Scheduler(), and toString().

QString ICalFormat::timeZoneId   const
 

Return id string of timezone used.

Definition at line 472 of file icalformat.cpp.

bool ICalFormat::utc   const
 

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

Definition at line 477 of file icalformat.cpp.

Referenced by setTimeZone().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:24 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003