KCalCore::Calendar Class Reference

Represents the main calendar class. More...

#include <calendar.h>

Inheritance diagram for KCalCore::Calendar:

[legend]

List of all members.

Classes
class	CalendarObserver
	The CalendarObserver class. More...
Public Types
typedef QSharedPointer< Calendar >	Ptr
Public Member Functions
	Calendar (const QString &timeZoneId)
	Calendar (const KDateTime::Spec &timeSpec)
virtual	~Calendar ()
virtual bool	addEvent (const Event::Ptr &event)=0
virtual bool	addIncidence (const Incidence::Ptr &incidence)
virtual bool	addJournal (const Journal::Ptr &journal)=0
bool	addNotebook (const QString &notebook, bool isVisible)
virtual bool	addTodo (const Todo::Ptr &todo)=0
virtual Alarm::List	alarms (const KDateTime &from, const KDateTime &to) const =0
bool	batchAdding () const
virtual bool	beginChange (const Incidence::Ptr &incidence)
QStringList	categories () const
virtual void	clearNotebookAssociations ()
virtual void	close ()=0
QString	defaultNotebook () const
virtual void	deleteAllEvents ()=0
virtual void	deleteAllJournals ()=0
virtual void	deleteAllTodos ()=0
Incidence::Ptr	deleted (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const
virtual Event::Ptr	deletedEvent (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
virtual Event::List	deletedEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual Journal::Ptr	deletedJournal (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
virtual Journal::List	deletedJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual Todo::Ptr	deletedTodo (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
virtual Todo::List	deletedTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual bool	deleteEvent (const Event::Ptr &event)=0
virtual bool	deleteEventInstances (const Event::Ptr &event)=0
virtual bool	deleteIncidence (const Incidence::Ptr &incidence)
virtual bool	deleteIncidenceInstances (const Incidence::Ptr &incidence)=0
virtual bool	deleteJournal (const Journal::Ptr &journal)=0
virtual bool	deleteJournalInstances (const Journal::Ptr &journal)=0
bool	deleteNotebook (const QString &notebook)
virtual bool	deleteTodo (const Todo::Ptr &todo)=0
virtual bool	deleteTodoInstances (const Todo::Ptr &todo)=0
Incidence::Ptr	dissociateOccurrence (const Incidence::Ptr &incidence, const QDate &date, const KDateTime::Spec &spec, bool single=true)
virtual Incidence::List	duplicates (const Incidence::Ptr &incidence)
virtual void	endBatchAdding ()
virtual bool	endChange (const Incidence::Ptr &incidence)
virtual Event::Ptr	event (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
virtual Event::List	eventInstances (const Incidence::Ptr &event, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
Event::List	events (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
Event::List	events (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false) const
Event::List	events (const KDateTime &dt) const
virtual Event::List	events (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
CalFilter *	filter () const
bool	hasValidNotebook (const QString &notebook) const
Incidence::Ptr	incidence (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const
virtual Incidence::Ptr	incidenceFromSchedulingID (const QString &sid) const
virtual Incidence::List	incidences (const QString &notebook) const
virtual Incidence::List	incidences (const QDate &date) const
virtual Incidence::List	incidences () const
virtual Incidence::List	incidencesFromSchedulingID (const QString &sid) const
virtual Incidence::List	instances (const Incidence::Ptr &incidence) const
bool	isAncestorOf (const Incidence::Ptr &ancestor, const Incidence::Ptr &incidence) const
bool	isModified () const
virtual bool	isSaving () const
bool	isVisible (const Incidence::Ptr &incidence) const
virtual Journal::Ptr	journal (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
virtual Journal::List	journalInstances (const Incidence::Ptr &journal, JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual Journal::List	journals (const QDate &date) const
virtual Journal::List	journals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
virtual QString	notebook (const QString &uid) const
virtual QString	notebook (const Incidence::Ptr &incidence) const
virtual QStringList	notebooks () const
Person::Ptr	owner () const
QString	productId () const
virtual Event::List	rawEvents (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false) const =0
virtual Event::List	rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual Event::List	rawEventsForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual Event::List	rawEventsForDate (const KDateTime &dt) const =0
virtual Incidence::List	rawIncidences () const
virtual Journal::List	rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual Journal::List	rawJournalsForDate (const QDate &date) const =0
virtual Todo::List	rawTodos (const QDate &start, const QDate &end, const KDateTime::Spec &timespec=KDateTime::Spec(), bool inclusive=false) const =0
virtual Todo::List	rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual Todo::List	rawTodosForDate (const QDate &date) const =0
void	registerObserver (CalendarObserver *observer)
Incidence::List	relations (const QString &uid) const
virtual bool	reload ()
virtual void	removeRelations (const Incidence::Ptr &incidence)
virtual bool	save ()
bool	setDefaultNotebook (const QString &notebook)
void	setFilter (CalFilter *filter)
void	setModified (bool modified)
virtual bool	setNotebook (const Incidence::Ptr &incidence, const QString &notebook)
void	setOwner (const Person::Ptr &owner)
void	setProductId (const QString &id)
void	setTimeSpec (const KDateTime::Spec &timeSpec)
void	setTimeZoneId (const QString &timeZoneId)
void	setTimeZones (ICalTimeZones *zones)
virtual void	setupRelations (const Incidence::Ptr &incidence)
void	setViewTimeSpec (const KDateTime::Spec &timeSpec) const
void	setViewTimeZoneId (const QString &timeZoneId) const
void	shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
virtual void	startBatchAdding ()
KDateTime::Spec	timeSpec () const
QString	timeZoneId () const
ICalTimeZones *	timeZones () const
virtual Todo::Ptr	todo (const QString &uid, const KDateTime &recurrenceId=KDateTime()) const =0
virtual Todo::List	todoInstances (const Incidence::Ptr &todo, TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const =0
virtual Todo::List	todos (const QDate &start, const QDate &end, const KDateTime::Spec &timespec=KDateTime::Spec(), bool inclusive=false) const
virtual Todo::List	todos (const QDate &date) const
virtual Todo::List	todos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
void	unregisterObserver (CalendarObserver *observer)
bool	updateNotebook (const QString &notebook, bool isVisible)
KDateTime::Spec	viewTimeSpec () const
QString	viewTimeZoneId () const
Static Public Member Functions
static Incidence::List	mergeIncidenceList (const Event::List &events, const Todo::List &todos, const Journal::List &journals)
static Event::List	sortEvents (const Event::List &eventList, EventSortField sortField, SortDirection sortDirection)
static Journal::List	sortJournals (const Journal::List &journalList, JournalSortField sortField, SortDirection sortDirection)
static Todo::List	sortTodos (const Todo::List &todoList, TodoSortField sortField, SortDirection sortDirection)
Protected Member Functions
void	appendAlarms (Alarm::List &alarms, const Incidence::Ptr &incidence, const KDateTime &from, const KDateTime &to) const
void	appendRecurringAlarms (Alarm::List &alarms, const Incidence::Ptr &incidence, const KDateTime &from, const KDateTime &to) const
virtual void	customPropertyUpdated ()
virtual void	doSetTimeSpec (const KDateTime::Spec &timeSpec)
void	incidenceUpdated (const QString &uid, const KDateTime &recurrenceId)
void	notifyIncidenceAdded (const Incidence::Ptr &incidence)
void	notifyIncidenceAdditionCanceled (const Incidence::Ptr &incidence)
void	notifyIncidenceChanged (const Incidence::Ptr &incidence)
void	notifyIncidenceDeleted (const Incidence::Ptr &incidence)
void	setObserversEnabled (bool enabled)
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

Represents the main calendar class.

A calendar contains information like incidences (events, to-dos, journals), alarms, time zones, and other useful information.

This is an abstract base class defining the interface to a calendar. It is implemented by subclasses like MemoryCalendar, which use different methods to store and access the data.

Ownership of Incidences:

Incidence ownership is handled by the following policy: as soon as an incidence (or any other subclass of IncidenceBase) is added to the Calendar by an add...() method it is owned by the Calendar object. The Calendar takes care of deleting the incidence using the delete...() methods. All Incidences returned by the query functions are returned as pointers so that changes to the returned Incidences are immediately visible in the Calendar. Do Not attempt to 'delete' any Incidence object you get from Calendar -- use the delete...() methods.

Definition at line 115 of file calendar.h.

---

Member Typedef Documentation

typedef QSharedPointer<Calendar> KCalCore::Calendar::Ptr

A shared pointer to a Calendar.

Reimplemented in KCalCore::MemoryCalendar.

Definition at line 125 of file calendar.h.

---

Constructor & Destructor Documentation

Calendar::Calendar

(

const KDateTime::Spec &

timeSpec

)

[explicit]

Constructs a calendar with a specified time zone timeZoneid.

Private class that helps to provide binary compatibility between releases.

The time specification is used as the default for creating or modifying incidences in the Calendar. The time specification does not alter existing incidences.

The constructor also calls setViewTimeSpec(timeSpec).

Parameters:

timeSpec

time specification

For internal use only.

Definition at line 212 of file calendar.cpp.

Calendar::Calendar

(

const QString &

timeZoneId

)

[explicit]

Construct Calendar object using a time zone ID.

The time zone ID is used as the default for creating or modifying incidences in the Calendar. The time zone does not alter existing incidences.

The constructor also calls setViewTimeZoneId(timeZoneId).

Parameters:

timeZoneId

is a string containing a time zone ID, which is assumed to be valid. If no time zone is found, the viewing time specification is set to local clock time. Example: "Europe/Berlin"

Definition at line 219 of file calendar.cpp.

Calendar::~Calendar

(

)

[virtual]

Destroys the calendar.

Definition at line 225 of file calendar.cpp.

---

Member Function Documentation

virtual bool KCalCore::Calendar::addEvent

(

const Event::Ptr &

event

)

[pure virtual]

Inserts an Event into the calendar.

Parameters:

event

is a pointer to the Event to insert.

Returns:

true if the Event was successfully inserted; false otherwise.

See also:

deleteEvent()

Implemented in KCalCore::MemoryCalendar.

bool Calendar::addIncidence

(

const Incidence::Ptr &

incidence

)

[virtual]

Inserts an Incidence into the calendar.

Parameters:

incidence

is a pointer to the Incidence to insert.

Returns:

true if the Incidence was successfully inserted; false otherwise.

See also:

deleteIncidence()

Reimplemented in KCalCore::MemoryCalendar.

Definition at line 673 of file calendar.cpp.

virtual bool KCalCore::Calendar::addJournal

(

const Journal::Ptr &

journal

)

[pure virtual]

Inserts a Journal into the calendar.

Parameters:

journal

is a pointer to the Journal to insert.

Returns:

true if the Journal was successfully inserted; false otherwise.

See also:

deleteJournal()

Implemented in KCalCore::MemoryCalendar.

bool Calendar::addNotebook	(	const QString &	notebook,
		bool	isVisible
	)

Add notebook information into calendar.

Is usually called by storages only.

Parameters:

	notebook	notebook uid
	isVisible	notebook visibility

Returns:

true if operation succeeded

See also:

isVisible()

Definition at line 449 of file calendar.cpp.

virtual bool KCalCore::Calendar::addTodo

(

const Todo::Ptr &

todo

)

[pure virtual]

Inserts a Todo into the calendar.

Parameters:

todo

is a pointer to the Todo to insert.

Returns:

true if the Todo was successfully inserted; false otherwise.

See also:

deleteTodo()

Implemented in KCalCore::MemoryCalendar.

virtual Alarm::List KCalCore::Calendar::alarms	(	const KDateTime &	from,
		const KDateTime &	to
	)			const [pure virtual]

Returns a list of Alarms within a time range for this Calendar.

Parameters:

	from	is the starting timestamp.
	to	is the ending timestamp.

Returns:

the list of Alarms for the for the specified time range.

Implemented in KCalCore::MemoryCalendar.

void Calendar::appendAlarms	(	Alarm::List &	alarms,
		const Incidence::Ptr &	incidence,
		const KDateTime &	from,
		const KDateTime &	to
	)			const [protected]

Appends alarms of incidence in interval to list of alarms.

Parameters:

	alarms	is a List of Alarms to be appended onto.
	incidence	is a pointer to an Incidence containing the Alarm to be appended.
	from	is the lower range of the next Alarm repitition.
	to	is the upper range of the next Alarm repitition.

Definition at line 1350 of file calendar.cpp.

void Calendar::appendRecurringAlarms	(	Alarm::List &	alarms,
		const Incidence::Ptr &	incidence,
		const KDateTime &	from,
		const KDateTime &	to
	)			const [protected]

Appends alarms of recurring events in interval to list of alarms.

Parameters:

	alarms	is a List of Alarms to be appended onto.
	incidence	is a pointer to an Incidence containing the Alarm to be appended.
	from	is the lower range of the next Alarm repitition.
	to	is the upper range of the next Alarm repitition.

Definition at line 1367 of file calendar.cpp.

bool Calendar::batchAdding

(

)

const

Returns:

true if batch adding is in progress

Definition at line 1491 of file calendar.cpp.

bool Calendar::beginChange

(

const Incidence::Ptr &

incidence

)

[virtual]

Flag that a change to a Calendar Incidence is starting.

Parameters:

incidence

is a pointer to the Incidence that will be changing.

Definition at line 1333 of file calendar.cpp.

QStringList Calendar::categories

(

)

const

Returns a list of all categories used by Incidences in this Calendar.

Returns:

a QStringList containing all the categories.

Definition at line 376 of file calendar.cpp.

void Calendar::clearNotebookAssociations

(

)

[virtual]

Clears notebook associations from hash-tables for incidences.

Called when in-memory content of the calendar is cleared.

Definition at line 515 of file calendar.cpp.

virtual void KCalCore::Calendar::close

(

)

[pure virtual]

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

Implemented in KCalCore::MemoryCalendar.

void Calendar::customPropertyUpdated

(

)

[protected, virtual]

Called when a custom property has been changed. The default implementation does nothing: override in derived classes to perform change processing.

Reimplemented from KCalCore::CustomProperties.

Definition at line 1295 of file calendar.cpp.

QString Calendar::defaultNotebook

(

)

const

Get uid of default notebook.

Returns:

notebook uid

Definition at line 488 of file calendar.cpp.

virtual void KCalCore::Calendar::deleteAllEvents

(

)

[pure virtual]

Removes all Events from the calendar.

See also:

deleteEvent()

Implemented in KCalCore::MemoryCalendar.

virtual void KCalCore::Calendar::deleteAllJournals

(

)

[pure virtual]

Removes all Journals from the calendar.

See also:

deleteJournal()

Implemented in KCalCore::MemoryCalendar.

virtual void KCalCore::Calendar::deleteAllTodos

(

)

[pure virtual]

Removes all To-dos from the calendar.

See also:

deleteTodo()

Implemented in KCalCore::MemoryCalendar.

Incidence::Ptr Calendar::deleted	(	const QString &	uid,
		const KDateTime &	recurrenceId = KDateTime()
	)			const

Returns the deleted Incidence associated with the given unique identifier.

Parameters:

	uid	is a unique identifier string.
	recurrenceId	is possible recurrenceid of incidence, default is null

Returns:

a pointer to the Incidence. A null pointer is returned if no such Incidence exists.

Definition at line 793 of file calendar.cpp.

virtual Event::Ptr KCalCore::Calendar::deletedEvent	(	const QString &	uid,
		const KDateTime &	recurrenceId = KDateTime()
	)			const [pure virtual]

Returns the deleted Event associated with the given unique identifier.

Parameters:

	uid	is a unique identifier string.
	recurrenceId	is possible recurrenceId of event, default is null

Returns:

a pointer to the deleted Event. A null pointer is returned if no such deleted Event exists.

Implemented in KCalCore::MemoryCalendar.

virtual Event::List KCalCore::Calendar::deletedEvents	(	EventSortField	sortField = EventSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all deleted Events for this Calendar.

Parameters:

	sortField	specifies the EventSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered deleted Events sorted as specified.

Implemented in KCalCore::MemoryCalendar.

virtual Journal::Ptr KCalCore::Calendar::deletedJournal	(	const QString &	uid,
		const KDateTime &	recurrenceId = KDateTime()
	)			const [pure virtual]

Returns the deleted Journal associated with the given unique identifier.

Parameters:

	uid	is a unique identifier string.
	recurrenceId	is possible recurrenceId of journal, default is null

Returns:

a pointer to the deleted Journal. A null pointer is returned if no such deleted Journal exists.

Implemented in KCalCore::MemoryCalendar.

virtual Journal::List KCalCore::Calendar::deletedJournals	(	JournalSortField	sortField = JournalSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all deleted Journals for this Calendar.

Parameters:

	sortField	specifies the JournalSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered deleted Journals sorted as specified.

Implemented in KCalCore::MemoryCalendar.

virtual Todo::Ptr KCalCore::Calendar::deletedTodo	(	const QString &	uid,
		const KDateTime &	recurrenceId = KDateTime()
	)			const [pure virtual]

Returns the deleted Todo associated with the given unique identifier.

Parameters:

	uid	is a unique identifier string.
	recurrenceId	is possible recurrenceId of todo, default is null

Returns:

a pointer to the deleted Todo. A null pointer is returned if no such deletef Todo exists.

Implemented in KCalCore::MemoryCalendar.

virtual Todo::List KCalCore::Calendar::deletedTodos	(	TodoSortField	sortField = TodoSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all deleted Todos for this Calendar.

Parameters:

	sortField	specifies the TodoSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered deleted Todos sorted as specified.

Implemented in KCalCore::MemoryCalendar.

virtual bool KCalCore::Calendar::deleteEvent

(

const Event::Ptr &

event

)

[pure virtual]

Removes an Event from the calendar.

Parameters:

event

is a pointer to the Event to remove.

Returns:

true if the Event was successfully remove; false otherwise.

See also:

addEvent(), deleteAllEvents()

Implemented in KCalCore::MemoryCalendar.

virtual bool KCalCore::Calendar::deleteEventInstances

(

const Event::Ptr &

event

)

[pure virtual]

Delete all events that are instances of recurring event event.

Parameters:

event

is a pointer to a deleted Event

Returns:

true if delete was successful; false otherwise

Implemented in KCalCore::MemoryCalendar.

bool Calendar::deleteIncidence

(

const Incidence::Ptr &

incidence

)

[virtual]

Removes an Incidence from the calendar.

Parameters:

incidence

is a pointer to the Incidence to remove.

Returns:

true if the Incidence was successfully removed; false otherwise.

See also:

addIncidence()

Reimplemented in KCalCore::MemoryCalendar.

Definition at line 683 of file calendar.cpp.

virtual bool KCalCore::Calendar::deleteIncidenceInstances

(

const Incidence::Ptr &

incidence

)

[pure virtual]

Delete all incidences that are instances of recurring incidence incidence.

Parameters:

incidence

is a pointer to a deleted Incidence

Returns:

true if delete was successful; false otherwise

Implemented in KCalCore::MemoryCalendar.

virtual bool KCalCore::Calendar::deleteJournal

(

const Journal::Ptr &

journal

)

[pure virtual]

Removes a Journal from the calendar.

Parameters:

journal

is a pointer to the Journal to remove.

Returns:

true if the Journal was successfully removed; false otherwise.

See also:

addJournal(), deleteAllJournals()

Implemented in KCalCore::MemoryCalendar.

virtual bool KCalCore::Calendar::deleteJournalInstances

(

const Journal::Ptr &

journal

)

[pure virtual]

Delete all journals that are instances of recurring journal journal.

Parameters:

journal

is a pointer to a deleted Journal

Returns:

true if delete was successful; false otherwise

Implemented in KCalCore::MemoryCalendar.

bool Calendar::deleteNotebook

(

const QString &

notebook

)

Delete notebook information from calendar.

Is usually called by storages only.

Parameters:

notebook

notebook uid

Returns:

true if operation succeeded

See also:

isVisible()

Definition at line 469 of file calendar.cpp.

virtual bool KCalCore::Calendar::deleteTodo

(

const Todo::Ptr &

todo

)

[pure virtual]

Removes a Todo from the calendar.

Parameters:

todo

is a pointer to the Todo to remove.

Returns:

true if the Todo was successfully removed; false otherwise.

See also:

addTodo(), deleteAllTodos()

Implemented in KCalCore::MemoryCalendar.

virtual bool KCalCore::Calendar::deleteTodoInstances

(

const Todo::Ptr &

todo

)

[pure virtual]

Delete all to-dos that are instances of recurring to-do todo.

Parameters:

todo

is a pointer to a deleted Todo

Returns:

true if delete was successful; false otherwise

Implemented in KCalCore::MemoryCalendar.

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

Dissociate an Incidence from a recurring Incidence.

By default, only one single Incidence for the specified date will be dissociated and returned. If single is false, then the recurrence will be split at date, the old Incidence will have its recurrence ending at date and the new Incidence will have all recurrences past the date.

Parameters:

	incidence	is a pointer to a recurring Incidence.
	date	is the QDate within the recurring Incidence on which the dissociation will be performed.
	spec	is the spec in which the date is formulated.
	single	is a flag meaning that a new Incidence should be created from the recurring Incidences after date.

Returns:

a pointer to a new recurring Incidence if single is false.

Definition at line 702 of file calendar.cpp.

void Calendar::doSetTimeSpec

(

const KDateTime::Spec &

timeSpec

)

[protected, virtual]

Let Calendar subclasses set the time specification.

Parameters:

timeSpec

is the time specification (time zone, etc.) for viewing Incidence dates.

Definition at line 1230 of file calendar.cpp.

Incidence::List Calendar::duplicates

(

const Incidence::Ptr &

incidence

)

[virtual]

List all possible duplicate incidences.

Parameters:

incidence

is the incidence to check.

Returns:

a list of duplicate incidences.

Definition at line 430 of file calendar.cpp.

void Calendar::endBatchAdding

(

)

[virtual]

Tells the Calendar that you stoped adding a batch of incidences.

See also:

startBatchAdding()

Definition at line 1486 of file calendar.cpp.

bool Calendar::endChange

(

const Incidence::Ptr &

incidence

)

[virtual]

Flag that a change to a Calendar Incidence has completed.

Parameters:

incidence

is a pointer to the Incidence that was changed.

Definition at line 1339 of file calendar.cpp.

virtual Event::Ptr KCalCore::Calendar::event	(	const QString &	uid,
		const KDateTime &	recurrenceId = KDateTime()
	)			const [pure virtual]

Returns the Event associated with the given unique identifier.

Parameters:

	uid	is a unique identifier string.
	recurrenceId	is possible recurrenceId of event, default is null

Returns:

a pointer to the Event. A null pointer is returned if no such Event exists.

Implemented in KCalCore::MemoryCalendar.

virtual Event::List KCalCore::Calendar::eventInstances	(	const Incidence::Ptr &	event,
		EventSortField	sortField = EventSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all possible instances for this recurring Event.

Parameters:

	event	event to check for. Caller guarantees it's of type Event.
	sortField	specifies the EventSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered event instances sorted as specified.

Implemented in KCalCore::MemoryCalendar.

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

Returns a sorted, filtered list of all Events which occur on the given date.

The Events are sorted according to sortField and sortDirection.

Parameters:

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

Returns:

the list of sorted, filtered Events occurring on date.

Definition at line 639 of file calendar.cpp.

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

Returns a filtered list of all Events occurring within a date range.

Parameters:

	start	is the starting date.
	end	is the ending date.
	timeSpec	time zone etc. to interpret start and end, or the calendar's default time spec if none is specified
	inclusive	if true only Events which are completely included within the date range are returned.

Returns:

the list of filtered Events occurring within the specified date range.

Definition at line 656 of file calendar.cpp.

Event::List Calendar::events

(

const KDateTime &

dt

)

const

Returns a filtered list of all Events which occur on the given timestamp.

Parameters:

dt

request filtered Event list for this KDateTime only.

Returns:

the list of filtered Events occurring on the specified timestamp.

Definition at line 649 of file calendar.cpp.

Event::List Calendar::events	(	EventSortField	sortField = EventSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [virtual]

Returns a sorted, filtered list of all Events for this Calendar.

Parameters:

	sortField	specifies the EventSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all filtered Events sorted as specified.

Definition at line 665 of file calendar.cpp.

CalFilter * Calendar::filter

(

)

const

Returns the calendar filter.

Returns:

a pointer to the calendar CalFilter. A null pointer is returned if no such CalFilter exists.

See also:

setFilter()

Definition at line 371 of file calendar.cpp.

bool Calendar::hasValidNotebook

(

const QString &

notebook

)

const

Check if calendar knows about the given notebook.

This means that it will be saved by one of the attached storages.

Parameters:

notebook

notebook uid

Returns:

true if calendar has valid notebook

Definition at line 493 of file calendar.cpp.

Incidence::Ptr Calendar::incidence	(	const QString &	uid,
		const KDateTime &	recurrenceId = KDateTime()
	)			const

Returns the Incidence associated with the given unique identifier.

Parameters:

	uid	is a unique identifier string.
	recurrenceId	is possible recurrenceid of incidence, default is null

Returns:

a pointer to the Incidence. A null pointer is returned if no such Incidence exists.

Definition at line 776 of file calendar.cpp.

Incidence::Ptr Calendar::incidenceFromSchedulingID

(

const QString &

sid

)

const [virtual]

Returns the Incidence associated with the given scheduling identifier.

Parameters:

sid

is a unique scheduling identifier string.

Returns:

a pointer to the Incidence. A null pointer is returned if no such Incidence exists.

Definition at line 822 of file calendar.cpp.

Incidence::List Calendar::incidences

(

const QString &

notebook

)

const [virtual]

List all notebook incidences in the memory.

Parameters:

notebook

is the notebook uid.

Returns:

a list of incidences for the notebook.

Definition at line 582 of file calendar.cpp.

Incidence::List Calendar::incidences

(

const QDate &

date

)

const [virtual]

Returns a filtered list of all Incidences which occur on the given date.

Parameters:

date

request filtered Incidence list for this QDate only.

Returns:

the list of filtered Incidences occurring on the specified date.

Definition at line 395 of file calendar.cpp.

Incidence::List Calendar::incidences

(

)

const [virtual]

Returns a filtered list of all Incidences for this Calendar.

Returns:

the list of all filtered Incidences.

Definition at line 400 of file calendar.cpp.

Incidence::List Calendar::incidencesFromSchedulingID

(

const QString &

sid

)

const [virtual]

Searches all events and todos for an incidence with this scheduling identifier.

Returns a list of matching results.

Parameters:

sid

is a unique scheduling identifier string.

Definition at line 809 of file calendar.cpp.

void Calendar::incidenceUpdated	(	const QString &	uid,
		const KDateTime &	recurrenceId
	)			[protected, virtual]

The Observer interface.

So far not implemented.

Parameters:

	uid	is the UID for the Incidence that has been updated.
	recurrenceId	is possible recurrenceid of incidence.

Implements KCalCore::IncidenceBase::IncidenceObserver.

Reimplemented in KCalCore::MemoryCalendar.

Definition at line 1211 of file calendar.cpp.

Incidence::List Calendar::instances

(

const Incidence::Ptr &

incidence

)

const [virtual]

Returns an unfiltered list of all possible instances for this recurring Incidence.

Parameters:

incidence

incidence to check

Returns:

the list of all unfiltered Incidences.

Definition at line 410 of file calendar.cpp.

bool Calendar::isAncestorOf	(	const Incidence::Ptr &	ancestor,
		const Incidence::Ptr &	incidence
	)			const

Checks if ancestor is an ancestor of incidence.

Parameters:

	ancestor	is the incidence we are testing to be an ancestor.
	incidence	is the incidence we are testing to be descended from ancestor.

Definition at line 1110 of file calendar.cpp.

bool Calendar::isModified

(

)

const

Determine the calendar's modification status.

Returns:

true if the calendar has been modified since open or last save.

See also:

setModified()

Definition at line 1196 of file calendar.cpp.

bool Calendar::isSaving

(

)

const [virtual]

Determine if the calendar is currently being saved.

Returns:

true if the calendar is currently being saved; false otherwise.

Definition at line 1180 of file calendar.cpp.

bool Calendar::isVisible

(

const Incidence::Ptr &

incidence

)

const

Check if incidence is visible.

Parameters:

incidence

is a pointer to the Incidence to check for visibility.

Returns:

true if incidence is visible, false otherwise

Definition at line 498 of file calendar.cpp.

virtual Journal::Ptr KCalCore::Calendar::journal	(	const QString &	uid,
		const KDateTime &	recurrenceId = KDateTime()
	)			const [pure virtual]

Returns the Journal associated with the given unique identifier.

Parameters:

	uid	is a unique identifier string.
	recurrenceId	is possible recurrenceId of journal, default is null

Returns:

a pointer to the Journal. A null pointer is returned if no such Journal exists.

Implemented in KCalCore::MemoryCalendar.

virtual Journal::List KCalCore::Calendar::journalInstances	(	const Incidence::Ptr &	journal,
		JournalSortField	sortField = JournalSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all instances for this recurring Journal.

Parameters:

	journal	journal to check for. Caller guarantees it's of type Journal.
	sortField	specifies the JournalSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered journal instances sorted as specified.

Implemented in KCalCore::MemoryCalendar.

Journal::List Calendar::journals

(

const QDate &

date

)

const [virtual]

Returns a filtered list of all Journals for on the specified date.

Parameters:

date

request filtered Journals for this QDate only.

Returns:

the list of filtered Journals for the specified date.

Definition at line 975 of file calendar.cpp.

Journal::List Calendar::journals	(	JournalSortField	sortField = JournalSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [virtual]

Returns a sorted, filtered list of all Journals for this Calendar.

Parameters:

	sortField	specifies the JournalSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all filtered Journals sorted as specified.

Definition at line 967 of file calendar.cpp.

Incidence::List Calendar::mergeIncidenceList	(	const Event::List &	events,
		const Todo::List &	todos,
		const Journal::List &	journals
	)			[static]

Create a merged list of Events, Todos, and Journals.

static

Parameters:

	events	is an Event list to merge.
	todos	is a Todo list to merge.
	journals	is a Journal list to merge.

Returns:

a list of merged Incidences.

Definition at line 1311 of file calendar.cpp.

QString Calendar::notebook

(

const QString &

uid

)

const [virtual]

Get incidence's notebook.

Parameters:

uid

is a unique identifier string

Returns:

notebook uid

Definition at line 572 of file calendar.cpp.

QString Calendar::notebook

(

const Incidence::Ptr &

incidence

)

const [virtual]

Get incidence's notebook.

Parameters:

incidence

incidence

Returns:

notebook uid

Definition at line 563 of file calendar.cpp.

QStringList Calendar::notebooks

(

)

const [virtual]

List all uids of notebooks currently in the memory.

Returns:

list of uids of notebooks

Definition at line 577 of file calendar.cpp.

void Calendar::notifyIncidenceAdded

(

const Incidence::Ptr &

incidence

)

[protected]

Let Calendar subclasses notify that they inserted an Incidence.

Parameters:

incidence

is a pointer to the Incidence object that was inserted.

Definition at line 1235 of file calendar.cpp.

void Calendar::notifyIncidenceAdditionCanceled

(

const Incidence::Ptr &

incidence

)

[protected]

Let Calendar subclasses notify that they canceled addition of an Incidence.

Parameters:

incidence

is a pointer to the Incidence object that addition as canceled.

Definition at line 1280 of file calendar.cpp.

void Calendar::notifyIncidenceChanged

(

const Incidence::Ptr &

incidence

)

[protected]

Let Calendar subclasses notify that they modified an Incidence.

Parameters:

incidence

is a pointer to the Incidence object that was modified.

Definition at line 1250 of file calendar.cpp.

void Calendar::notifyIncidenceDeleted

(

const Incidence::Ptr &

incidence

)

[protected]

Let Calendar subclasses notify that they removed an Incidence.

Parameters:

incidence

is a pointer to the Incidence object that was removed.

Definition at line 1265 of file calendar.cpp.

Person::Ptr Calendar::owner

(

)

const

Returns the owner of the calendar.

Returns:

the owner Person object.

See also:

setOwner()

Definition at line 230 of file calendar.cpp.

QString Calendar::productId

(

)

const

Returns the calendar's Product ID.

See also:

setProductId()

Definition at line 1305 of file calendar.cpp.

virtual Event::List KCalCore::Calendar::rawEvents	(	const QDate &	start,
		const QDate &	end,
		const KDateTime::Spec &	timeSpec = KDateTime::Spec(),
		bool	inclusive = false
	)			const [pure virtual]

Returns an unfiltered list of all Events occurring within a date range.

Parameters:

	start	is the starting date
	end	is the ending date
	timeSpec	time zone etc. to interpret start and end, or the calendar's default time spec if none is specified
	inclusive	if true only Events which are completely included within the date range are returned.

Returns:

the list of unfiltered Events occurring within the specified date range.

Implemented in KCalCore::MemoryCalendar.

virtual Event::List KCalCore::Calendar::rawEvents	(	EventSortField	sortField = EventSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all Events for this Calendar.

Parameters:

	sortField	specifies the EventSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered Events sorted as specified.

Implemented in KCalCore::MemoryCalendar.

virtual Event::List KCalCore::Calendar::rawEventsForDate	(	const QDate &	date,
		const KDateTime::Spec &	timeSpec = KDateTime::Spec(),
		EventSortField	sortField = EventSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all Events which occur on the given date.

The Events are sorted according to sortField and sortDirection.

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

Returns:

the list of sorted, unfiltered Events occurring on date

Implemented in KCalCore::MemoryCalendar.

virtual Event::List KCalCore::Calendar::rawEventsForDate

(

const KDateTime &

dt

)

const [pure virtual]

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

Parameters:

dt

request unfiltered Event list for this KDateTime only.

Returns:

the list of unfiltered Events occurring on the specified timestamp.

Implemented in KCalCore::MemoryCalendar.

Incidence::List Calendar::rawIncidences

(

)

const [virtual]

Returns an unfiltered list of all Incidences for this Calendar.

Returns:

the list of all unfiltered Incidences.

Definition at line 405 of file calendar.cpp.

virtual Journal::List KCalCore::Calendar::rawJournals	(	JournalSortField	sortField = JournalSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all Journals for this Calendar.

Parameters:

	sortField	specifies the JournalSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered Journals sorted as specified.

Implemented in KCalCore::MemoryCalendar.

virtual Journal::List KCalCore::Calendar::rawJournalsForDate

(

const QDate &

date

)

const [pure virtual]

Returns an unfiltered list of all Journals for on the specified date.

Parameters:

date

request unfiltered Journals for this QDate only.

Returns:

the list of unfiltered Journals for the specified date.

Implemented in KCalCore::MemoryCalendar.

virtual Todo::List KCalCore::Calendar::rawTodos	(	const QDate &	start,
		const QDate &	end,
		const KDateTime::Spec &	timespec = KDateTime::Spec(),
		bool	inclusive = false
	)			const [pure virtual]

Returns an unfiltered list of all Todos occurring within a date range.

Parameters:

	start	is the starting date
	end	is the ending date
	timespec	time zone etc. to interpret start and end, or the calendar's default time spec if none is specified
	inclusive	if true only Todos which are completely included within the date range are returned.

Returns:

the list of unfiltered Todos occurring within the specified date range.

Implemented in KCalCore::MemoryCalendar.

virtual Todo::List KCalCore::Calendar::rawTodos	(	TodoSortField	sortField = TodoSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all Todos for this Calendar.

Parameters:

	sortField	specifies the TodoSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered Todos sorted as specified.

Implemented in KCalCore::MemoryCalendar.

virtual Todo::List KCalCore::Calendar::rawTodosForDate

(

const QDate &

date

)

const [pure virtual]

Returns an unfiltered list of all Todos which due on the specified date.

Parameters:

date

request unfiltered Todos due on this QDate.

Returns:

the list of unfiltered Todos due on the specified date.

Implemented in KCalCore::MemoryCalendar.

void Calendar::registerObserver

(

CalendarObserver *

observer

)

Registers an Observer for this Calendar.

Parameters:

observer

is a pointer to an Observer object that will be watching this Calendar.

See also:

unregisterObserver()

Definition at line 1158 of file calendar.cpp.

Incidence::List Calendar::relations

(

const QString &

uid

)

const

Returns a list of incidences that have a relation of RELTYPE parent to incidence uid.

Parameters:

uid

The parent identifier whos children we want to obtain.

Definition at line 1122 of file calendar.cpp.

bool Calendar::reload

(

)

[virtual]

Loads the calendar contents from storage.

This requires that the calendar has been previously loaded (initialized).

Returns:

true if the reload was successful; otherwise false. Base implementation returns true.

Definition at line 1206 of file calendar.cpp.

void Calendar::removeRelations

(

const Incidence::Ptr &

incidence

)

[virtual]

Removes all Relations from an Incidence.

Parameters:

incidence

is a pointer to the Incidence to have a Relation removed.

Definition at line 1027 of file calendar.cpp.

bool Calendar::save

(

)

[virtual]

Syncs changes in memory to persistent storage.

Returns:

true if the save was successful; false otherwise. Base implementation returns true.

Definition at line 1201 of file calendar.cpp.

bool Calendar::setDefaultNotebook

(

const QString &

notebook

)

set DefaultNotebook information to calendar.

Parameters:

notebook

notebook uid

Returns:

true if operation was successful; false otherwise.

Definition at line 478 of file calendar.cpp.

void Calendar::setFilter

(

CalFilter *

filter

)

Sets the calendar filter.

Parameters:

filter

a pointer to a CalFilter object which will be used to filter Calendar Incidences. The Calendar takes ownership of filter.

See also:

filter()

Definition at line 362 of file calendar.cpp.

void Calendar::setModified

(

bool

modified

)

Sets if the calendar has been modified.

Parameters:

modified

is true if the calendar has been modified since open or last save.

See also:

isModified()

Definition at line 1185 of file calendar.cpp.

bool Calendar::setNotebook	(	const Incidence::Ptr &	incidence,
		const QString &	notebook
	)			[virtual]

Associate notebook for an incidence.

Parameters:

	incidence	incidence
	notebook	notebook uid

Returns:

true if the operation was successful; false otherwise.

Definition at line 522 of file calendar.cpp.

void Calendar::setObserversEnabled

(

bool

enabled

)

[protected]

Let Calendar subclasses notify that they enabled an Observer.

Parameters:

enabled

if true tells the calendar that a subclass has enabled an Observer.

Definition at line 1345 of file calendar.cpp.

void Calendar::setOwner

(

const Person::Ptr &

owner

)

Sets the owner of the calendar to owner.

Parameters:

owner

is a Person object. Must be a non-null pointer.

See also:

owner()

Definition at line 235 of file calendar.cpp.

void Calendar::setProductId

(

const QString &

id

)

Sets the calendar Product ID to id.

Parameters:

id

is a string containing the Product ID.

See also:

productId() const

Definition at line 1300 of file calendar.cpp.

void Calendar::setTimeSpec

(

const KDateTime::Spec &

timeSpec

)

Sets the default time specification (time zone, etc.

) used for creating or modifying incidences in the Calendar.

The method also calls setViewTimeSpec(timeSpec).

Parameters:

timeSpec

time specification

Definition at line 242 of file calendar.cpp.

void Calendar::setTimeZoneId

(

const QString &

timeZoneId

)

Sets the time zone ID used for creating or modifying incidences in the Calendar.

This method has no effect on existing incidences.

The method also calls setViewTimeZoneId(timeZoneId).

Parameters:

timeZoneId

is a string containing a time zone ID, which is assumed to be valid. The time zone ID is used to set the time zone for viewing Incidence date/times. If no time zone is found, the viewing time specification is set to local clock time. Example: "Europe/Berlin"

See also:

setTimeSpec()

Definition at line 256 of file calendar.cpp.

void Calendar::setTimeZones

(

ICalTimeZones *

zones

)

Set the time zone collection used by the calendar.

Parameters:

zones

time zones collection. Important: all time zones references in the calendar must be included in the collection.

Definition at line 328 of file calendar.cpp.

void Calendar::setupRelations

(

const Incidence::Ptr &

incidence

)

[virtual]

Setup Relations for an Incidence.

Parameters:

incidence

is a pointer to the Incidence to have a Relation setup.

Definition at line 984 of file calendar.cpp.

void Calendar::setViewTimeSpec

(

const KDateTime::Spec &

timeSpec

)

const

Notes the time specification which the client application intends to use for viewing the incidences in this calendar.

This is simply a convenience method which makes a note of the new time zone so that it can be read back by viewTimeSpec(). The client application must convert date/time values to the desired time zone itself.

The time specification is not used in any way by the Calendar or its incidences; it is solely for use by the client application.

Parameters:

timeSpec

time specification

See also:

viewTimeSpec()

Definition at line 301 of file calendar.cpp.

void Calendar::setViewTimeZoneId

(

const QString &

timeZoneId

)

const

Notes the time zone Id which the client application intends to use for viewing the incidences in this calendar.

This is simply a convenience method which makes a note of the new time zone so that it can be read back by viewTimeId(). The client application must convert date/time values to the desired time zone itself.

The Id is not used in any way by the Calendar or its incidences. It is solely for use by the client application.

Parameters:

timeZoneId

is a string containing a time zone ID, which is assumed to be valid. The time zone ID is used to set the time zone for viewing Incidence date/times. If no time zone is found, the viewing time specification is set to local clock time. Example: "Europe/Berlin"

See also:

viewTimeZoneId()

Definition at line 307 of file calendar.cpp.

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

Shifts the times of all incidences so that they appear at the same clock time as before but in a new time zone.

The shift is done from a viewing time zone rather than from the actual incidence time zone.

For example, shifting an incidence whose start time is 09:00 America/New York, using an old viewing time zone (oldSpec) of Europe/London, to a new time zone (newSpec) of Europe/Paris, will result in the time being shifted from 14:00 (which is the London time of the incidence start) to 14:00 Paris time.

Parameters:

	oldSpec	the time specification which provides the clock times
	newSpec	the new time specification

See also:

isLocalTime()

Definition at line 341 of file calendar.cpp.

Event::List Calendar::sortEvents	(	const Event::List &	eventList,
		EventSortField	sortField,
		SortDirection	sortDirection
	)			[static]

Sort a list of Events.

static

Parameters:

	eventList	is a pointer to a list of Events.
	sortField	specifies the EventSortField.
	sortDirection	specifies the SortDirection.

Returns:

a list of Events sorted as specified.

Definition at line 592 of file calendar.cpp.

Journal::List Calendar::sortJournals	(	const Journal::List &	journalList,
		JournalSortField	sortField,
		SortDirection	sortDirection
	)			[static]

Sort a list of Journals.

static

Parameters:

	journalList	is a pointer to a list of Journals.
	sortField	specifies the JournalSortField.
	sortDirection	specifies the SortDirection.

Returns:

a list of Journals sorted as specified.

Definition at line 933 of file calendar.cpp.

Todo::List Calendar::sortTodos	(	const Todo::List &	todoList,
		TodoSortField	sortField,
		SortDirection	sortDirection
	)			[static]

Sort a list of Todos.

static

Parameters:

	todoList	is a pointer to a list of Todos.
	sortField	specifies the TodoSortField.
	sortDirection	specifies the SortDirection.

Returns:

a list of Todos sorted as specified.

Definition at line 837 of file calendar.cpp.

void Calendar::startBatchAdding

(

)

[virtual]

Call this to tell the calendar that you're adding a batch of incidences.

So it doesn't, for example, ask the destination for each incidence.

See also:

endBatchAdding()

Definition at line 1481 of file calendar.cpp.

KDateTime::Spec Calendar::timeSpec

(

)

const

Get the time specification (time zone etc.

) used for creating or modifying incidences in the Calendar.

Returns:

time specification

Definition at line 251 of file calendar.cpp.

QString Calendar::timeZoneId

(

)

const

Returns the time zone ID used for creating or modifying incidences in the calendar.

Returns:

the string containing the time zone ID, or empty string if the creation/modification time specification is not a time zone.

Definition at line 295 of file calendar.cpp.

ICalTimeZones * Calendar::timeZones

(

)

const

Returns the time zone collection used by the calendar.

Returns:

the time zones collection.

See also:

setLocalTime()

Definition at line 323 of file calendar.cpp.

virtual Todo::Ptr KCalCore::Calendar::todo	(	const QString &	uid,
		const KDateTime &	recurrenceId = KDateTime()
	)			const [pure virtual]

Returns the Todo associated with the given unique identifier.

Parameters:

	uid	is a unique identifier string.
	recurrenceId	is possible recurrenceId of todo, default is null

Returns:

a pointer to the Todo. A null pointer is returned if no such Todo exists.

Implemented in KCalCore::MemoryCalendar.

virtual Todo::List KCalCore::Calendar::todoInstances	(	const Incidence::Ptr &	todo,
		TodoSortField	sortField = TodoSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [pure virtual]

Returns a sorted, unfiltered list of all possible instances for this recurring Todo.

Parameters:

	todo	todo to check for. Caller guarantees it's of type Todo.
	sortField	specifies the TodoSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all unfiltered todo instances sorted as specified.

Implemented in KCalCore::MemoryCalendar.

Todo::List Calendar::todos	(	const QDate &	start,
		const QDate &	end,
		const KDateTime::Spec &	timespec = KDateTime::Spec(),
		bool	inclusive = false
	)			const [virtual]

Returns a filtered list of all Todos occurring within a date range.

Parameters:

	start	is the starting date
	end	is the ending date
	timespec	time zone etc. to interpret start and end, or the calendar's default time spec if none is specified
	inclusive	if true only Todos which are completely included within the date range are returned.

Returns:

the list of filtered Todos occurring within the specified date range.

Definition at line 924 of file calendar.cpp.

Todo::List Calendar::todos

(

const QDate &

date

)

const [virtual]

Returns a filtered list of all Todos which are due on the specified date.

Parameters:

date

request filtered Todos due on this QDate.

Returns:

the list of filtered Todos due on the specified date.

Definition at line 917 of file calendar.cpp.

Todo::List Calendar::todos	(	TodoSortField	sortField = TodoSortUnsorted,
		SortDirection	sortDirection = SortDirectionAscending
	)			const [virtual]

Returns a sorted, filtered list of all Todos for this Calendar.

Parameters:

	sortField	specifies the TodoSortField.
	sortDirection	specifies the SortDirection.

Returns:

the list of all filtered Todos sorted as specified.

Definition at line 909 of file calendar.cpp.

void Calendar::unregisterObserver

(

CalendarObserver *

observer

)

Unregisters an Observer for this Calendar.

Parameters:

observer

is a pointer to an Observer object that has been watching this Calendar.

See also:

registerObserver()

Definition at line 1171 of file calendar.cpp.

bool Calendar::updateNotebook	(	const QString &	notebook,
		bool	isVisible
	)

Update notebook information in calendar.

Is usually called by storages only.

Parameters:

	notebook	notebook uid
	isVisible	notebook visibility

Returns:

true if operation succeeded

See also:

isVisible()

Definition at line 459 of file calendar.cpp.

KDateTime::Spec Calendar::viewTimeSpec

(

)

const

Returns the time specification used for viewing the incidences in this calendar.

This simply returns the time specification last set by setViewTimeSpec().

See also:

setViewTimeSpec().

Definition at line 312 of file calendar.cpp.

QString Calendar::viewTimeZoneId

(

)

const

Returns the time zone Id used for viewing the incidences in this calendar.

This simply returns the time specification last set by setViewTimeSpec().

See also:

setViewTimeZoneId().

Definition at line 317 of file calendar.cpp.

void Calendar::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Standard trick to add virtuals later.

Parameters:

	id	is any integer unique to this class which we will use to identify the method to be called.
	data	is a pointer to some glob of data, typically a struct.

Reimplemented from KCalCore::CustomProperties.

Reimplemented in KCalCore::MemoryCalendar.

Definition at line 1496 of file calendar.cpp.

---

The documentation for this class was generated from the following files:

• calendar.h
• calendar.cpp