KCalCore Namespace Reference

Classes
struct	_MSSystemTime
class	Alarm
class	Attachment
class	Attendee
class	Calendar
class	CalFilter
class	CalFormat
class	CalStorage
class	Compat
class	Compat32PrereleaseVersions
class	CompatDecorator
class	CompatFactory
class	CompatOutlook9
class	CompatPre31
class	CompatPre32
class	CompatPre34
class	CompatPre35
class	CompatPre410
class	CustomProperties
class	Duration
class	Event
class	Exception
class	FileStorage
class	FreeBusy
class	FreeBusyCache
class	FreeBusyPeriod
class	FreeBusyUrlStore
class	ICalFormat
class	ICalFormatImpl
class	ICalTimeZone
class	ICalTimeZoneBackend
class	ICalTimeZoneData
class	ICalTimeZones
class	ICalTimeZoneSource
class	Incidence
class	IncidenceBase
class	Journal
class	MemoryCalendar
class	OccurrenceIterator
class	Period
class	Person
class	Recurrence
class	RecurrenceRule
class	ScheduleMessage
class	SortableList
class	Todo
class	VCalFormat
class	Visitor

Typedefs
typedef SortableList< QDate >	DateList
typedef SortableList< KDateTime >	DateTimeList
typedef struct KCalCore::_MSSystemTime	MSSystemTime
typedef struct KCalCore::_MSTimeZone	MSTimeZone
typedef SortableList< QTime >	TimeList

Enumerations
enum	EventSortField { EventSortUnsorted, EventSortStartDate, EventSortEndDate, EventSortSummary }
enum	iTIPMethod {   iTIPPublish, iTIPRequest, iTIPReply, iTIPAdd,   iTIPCancel, iTIPRefresh, iTIPCounter, iTIPDeclineCounter,   iTIPNoMethod }
enum	JournalSortField { JournalSortUnsorted, JournalSortDate, JournalSortSummary }
enum	SortDirection { SortDirectionAscending, SortDirectionDescending }
enum	TodoSortField {   TodoSortUnsorted, TodoSortStartDate, TodoSortDueDate, TodoSortPriority,   TodoSortPercentComplete, TodoSortSummary, TodoSortCreated }

Functions
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::FreeBusyPeriod &period)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::Person::Ptr &person)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::Period &period)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::CustomProperties &properties)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &out, const KCalCore::Attachment::Ptr &)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::FreeBusy::Ptr &freebusy)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &out, const KCalCore::Duration &)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &out, const KCalCore::RecurrenceRule *)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::Attendee::Ptr &attendee)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &out, const KCalCore::RecurrenceRule::WDayPos &)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &out, KCalCore::Recurrence *)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &out, const KCalCore::Alarm::Ptr &)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &out, const KCalCore::IncidenceBase::Ptr &)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &stream, KCalCore::FreeBusyPeriod &period)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &stream, KCalCore::Period &period)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &stream, KCalCore::Person::Ptr &person)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &stream, KCalCore::CustomProperties &properties)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &in, const KCalCore::Attachment::Ptr &)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &stream, KCalCore::FreeBusy::Ptr &freebusy)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &in, KCalCore::Duration &)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &in, const KCalCore::RecurrenceRule *)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &in, KCalCore::RecurrenceRule::WDayPos &)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &stream, KCalCore::Attendee::Ptr &attendee)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &in, KCalCore::Recurrence *)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &in, const KCalCore::Alarm::Ptr &)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &in, const KCalCore::IncidenceBase::Ptr &)

Detailed Description

TODO: KDE5:

This API needs serious cleaning up:

• Most (all) methods aren't async ( deleteIncidence(), addIncidence(), load(), save(), ... ) so it's not very easy to make a derived class that loads from akonadi.
• It has too many methods. Why do we need fooEvent()/fooJournal()/fooTodo() when fooIncidence() should be enough.

Typedef Documentation

typedef SortableList< QDate > KCalCore::DateList

List of dates.

Definition at line 76 of file incidencebase.h.

typedef SortableList< KDateTime > KCalCore::DateTimeList

List of times.

Definition at line 79 of file incidencebase.h.

typedef struct KCalCore::_MSSystemTime KCalCore::MSSystemTime

Placeholhers for Microsoft and ActiveSync timezone data.

See also

http://msdn.microsoft.com/en-us/library/ms725481(VS.85).aspx (TIME_ZONE_INFORMATION Structure)

Enumeration Type Documentation

enum KCalCore::EventSortField

Calendar Event sort keys.

Enumerator
EventSortUnsorted	Do not sort Events.
EventSortStartDate	Sort Events chronologically, by start date.
EventSortEndDate	Sort Events chronologically, by end date.
EventSortSummary	Sort Events alphabetically, by summary.

Definition at line 77 of file calendar.h.

enum KCalCore::iTIPMethod

iTIP methods.

Enumerator
iTIPPublish	Event, to-do, journal or freebusy posting.
iTIPRequest	Event, to-do or freebusy scheduling request.
iTIPReply	Event, to-do or freebusy reply to request.
iTIPAdd	Event, to-do or journal additional property request.
iTIPCancel	Event, to-do or journal cancellation notice.
iTIPRefresh	Event or to-do description update request.
iTIPCounter	Event or to-do submit counter proposal.
iTIPDeclineCounter	Event or to-do decline a counter proposal.
iTIPNoMethod	No method.

Definition at line 35 of file schedulemessage.h.

enum KCalCore::JournalSortField

Calendar Journal sort keys.

