#include <calendarlocal.h>

Inheritance diagram for KCal::CalendarLocal:

Public Member Functions
	CalendarLocal (const KDateTime::Spec &timeSpec)

	CalendarLocal (const QString &timeZoneId)

	~CalendarLocal ()

bool	addEvent (Event *event)

bool	addJournal (Journal *journal)

bool	addTodo (Todo *todo)

Alarm::List	alarms (const KDateTime &from, const KDateTime &to)

Alarm::List	alarmsTo (const KDateTime &to)

void	close ()

void	deleteAllEvents ()

void	deleteAllJournals ()

void	deleteAllTodos ()

bool	deleteEvent (Event *event)

bool	deleteJournal (Journal *journal)

bool	deleteTodo (Todo *todo)

Event *	event (const QString &uid)

void	incidenceUpdated (IncidenceBase *incidenceBase)

Journal *	journal (const QString &uid)

bool	load (const QString &fileName, CalFormat *format=0)

Event::List	rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)

Event::List	rawEvents (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)

Event::List	rawEventsForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)

Event::List	rawEventsForDate (const KDateTime &dt)

Journal::List	rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)

Journal::List	rawJournalsForDate (const QDate &date)

Todo::List	rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)

Todo::List	rawTodosForDate (const QDate &date)

bool	reload ()

bool	save ()

bool	save (const QString &fileName, CalFormat *format=0)

Todo *	todo (const QString &uid)

Public Member Functions inherited from KCal::Calendar
	Calendar (const KDateTime::Spec &timeSpec)

	Calendar (const QString &timeZoneId)

virtual	~Calendar ()

virtual bool	addIncidence (Incidence *incidence)

void	beginBatchAdding ()

virtual bool	beginChange (Incidence *incidence)

QStringList	categories ()

virtual bool	deleteIncidence (Incidence *incidence)

Incidence *	dissociateOccurrence (Incidence *incidence, const QDate &date, const KDateTime::Spec &spec, bool single=true)

void	endBatchAdding ()

virtual bool	endChange (Incidence *incidence)

virtual Event::List	events (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)

Event::List	events (const KDateTime &dt)

Event::List	events (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)

Event::List	events (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)

CalFilter *	filter ()

Incidence *	incidence (const QString &uid)

Incidence *	incidenceFromSchedulingID (const QString &sid)

virtual Incidence::List	incidences ()

virtual Incidence::List	incidences (const QDate &date)

Incidence::List	incidencesFromSchedulingID (const QString &sid)

bool	isAncestorOf (Incidence ancestor, Incidence incidence)

bool	isModified () const

virtual bool	isSaving ()

virtual Journal::List	journals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)

virtual Journal::List	journals (const QDate &date)

Person	owner () const

QString	productId () const

virtual Incidence::List	rawIncidences ()

void	registerObserver (CalendarObserver *observer)

virtual void	removeRelations (Incidence *incidence)

void	setFilter (CalFilter *filter)

void	setModified (bool modified)

void	setOwner (const Person &owner)

void	setProductId (const QString &id)

void	setTimeSpec (const KDateTime::Spec &timeSpec)

void	setTimeZoneId (const QString &timeZoneId)

void	setTimeZones (const ICalTimeZones &zones)

virtual void	setupRelations (Incidence *incidence)

void	setViewTimeSpec (const KDateTime::Spec &timeSpec) const

void	setViewTimeZoneId (const QString &timeZoneId) const

void	shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)

KDateTime::Spec	timeSpec () const

QString	timeZoneId () const

ICalTimeZones *	timeZones () const

virtual Todo::List	todos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)

virtual Todo::List	todos (const QDate &date)

void	unregisterObserver (CalendarObserver *observer)

KDateTime::Spec	viewTimeSpec () const

QString	viewTimeZoneId () const

Public Member Functions inherited from KCal::CustomProperties
	CustomProperties ()

	CustomProperties (const CustomProperties &other)

virtual	~CustomProperties ()

QMap< QByteArray, QString >	customProperties () const

QString	customProperty (const QByteArray &app, const QByteArray &key) const

