libkpimexchange Library API Documentation

KCal::ExchangeCalendar Class Reference

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

#include <exchangecalendar.h>

List of all members.

Public Methods

 ExchangeCalendar (KPIM::ExchangeAccount *account)
 ExchangeCalendar (KPIM::ExchangeAccount *account, const QString &timeZoneId)
virtual ~ExchangeCalendar ()
bool load (const QString &fileName)
bool save (const QString &fileName, CalFormat *format=0)
void close ()
void addEvent (Event *anEvent)
void deleteEvent (Event *)
Event * event (const QString &UniqueStr)
QPtrList< Event > rawEvents ()
QString getHolidayForDate (const QDate &qd)
void addTodo (Todo *todo)
void deleteTodo (Todo *)
Todo * todo (const QString &uid)
QPtrList< Todo > rawTodos () const
QPtrList< Todo > todos (const QDate &date)
QPtrList< Todo > todos ()
virtual void addJournal (Journal *)
virtual Journal * journal (const QDate &)
virtual Journal * journal (const QString &UID)
QPtrList< Journal > journals ()
Alarm::List alarms (const QDateTime &from, const QDateTime &to)
Alarm::List alarmsTo (const QDateTime &to)

Protected Methods

QPtrList< Event > rawEventsForDate (const QDate &date, bool sorted=false)
QPtrList< Event > rawEventsForDate (const QDateTime &qdt)
QPtrList< Event > rawEvents (const QDate &start, const QDate &end, bool inclusive=false)
void update (IncidenceBase *incidence)
void incidenceUpdated (IncidenceBase *i)
void insertEvent (const Event *anEvent)


Detailed Description

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

Definition at line 45 of file exchangecalendar.h.


Constructor & Destructor Documentation

ExchangeCalendar::ExchangeCalendar KPIM::ExchangeAccount *    account
 

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

Definition at line 42 of file exchangecalendar.cpp.

ExchangeCalendar::ExchangeCalendar KPIM::ExchangeAccount *    account,
const QString   timeZoneId
 

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

Definition at line 49 of file exchangecalendar.cpp.


Member Function Documentation

bool ExchangeCalendar::load const QString   fileName
 

Semantics not yet defined.

Should the Exchange calendar be wiped clean? Should the disk calendar be copied to the Exchange calendar? At the moment, does nothing.

Returns:
true, if successful, false on error.
Parameters:
fileName  the name of the calendar on disk.

Definition at line 86 of file exchangecalendar.cpp.

bool ExchangeCalendar::save const QString   fileName,
CalFormat *    format = 0
 

Writes out the calendar to disk in the specified format.

ExchangeCalendar takes ownership of the CalFormat object.

Returns:
true, if successful, false on error.
Parameters:
fileName  the name of the file

Definition at line 92 of file exchangecalendar.cpp.

void ExchangeCalendar::close  
 

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

etc.

Definition at line 97 of file exchangecalendar.cpp.

void ExchangeCalendar::addEvent Event *    anEvent
 

Add Event to calendar.

Definition at line 104 of file exchangecalendar.cpp.

References insertEvent().

void ExchangeCalendar::deleteEvent Event *   
 

deletes an event from this calendar.

Definition at line 116 of file exchangecalendar.cpp.

References event().

Event * ExchangeCalendar::event const QString   UniqueStr
 

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

Definition at line 124 of file exchangecalendar.cpp.

Referenced by deleteEvent().

QPtrList< Event > ExchangeCalendar::rawEvents  
 

Return unfiltered list of all events in calendar.

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

Definition at line 259 of file exchangecalendar.cpp.

void ExchangeCalendar::addTodo Todo *    todo
 

Add a todo to the todolist.

Definition at line 131 of file exchangecalendar.cpp.

References todo().

void ExchangeCalendar::deleteTodo Todo *   
 

Remove a todo from the todolist.

Definition at line 140 of file exchangecalendar.cpp.

References todo().

Todo * ExchangeCalendar::todo const QString   uid
 

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

Definition at line 152 of file exchangecalendar.cpp.

Referenced by addTodo(), and deleteTodo().

QPtrList< Todo > ExchangeCalendar::rawTodos   const
 

Return list of all todos.

Definition at line 147 of file exchangecalendar.cpp.

QPtrList< Todo > ExchangeCalendar::todos const QDate   date
 

Returns list of todos due on the specified date.

Definition at line 157 of file exchangecalendar.cpp.

QPtrList<Todo> KCal::ExchangeCalendar::todos   [inline]
 

Return list of all todos.

Workaround because compiler does not recognize function of base class.

Definition at line 124 of file exchangecalendar.h.

void ExchangeCalendar::addJournal Journal *    [virtual]
 

Add a Journal entry to calendar.

Definition at line 265 of file exchangecalendar.cpp.

References journal().

Journal * ExchangeCalendar::journal const QDate   [virtual]
 

Return Journal for given date.

Definition at line 275 of file exchangecalendar.cpp.

Referenced by addJournal().

Journal * ExchangeCalendar::journal const QString   UID [virtual]
 

Return Journal with given UID.

Definition at line 281 of file exchangecalendar.cpp.

QPtrList< Journal > ExchangeCalendar::journals  
 

Return list of all Journals stored in calendar.

Definition at line 286 of file exchangecalendar.cpp.

Alarm::List ExchangeCalendar::alarms const QDateTime   from,
const QDateTime   to
 

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

Definition at line 167 of file exchangecalendar.cpp.

References QDateTime::toString().

Alarm::List ExchangeCalendar::alarmsTo const QDateTime   to
 

Return all alarms, which ocur before given date.

Definition at line 162 of file exchangecalendar.cpp.

QPtrList< Event > ExchangeCalendar::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.

Definition at line 192 of file exchangecalendar.cpp.

References QDate::addMonths(), QPtrList::count(), QDateTime::currentDateTime(), QMap< QDate, QDateTime >::insert(), QDate::month(), QDate::toString(), and QDate::year().

Referenced by rawEventsForDate().

QPtrList< Event > ExchangeCalendar::rawEventsForDate const QDateTime   qdt [protected]
 

Get unfiltered events for date qdt.

Definition at line 253 of file exchangecalendar.cpp.

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

QPtrList< Event > ExchangeCalendar::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.

Definition at line 246 of file exchangecalendar.cpp.

void ExchangeCalendar::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.

Definition at line 176 of file exchangecalendar.cpp.

Referenced by incidenceUpdated().

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

Notification function of IncidenceBase::Observer.

Definition at line 164 of file exchangecalendar.h.

References update().

void ExchangeCalendar::insertEvent const Event *    anEvent [protected]
 

inserts an event into its "proper place" in the calendar.

Definition at line 184 of file exchangecalendar.cpp.

Referenced by addEvent().


The documentation for this class was generated from the following files:
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 Sat May 1 11:38:10 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003