Classes
struct	_MSSystemTime
	Placeholhers for Microsoft and ActiveSync timezone data. More...
class	Alarm
	Represents an alarm notification. More...
class	Attachment
	Represents information related to an attachment for a Calendar Incidence. More...
class	Attendee
	Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (to-do). More...
class	Calendar
	Represents the main calendar class. More...
class	CalFilter
	Provides a filter for calendars. More...
class	CalFormat
	An abstract base class that provides an interface to various calendar formats. More...
class	CalStorage
	An abstract base class that provides a calendar storage interface. More...
class	Compat
	This class provides compatibility to older or broken calendar files. More...
class	Compat32PrereleaseVersions
	Compatibility class for KOrganizer prerelease 3.2 calendar files. More...
class	CompatFactory
	Factory for creating the right Compat object. More...
class	CompatOutlook9
	Compatibility class for Outlook 9 calendar files. More...
class	CompatPre31
	Compatibility class for KOrganizer pre-3.1 calendar files. More...
class	CompatPre32
	Compatibility class for KOrganizer pre-3.2 calendar files. More...
class	CompatPre34
	Compatibility class for KOrganizer pre-3.4 calendar files. More...
class	CompatPre35
	Compatibility class for KOrganizer pre-3.5 calendar files. More...
class	CustomProperties
	A class to manage custom calendar properties. More...
class	Duration
	Represents a span of time measured in seconds or days. More...
class	Event
	This class provides an Event in the sense of RFC2445. More...
class	Exception
	Exception base class, currently used as a fancy kind of error code and not as an C++ exception. More...
class	FileStorage
	This class provides a calendar storage as a local file. More...
class	FreeBusy
	Provides information about the free/busy time of a calendar. More...
class	FreeBusyCache
	An abstract base class to allow different implementations of storing free busy information, e.g. More...
class	FreeBusyPeriod
	The period can be defined by either a start time and an end time or by a start time and a duration. More...
class	FreeBusyUrlStore
	A class for reading and writing Free/Busy URLs to a cache file. More...
class	ICalFormat
	iCalendar format implementation. More...
class	ICalFormatImpl
	This class provides the libical dependent functions for ICalFormat. More...
class	ICalTimeZone
	The ICalTimeZone class represents an iCalendar VTIMEZONE component. More...
class	ICalTimeZoneBackend
	Backend class for KICalTimeZone class. More...
class	ICalTimeZoneData
	Parsed iCalendar VTIMEZONE data. More...
class	ICalTimeZones
	The ICalTimeZones class represents a time zone database which consists of a collection of individual iCalendar time zone definitions. More...
class	ICalTimeZoneSource
	A class which reads and parses iCalendar VTIMEZONE components, and accesses libical time zone data. More...
class	Incidence
	Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar components known as incidences. More...
class	IncidenceBase
	An abstract class that provides a common base for all calendar incidence classes. More...
class	Journal
	Provides a Journal in the sense of RFC2445. More...
class	MemoryCalendar
	This class provides a calendar stored in memory. More...
class	Period
	The period can be defined by either a start time and an end time or by a start time and a duration. More...
class	Person
	Represents a person, by name and email address. More...
class	Recurrence
	This class represents a recurrence rule for a calendar incidence. More...
class	RecurrenceRule
	This class represents a recurrence rule for a calendar incidence. More...
class	ScheduleMessage
	A Scheduling message class. More...
class	SortableList
	A QList which can be sorted. More...
class	Todo
	Provides a To-do in the sense of RFC2445. More...
class	VCalFormat
	vCalendar format implementation. More...
class	Visitor
	This class provides the interface for a visitor of calendar components. More...
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::Period &period)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::Person::Ptr &person)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::CustomProperties &properties)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::Attendee::Ptr &attendee)
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &stream, const KCalCore::FreeBusy::Ptr &freebusy)
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 &stream, KCalCore::Attendee::Ptr &attendee)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &stream, KCalCore::FreeBusy::Ptr &freebusy)

Detailed Description

TODO: KDE5:

Contains all the KCalCore library global classes, objects, and functions.

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 74 of file incidencebase.h.

typedef SortableList< KDateTime > KCalCore::DateTimeList

List of times.

Definition at line 77 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::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::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::CustomProperties &	properties
	)

Serializes the properties object into the stream.

Definition at line 233 of file customproperties.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 183 of file attendee.cpp.

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

Serializes the fb object into the stream.

Definition at line 406 of file freebusy.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 240 of file customproperties.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 196 of file attendee.cpp.

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

Initializes the fb object from the stream.

Definition at line 413 of file freebusy.cpp.

KCalCore Library

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

KCalCore Library

KDE-PIM Libraries