#include <icalformat.h>

Public Member Functions | |
bool | load (Calendar *calendar, const TQString &fileName) |
bool | save (Calendar *calendar, const TQString &fileName) |
bool | fromString (Calendar *calendar, const TQString &) |
Incidence * | fromString (const TQString &) |
TQString | toString (Calendar *) |
TQString | toICalString (Incidence *) |
TQString | toString (Incidence *) |
TQString | toString (Incidence *, Calendar *) |
TQString | toString (RecurrenceRule *) |
bool | fromString (RecurrenceRule *, const TQString &) |
TQString | createScheduleMessage (IncidenceBase *e, Scheduler::Method m) |
ScheduleMessage * | parseScheduleMessage (Calendar *, const TQString &s) |
FreeBusy * | parseFreeBusy (const TQString &) |
void | setTimeZone (const TQString &id, bool utc) |
TQString | timeZoneId () const |
bool | utc () const |
Protected Member Functions | |
bool | fromRawString (Calendar *calendar, const TQCString &) |
void | setImplementation (ICalFormatImpl *impl) |
Detailed Description
This class implements the iCalendar format.
It provides methods for loading/saving/converting iCalendar format data into the internal KOrganizer representation as Calendar and Events.
iCalendar format implementation
Definition at line 43 of file icalformat.h.
Member Function Documentation
TQString ICalFormat::createScheduleMessage | ( | IncidenceBase * | e, |
Scheduler::Method | m | ||
) |
Create a scheduling message for event e
using method m
.
Definition at line 369 of file icalformat.cpp.
bool ICalFormat::fromRawString | ( | Calendar * | calendar, |
const TQCString & | text | ||
) | [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.
Definition at line 144 of file icalformat.cpp.
bool ICalFormat::fromString | ( | Calendar * | calendar, |
const TQString & | text | ||
) | [virtual] |
Parse string and populate calendar with that information.
Implements KCal::CalFormat.
Definition at line 139 of file icalformat.cpp.
Incidence * ICalFormat::fromString | ( | const TQString & | text | ) |
Parse string and return first ical component.
Definition at line 201 of file icalformat.cpp.
bool ICalFormat::fromString | ( | RecurrenceRule * | recurrence, |
const TQString & | rrule | ||
) |
Parse string and fill recurrence object with that information.
Definition at line 350 of file icalformat.cpp.
bool ICalFormat::load | ( | Calendar * | calendar, |
const TQString & | 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.
Definition at line 78 of file icalformat.cpp.
FreeBusy * ICalFormat::parseFreeBusy | ( | const TQString & | str | ) |
Parse FREEBUSY object.
Definition at line 406 of file icalformat.cpp.
ScheduleMessage * ICalFormat::parseScheduleMessage | ( | Calendar * | cal, |
const TQString & | s | ||
) |
Parse scheduling message provided as string s
.
Definition at line 436 of file icalformat.cpp.
bool ICalFormat::save | ( | Calendar * | calendar, |
const TQString & | 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.
Definition at line 102 of file icalformat.cpp.
void ICalFormat::setTimeZone | ( | const TQString & | id, |
bool | utc | ||
) |
Set id of used time zone and whether this time zone is UTC or not.
Definition at line 611 of file icalformat.cpp.
TQString ICalFormat::timeZoneId | ( | ) | const |
Return id string of timezone used.
Definition at line 617 of file icalformat.cpp.
TQString ICalFormat::toICalString | ( | Incidence * | incidence | ) |
Return incidence as full iCalendar formatted text.
Definition at line 277 of file icalformat.cpp.
TQString ICalFormat::toString | ( | Calendar * | cal | ) | [virtual] |
Return calendar information as string.
Implements KCal::CalFormat.
Definition at line 225 of file icalformat.cpp.
TQString ICalFormat::toString | ( | Incidence * | incidence | ) |
Return incidence as iCalendar formatted text.
Definition at line 284 of file icalformat.cpp.
TQString ICalFormat::toString | ( | Incidence * | incidence, |
Calendar * | calendar | ||
) |
Return incidence as iCalendar formatted text.
This function includes all RECURRENCE-ID related incidences.
- Returns:
- TQString of iCalendar formatted text.
- Since:
- 3.5.12
Definition at line 297 of file icalformat.cpp.
TQString ICalFormat::toString | ( | RecurrenceRule * | recurrence | ) |
Return recurrence rule as iCalendar formatted text.
Definition at line 341 of file icalformat.cpp.
bool ICalFormat::utc | ( | ) | const |
Return true if timezone used is UTC, otherwise return false.
Definition at line 622 of file icalformat.cpp.
The documentation for this class was generated from the following files: