libkcal

KCal::ICalFormat Class Reference

#include <icalformat.h>

Inheritance diagram for KCal::ICalFormat:

KCal::CalFormat List of all members.

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 43 of file icalformat.h.


Public Member Functions

 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 (RecurrenceRule *)
bool fromString (RecurrenceRule *, const QString &)
QString createScheduleMessage (IncidenceBase *e, Scheduler::Method m)
ScheduleMessageparseScheduleMessage (Calendar *, const QString &s)
FreeBusyparseFreeBusy (const QString &)
void setTimeZone (const QString &id, bool utc)
QString timeZoneId () const
bool utc () const

Protected Member Functions

bool fromRawString (Calendar *calendar, const QCString &)
void setImplementation (ICalFormatImpl *impl)

Member Function Documentation

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

Create a scheduling message for event e using method m.

Definition at line 321 of file icalformat.cpp.

bool ICalFormat::fromRawString Calendar calendar,
const QCString & 
[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 142 of file icalformat.cpp.

bool ICalFormat::fromString RecurrenceRule ,
const QString & 
 

Parse string and fill recurrence object with that information.

Definition at line 302 of file icalformat.cpp.

Incidence * ICalFormat::fromString const QString &   ) 
 

Parse string and return first ical component.

Definition at line 197 of file icalformat.cpp.

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

Parse string and populate calendar with that information.

Implements KCal::CalFormat.

Definition at line 137 of file icalformat.cpp.

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

FreeBusy * ICalFormat::parseFreeBusy const QString &   ) 
 

Parse FREEBUSY object.

Definition at line 358 of file icalformat.cpp.

ScheduleMessage * ICalFormat::parseScheduleMessage Calendar ,
const QString &  s
 

Parse scheduling message provided as string s.

Definition at line 388 of file icalformat.cpp.

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

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

QString ICalFormat::timeZoneId  )  const
 

Return id string of timezone used.

Definition at line 569 of file icalformat.cpp.

QString ICalFormat::toICalString Incidence  ) 
 

Return incidence as full iCalendar formatted text.

Definition at line 273 of file icalformat.cpp.

QString ICalFormat::toString RecurrenceRule  ) 
 

Return recurrence rule as iCalendar formatted text.

Definition at line 293 of file icalformat.cpp.

QString ICalFormat::toString Incidence  ) 
 

Return incidence as iCalendar formatted text.

Definition at line 280 of file icalformat.cpp.

QString ICalFormat::toString Calendar  )  [virtual]
 

Return calendar information as string.

Implements KCal::CalFormat.

Definition at line 221 of file icalformat.cpp.

bool ICalFormat::utc  )  const
 

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

Definition at line 574 of file icalformat.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys