KDE PIM / Developers / API Docs / libkcal
KCal::VCalFormat

KCal::VCalFormat Class Reference

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

#include <vcalformat.h>

Inherits KCal::CalFormat.

List of all members.

Public Member Functions

Protected Member Functions

Detailed Description

This class implements the vCalendar format. vCalendar format implementation.

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

Member Function Documentation

bool VCalFormat::load (  Calendar *  calendar,
const QString &  fileName
)  [virtual]
 

Loads a calendar on disk in vCalendar format into the given calendar.

Parameters:
calendar Calendar object the loaded data is stored into.
fileName Name of the vCalendar file on disk.
Returns:
true on success, otherwise false

Implements KCal::CalFormat.

bool VCalFormat::save (  Calendar *  calendar,
const QString &  fileName
)  [virtual]
 

Writes out the given calendar to disk in vCalendar format.

Parameters:
calendar Calendar object holding data to be written
fileName the name of the file
Returns:
true on success, otherwise false

Implements KCal::CalFormat.

bool VCalFormat::fromString (  Calendar *  ,
const QString & 
)  [virtual]
 

Parse string and populate calendar with that information.

Implements KCal::CalFormat.

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

Return calendar information as string.

Implements KCal::CalFormat.

Todo * VCalFormat::VTodoToEvent (  VObject *  vtodo  )  [protected]
 

translates a VObject of the TODO type into a Event

Event * VCalFormat::VEventToEvent (  VObject *  vevent  )  [protected]
 

translates a VObject into a Event and returns a pointer to it.

VObject * VCalFormat::eventToVTodo (  const Todo *  anEvent  )  [protected]
 

translate a Event into a VTodo-type VObject and return pointer

VObject * VCalFormat::eventToVEvent (  const Event *  anEvent  )  [protected]
 

translate a Event into a VObject and returns a pointer to it.

QString VCalFormat::qDateToISO (  const QDate &   )  [protected]
 

takes a QDate and returns a string in the format YYYYMMDDTHHMMSS

QString VCalFormat::qDateTimeToISO (  const QDateTime &  ,
bool  zulu = TRUE
)  [protected]
 

takes a QDateTime and returns a string in format YYYYMMDDTHHMMSS

QDateTime VCalFormat::ISOToQDateTime (  const QString &  dtStr  )  [protected]
 

takes a string in the format YYYYMMDDTHHMMSS and returns a valid QDateTime.

QDate VCalFormat::ISOToQDate (  const QString &  dtStr  )  [protected]
 

takes a string in the format YYYYMMDD and returns a valid QDate.

void VCalFormat::populate (  VObject *  vcal  )  [protected]
 

takes a vCalendar tree of VObjects, and puts all of them that have the "event" property into the dictionary, todos in the todo-list, etc.

const char * VCalFormat::dayFromNum (  int  day  )  [protected]
 

takes a number 0 - 6 and returns the two letter string of that day, i.e.

MO, TU, WE, etc.

int VCalFormat::numFromDay (  const QString &  day  )  [protected]
 

the reverse of the above function.

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