libkcal Library API Documentation

KCal::ResourceCached Class Reference

This class provides a calendar resource using a local CalendarLocal object to cache the calendar data. More...

#include <resourcecached.h>

Inheritance diagram for KCal::ResourceCached:

KCal::ResourceCalendar KCal::ResourceLocal KCal::ResourceRemote List of all members.

Public Methods

 ResourceCached (const KConfig *)
virtual ~ResourceCached ()
bool addEvent (Event *anEvent)
void deleteEvent (Event *)
Eventevent (const QString &UniqueStr)
Event::List events ()
Event::List rawEvents ()
Event::List rawEventsForDate (const QDate &date, bool sorted=false)
Event::List rawEventsForDate (const QDateTime &qdt)
Event::List rawEvents (const QDate &start, const QDate &end, bool inclusive=false)
bool addTodo (Todo *todo)
void deleteTodo (Todo *)
Todotodo (const QString &uid)
Todo::List rawTodos ()
Todo::List todos (const QDate &date)
virtual bool addJournal (Journal *)
virtual void deleteJournal (Journal *)
virtual Journaljournal (const QDate &)
virtual Journaljournal (const QString &uid)
Journal::List journals ()
Alarm::List alarms (const QDateTime &from, const QDateTime &to)
Alarm::List alarmsTo (const QDateTime &to)
void setTimeZoneId (const QString &tzid)

Protected Attributes

CalendarLocal mCalendar

Detailed Description

This class provides a calendar resource using a local CalendarLocal object to cache the calendar data.

Definition at line 40 of file resourcecached.h.


Member Function Documentation

bool ResourceCached::addEvent Event   anEvent [virtual]
 

Add event to calendar.

Implements KCal::ResourceCalendar.

Definition at line 49 of file resourcecached.cpp.

References KCal::CalendarLocal::addEvent().

void ResourceCached::deleteEvent Event   [virtual]
 

Deletes an event from this calendar.

Implements KCal::ResourceCalendar.

Definition at line 55 of file resourcecached.cpp.

References KCal::CalendarLocal::deleteEvent().

Event * ResourceCached::event const QString   UniqueStr [virtual]
 

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

Implements KCal::ResourceCalendar.

Definition at line 63 of file resourcecached.cpp.

References KCal::CalendarLocal::event().

Event::List KCal::ResourceCached::events  
 

Return filtered list of all events in calendar.

Event::List ResourceCached::rawEvents   [virtual]
 

Return unfiltered list of all events in calendar.

Implements KCal::ResourceCalendar.

Definition at line 87 of file resourcecached.cpp.

References KCal::CalendarLocal::rawEvents().

Event::List ResourceCached::rawEventsForDate const QDate   date,
bool    sorted = false
[virtual]
 

Builds and then returns a list of all events that match for the date specified.

useful for dayView, etc. etc.

Implements KCal::ResourceCalendar.

Definition at line 68 of file resourcecached.cpp.

References KCal::CalendarLocal::rawEventsForDate().

Event::List ResourceCached::rawEventsForDate const QDateTime   qdt [virtual]
 

Get unfiltered events for date qdt.

Implements KCal::ResourceCalendar.

Definition at line 82 of file resourcecached.cpp.

References QDateTime::date(), and KCal::CalendarLocal::rawEventsForDate().

Event::List ResourceCached::rawEvents const QDate   start,
const QDate   end,
bool    inclusive = false
[virtual]
 

Get unfiltered 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::ResourceCalendar.

Definition at line 76 of file resourcecached.cpp.

References KCal::CalendarLocal::rawEvents().

bool ResourceCached::addTodo Todo   todo [virtual]
 

Add a todo to the todolist.

Implements KCal::ResourceCalendar.

Definition at line 92 of file resourcecached.cpp.

References KCal::CalendarLocal::addTodo().

void ResourceCached::deleteTodo Todo   [virtual]
 

Remove a todo from the todolist.

Implements KCal::ResourceCalendar.

Definition at line 97 of file resourcecached.cpp.

References KCal::CalendarLocal::deleteTodo().

Todo * ResourceCached::todo const QString   uid [virtual]
 

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

Implements KCal::ResourceCalendar.

Definition at line 113 of file resourcecached.cpp.

References KCal::CalendarLocal::todo().

Todo::List ResourceCached::rawTodos   [virtual]
 

Return list of all todos.

Implements KCal::ResourceCalendar.

Definition at line 108 of file resourcecached.cpp.

References KCal::CalendarLocal::rawTodos().

Todo::List ResourceCached::todos const QDate   date [virtual]
 

Returns list of todos due on the specified date.

Implements KCal::ResourceCalendar.

Definition at line 118 of file resourcecached.cpp.

References KCal::CalendarLocal::todos().

bool ResourceCached::addJournal Journal   [virtual]
 

Add a Journal entry to calendar.

Implements KCal::ResourceCalendar.

Definition at line 124 of file resourcecached.cpp.

References KCal::CalendarLocal::addJournal(), KCal::IncidenceBase::dtStart(), and QDateTime::toString().

void ResourceCached::deleteJournal Journal   [virtual]
 

Remove a Journal from the calendar.

Implements KCal::ResourceCalendar.

Definition at line 102 of file resourcecached.cpp.

References KCal::CalendarLocal::deleteJournal().

Journal * ResourceCached::journal const QDate   [virtual]
 

Return Journal for given date.

Implements KCal::ResourceCalendar.

Definition at line 131 of file resourcecached.cpp.

References KCal::CalendarLocal::journal().

Journal * ResourceCached::journal const QString   uid [virtual]
 

Return Journal with given unique id.

Implements KCal::ResourceCalendar.

Definition at line 138 of file resourcecached.cpp.

References KCal::CalendarLocal::journal().

Journal::List ResourceCached::journals   [virtual]
 

Return list of all Journals stored in calendar.

Implements KCal::ResourceCalendar.

Definition at line 143 of file resourcecached.cpp.

References KCal::CalendarLocal::journals().

Alarm::List ResourceCached::alarms const QDateTime   from,
const QDateTime   to
[virtual]
 

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

Implements KCal::ResourceCalendar.

Definition at line 154 of file resourcecached.cpp.

References KCal::CalendarLocal::alarms().

Alarm::List ResourceCached::alarmsTo const QDateTime   to [virtual]
 

Return all alarms, which ocur before given date.

Implements KCal::ResourceCalendar.

Definition at line 149 of file resourcecached.cpp.

References KCal::CalendarLocal::alarmsTo().

void ResourceCached::setTimeZoneId const QString   tzid [virtual]
 

Set id of timezone, e.g.

"Europe/Berlin"

Implements KCal::ResourceCalendar.

Definition at line 162 of file resourcecached.cpp.

References KCal::Calendar::setTimeZoneId().


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:25 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003