QString	nonKDECustomProperty (const QByteArray &name) const

CustomProperties &	operator= (const CustomProperties &other)

bool	operator== (const CustomProperties &properties) const

void	removeCustomProperty (const QByteArray &app, const QByteArray &key)

void	removeNonKDECustomProperty (const QByteArray &name)

void	setCustomProperties (const QMap< QByteArray, QString > &properties)

void	setCustomProperty (const QByteArray &app, const QByteArray &key, const QString &value)

void	setNonKDECustomProperty (const QByteArray &name, const QString &value)

Public Member Functions inherited from KCal::IncidenceBase::IncidenceObserver
virtual	~IncidenceObserver ()

Additional Inherited Members
Signals inherited from KCal::Calendar
void	batchAddingBegins ()

void	batchAddingEnds ()

void	calendarChanged ()

void	calendarLoaded ()

void	calendarSaved ()

Static Public Member Functions inherited from KCal::Calendar
static Incidence::List	mergeIncidenceList (const Event::List &events, const Todo::List &todos, const Journal::List &journals)

static Event::List	sortEvents (Event::List *eventList, EventSortField sortField, SortDirection sortDirection)

static Event::List	sortEventsForDate (Event::List *eventList, const QDate &date, const KDateTime::Spec &timeSpec, EventSortField sortField, SortDirection sortDirection)

static Journal::List	sortJournals (Journal::List *journalList, JournalSortField sortField, SortDirection sortDirection)

static Todo::List	sortTodos (Todo::List *todoList, TodoSortField sortField, SortDirection sortDirection)

Static Public Member Functions inherited from KCal::CustomProperties
static QByteArray	customPropertyName (const QByteArray &app, const QByteArray &key)

Protected Member Functions inherited from KCal::Calendar
void	appendAlarms (Alarm::List &alarms, Incidence *incidence, const KDateTime &from, const KDateTime &to)

void	appendRecurringAlarms (Alarm::List &alarms, Incidence *incidence, const KDateTime &from, const KDateTime &to)

virtual void	customPropertyUpdated ()

virtual void	doSetTimeSpec (const KDateTime::Spec &timeSpec)

void	notifyIncidenceAdded (Incidence *incidence)

void	notifyIncidenceChanged (Incidence *incidence)

void	notifyIncidenceDeleted (Incidence *incidence)

void	setObserversEnabled (bool enabled)

Detailed Description

This class provides a calendar stored as a local file.

Definition at line 43 of file calendarlocal.h.

Constructor & Destructor Documentation

CalendarLocal::CalendarLocal ( const KDateTime::Spec & timeSpec )

explicit

Private class that helps to provide binary compatibility between releases.

Calendar::Calendar(const KDateTime::Spec &)

Definition at line 97 of file calendarlocal.cpp.

CalendarLocal::CalendarLocal ( const QString & timeZoneId )

explicit

Calendar::Calendar(const QString &)

Definition at line 103 of file calendarlocal.cpp.

CalendarLocal::~CalendarLocal ( )

Calendar::~Calendar()

Definition at line 109 of file calendarlocal.cpp.

Member Function Documentation

bool CalendarLocal::addEvent ( Event * event )

virtual

Calendar::addEvent()

Implements KCal::Calendar.

Definition at line 172 of file calendarlocal.cpp.

bool CalendarLocal::addJournal ( Journal * journal )

virtual

Calendar::addJournal()

Implements KCal::Calendar.

Definition at line 553 of file calendarlocal.cpp.

bool CalendarLocal::addTodo ( Todo * todo )

virtual

Calendar::addTodo()

Implements KCal::Calendar.

Definition at line 222 of file calendarlocal.cpp.

Alarm::List CalendarLocal::alarms	(	const KDateTime &	from,
		const KDateTime &	to
	)

virtual

Calendar::alarms()

Implements KCal::Calendar.

Definition at line 329 of file calendarlocal.cpp.

Alarm::List CalendarLocal::alarmsTo ( const KDateTime & to )

Return a list of Alarms that occur before the specified timestamp.

Parameters

