libkcal Library API Documentation

KCal::VCalFormat Class Reference

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

#include <vcalformat.h>

Inheritance diagram for KCal::VCalFormat:

Inheritance graph
[legend]
Collaboration diagram for KCal::VCalFormat:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Protected Member Functions

TodoVTodoToEvent (VObject *vtodo)
EventVEventToEvent (VObject *vevent)
VObject * eventToVTodo (const Todo *anEvent)
VObject * eventToVEvent (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

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


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

References KCal::CalFormat::clearException(), populate(), and KCal::CalFormat::setException().

bool VCalFormat::save 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 89 of file vcalformat.cpp.

References eventToVEvent(), eventToVTodo(), KCal::CalFormat::productId(), KCal::Calendar::rawEvents(), and KCal::Calendar::rawTodos().

bool VCalFormat::fromString Calendar ,
const QString
[virtual]
 

Parse string and populate calendar with that information.

Implements KCal::CalFormat.

Definition at line 135 of file vcalformat.cpp.

References KCal::Calendar::addEvent(), and VEventToEvent().

Referenced by KCal::VCalDrag::decode().

QString VCalFormat::toString Calendar  )  [virtual]
 

Return calendar information as string.

Implements KCal::CalFormat.

Definition at line 170 of file vcalformat.cpp.

References KCal::Calendar::events(), eventToVEvent(), and KCal::CalFormat::productId().

Referenced by KCal::VCalDrag::VCalDrag().

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

translates a VObject of the TODO type into a Event

Definition at line 654 of file vcalformat.cpp.

References KCal::IncidenceBase::addAttendee(), KCal::Calendar::getEmail(), ISOToQDateTime(), KCal::Incidence::newAlarm(), KCal::Alarm::setAudioAlarm(), KCal::Incidence::setCategories(), KCal::Todo::setCompleted(), KCal::Incidence::setCreated(), KCal::Incidence::setDescription(), KCal::Todo::setDtDue(), KCal::Todo::setDtStart(), KCal::Alarm::setEnabled(), KCal::Todo::setHasDueDate(), KCal::Todo::setHasStartDate(), KCal::IncidenceBase::setLastModified(), KCal::Incidence::setLocation(), KCal::IncidenceBase::setOrganizer(), KCal::IncidenceBase::setPilotId(), KCal::Incidence::setPriority(), KCal::Alarm::setProcedureAlarm(), KCal::Incidence::setRelatedToUid(), KCal::Attendee::setRSVP(), KCal::Attendee::setStatus(), KCal::Incidence::setSummary(), KCal::IncidenceBase::setSyncStatus(), KCal::Alarm::setTime(), and KCal::IncidenceBase::setUid().

Referenced by populate().

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

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

Definition at line 873 of file vcalformat.cpp.

References KCal::Incidence::addAttachment(), KCal::IncidenceBase::addAttendee(), KCal::Incidence::addExDate(), KCal::Incidence::description(), KCal::Event::dtEnd(), KCal::IncidenceBase::dtStart(), KCal::Calendar::getEmail(), ISOToQDate(), ISOToQDateTime(), KCal::Incidence::newAlarm(), numFromDay(), KCal::Incidence::recurrence(), KCal::Alarm::setAudioAlarm(), KCal::Incidence::setCategories(), KCal::Incidence::setCreated(), KCal::Incidence::setDescription(), KCal::Event::setDtEnd(), KCal::Incidence::setDtStart(), KCal::Alarm::setEnabled(), KCal::IncidenceBase::setFloats(), KCal::IncidenceBase::setLastModified(), KCal::Incidence::setLocation(), KCal::IncidenceBase::setOrganizer(), KCal::IncidenceBase::setPilotId(), KCal::Incidence::setPriority(), KCal::Alarm::setProcedureAlarm(), KCal::Incidence::setRelatedToUid(), KCal::Incidence::setResources(), KCal::Incidence::setRevision(), KCal::Attendee::setRSVP(), KCal::Incidence::setSecrecy(), KCal::Attendee::setStatus(), KCal::Incidence::setSummary(), KCal::IncidenceBase::setSyncStatus(), KCal::Alarm::setTime(), KCal::Event::setTransparency(), KCal::IncidenceBase::setUid(), and KCal::Incidence::summary().

