KCalCore::ICalFormatImpl Class Reference

#include <icalformat_p.h>

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

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.

Definition at line 89 of file icalformat_p.h.

Constructor & Destructor Documentation

KCalCore::ICalFormatImpl::ICalFormatImpl ( ICalFormat *  parent )

explicit

Construct a new iCal format for calendar object.

Parameters

parent

is a pointer to a valid ICalFormat object.

virtual KCalCore::ICalFormatImpl::~ICalFormatImpl ( )

virtual

Destructor.

Member Function Documentation

QString KCalCore::ICalFormatImpl::loadedProductId

(

)

const

Returns the PRODID string loaded from calendar file.

bool KCalCore::ICalFormatImpl::populate	(	const Calendar::Ptr &	calendar,
		icalcomponent *	fs,
		bool	deleted = false,
		const QString &	notebook = QString()
	)

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 KCalCore::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 KCalCore::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 KCalCore::ICalFormatImpl::readICalUtcDateTime ( icalproperty *  p, icaltimetype &  t, ICalTimeZones *  tzlist = 0  )

inlinestatic

Converts a UTC date/time from ICal format.

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

Parameters

p	ical parameter to read from
t	ICal format date/time
tzlist	time zones collection

Returns

date/time, or invalid if t is not UTC

Definition at line 215 of file icalformat_p.h.

static KDateTime KCalCore::ICalFormatImpl::readICalUtcDateTimeProperty ( icalproperty *  p )

inlinestatic

Reads a UTC date/time value from a property.

Parameters

p	is a pointer to a valid icalproperty structure.

Definition at line 239 of file icalformat_p.h.

static icalproperty* KCalCore::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