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 Member Functions

 ExchangeCalendar (KPIM::ExchangeAccount *account)
 constructs a new calendar, with variables initialized to sane values.

 ExchangeCalendar (KPIM::ExchangeAccount *account, const QString &timeZoneId)
 constructs a new calendar, with variables initialized to sane values.

bool load (const QString &fileName)
 Semantics not yet defined.

bool save (const QString &fileName, CalFormat *format=0)
 Writes out the calendar to disk in the specified format.

void close ()
 clears out the current calendar, freeing all used memory etc.

void addEvent (Event *anEvent)
 Add Event to calendar.

void deleteEvent (Event *)
 deletes an event from this calendar.

Event * event (const QString &UniqueStr)
 Retrieves an event on the basis of the unique string ID.

QPtrList< Event > rawEvents ()
 Return unfiltered list of all events in calendar.

QString getHolidayForDate (const QDate &qd)
int numEvents (const QDate &qd)
 returns the number of events that are present on the specified date.

void addTodo (Todo *todo)
 Add a todo to the todolist.

void deleteTodo (Todo *)
 Remove a todo from the todolist.

Todo * todo (const QString &uid)
 Searches todolist for an event with this unique string identifier, returns a pointer or null.

QPtrList< Todo > rawTodos () const
 Return list of all todos.

QPtrList< Todo > todos (const QDate &date)
 Returns list of todos due on the specified date.

QPtrList< Todo > todos ()
 Return list of all todos.

virtual void addJournal (Journal *)
 Add a Journal entry to calendar.

virtual Journal * journal (const QDate &)
 Return Journal for given date.

virtual Journal * journal (const QString &UID)
 Return Journal with given UID.

QPtrList< Journal > journals ()
 Return list of all Journals stored in calendar.

Alarm::List alarms (const QDateTime &from, const QDateTime &to)
 Return all alarms, which ocur in the given time interval.

Alarm::List alarmsTo (const QDateTime &to)
 Return all alarms, which ocur before given date.


Protected Member Functions

QPtrList< Event > rawEventsForDate (const QDate &date, bool sorted=false)
 Builds and then returns a list of all events that match for the date specified.

QPtrList< Event > rawEventsForDate (const QDateTime &qdt)
 Get unfiltered events for date qdt.

QPtrList< Event > rawEvents (const QDate &start, const QDate &end, bool inclusive=false)
 Get unfiltered events in a range of dates.

void update (IncidenceBase *incidence)
 this method should be called whenever a Event is modified directly via it's pointer.

void incidenceUpdated (IncidenceBase *i)
 Notification function of IncidenceBase::Observer.

void insertEvent (const Event *anEvent)
 inserts an event into its "proper place" in the calendar.


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 successfull, 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.

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.

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 266 of file exchangecalendar.cpp.

int ExchangeCalendar::numEvents const QDate qd  ) 
 

returns the number of events that are present on the specified date.

Definition at line 162 of file exchangecalendar.cpp.

void ExchangeCalendar::addTodo Todo *  todo  ) 
 

Add a todo to the todolist.

Definition at line 131 of file exchangecalendar.cpp.

void ExchangeCalendar::deleteTodo Todo *   ) 
 

Remove a todo from the todolist.

Definition at line 140 of file exchangecalendar.cpp.

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.

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 127 of file exchangecalendar.h.

void ExchangeCalendar::addJournal Journal *   )  [virtual]
 

Add a Journal entry to calendar.

Definition at line 272 of file exchangecalendar.cpp.

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

Return Journal for given date.

Definition at line 282 of file exchangecalendar.cpp.

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

Return Journal with given UID.

Definition at line 288 of file exchangecalendar.cpp.

QPtrList< Journal > ExchangeCalendar::journals  ) 
 

Return list of all Journals stored in calendar.

Definition at line 293 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 174 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 169 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 199 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 260 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 253 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 183 of file exchangecalendar.cpp.

Referenced by incidenceUpdated().

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

Notification function of IncidenceBase::Observer.

Definition at line 167 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 191 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 kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sat Oct 18 02:47:24 2003 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001