to	is the ending timestamp.

Returns: the list of Alarms occurring before the specified KDateTime.

Definition at line 324 of file calendarlocal.cpp.

void CalendarLocal::close ( )

virtual

Clears out the current calendar, freeing all used memory etc.

etc.

Implements KCal::Calendar.

Definition at line 158 of file calendarlocal.cpp.

void CalendarLocal::deleteAllEvents ( )

virtual

Calendar::deleteAllEvents()

Implements KCal::Calendar.

Definition at line 202 of file calendarlocal.cpp.

void CalendarLocal::deleteAllJournals ( )

virtual

Calendar::deleteAllJournals()

Implements KCal::Calendar.

Definition at line 597 of file calendarlocal.cpp.

void CalendarLocal::deleteAllTodos ( )

virtual

Calendar::deleteAllTodos()

Implements KCal::Calendar.

Definition at line 277 of file calendarlocal.cpp.

bool CalendarLocal::deleteEvent ( Event * event )

virtual

Calendar::deleteEvent()

Implements KCal::Calendar.

Definition at line 185 of file calendarlocal.cpp.

bool CalendarLocal::deleteJournal ( Journal * journal )

virtual

Calendar::deleteJournal()

Implements KCal::Calendar.

Definition at line 583 of file calendarlocal.cpp.

bool CalendarLocal::deleteTodo ( Todo * todo )

virtual

Calendar::deleteTodo()

Implements KCal::Calendar.

Definition at line 258 of file calendarlocal.cpp.

Event * CalendarLocal::event ( const QString & uid )

virtual

Calendar::event()

Implements KCal::Calendar.

Definition at line 217 of file calendarlocal.cpp.

void CalendarLocal::incidenceUpdated ( IncidenceBase * incidenceBase )

virtual

Notify the IncidenceBase::Observer that the incidence has been updated.

Parameters

incidenceBase is a pointer to the updated IncidenceBase.

Reimplemented from KCal::Calendar.

Definition at line 380 of file calendarlocal.cpp.

Journal * CalendarLocal::journal ( const QString & uid )

virtual

Calendar::journal()

Implements KCal::Calendar.

Definition at line 612 of file calendarlocal.cpp.

bool CalendarLocal::load	(	const QString &	fileName,
		CalFormat *	format = `0`
	)

Loads a calendar on disk in vCalendar or iCalendar format into the current calendar.

Incidences already present are preserved. If an incidence of the file to be loaded has the same unique id as an incidence already present the new incidence is ignored.

To load a CalendarLocal object from a file without preserving existing incidences call close() before load().

Parameters

fileName	the name of the calendar on disk.
format	the format to use. If 0, an attempt is made to load iCalendar format, and if that fails tries vCalendar format.

Returns: true, if successful, false on error.

See also: save( const QString &, CalFormat *)

Definition at line 115 of file calendarlocal.cpp.

Event::List CalendarLocal::rawEvents	(	EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)

virtual

Calendar::rawEvents(EventSortField, SortDirection)

Implements KCal::Calendar.

Definition at line 541 of file calendarlocal.cpp.

Event::List CalendarLocal::rawEvents	(	const QDate &	start,
		const QDate &	end,
		const KDateTime::Spec &	timeSpec = `KDateTime::Spec()`,
		bool	inclusive = `false`
	)

virtual

Calendar::rawEvents(const QDate &, const QDate &, const KDateTime::Spec &, bool)

Implements KCal::Calendar.

Definition at line 476 of file calendarlocal.cpp.

Event::List CalendarLocal::rawEventsForDate	(	const QDate &	date,
		const KDateTime::Spec &	timeSpec = `KDateTime::Spec()`,
		EventSortField	sortField = `EventSortUnsorted`,
		SortDirection	sortDirection = `SortDirectionAscending`
	)

virtual

Returns an unfiltered list of all Events which occur on the given date.

Parameters

date	request unfiltered Event list for this QDate only.
timeSpec	time zone etc. to interpret `date`, or the calendar's default time spec if none is specified
sortField	specifies the EventSortField.
sortDirection	specifies the SortDirection.