KCal::CalendarNull Class Reference

#include <calendarnull.h>

Inheritance diagram for KCal::CalendarNull:

Public Member Functions
	CalendarNull (const KDateTime::Spec &timeSpec)
	CalendarNull (const QString &timeZoneId)
	~CalendarNull ()
bool	addEvent (Event *event)
bool	addJournal (Journal *journal)
bool	addTodo (Todo *todo)
Alarm::List	alarms (const KDateTime &from, 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)
Event::List	rawEvents (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)
Event::List	rawEvents (EventSortField sortField, SortDirection sortDirection)
Event::List	rawEventsForDate (const KDateTime &dt)
Event::List	rawEventsForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Journal::List	rawJournals (JournalSortField sortField, SortDirection sortDirection)
Journal::List	rawJournalsForDate (const QDate &date)
Todo::List	rawTodos (TodoSortField sortField, SortDirection sortDirection)
Todo::List	rawTodosForDate (const QDate &date)
bool	reload ()
bool	save ()
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	addEvent (Event *event)=0
virtual bool	addIncidence (Incidence *incidence)
virtual bool	addJournal (Journal *journal)=0
virtual bool	addTodo (Todo *todo)=0
virtual Alarm::List	alarms (const KDateTime &from, const KDateTime &to)=0
void	beginBatchAdding ()
virtual bool	beginChange (Incidence *incidence)
QStringList	categories ()
virtual void	close ()=0
virtual void	deleteAllEvents ()=0
virtual void	deleteAllJournals ()=0
virtual void	deleteAllTodos ()=0
virtual bool	deleteEvent (Event *event)=0
virtual bool	deleteIncidence (Incidence *incidence)
virtual bool	deleteJournal (Journal *journal)=0
virtual bool	deleteTodo (Todo *todo)=0
Incidence *	dissociateOccurrence (Incidence *incidence, const QDate &date, const KDateTime::Spec &spec, bool single=true)
void	endBatchAdding ()
virtual bool	endChange (Incidence *incidence)
virtual Event *	event (const QString &uid)=0
Event::List	events (const KDateTime &dt)
Event::List	events (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Event::List	events (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)
virtual Event::List	events (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 *	journal (const QString &uid)=0
virtual Journal::List	journals (const QDate &date)
virtual Journal::List	journals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
Person	owner () const
QString	productId () const
virtual Event::List	rawEvents (const QDate &start, const QDate &end, const KDateTime::Spec &timeSpec=KDateTime::Spec(), bool inclusive=false)=0
virtual Event::List	rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
virtual Event::List	rawEventsForDate (const KDateTime &dt)=0
virtual Event::List	rawEventsForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::Spec(), EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
virtual Incidence::List	rawIncidences ()
virtual Journal::List	rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
virtual Journal::List	rawJournalsForDate (const QDate &date)=0
virtual Todo::List	rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)=0
virtual Todo::List	rawTodosForDate (const QDate &date)=0
void	registerObserver (CalendarObserver *observer)
virtual bool	reload ()=0
virtual void	removeRelations (Incidence *incidence)
virtual bool	save ()=0
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 *	todo (const QString &uid)=0
virtual Todo::List	todos (const QDate &date)
virtual Todo::List	todos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending)
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 ()
virtual void	incidenceUpdated (IncidenceBase *incidenceBase)=0

Static Public Member Functions
static CalendarNull *	self ()
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)

Additional Inherited Members
Signals inherited from KCal::Calendar
void	batchAddingBegins ()
void	batchAddingEnds ()
void	calendarChanged ()
void	calendarLoaded ()
void	calendarSaved ()
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	incidenceUpdated (IncidenceBase *incidenceBase)
void	notifyIncidenceAdded (Incidence *incidence)
void	notifyIncidenceChanged (Incidence *incidence)
void	notifyIncidenceDeleted (Incidence *incidence)
void	setObserversEnabled (bool enabled)
virtual void	customPropertyUpdated ()

Detailed Description

Represents a null calendar class; that is, a calendar which contains no information and provides no capabilities.

The null calendar can be passed to functions which need a calendar object when there is no real calendar available yet.

CalendarNull can be used to implement the null object design pattern: pass a CalendarNull object instead of passing a 0 pointer and checking for 0 with each access.

Definition at line 48 of file calendarnull.h.

Constructor & Destructor Documentation

CalendarNull() [1/2]

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

explicit

Construct Calendar object using a time specification (time zone, etc.).

Private class that helps to provide binary compatibility between releases.

The time specification is used for creating or modifying incidences in the Calendar. It is also used for viewing incidences (see setViewTimeSpec()). The time specification does not alter existing incidences.

Parameters

timeSpec

time specification

Definition at line 47 of file calendarnull.cpp.

CalendarNull() [2/2]

CalendarNull::CalendarNull ( const QString &  timeZoneId )

explicit

Constructs a null calendar with a specified time zone 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 52 of file calendarnull.cpp.

~CalendarNull()

CalendarNull::~CalendarNull

(

)

Destroys the null calendar.

Definition at line 57 of file calendarnull.cpp.

Member Function Documentation

addEvent()

bool CalendarNull::addEvent ( Event *  event )

virtual

Calendar::addEvent()

