libkcal
KCal::ICalFormat Class Reference
This class implements the iCalendar format. More...
#include <icalformat.h>
Public Member Functions | |
| QString | createScheduleMessage (IncidenceBase *e, Scheduler::Method m) |
| bool | fromString (RecurrenceRule *, const QString &) |
| Incidence * | fromString (const QString &) |
| bool | fromString (Calendar *calendar, const QString &) |
| ICalFormat () | |
| bool | load (Calendar *calendar, const QString &fileName) |
| FreeBusy * | parseFreeBusy (const QString &) |
| ScheduleMessage * | parseScheduleMessage (Calendar *, const QString &s) |
| bool | save (Calendar *calendar, const QString &fileName) |
| void | setTimeZone (const QString &id, bool utc) |
| QString | timeZoneId () const |
| QString | toICalString (Incidence *) |
| QString | toString (RecurrenceRule *) |
| QString | toString (Incidence *) |
| QString | toString (Calendar *) |
| bool | utc () const |
| virtual | ~ICalFormat () |
Protected Member Functions | |
| bool | fromRawString (Calendar *calendar, const QCString &) |
| 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.
Constructor & Destructor Documentation
| ICalFormat::ICalFormat | ( | ) |
Definition at line 55 of file icalformat.cpp.
| ICalFormat::~ICalFormat | ( | ) | [virtual] |
Definition at line 63 of file icalformat.cpp.
Member Function Documentation
| QString ICalFormat::createScheduleMessage | ( | IncidenceBase * | e, | |
| Scheduler::Method | m | |||
| ) |
Create a scheduling message for event e using method m.
Definition at line 324 of file icalformat.cpp.
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 143 of file icalformat.cpp.
| bool ICalFormat::fromString | ( | RecurrenceRule * | recurrence, | |
| const QString & | rrule | |||
| ) |
Parse string and fill recurrence object with that information.
Definition at line 305 of file icalformat.cpp.
Parse string and populate calendar with that information.
Implements KCal::CalFormat.
Definition at line 138 of file icalformat.cpp.
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.
| ScheduleMessage * ICalFormat::parseScheduleMessage | ( | Calendar * | cal, | |
| const QString & | s | |||
| ) |
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::setImplementation | ( | ICalFormatImpl * | impl | ) | [protected] |
Definition at line 68 of file icalformat.cpp.
| void ICalFormat::setTimeZone | ( | const QString & | id, | |
| bool | utc | |||
| ) |
Set id of used time zone and whether this time zone is UTC or not.
Definition at line 566 of file icalformat.cpp.
| QString ICalFormat::timeZoneId | ( | ) | const |
| QString ICalFormat::toString | ( | RecurrenceRule * | recurrence | ) |
Return calendar information as string.
Implements KCal::CalFormat.
Definition at line 224 of file icalformat.cpp.
| bool ICalFormat::utc | ( | ) | const |
Return true if timezone used is UTC, otherwise return false.
Definition at line 577 of file icalformat.cpp.
The documentation for this class was generated from the following files:
