libkcal Library API Documentation

KCal::CalendarResources Class Reference

This class provides a calendar composed of several calendar resources. More...

#include <calendarresources.h>

Inheritance diagram for KCal::CalendarResources:

Inheritance graph
[legend]
Collaboration diagram for KCal::CalendarResources:

Collaboration graph
[legend]
List of all members.

Signals

void signalResourceAdded (ResourceCalendar *)
void signalResourceModified (ResourceCalendar *)
void signalResourceDeleted (ResourceCalendar *)
void signalErrorMessage (const QString &)

Public Member Functions

 CalendarResources ()
 CalendarResources (const QString &timeZoneId)
void readConfig (KConfig *config=0)
void load ()
CalendarResourceManager * resourceManager () const
void setStandardDestinationPolicy ()
void setAskDestinationPolicy ()
void close ()
Ticket * requestSaveTicket (ResourceCalendar *)
virtual bool save (Ticket *)
virtual void releaseSaveTicket (Ticket *ticket)
void save ()
bool isSaving ()
bool addIncidence (Incidence *)
bool addEvent (Event *anEvent)
bool addEvent (Event *anEvent, ResourceCalendar *resource)
void deleteEvent (Event *)
Eventevent (const QString &UniqueStr)
Event::List rawEvents ()
QString getHolidayForDate (const QDate &qd)
bool addTodo (Todo *todo)
bool addTodo (Todo *todo, ResourceCalendar *resource)
void deleteTodo (Todo *)
Todotodo (const QString &uid)
Todo::List rawTodos ()
Todo::List rawTodosForDate (const QDate &date)
bool addJournal (Journal *)
void deleteJournal (Journal *)
bool addJournal (Journal *journal, ResourceCalendar *resource)
Journaljournal (const QDate &)
Journaljournal (const QString &UID)
Journal::List journals ()
Alarm::List alarms (const QDateTime &from, const QDateTime &to)
Alarm::List alarmsTo (const QDateTime &to)
ResourceCalendarresource (Incidence *)
bool beginChange (Incidence *)
bool endChange (Incidence *)
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)

Protected Slots

void slotLoadError (ResourceCalendar *r, const QString &err)
void slotSaveError (ResourceCalendar *r, const QString &err)

Protected Member Functions

void incidenceUpdated (IncidenceBase *)
void connectResource (ResourceCalendar *)
void resourceAdded (ResourceCalendar *resource)
void resourceModified (ResourceCalendar *resource)
void resourceDeleted (ResourceCalendar *resource)
virtual void doSetTimeZoneId (const QString &tzid)
int incrementChangeCount (ResourceCalendar *)
int decrementChangeCount (ResourceCalendar *)

Detailed Description

This class provides a calendar composed of several calendar resources.

Definition at line 41 of file calendarresources.h.


Constructor & Destructor Documentation

CalendarResources::CalendarResources  ) 
 

constructs a new calendar that uses the ResourceManager for "calendar"

Definition at line 69 of file calendarresources.cpp.

CalendarResources::CalendarResources const QString timeZoneId  ) 
 

constructs a new calendar, with variables initialized to sane values.

Definition at line 75 of file calendarresources.cpp.


Member Function Documentation

void CalendarResources::readConfig KConfig *  config = 0  ) 
 

Read the resources settings from a config file.

You have to call this method before load().

Parameters:
config The KConfig object which points to the config file. If no object is given (null pointer) the standard config file is used.

Definition at line 102 of file calendarresources.cpp.

void CalendarResources::load  ) 
 

Loads all events from the resources.

You have to add the resources first or call readConfig() to load the system resources.

Definition at line 112 of file calendarresources.cpp.

References KCal::Calendar::timeZoneId().

CalendarResourceManager* KCal::CalendarResources::resourceManager  )  const [inline]
 

Return ResourceManager used by this calendar.

Definition at line 131 of file calendarresources.h.

void CalendarResources::setStandardDestinationPolicy  ) 
 

Set the destinatinpolicy to add incidences always to the standard resource.

Definition at line 136 of file calendarresources.cpp.

void CalendarResources::setAskDestinationPolicy  ) 
 

Set the destinatinpolicy to ask to which resource incidences are added.

Definition at line 141 of file calendarresources.cpp.

void CalendarResources::close  )  [virtual]
 

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

etc.

Implements KCal::Calendar.

Definition at line 146 of file calendarresources.cpp.

CalendarResources::Ticket * CalendarResources::requestSaveTicket ResourceCalendar  ) 
 

Request ticket for saving the calendar.

If a ticket is returned the calendar is locked for write access until save() or releaseSaveTicket() is called.

Definition at line 655 of file calendarresources.cpp.

bool CalendarResources::save Ticket *   )  [virtual]
 

Save calendar.

If save is successfull, the ticket is deleted. Otherwise the caller has to release the ticket with releaseSaveTicket() to abandon the save operation or to call save() to try to save again.

Definition at line 665 of file calendarresources.cpp.

References releaseSaveTicket().

void CalendarResources::releaseSaveTicket Ticket *  ticket  )  [virtual]
 

Release the save ticket.

The calendar is unlocked without saving.

