KDE PIM / Developers / API Docs / libkcal

KCal::ICalFormat Class Reference

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

#include <icalformat.h>

Inherits KCal::CalFormat.

List of all members.

Public Member Functions

Protected Member Functions


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.


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.

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.

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

Parse string and populate calendar with that information.

Implements KCal::CalFormat.

Incidence * ICalFormat::fromString const QString &   ) 
 

Parse string and return first ical component.

QString ICalFormat::toString Calendar  )  [virtual]
 

Return calendar information as string.

Implements KCal::CalFormat.

QString ICalFormat::toICalString Incidence  ) 
 

Return incidence as full iCalendar formatted text.

QString ICalFormat::toString Incidence  ) 
 

Return incidence as iCalendar formatted text.

QString ICalFormat::toString Recurrence  ) 
 

Return recurrence as iCalendar formatted text.

bool ICalFormat::fromString Recurrence ,
const QString & 
 

Parse string and fill recurrence object with that information.

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

Create a scheduling message for event e using method m.

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

Parse scheduling message provided as string s.

FreeBusy * ICalFormat::parseFreeBusy const QString &   ) 
 

Parse FREEBUSY object.

void ICalFormat::setTimeZone const QString &  id,
bool  utc
 

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

QString ICalFormat::timeZoneId  )  const
 

Return id string of timezone used.

bool ICalFormat::utc  )  const
 

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

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.


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