Referenced by fromString(), and populate().

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

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

Definition at line 197 of file vcalformat.cpp.

References KCal::Incidence::alarms(), KCal::IncidenceBase::attendeeCount(), KCal::IncidenceBase::attendees(), KCal::Alarm::audioFile(), KCal::Incidence::categories(), KCal::Todo::completed(), KCal::Incidence::created(), KCal::Incidence::description(), KCal::IncidenceBase::doesFloat(), KCal::Todo::dtDue(), KCal::Todo::dtStart(), KCal::Person::email(), KCal::Alarm::enabled(), KCal::Todo::hasCompletedDate(), KCal::Todo::hasDueDate(), KCal::Todo::hasStartDate(), KCal::Todo::isCompleted(), KCal::IncidenceBase::lastModified(), KCal::Incidence::location(), KCal::Person::name(), KCal::IncidenceBase::organizer(), KCal::IncidenceBase::pilotId(), KCal::Incidence::priority(), KCal::Alarm::programFile(), qDateTimeToISO(), KCal::Incidence::relatedTo(), KCal::Incidence::revision(), KCal::Attendee::RSVP(), KCal::Attendee::status(), KCal::Incidence::summary(), KCal::IncidenceBase::syncStatus(), KCal::Alarm::time(), KCal::Alarm::type(), and KCal::IncidenceBase::uid().

Referenced by save().

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

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

Definition at line 360 of file vcalformat.cpp.

References KCal::Incidence::alarms(), KCal::Incidence::attachments(), KCal::IncidenceBase::attendeeCount(), KCal::IncidenceBase::attendees(), KCal::Alarm::audioFile(), KCal::Incidence::categories(), KCal::Incidence::created(), dayFromNum(), KCal::Incidence::description(), KCal::IncidenceBase::doesFloat(), KCal::Event::dtEnd(), KCal::IncidenceBase::dtStart(), KCal::Person::email(), KCal::Alarm::enabled(), KCal::Incidence::exDates(), KCal::IncidenceBase::lastModified(), KCal::Incidence::location(), KCal::Person::name(), KCal::Recurrence::rMonthPos::negative, KCal::IncidenceBase::organizer(), KCal::IncidenceBase::pilotId(), KCal::Incidence::priority(), KCal::Alarm::programFile(), qDateTimeToISO(), qDateToISO(), KCal::Recurrence::rMonthPos::rDays, KCal::Incidence::recurrence(), KCal::Incidence::relatedTo(), KCal::Incidence::resources(), KCal::Incidence::revision(), KCal::Recurrence::rMonthPos::rPos, KCal::Attendee::RSVP(), KCal::Incidence::secrecy(), KCal::Attendee::status(), KCal::Incidence::summary(), KCal::IncidenceBase::syncStatus(), KCal::Alarm::time(), KCal::Event::transparency(), KCal::Alarm::type(), and KCal::IncidenceBase::uid().

Referenced by save(), and toString().

QString VCalFormat::qDateToISO const QDate  )  [protected]
 

takes a QDate and returns a string in the format YYYYMMDDTHHMMSS

Definition at line 1404 of file vcalformat.cpp.

Referenced by eventToVEvent().

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

takes a QDateTime and returns a string in format YYYYMMDDTHHMMSS

Definition at line 1424 of file vcalformat.cpp.

References KCal::Calendar::timeZoneId().

Referenced by eventToVEvent(), and eventToVTodo().

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

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

Definition at line 1447 of file vcalformat.cpp.

References KCal::Calendar::timeZoneId().

Referenced by VEventToEvent(), and VTodoToEvent().

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

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

Definition at line 1474 of file vcalformat.cpp.

Referenced by VEventToEvent().

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

References KCal::Calendar::addEvent(), KCal::Calendar::addTodo(), KCal::Event::dtEnd(), KCal::IncidenceBase::dtStart(), KCal::Calendar::event(), KCal::CalFormat::productId(), KCal::Calendar::todo(), VEventToEvent(), and VTodoToEvent().

Referenced by load().

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

Referenced by eventToVEvent().

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

the reverse of the above function.

Definition at line 1630 of file vcalformat.cpp.

Referenced by VEventToEvent().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Dec 21 14:22:33 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003