Definition at line 681 of file calendarresources.cpp.

Referenced by save().

void CalendarResources::save  )  [virtual]
 

Sync changes in memory to persistant storage.

Implements KCal::Calendar.

Definition at line 161 of file calendarresources.cpp.

bool CalendarResources::addIncidence Incidence  )  [virtual]
 

Add an incidence to calendar.

Returns:
true on success, false on error.

Reimplemented from KCal::Calendar.

Definition at line 187 of file calendarresources.cpp.

References resource().

Referenced by addEvent(), addJournal(), and addTodo().

bool CalendarResources::addEvent Event anEvent  )  [virtual]
 

Add Event to calendar.

Implements KCal::Calendar.

Definition at line 205 of file calendarresources.cpp.

References addIncidence().

bool CalendarResources::addEvent Event anEvent,
ResourceCalendar resource
 

Add Event to a resource.

Definition at line 210 of file calendarresources.cpp.

References KCal::ResourceCalendar::addEvent().

void CalendarResources::deleteEvent Event  )  [virtual]
 

deletes an event from this calendar.

Implements KCal::Calendar.

Definition at line 226 of file calendarresources.cpp.

Event * CalendarResources::event const QString UniqueStr  )  [virtual]
 

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

Implements KCal::Calendar.

Definition at line 244 of file calendarresources.cpp.

Event::List CalendarResources::rawEvents  )  [virtual]
 

Return unfiltered list of all events in calendar.

Implements KCal::Calendar.

Definition at line 467 of file calendarresources.cpp.

bool CalendarResources::addTodo Todo todo  )  [virtual]
 

Add a todo to the todolist.

Implements KCal::Calendar.

Definition at line 262 of file calendarresources.cpp.

References addIncidence().

bool CalendarResources::addTodo Todo todo,
ResourceCalendar resource
 

Add Todo to a resource.

Definition at line 269 of file calendarresources.cpp.

References KCal::ResourceCalendar::addTodo().

void CalendarResources::deleteTodo Todo  )  [virtual]
 

Remove a todo from the todolist.

Implements KCal::Calendar.

Definition at line 285 of file calendarresources.cpp.

Todo * CalendarResources::todo const QString uid  )  [virtual]
 

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

Implements KCal::Calendar.

Definition at line 326 of file calendarresources.cpp.

Todo::List CalendarResources::rawTodos  )  [virtual]
 

Return list of all todos.

Implements KCal::Calendar.

Definition at line 304 of file calendarresources.cpp.

References KCal::Calendar::todos().

Todo::List CalendarResources::rawTodosForDate const QDate date  )  [virtual]
 

Returns list of todos due on the specified date.

Implements KCal::Calendar.

Definition at line 343 of file calendarresources.cpp.

References KCal::Calendar::todos().

bool CalendarResources::addJournal Journal  )  [virtual]
 

Add a Journal entry to calendar.

Implements KCal::Calendar.

Definition at line 485 of file calendarresources.cpp.

References addIncidence().

void CalendarResources::deleteJournal Journal  )  [virtual]
 

Remove journal entry.

Implements KCal::Calendar.

Definition at line 492 of file calendarresources.cpp.

bool CalendarResources::addJournal Journal journal,
ResourceCalendar resource
 

Add Event to a resource.

Definition at line 509 of file calendarresources.cpp.

References KCal::ResourceCalendar::addJournal().

Journal * CalendarResources::journal const QDate  )  [virtual]
 

Return Journal for given date.

Implements KCal::Calendar.

Definition at line 525 of file calendarresources.cpp.

Referenced by journal().

Journal * CalendarResources::journal const QString UID  )  [virtual]
 

Return Journal with given UID.

Implements KCal::Calendar.

Definition at line 553 of file calendarresources.cpp.

References journal().

Journal::List CalendarResources::journals  )  [virtual]
 

Return list of all Journals stored in calendar.

Implements KCal::Calendar.

Definition at line 570 of file calendarresources.cpp.

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

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

Implements KCal::Calendar.

Definition at line 378 of file calendarresources.cpp.

Alarm::List CalendarResources::alarmsTo const QDateTime to  ) 
 

Return all alarms, which ocur before given date.

Definition at line 363 of file calendarresources.cpp.

ResourceCalendar * CalendarResources::resource Incidence  ) 
 

Return Resource for given uid.

Definition at line 608 of file calendarresources.cpp.

Referenced by addIncidence().

void CalendarResources::incidenceUpdated IncidenceBase  )  [protected]
 

The observer interface.

So far not implemented.

Definition at line 588 of file calendarresources.cpp.

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

Definition at line 399 of file calendarresources.cpp.

Event::List CalendarResources::rawEventsForDate const QDateTime qdt  )  [virtual]
 

Get unfiltered events for date qdt.

Implements KCal::Calendar.

Definition at line 449 of file calendarresources.cpp.

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

Definition at line 431 of file calendarresources.cpp.

void CalendarResources::doSetTimeZoneId const QString tzid  )  [protected, virtual]
 

let the subclasses of KCal::Calendar set the time zone

Reimplemented from KCal::Calendar.

Definition at line 645 of file calendarresources.cpp.


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.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu May 3 20:18:07 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003