libkcal Library API Documentation

KCal::ResourceLocal Class Reference

This class provides a calendar resource stored as a local file. More...

#include <resourcelocal.h>

Inheritance diagram for KCal::ResourceLocal:

KCal::ResourceCached KCal::ResourceCalendar List of all members.

Public Member Functions

 ResourceLocal (const KConfig *)
 ResourceLocal (const QString &fileName)
virtual void writeConfig (KConfig *config)
bool load ()
bool save ()
KABC::Lock * lock ()
void dump () const

Protected Slots

void reload ()

Protected Member Functions

bool doOpen ()
void doClose ()
virtual void update (IncidenceBase *incidence)
QDateTime readLastModified ()

Detailed Description

This class provides a calendar resource stored as a local file.

Definition at line 43 of file resourcelocal.h.


Constructor & Destructor Documentation

KCal::ResourceLocal::ResourceLocal const KConfig *   ) 
 

Create resource from configuration information stored in a KConfig object.

KCal::ResourceLocal::ResourceLocal const QString &  fileName  ) 
 

Create resource for file named fileName.


Member Function Documentation

bool KCal::ResourceLocal::load  )  [virtual]
 

Load resource data.

After calling this function all data is accessible by calling the incidence/event/todo/etc. accessor functions.

If data is actually loaded within this function or the loading is delayed until it is accessed by another function depends on the implementation of the resource.

If loading the data takes significant time, the resource should return cached values, if available and return the results via the resourceChanged signal. When the resource has finished loading the resourceLoaded() signal is emitted.

Calling this function multiple times should have the same effect as calling it once, given that the data isn't changed between calls.

Implements KCal::ResourceCalendar.

bool KCal::ResourceLocal::save  )  [virtual]
 

Save resource data.

After calling this function it is save to close the resource without losing data.

If data is actually saved within this function or saving is delayed depends on the implementation of the resource.

If saving the data takes significant time, the resource should return from the function, do the saving in the background and notify the end of the save by emitting the signal resourceSaved().

Implements KCal::ResourceCalendar.

KABC::Lock* KCal::ResourceLocal::lock  )  [virtual]
 

Return object for locking the resource.

Implements KCal::ResourceCalendar.

void KCal::ResourceLocal::doClose  )  [protected]
 

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

etc.

virtual void KCal::ResourceLocal::update IncidenceBase incidence  )  [protected, virtual]
 

This method should be called whenever a Event is modified directly via it's pointer.

It makes sure that the calendar is internally consistent.

Implements KCal::ResourceCalendar.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Mar 6 17:18:05 2004 by doxygen 1.3.6-20040222 written by Dimitri van Heesch, © 1997-2003