libkcal

KCal::VCalFormat Class Reference

#include <vcalformat.h>

Inheritance diagram for KCal::VCalFormat:

KCal::CalFormat List of all members.

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.

Definition at line 44 of file vcalformat.h.


Public Member Functions

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

Protected Member Functions

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

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.

Definition at line 58 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.

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

Parse string and populate calendar with that information.

Implements KCal::CalFormat.

Definition at line 136 of file vcalformat.cpp.

QString VCalFormat::toString ( Calendar  )  [virtual]

Return calendar information as string.

Implements KCal::CalFormat.

Definition at line 172 of file vcalformat.cpp.

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

translates a VObject of the TODO type into a Event

Definition at line 648 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 854 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 200 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 362 of file vcalformat.cpp.

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

takes a QDate and returns a string in the format YYYYMMDDTHHMMSS

Definition at line 1321 of file vcalformat.cpp.

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

takes a QDateTime and returns a string in format YYYYMMDDTHHMMSS

Definition at line 1349 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 1372 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 1399 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 1413 of file vcalformat.cpp.

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 1545 of file vcalformat.cpp.

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

the reverse of the above function.

Definition at line 1552 of file vcalformat.cpp.


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