libkpimexchange Library API Documentation

KCal::ResourceExchange Class Reference

This class provides a calendar stored on a Microsoft Exchange 2000 server. More...

#include <resourceexchange.h>

List of all members.

Public Member Functions

 ResourceExchange (const KConfig *)
virtual void writeConfig (KConfig *config)
virtual bool load ()
virtual bool save ()
KABC::Lock * lock ()
bool addEvent (Event *anEvent)
void deleteEvent (Event *)
Event * event (const QString &UniqueStr)
Event::List rawEvents ()
QString getHolidayForDate (const QDate &qd)
virtual void subscribeEvents (const QDate &start, const QDate &end)
virtual void unsubscribeEvents (const QDate &start, const QDate &end)
bool addTodo (Todo *todo)
void deleteTodo (Todo *)
Todo * todo (const QString &uid)
Todo::List rawTodos ()
Todo::List todos (const QDate &date)
virtual bool addJournal (Journal *)
virtual void deleteJournal (Journal *)
virtual Journal * journal (const QDate &)
virtual Journal * journal (const QString &UID)
Journal::List journals ()
Alarm::List alarms (const QDateTime &from, const QDateTime &to)
Alarm::List alarmsTo (const QDateTime &to)

Protected Slots

void slotMonitorNotify (const QValueList< long > &IDs, const QValueList< KURL > &urls)
void slotMonitorError (int errorCode, const QString &moreInfo)
void slotDownloadFinished (int result, const QString &moreinfo)
void downloadedEvent (KCal::Event *, const KURL &)

Protected Member Functions

virtual bool doOpen ()
virtual void doClose ()
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)
void update (IncidenceBase *incidence)
void incidenceUpdated (IncidenceBase *i)
void uploadEvent (Event *event)
void setTimeZoneId (const QString &tzid)


Detailed Description

This class provides a calendar stored on a Microsoft Exchange 2000 server.

Definition at line 47 of file resourceexchange.h.


Member Function Documentation

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

Writes calendar to storage.

Writes calendar to disk file, writes updates to server, whatever.

bool KCal::ResourceExchange::addEvent Event *  anEvent  ) 
 

Add Event to calendar.

void KCal::ResourceExchange::deleteEvent Event *   ) 
 

deletes an event from this calendar.

Event* KCal::ResourceExchange::event const QString &  UniqueStr  ) 
 

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

Event::List KCal::ResourceExchange::rawEvents  ) 
 

Return unfiltered list of all events in calendar.

Use with care, since this causes a LOT of network activity

virtual void KCal::ResourceExchange::unsubscribeEvents const QDate &  start,
const QDate &  end
[virtual]
 

Stop receiving event signals for the given period (inclusive).

After this call, the calendar resource will no longer send eventsAdded, eventsModified or eventsDeleted signals for events falling completely in this period. The resource MAY delete the Events objects. The application MUST NOT dereference pointers to the relevant Events after this call.

bool KCal::ResourceExchange::addTodo Todo *  todo  ) 
 

Add a todo to the todolist.

void KCal::ResourceExchange::deleteTodo Todo *   ) 
 

Remove a todo from the todolist.

Todo* KCal::ResourceExchange::todo const QString &  uid  ) 
 

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

Todo::List KCal::ResourceExchange::rawTodos  ) 
 

Return list of all todos.

Todo::List KCal::ResourceExchange::todos const QDate &  date  ) 
 

Returns list of todos due on the specified date.

virtual bool KCal::ResourceExchange::addJournal Journal *   )  [virtual]
 

Add a Journal entry to calendar.

virtual void KCal::ResourceExchange::deleteJournal Journal *   )  [virtual]
 

deletes an event from this calendar.

virtual Journal* KCal::ResourceExchange::journal const QDate &   )  [virtual]
 

Return Journal for given date.

virtual Journal* KCal::ResourceExchange::journal const QString &  UID  )  [virtual]
 

Return Journal with given UID.

Journal::List KCal::ResourceExchange::journals  ) 
 

Return list of all Journals stored in calendar.

Alarm::List KCal::ResourceExchange::alarms const QDateTime &  from,
const QDateTime &  to
 

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

Alarm::List KCal::ResourceExchange::alarmsTo const QDateTime &  to  ) 
 

Return all alarms, which ocur before given date.

virtual bool KCal::ResourceExchange::doOpen  )  [protected, virtual]
 

Prepare the calendar for use.

Load the calendar from disk, open connections to the calendaring server, whatever. Must be called before other methods can be called.

virtual void KCal::ResourceExchange::doClose  )  [protected, virtual]
 

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

etc.

Event::List KCal::ResourceExchange::rawEventsForDate const QDate &  date,
bool  sorted = false
[protected]
 

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

useful for dayView, etc. etc.

Event::List KCal::ResourceExchange::rawEventsForDate const QDateTime &  qdt  )  [protected]
 

Get unfiltered events for date qdt.

Event::List KCal::ResourceExchange::rawEvents const QDate &  start,
const QDate &  end,
bool  inclusive = false
[protected]
 

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.

void KCal::ResourceExchange::update IncidenceBase *  incidence  )  [protected]
 

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

It makes sure that the calendar is internally consistent.

void KCal::ResourceExchange::incidenceUpdated IncidenceBase *  i  )  [inline, protected]
 

Notification function of IncidenceBase::Observer.

Definition at line 202 of file resourceexchange.h.

References incidenceUpdated().

Referenced by incidenceUpdated().

void KCal::ResourceExchange::uploadEvent Event *  event  )  [protected]
 

Append alarms of recurring events in interval to list of alarms.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for libkpimexchange Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jul 28 23:58:10 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003