KDE PIM / Developers / API Docs / libkcal

KCal::CalendarNull Class Reference

This is a null calendar object which does nothing. More...

#include <calendarnull.h>

Inherits KCal::Calendar.

List of all members.

Public Member Functions

Static Public Member Functions


Detailed Description

This is a null calendar object which does nothing.

It can be passed to functions which need a calendar object when there actually isn't a real calendar yet. CalendarNull can be used to implement the null object design pattern. Instead of passing a 0 pointer and checking for 0 with each access a CalendarNull object can be passed.


Member Function Documentation

void KCal::CalendarNull::incidenceUpdated IncidenceBase  )  [inline]
 

The observer interface.

So far not implemented.

Reimplemented from KCal::Calendar.

void KCal::CalendarNull::close  )  [inline, virtual]
 

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

Implements KCal::Calendar.

void KCal::CalendarNull::save  )  [inline, virtual]
 

Sync changes in memory to persistant storage.

Implements KCal::Calendar.

bool KCal::CalendarNull::addEvent Event  )  [inline, virtual]
 

Adds a Event to this calendar object.

Returns:
true on success, false on error.

Implements KCal::Calendar.

void KCal::CalendarNull::deleteEvent Event  )  [inline, virtual]
 

Delete event from calendar.

Implements KCal::Calendar.

Event* KCal::CalendarNull::event const QString &   )  [inline, virtual]
 

Retrieves an event on the basis of the unique string ID.

Implements KCal::Calendar.

Event::List KCal::CalendarNull::rawEvents EventSortField  ,
SortDirection 
[inline, virtual]
 

Return unfiltered list of all events in calendar.

Implements KCal::Calendar.

Event::List KCal::CalendarNull::rawEvents const QDate &  ,
const QDate &  ,
bool 
[inline, virtual]
 

Get events in a range of dates.

If inclusive is set to true, only events are returned, which are completely included in the range.

Implements KCal::Calendar.

Event::List KCal::CalendarNull::rawEventsForDate const QDateTime &   )  [inline, virtual]
 

Get unfiltered events, which occur on the given date.

Implements KCal::Calendar.

Event::List KCal::CalendarNull::rawEventsForDate const QDate &  ,
bool 
[inline, virtual]
 

Get unfiltered events, which occur on the given date.

Implements KCal::Calendar.

bool KCal::CalendarNull::addTodo Todo  )  [inline, virtual]
 

Add a todo to the todolist.

Returns:
true on success, false on error.

Implements KCal::Calendar.

void KCal::CalendarNull::deleteTodo Todo  )  [inline, virtual]
 

Remove a todo from the todolist.

Implements KCal::Calendar.

Todo* KCal::CalendarNull::todo const QString &   )  [inline, virtual]
 

Searches todolist for an event with this unique string identifier, returns a pointer or null.

Implements KCal::Calendar.

Todo::List KCal::CalendarNull::rawTodos TodoSortField  ,
SortDirection 
[inline, virtual]
 

Return unfiltered list of todos.

Implements KCal::Calendar.

Todo::List KCal::CalendarNull::rawTodosForDate const QDate &   )  [inline, virtual]
 

Return unfiltered list of todos.

Implements KCal::Calendar.

bool KCal::CalendarNull::addJournal Journal  )  [inline, virtual]
 

Add a Journal entry to calendar.

Returns:
true on success, false on error.

Implements KCal::Calendar.

void KCal::CalendarNull::deleteJournal Journal  )  [inline, virtual]
 

Remove a journal entry from the calendar.

Implements KCal::Calendar.

Journal* KCal::CalendarNull::journal const QString &   )  [inline, virtual]
 

Return Journal with given UID.

Implements KCal::Calendar.

Journal::List KCal::CalendarNull::rawJournals JournalSortField  ,
SortDirection 
[inline, virtual]
 

Return unfiltered list of all journals in calendar.

Implements KCal::Calendar.

Journal::List KCal::CalendarNull::rawJournalsForDate const QDate &   )  [inline, virtual]
 

Return unfiltered list of journals for a given date.

Implements KCal::Calendar.

Alarm::List KCal::CalendarNull::alarms const QDateTime &  ,
const QDateTime & 
[inline, virtual]
 

Return all alarms, which ocur in the given time interval.

Implements KCal::Calendar.


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