libkcal Library API Documentation

KCal::CalendarNull Class Reference

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

#include <calendarnull.h>

Inheritance diagram for KCal::CalendarNull:

KCal::Calendar QObject KCal::CustomProperties List of all members.

Public Methods

 CalendarNull ()
 ~CalendarNull ()
void incidenceUpdated (IncidenceBase *)
void close ()
void save ()
bool addEvent (Event *)
void deleteEvent (Event *)
Eventevent (const QString &)
Event::List rawEvents ()
bool addTodo (Todo *)
void deleteTodo (Todo *)
Todotodo (const QString &)
Todo::List todos (const QDate &)
Todo::List rawTodos ()
bool addJournal (Journal *)
void deleteJournal (Journal *)
Journaljournal (const QDate &)
Journaljournal (const QString &)
Journal::List journals ()
Alarm::List alarms (const QDateTime &, const QDateTime &)

Static Public Methods

CalendarNull * self ()

Protected Methods

Event::List rawEventsForDate (const QDateTime &)
Event::List rawEventsForDate (const QDate &, bool)
Event::List rawEvents (const QDate &, const QDate &, bool)

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.

Definition at line 37 of file calendarnull.h.


Member Function Documentation

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

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

Implements KCal::Calendar.

Definition at line 47 of file calendarnull.h.

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

Sync changes in memory to persistant storage.

Implements KCal::Calendar.

Definition at line 48 of file calendarnull.h.

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

Adds a Event to this calendar object.

Parameters:
anEvent  a pointer to the event to add
Returns:
true on success, false on error.

Implements KCal::Calendar.

Definition at line 50 of file calendarnull.h.

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

Delete event from calendar.

Implements KCal::Calendar.

Definition at line 51 of file calendarnull.h.

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

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

Implements KCal::Calendar.

Definition at line 52 of file calendarnull.h.

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

Return unfiltered list of all events in calendar.

Implements KCal::Calendar.

Definition at line 53 of file calendarnull.h.

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

Add a todo to the todolist.

Returns:
true on success, false on error.

Implements KCal::Calendar.

Definition at line 55 of file calendarnull.h.

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

Remove a todo from the todolist.

Implements KCal::Calendar.

Definition at line 56 of file calendarnull.h.

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.

Definition at line 57 of file calendarnull.h.

Todo::List KCal::CalendarNull::todos const QDate   [inline, virtual]
 

Returns list of todos due on the specified date.

Implements KCal::Calendar.

Definition at line 58 of file calendarnull.h.

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

Return unfiltered list of todos.

Implements KCal::Calendar.

Definition at line 59 of file calendarnull.h.

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

Add a Journal entry to calendar.

Returns:
true on success, false on error.

Implements KCal::Calendar.

Definition at line 61 of file calendarnull.h.

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

Remove a journal entry from the calendar.

Implements KCal::Calendar.

Definition at line 62 of file calendarnull.h.

Journal* KCal::CalendarNull::journal const QDate   [inline, virtual]
 

Return Journal for given date.

Implements KCal::Calendar.

Definition at line 63 of file calendarnull.h.

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

Return Journal with given UID.

Implements KCal::Calendar.

Definition at line 64 of file calendarnull.h.

Journal::List KCal::CalendarNull::journals   [inline, virtual]
 

Return list of all Journal entries.

Implements KCal::Calendar.

Definition at line 65 of file calendarnull.h.

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

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

Implements KCal::Calendar.

Definition at line 67 of file calendarnull.h.

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

Get unfiltered events, which occur on the given date.

Implements KCal::Calendar.

Definition at line 73 of file calendarnull.h.

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

Get unfiltered events, which occur on the given date.

Implements KCal::Calendar.

Definition at line 77 of file calendarnull.h.

Event::List KCal::CalendarNull::rawEvents const QDate  ,
const QDate  ,
bool   
[inline, protected, 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.

Definition at line 81 of file calendarnull.h.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:24 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003