Enumerator
JournalSortUnsorted	Do not sort Journals.
JournalSortDate	Sort Journals chronologically by date.
JournalSortSummary	Sort Journals alphabetically, by summary.

Definition at line 100 of file calendar.h.

enum KCalCore::SortDirection

Calendar Incidence sort directions.

Enumerator
SortDirectionAscending	Sort in ascending order (first to last)
SortDirectionDescending	Sort in descending order (last to first)

Definition at line 69 of file calendar.h.

enum KCalCore::TodoSortField

Calendar Todo sort keys.

Enumerator
TodoSortUnsorted	Do not sort Todos.
TodoSortStartDate	Sort Todos chronologically, by start date.
TodoSortDueDate	Sort Todos chronologically, by due date.
TodoSortPriority	Sort Todos by priority.
TodoSortPercentComplete	Sort Todos by percentage completed.
TodoSortSummary	Sort Todos alphabetically, by summary.
TodoSortCreated	Sort Todos chronologically, by creation date.

Definition at line 87 of file calendar.h.

Function Documentation

QDataStream & KCalCore::operator<<	(	QDataStream &	stream,
		const KCalCore::FreeBusyPeriod &	period
	)

Write period to the datastream stream, in binary format.

Definition at line 109 of file freebusyperiod.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	stream,
		const KCalCore::Person::Ptr &	person
	)

Serializes the person object into the stream.

Definition at line 176 of file person.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	stream,
		const KCalCore::Period &	period
	)

Write period to the datastream stream, in binary format.

Definition at line 152 of file period.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	stream,
		const KCalCore::CustomProperties &	properties
	)

Serializes the properties object into the stream.

Definition at line 263 of file customproperties.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	out,
		const KCalCore::Attachment::Ptr &	a
	)

Attachment serializer.

Since

4.12

Definition at line 243 of file attachment.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	stream,
		const KCalCore::FreeBusy::Ptr &	freebusy
	)

Serializes the freebusy object into the stream.

Definition at line 407 of file freebusy.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	out,
		const KCalCore::Duration &	duration
	)

Duration serializer.

Since

4.12

Definition at line 215 of file duration.cpp.

KCALCORE_EXPORT QDataStream & KCalCore::operator<<	(	QDataStream &	out,
		const KCalCore::RecurrenceRule *	r
	)

RecurrenceRule serializer and deserializer.

Since

4.12

Definition at line 2301 of file recurrencerule.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	stream,
		const KCalCore::Attendee::Ptr &	attendee
	)

Serializes an Attendee object into a data stream.

Parameters

stream	is a QDataStream.
attendee	is a pointer to a Attendee object to be serialized.

Definition at line 269 of file attendee.cpp.

KCALCORE_EXPORT QDataStream & KCalCore::operator<<	(	QDataStream &	out,
		const KCalCore::RecurrenceRule::WDayPos &	w
	)

RecurrenceRule::WDayPos serializer and deserializer.

Since

4.12

Definition at line 2289 of file recurrencerule.cpp.

KCALCORE_EXPORT QDataStream & KCalCore::operator<<	(	QDataStream &	out,
		KCalCore::Recurrence *	r
	)

Recurrence serializer and deserializer.

Since

4.12

Definition at line 1398 of file recurrence.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	out,
		const KCalCore::Alarm::Ptr &	a
	)

Alarm serializer.

Since

4.12

Definition at line 853 of file alarm.cpp.

QDataStream & KCalCore::operator<<	(	QDataStream &	out,
		const KCalCore::IncidenceBase::Ptr &	i
	)

Incidence serializer.

Uses the virtual_hook internally to avoid slicing.

// TODO_KDE5: Provide a virtual serialize() method, as done with assign() and equals().

Since

4.12

Definition at line 678 of file incidencebase.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	stream,
		KCalCore::FreeBusyPeriod &	period
	)

Read a Period object into period from stream, in binary format.

Definition at line 117 of file freebusyperiod.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	stream,
		KCalCore::Period &	period
	)

Read a Period object into period from stream, in binary format.

Definition at line 160 of file period.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	stream,
		KCalCore::Person::Ptr &	person
	)

Initializes the person object from the stream.

Definition at line 183 of file person.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	stream,
		KCalCore::CustomProperties &	properties
	)

Initializes the properties object from the stream.

Definition at line 270 of file customproperties.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	in,
		const KCalCore::Attachment::Ptr &	a
	)

Attachment deserializer.

Since

4.12

Definition at line 250 of file attachment.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	stream,
		KCalCore::FreeBusy::Ptr &	freebusy
	)

Initializes the freebusy object from the stream.

Definition at line 414 of file freebusy.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	in,
		KCalCore::Duration &	duration
	)

Duration deserializer.

Since

4.12

Definition at line 221 of file duration.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	stream,
		KCalCore::Attendee::Ptr &	attendee
	)

Initializes an Attendee object from a data stream.

Parameters

stream	is a QDataStream.
attendee	is a pointer to a Attendee object to be initialized.

Definition at line 283 of file attendee.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	in,
		const KCalCore::Alarm::Ptr &	a
	)

Alarm deserializer.

Since

4.12

Definition at line 863 of file alarm.cpp.

QDataStream & KCalCore::operator>>	(	QDataStream &	in,
		const KCalCore::IncidenceBase::Ptr &	i
	)

Incidence deserializer.

Uses the virtual_hook internally to avoid slicing.

// TODO_KDE5: Provide a virtual serialize() method, as done with assign() and equals().

Since

4.12

Definition at line 702 of file incidencebase.cpp.