libkcal

KCal::VCalFormat

KCal::VCalFormat Class Reference

This class implements the vCalendar format. More...

#include <vcalformat.h>

Inheritance diagram for KCal::VCalFormat:

Inheritance graph
[legend]

List of all members.


Public Member Functions

bool fromString (Calendar *, const QString &)
bool load (Calendar *calendar, const QString &fileName)
bool save (Calendar *calendar, const QString &fileName)
QString toString (Calendar *)
 VCalFormat ()
virtual ~VCalFormat ()

Protected Member Functions

const char * dayFromNum (int day)
VObject * eventToVEvent (const Event *anEvent)
VObject * eventToVTodo (const Todo *anEvent)
QDate ISOToQDate (const QString &dtStr)
QDateTime ISOToQDateTime (const QString &dtStr)
int numFromDay (const QString &day)
void populate (VObject *vcal)
QString qDateTimeToISO (const QDateTime &, bool zulu=TRUE)
QString qDateToISO (const QDate &)
Attendee::PartStat readStatus (const char *s) const
Event * VEventToEvent (VObject *vevent)
Todo * VTodoToEvent (VObject *vtodo)
QCString writeStatus (Attendee::PartStat status) const

Detailed Description

This class implements the vCalendar format.

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

vCalendar format implementation

Definition at line 44 of file vcalformat.h.

Constructor & Destructor Documentation

VCalFormat::VCalFormat (  ) 

Definition at line 50 of file vcalformat.cpp.

VCalFormat::~VCalFormat (  )  [virtual]

Definition at line 54 of file vcalformat.cpp.

Member Function Documentation

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.

Definition at line 1548 of file vcalformat.cpp.

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

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

Definition at line 365 of file vcalformat.cpp.

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

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

Definition at line 203 of file vcalformat.cpp.

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

Parse string and populate calendar with that information.

Implements KCal::CalFormat.

Definition at line 136 of file vcalformat.cpp.

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

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

Definition at line 1402 of file vcalformat.cpp.

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

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

Definition at line 1375 of file vcalformat.cpp.

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.

Definition at line 58 of file vcalformat.cpp.

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

the reverse of the above function.

Definition at line 1555 of file vcalformat.cpp.

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.

Definition at line 1416 of file vcalformat.cpp.

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

takes a QDateTime and returns a string in format YYYYMMDDTHHMMSS

Definition at line 1352 of file vcalformat.cpp.

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

takes a QDate and returns a string in the format YYYYMMDDTHHMMSS

Definition at line 1324 of file vcalformat.cpp.

Attendee::PartStat VCalFormat::readStatus ( const char *  s  )  const [protected]

Definition at line 1568 of file vcalformat.cpp.

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.

Definition at line 90 of file vcalformat.cpp.

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

Return calendar information as string.

Implements KCal::CalFormat.

Definition at line 172 of file vcalformat.cpp.

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

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

Definition at line 857 of file vcalformat.cpp.

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

translates a VObject of the TODO type into a Event

Definition at line 651 of file vcalformat.cpp.

QCString VCalFormat::writeStatus ( Attendee::PartStat  status  )  const [protected]

Definition at line 1600 of file vcalformat.cpp.

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