Implements KCal::Calendar.

Definition at line 85 of file calendarnull.cpp.

addJournal()

bool CalendarNull::addJournal ( Journal *  journal )

virtual

Calendar::addJournal()

Implements KCal::Calendar.

Definition at line 180 of file calendarnull.cpp.

addTodo()

bool CalendarNull::addTodo ( Todo *  todo )

virtual

Calendar::addTodo()

Implements KCal::Calendar.

Definition at line 144 of file calendarnull.cpp.

alarms()

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

virtual

Calendar::alarms()

Implements KCal::Calendar.

Definition at line 216 of file calendarnull.cpp.

close()

void CalendarNull::close ( )

virtual

Calendar::close()

Implements KCal::Calendar.

Definition at line 71 of file calendarnull.cpp.

deleteAllEvents()

void CalendarNull::deleteAllEvents ( )

virtual

Calendar::deleteAllEvents()

Implements KCal::Calendar.

Definition at line 97 of file calendarnull.cpp.

deleteAllJournals()

void CalendarNull::deleteAllJournals ( )

virtual

Calendar::deleteAllJournals()

Implements KCal::Calendar.

Definition at line 192 of file calendarnull.cpp.

deleteAllTodos()

void CalendarNull::deleteAllTodos ( )

virtual

Calendar::deleteAllTodos()

Implements KCal::Calendar.

Definition at line 156 of file calendarnull.cpp.

deleteEvent()

bool CalendarNull::deleteEvent ( Event *  event )

virtual

Calendar::deleteEvent()

Implements KCal::Calendar.

Definition at line 91 of file calendarnull.cpp.

deleteJournal()

bool CalendarNull::deleteJournal ( Journal *  journal )

virtual

Calendar::deleteJournal()

Implements KCal::Calendar.

Definition at line 186 of file calendarnull.cpp.

deleteTodo()

bool CalendarNull::deleteTodo ( Todo *  todo )

virtual

Calendar::deleteTodo()

Implements KCal::Calendar.

Definition at line 150 of file calendarnull.cpp.

event()

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

virtual

Calendar::event()

Implements KCal::Calendar.

Definition at line 138 of file calendarnull.cpp.

incidenceUpdated()

void CalendarNull::incidenceUpdated ( IncidenceBase *  incidenceBase )

virtual

Calendar::incidenceUpdated()

Reimplemented from KCal::Calendar.

Definition at line 223 of file calendarnull.cpp.

journal()

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

virtual

Calendar::journal()

Implements KCal::Calendar.

Definition at line 210 of file calendarnull.cpp.

rawEvents() [1/2]

Event::List CalendarNull::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 109 of file calendarnull.cpp.

rawEvents() [2/2]

Event::List CalendarNull::rawEvents ( EventSortField  sortField, SortDirection  sortDirection  )

virtual

Calendar::rawEvents(EventSortField, SortDirection)

Implements KCal::Calendar.

Definition at line 101 of file calendarnull.cpp.

rawEventsForDate() [1/2]

Event::List CalendarNull::rawEventsForDate ( const KDateTime &  dt )

virtual

Calendar::rawEventsForDate(const KDateTime &)

Implements KCal::Calendar.

Definition at line 132 of file calendarnull.cpp.

rawEventsForDate() [2/2]

Event::List CalendarNull::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.

Returns

the list of unfiltered Events occurring on the specified QDate.

Implements KCal::Calendar.

Definition at line 120 of file calendarnull.cpp.

rawJournals()

Journal::List CalendarNull::rawJournals ( JournalSortField  sortField, SortDirection  sortDirection  )

virtual

Calendar::rawJournals()

Implements KCal::Calendar.

Definition at line 196 of file calendarnull.cpp.

rawJournalsForDate()

Journal::List CalendarNull::rawJournalsForDate ( const QDate &  date )

virtual

Calendar::rawJournalsForDate()

Implements KCal::Calendar.

Definition at line 204 of file calendarnull.cpp.

rawTodos()

Todo::List CalendarNull::rawTodos ( TodoSortField  sortField, SortDirection  sortDirection  )

virtual

Calendar::rawTodos()

Implements KCal::Calendar.

Definition at line 160 of file calendarnull.cpp.

rawTodosForDate()

Todo::List CalendarNull::rawTodosForDate ( const QDate &  date )

virtual

Calendar::rawTodosForDate()

Implements KCal::Calendar.

Definition at line 168 of file calendarnull.cpp.

reload()

bool CalendarNull::reload ( )

virtual

Calendar::reload()

Implements KCal::Calendar.

Definition at line 80 of file calendarnull.cpp.

save()

bool CalendarNull::save ( )

virtual

Calendar::save()

Implements KCal::Calendar.

Definition at line 75 of file calendarnull.cpp.

self()

CalendarNull * CalendarNull::self ( )

static

Returns a pointer to the CalendarNull object, of which there can be only one.

The object is constructed if necessary.

Definition at line 62 of file calendarnull.cpp.

todo()

Todo * CalendarNull::todo ( const QString &  uid )

virtual

Calendar::todo()

Implements KCal::Calendar.

Definition at line 174 of file calendarnull.cpp.

---

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

• calendarnull.h
• calendarnull.cpp