• Skip to content
  • Skip to link menu
KDE 4.4 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KCal Library

KCal::ICalFormatImpl

KCal::ICalFormatImpl Class Reference

This class provides the libical dependent functions for ICalFormat. More...

#include <icalformat_p.h>

List of all members.

Public Member Functions

 ICalFormatImpl (ICalFormat *parent)
icalcomponent * createCalendarComponent (Calendar *calendar=0)
icalcomponent * createScheduleComponent (IncidenceBase *incidence, iTIPMethod method)
QString extractErrorProperty (icalcomponent *)
QString loadedProductId () const
bool populate (Calendar *calendar, icalcomponent *fs)
void readAlarm (icalcomponent *alarm, Incidence *incidence, ICalTimeZones *tzlist)
Attachment * readAttachment (icalproperty *attach)
Attendee * readAttendee (icalproperty *attendee)
Event * readEvent (icalcomponent *vevent, ICalTimeZones *tzlist)
void readExceptionRule (icalproperty *rrule, Incidence *incidence)
FreeBusy * readFreeBusy (icalcomponent *vfreebusy)
void readIncidence (icalcomponent *parent, Incidence *incidence, ICalTimeZones *tzlist)
Journal * readJournal (icalcomponent *vjournal, ICalTimeZones *tzlist)
Person readOrganizer (icalproperty *organizer)
void readRecurrence (const struct icalrecurrencetype &r, RecurrenceRule *recur)
void readRecurrenceRule (icalproperty *rrule, Incidence *event)
Todo * readTodo (icalcomponent *vtodo, ICalTimeZones *tzlist)
icalcomponent * writeAlarm (Alarm *alarm)
icalproperty * writeAttachment (Attachment *attach)
icalproperty * writeAttendee (Attendee *attendee)
icalproperty * writeDescription (const QString &description, bool isRich=false)
icalcomponent * writeEvent (Event *event, ICalTimeZones *tzlist=0, ICalTimeZones *tzUsedList=0)
icalcomponent * writeFreeBusy (FreeBusy *freebusy, iTIPMethod method=iTIPPublish)
void writeIncidence (icalcomponent *parent, Incidence *incidence, ICalTimeZones *tzlist=0, ICalTimeZones *tzUsedList=0)
icalcomponent * writeIncidence (IncidenceBase *incidence, iTIPMethod method=iTIPRequest)
icalcomponent * writeJournal (Journal *journal, ICalTimeZones *tzlist=0, ICalTimeZones *tzUsedList=0)
icalproperty * writeLocation (const QString &location, bool isRich=false)
icalproperty * writeOrganizer (const Person &organizer)
icalrecurrencetype writeRecurrenceRule (RecurrenceRule *recur)
icalproperty * writeRecurrenceRule (Recurrence *)
icalproperty * writeSummary (const QString &summary, bool isRich=false)
icalcomponent * writeTodo (Todo *todo, ICalTimeZones *tzlist=0, ICalTimeZones *tzUsedList=0)

Static Public Member Functions

static QDate readICalDate (icaltimetype)
static KDateTime readICalDateTime (icalproperty *p, const icaltimetype &t, ICalTimeZones *tzlist, bool utc=false)
static KDateTime readICalDateTimeProperty (icalproperty *p, ICalTimeZones *tzlist, bool utc=false)
static Duration readICalDuration (icaldurationtype d)
static KDateTime readICalUtcDateTime (icalproperty *p, icaltimetype &t, ICalTimeZones *tzlist=0)
static KDateTime readICalUtcDateTimeProperty (icalproperty *p)
static icaltimetype writeICalDate (const QDate &)
static icaldatetimeperiodtype writeICalDatePeriod (const QDate &date)
static icaltimetype writeICalDateTime (const KDateTime &)
static icalproperty * writeICalDateTimeProperty (const icalproperty_kind kind, const KDateTime &dt, ICalTimeZones *tzlist=0, ICalTimeZones *tzUsedList=0)
static icaldurationtype writeICalDuration (const Duration &duration)
static icaltimetype writeICalUtcDateTime (const KDateTime &)

Protected Member Functions

void dumpIcalRecurrence (icalrecurrencetype r)

Detailed Description

This class provides the libical dependent functions for ICalFormat.

This class implements the iCalendar format. It provides methods for loading/saving/converting iCalendar format data into the internal representation as Calendar and Incidences.

For internal use only.

Definition at line 67 of file icalformat_p.h.


Constructor & Destructor Documentation

KCal::ICalFormatImpl::ICalFormatImpl ( ICalFormat *  parent  )  [explicit]

Create new iCal format for calendar object.


Member Function Documentation

QString KCal::ICalFormatImpl::loadedProductId (  )  const

Returns the PRODID string loaded from calendar file.

bool KCal::ICalFormatImpl::populate ( Calendar *  calendar,
icalcomponent *  fs 
)

Updates a calendar with data from a raw iCalendar.

Incidences already existing in calendar are not affected except that if a new incidence with the same UID is found, the existing incidence is replaced.

static KDateTime KCal::ICalFormatImpl::readICalDateTime ( icalproperty *  p,
const icaltimetype &  t,
ICalTimeZones *  tzlist,
bool  utc = false 
) [static]

Converts a date/time from ICal format.

If the property p specifies a time zone using the TZID parameter, a match is searched for in tzlist. If no match is found, the time zone is added to tzlist.

Parameters:
p property from which t has been obtained
t ICal format date/time
tzlist time zones collection
utc UTC date/time is expected
Returns:
date/time, converted to UTC if utc is true
static KDateTime KCal::ICalFormatImpl::readICalDateTimeProperty ( icalproperty *  p,
ICalTimeZones *  tzlist,
bool  utc = false 
) [static]

Reads a date or date/time value from a property.

Parameters:
p ical parameter to read from
tzlist time zones collection
utc true to read a UTC value, false to allow time zone to be specified.
Returns:
date or date/time, or invalid if property doesn't contain a time value.
static KDateTime KCal::ICalFormatImpl::readICalUtcDateTime ( icalproperty *  p,
icaltimetype &  t,
ICalTimeZones *  tzlist = 0 
) [inline, static]

Converts a UTC date/time from ICal format.

If t is not a UTC date/time, it is treated as invalid.

Parameters:
t ICal format date/time
Returns:
date/time, or invalid if t is not UTC

Definition at line 182 of file icalformat_p.h.

static KDateTime KCal::ICalFormatImpl::readICalUtcDateTimeProperty ( icalproperty *  p  )  [inline, static]

Reads a UTC date/time value from a property.

Definition at line 202 of file icalformat_p.h.

static icalproperty* KCal::ICalFormatImpl::writeICalDateTimeProperty ( const icalproperty_kind  kind,
const KDateTime &  dt,
ICalTimeZones *  tzlist = 0,
ICalTimeZones *  tzUsedList = 0 
) [static]

Creates an ical property from a date/time value.

If a time zone is specified for the value, a TZID parameter is inserted into the ical property, tzlist and tzUsedList are updated to include the time zone. Note that while tzlist owns any time zone instances in its collection, tzUsedList does not.

Parameters:
kind kind of property
dt date/time value
tzlist time zones collection
tzUsedList time zones collection, only updated if tzlist is also specified
Returns:
property, or null if error. It is the caller's responsibility to free the returned property.

The documentation for this class was generated from the following file:
  • icalformat_p.h

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.2-20100208
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal