summaryrefslogtreecommitdiffabout
path: root/libkcal/calendar.h
Unidiff
Diffstat (limited to 'libkcal/calendar.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libkcal/calendar.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/libkcal/calendar.h b/libkcal/calendar.h
index 4a3223c..06a911c 100644
--- a/libkcal/calendar.h
+++ b/libkcal/calendar.h
@@ -1,350 +1,351 @@
1/* 1/*
2 This file is part of libkcal. 2 This file is part of libkcal.
3 Copyright (c) 1998 Preston Brown 3 Copyright (c) 1998 Preston Brown
4 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> 4 Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>
5 5
6 This library is free software; you can redistribute it and/or 6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public 7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either 8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version. 9 version 2 of the License, or (at your option) any later version.
10 10
11 This library is distributed in the hope that it will be useful, 11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of 12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details. 14 Library General Public License for more details.
15 15
16 You should have received a copy of the GNU Library General Public License 16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to 17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. 19 Boston, MA 02111-1307, USA.
20*/ 20*/
21 21
22#ifndef CALENDAR_H 22#ifndef CALENDAR_H
23#define CALENDAR_H 23#define CALENDAR_H
24 24
25#include <qobject.h> 25#include <qobject.h>
26#include <qstring.h> 26#include <qstring.h>
27#include <qdatetime.h> 27#include <qdatetime.h>
28#include <qptrlist.h> 28#include <qptrlist.h>
29#include <qdict.h> 29#include <qdict.h>
30 30
31#include "customproperties.h" 31#include "customproperties.h"
32#include "event.h" 32#include "event.h"
33#include "todo.h" 33#include "todo.h"
34#include "journal.h" 34#include "journal.h"
35 35
36#define _TIME_ZONE "-0500" /* hardcoded, overridden in config file. */ 36#define _TIME_ZONE "-0500" /* hardcoded, overridden in config file. */
37 37
38class KConfig; 38class KConfig;
39 39
40namespace KCal { 40namespace KCal {
41 41
42class CalFilter; 42class CalFilter;
43 43
44/** 44/**
45 This is the main "calendar" object class for KOrganizer. It holds 45 This is the main "calendar" object class for KOrganizer. It holds
46 information like all appointments/events, user information, etc. etc. 46 information like all appointments/events, user information, etc. etc.
47 one calendar is associated with each CalendarView (@see calendarview.h). 47 one calendar is associated with each CalendarView (@see calendarview.h).
48 This is an abstract base class defining the interface to a calendar. It is 48 This is an abstract base class defining the interface to a calendar. It is
49 implemented by subclasses like @see CalendarLocal, which use different 49 implemented by subclasses like @see CalendarLocal, which use different
50 methods to store and access the data. 50 methods to store and access the data.
51 51
52 Ownership of events etc. is handled by the following policy: As soon as an 52 Ownership of events etc. is handled by the following policy: As soon as an
53 event (or any other subclass of IncidenceBase) object is added to the 53 event (or any other subclass of IncidenceBase) object is added to the
54 Calendar by addEvent() it is owned by the Calendar object. The Calendar takes 54 Calendar by addEvent() it is owned by the Calendar object. The Calendar takes
55 care of deleting it. All Events returned by the query functions are returned 55 care of deleting it. All Events returned by the query functions are returned
56 as pointers, that means all changes to the returned events are immediately 56 as pointers, that means all changes to the returned events are immediately
57 visible in the Calendar. You shouldn't delete any Event object you get from 57 visible in the Calendar. You shouldn't delete any Event object you get from
58 Calendar. 58 Calendar.
59*/ 59*/
60class Calendar : public QObject, public CustomProperties, 60class Calendar : public QObject, public CustomProperties,
61 public IncidenceBase::Observer 61 public IncidenceBase::Observer
62{ 62{
63 Q_OBJECT 63 Q_OBJECT
64public: 64public:
65 Calendar(); 65 Calendar();
66 Calendar(const QString &timeZoneId); 66 Calendar(const QString &timeZoneId);
67 virtual ~Calendar(); 67 virtual ~Calendar();
68 void deleteIncidence(Incidence *in); 68 void deleteIncidence(Incidence *in);
69 void resetTempSyncStat();
69 /** 70 /**
70 Clears out the current calendar, freeing all used memory etc. 71 Clears out the current calendar, freeing all used memory etc.
71 */ 72 */
72 virtual void close() = 0; 73 virtual void close() = 0;
73 74
74 /** 75 /**
75 Sync changes in memory to persistant storage. 76 Sync changes in memory to persistant storage.
76 */ 77 */
77 virtual void save() = 0; 78 virtual void save() = 0;
78 virtual QPtrList<Event> getExternLastSyncEvents() = 0; 79 virtual QPtrList<Event> getExternLastSyncEvents() = 0;
79 virtual bool isSaving() { return false; } 80 virtual bool isSaving() { return false; }
80 81
81 /** 82 /**
82 Return the owner of the calendar's full name. 83 Return the owner of the calendar's full name.
83 */ 84 */
84 const QString &getOwner() const; 85 const QString &getOwner() const;
85 /** 86 /**
86 Set the owner of the calendar. Should be owner's full name. 87 Set the owner of the calendar. Should be owner's full name.
87 */ 88 */
88 void setOwner( const QString &os ); 89 void setOwner( const QString &os );
89 /** 90 /**
90 Return the email address of the calendar owner. 91 Return the email address of the calendar owner.
91 */ 92 */
92 const QString &getEmail(); 93 const QString &getEmail();
93 /** 94 /**
94 Set the email address of the calendar owner. 95 Set the email address of the calendar owner.
95 */ 96 */
96 void setEmail( const QString & ); 97 void setEmail( const QString & );
97 98
98 /** 99 /**
99 Set time zone from a timezone string (e.g. -2:00) 100 Set time zone from a timezone string (e.g. -2:00)
100 */ 101 */
101 void setTimeZone( const QString &tz ); 102 void setTimeZone( const QString &tz );
102 /** 103 /**
103 Set time zone from a minutes value (e.g. -60) 104 Set time zone from a minutes value (e.g. -60)
104 */ 105 */
105 void setTimeZone( int tz ); 106 void setTimeZone( int tz );
106 /** 107 /**
107 Return time zone as offest in minutes. 108 Return time zone as offest in minutes.
108 */ 109 */
109 int getTimeZone() const; 110 int getTimeZone() const;
110 /** 111 /**
111 Compute an ISO 8601 format string from the time zone. 112 Compute an ISO 8601 format string from the time zone.
112 */ 113 */
113 QString getTimeZoneStr() const; 114 QString getTimeZoneStr() const;
114 /** 115 /**
115 Set time zone id (see /usr/share/zoneinfo/zone.tab for list of legal 116 Set time zone id (see /usr/share/zoneinfo/zone.tab for list of legal
116 values). 117 values).
117 */ 118 */
118 void setTimeZoneId( const QString & ); 119 void setTimeZoneId( const QString & );
119 /** 120 /**
120 Return time zone id. 121 Return time zone id.
121 */ 122 */
122 QString timeZoneId() const; 123 QString timeZoneId() const;
123 /** 124 /**
124 Use local time, not UTC or a time zone. 125 Use local time, not UTC or a time zone.
125 */ 126 */
126 void setLocalTime(); 127 void setLocalTime();
127 /** 128 /**
128 Return whether local time is being used. 129 Return whether local time is being used.
129 */ 130 */
130 bool isLocalTime() const; 131 bool isLocalTime() const;
131 132
132 /** 133 /**
133 Add an incidence to calendar. 134 Add an incidence to calendar.
134 135
135 @return true on success, false on error. 136 @return true on success, false on error.
136 */ 137 */
137 virtual bool addIncidence( Incidence * ); 138 virtual bool addIncidence( Incidence * );
138 /** 139 /**
139 Return filtered list of all incidences of this calendar. 140 Return filtered list of all incidences of this calendar.
140 */ 141 */
141 virtual QPtrList<Incidence> incidences(); 142 virtual QPtrList<Incidence> incidences();
142 143
143 /** 144 /**
144 Return unfiltered list of all incidences of this calendar. 145 Return unfiltered list of all incidences of this calendar.
145 */ 146 */
146 virtual QPtrList<Incidence> rawIncidences(); 147 virtual QPtrList<Incidence> rawIncidences();
147 148
148 /** 149 /**
149 Adds a Event to this calendar object. 150 Adds a Event to this calendar object.
150 @param anEvent a pointer to the event to add 151 @param anEvent a pointer to the event to add
151 152
152 @return true on success, false on error. 153 @return true on success, false on error.
153 */ 154 */
154 virtual bool addEventNoDup( Event *event ) = 0; 155 virtual bool addEventNoDup( Event *event ) = 0;
155 virtual bool addAnniversaryNoDup( Event *event ) = 0; 156 virtual bool addAnniversaryNoDup( Event *event ) = 0;
156 virtual bool addEvent( Event *anEvent ) = 0; 157 virtual bool addEvent( Event *anEvent ) = 0;
157 /** 158 /**
158 Delete event from calendar. 159 Delete event from calendar.
159 */ 160 */
160 virtual void deleteEvent( Event * ) = 0; 161 virtual void deleteEvent( Event * ) = 0;
161 /** 162 /**
162 Retrieves an event on the basis of the unique string ID. 163 Retrieves an event on the basis of the unique string ID.
163 */ 164 */
164 virtual Event *event( const QString &UniqueStr ) = 0; 165 virtual Event *event( const QString &UniqueStr ) = 0;
165 virtual Event *event( QString, QString ) = 0; 166 virtual Event *event( QString, QString ) = 0;
166 /** 167 /**
167 Builds and then returns a list of all events that match for the 168 Builds and then returns a list of all events that match for the
168 date specified. useful for dayView, etc. etc. 169 date specified. useful for dayView, etc. etc.
169 The calendar filter is applied. 170 The calendar filter is applied.
170 */ 171 */
171 QPtrList<Event> events( const QDate &date, bool sorted = false); 172 QPtrList<Event> events( const QDate &date, bool sorted = false);
172 /** 173 /**
173 Get events, which occur on the given date. 174 Get events, which occur on the given date.
174 The calendar filter is applied. 175 The calendar filter is applied.
175 */ 176 */
176 QPtrList<Event> events( const QDateTime &qdt ); 177 QPtrList<Event> events( const QDateTime &qdt );
177 /** 178 /**
178 Get events in a range of dates. If inclusive is set to true, only events 179 Get events in a range of dates. If inclusive is set to true, only events
179 are returned, which are completely included in the range. 180 are returned, which are completely included in the range.
180 The calendar filter is applied. 181 The calendar filter is applied.
181 */ 182 */
182 QPtrList<Event> events( const QDate &start, const QDate &end, 183 QPtrList<Event> events( const QDate &start, const QDate &end,
183 bool inclusive = false); 184 bool inclusive = false);
184 /** 185 /**
185 Return filtered list of all events in calendar. 186 Return filtered list of all events in calendar.
186 */ 187 */
187 virtual QPtrList<Event> events(); 188 virtual QPtrList<Event> events();
188 /** 189 /**
189 Return unfiltered list of all events in calendar. 190 Return unfiltered list of all events in calendar.
190 */ 191 */
191 virtual QPtrList<Event> rawEvents() = 0; 192 virtual QPtrList<Event> rawEvents() = 0;
192 193
193 /** 194 /**
194 Add a todo to the todolist. 195 Add a todo to the todolist.
195 196
196 @return true on success, false on error. 197 @return true on success, false on error.
197 */ 198 */
198 virtual bool addTodo( Todo *todo ) = 0; 199 virtual bool addTodo( Todo *todo ) = 0;
199 virtual bool addTodoNoDup( Todo *todo ) = 0; 200 virtual bool addTodoNoDup( Todo *todo ) = 0;
200 /** 201 /**
201 Remove a todo from the todolist. 202 Remove a todo from the todolist.
202 */ 203 */
203 virtual void deleteTodo( Todo * ) = 0; 204 virtual void deleteTodo( Todo * ) = 0;
204 virtual void deleteJournal( Journal * ) = 0; 205 virtual void deleteJournal( Journal * ) = 0;
205 /** 206 /**
206 Return filterd list of todos. 207 Return filterd list of todos.
207 */ 208 */
208 virtual QPtrList<Todo> todos(); 209 virtual QPtrList<Todo> todos();
209 /** 210 /**
210 Searches todolist for an event with this unique string identifier, 211 Searches todolist for an event with this unique string identifier,
211 returns a pointer or null. 212 returns a pointer or null.
212 */ 213 */
213 virtual Todo *todo( const QString &uid ) = 0; 214 virtual Todo *todo( const QString &uid ) = 0;
214 virtual Todo *todo( QString, QString ) = 0; 215 virtual Todo *todo( QString, QString ) = 0;
215 /** 216 /**
216 Returns list of todos due on the specified date. 217 Returns list of todos due on the specified date.
217 */ 218 */
218 virtual QPtrList<Todo> todos( const QDate &date ) = 0; 219 virtual QPtrList<Todo> todos( const QDate &date ) = 0;
219 /** 220 /**
220 Return unfiltered list of todos. 221 Return unfiltered list of todos.
221 */ 222 */
222 virtual QPtrList<Todo> rawTodos() = 0; 223 virtual QPtrList<Todo> rawTodos() = 0;
223 224
224 /** 225 /**
225 Add a Journal entry to calendar. 226 Add a Journal entry to calendar.
226 227
227 @return true on success, false on error. 228 @return true on success, false on error.
228 */ 229 */
229 virtual bool addJournal( Journal * ) = 0; 230 virtual bool addJournal( Journal * ) = 0;
230 /** 231 /**
231 Return Journal for given date. 232 Return Journal for given date.
232 */ 233 */
233 virtual Journal *journal( const QDate & ) = 0; 234 virtual Journal *journal( const QDate & ) = 0;
234 /** 235 /**
235 Return Journal with given UID. 236 Return Journal with given UID.
236 */ 237 */
237 virtual Journal *journal( const QString &UID ) = 0; 238 virtual Journal *journal( const QString &UID ) = 0;
238 /** 239 /**
239 Return list of all Journal entries. 240 Return list of all Journal entries.
240 */ 241 */
241 virtual QPtrList<Journal> journals() = 0; 242 virtual QPtrList<Journal> journals() = 0;
242 243
243 /** 244 /**
244 Searches all incidence types for an incidence with this unique 245 Searches all incidence types for an incidence with this unique
245 string identifier, returns a pointer or null. 246 string identifier, returns a pointer or null.
246 */ 247 */
247 Incidence* incidence( const QString&UID ); 248 Incidence* incidence( const QString&UID );
248 249
249 /** 250 /**
250 Setup relations for an incidence. 251 Setup relations for an incidence.
251 */ 252 */
252 virtual void setupRelations( Incidence * ); 253 virtual void setupRelations( Incidence * );
253 /** 254 /**
254 Remove all relations to an incidence 255 Remove all relations to an incidence
255 */ 256 */
256 virtual void removeRelations( Incidence * ); 257 virtual void removeRelations( Incidence * );
257 258
258 /** 259 /**
259 Set calendar filter, which filters events for the events() functions. 260 Set calendar filter, which filters events for the events() functions.
260 The Filter object is owned by the caller. 261 The Filter object is owned by the caller.
261 */ 262 */
262 void setFilter( CalFilter * ); 263 void setFilter( CalFilter * );
263 /** 264 /**
264 Return calendar filter. 265 Return calendar filter.
265 */ 266 */
266 CalFilter *filter(); 267 CalFilter *filter();
267 virtual QDateTime nextAlarm( int daysTo ) = 0; 268 virtual QDateTime nextAlarm( int daysTo ) = 0;
268 virtual QString nextSummary( ) const = 0; 269 virtual QString nextSummary( ) const = 0;
269 virtual void reInitAlarmSettings() = 0; 270 virtual void reInitAlarmSettings() = 0;
270 virtual QDateTime nextAlarmEventDateTime() const = 0; 271 virtual QDateTime nextAlarmEventDateTime() const = 0;
271 virtual void checkAlarmForIncidence( Incidence *, bool ) = 0; 272 virtual void checkAlarmForIncidence( Incidence *, bool ) = 0;
272 /** 273 /**
273 Return all alarms, which ocur in the given time interval. 274 Return all alarms, which ocur in the given time interval.
274 */ 275 */
275 virtual Alarm::List alarms( const QDateTime &from, 276 virtual Alarm::List alarms( const QDateTime &from,
276 const QDateTime &to ) = 0; 277 const QDateTime &to ) = 0;
277 278
278 class Observer { 279 class Observer {
279 public: 280 public:
280 virtual void calendarModified( bool, Calendar * ) = 0; 281 virtual void calendarModified( bool, Calendar * ) = 0;
281 }; 282 };
282 283
283 void registerObserver( Observer * ); 284 void registerObserver( Observer * );
284 285
285 void setModified( bool ); 286 void setModified( bool );
286 287
287 /** 288 /**
288 Set product id returned by loadedProductId(). This function is only 289 Set product id returned by loadedProductId(). This function is only
289 useful for the calendar loading code. 290 useful for the calendar loading code.
290 */ 291 */
291 void setLoadedProductId( const QString & ); 292 void setLoadedProductId( const QString & );
292 /** 293 /**
293 Return product id taken from file that has been loaded. Returns 294 Return product id taken from file that has been loaded. Returns
294 QString::null, if no calendar has been loaded. 295 QString::null, if no calendar has been loaded.
295 */ 296 */
296 QString loadedProductId(); 297 QString loadedProductId();
297 298
298 signals: 299 signals:
299 void calendarChanged(); 300 void calendarChanged();
300 void calendarSaved(); 301 void calendarSaved();
301 void calendarLoaded(); 302 void calendarLoaded();
302 void addAlarm(const QDateTime &qdt, const QString &noti ); 303 void addAlarm(const QDateTime &qdt, const QString &noti );
303 void removeAlarm(const QDateTime &qdt, const QString &noti ); 304 void removeAlarm(const QDateTime &qdt, const QString &noti );
304 305
305 protected: 306 protected:
306 /** 307 /**
307 Get unfiltered events, which occur on the given date. 308 Get unfiltered events, which occur on the given date.
308 */ 309 */
309 virtual QPtrList<Event> rawEventsForDate( const QDateTime &qdt ) = 0; 310 virtual QPtrList<Event> rawEventsForDate( const QDateTime &qdt ) = 0;
310 /** 311 /**
311 Get unfiltered events, which occur on the given date. 312 Get unfiltered events, which occur on the given date.
312 */ 313 */
313 virtual QPtrList<Event> rawEventsForDate( const QDate &date, 314 virtual QPtrList<Event> rawEventsForDate( const QDate &date,
314 bool sorted = false ) = 0; 315 bool sorted = false ) = 0;
315 /** 316 /**
316 Get events in a range of dates. If inclusive is set to true, only events 317 Get events in a range of dates. If inclusive is set to true, only events
317 are returned, which are completely included in the range. 318 are returned, which are completely included in the range.
318 */ 319 */
319 virtual QPtrList<Event> rawEvents( const QDate &start, const QDate &end, 320 virtual QPtrList<Event> rawEvents( const QDate &start, const QDate &end,
320 bool inclusive = false ) = 0; 321 bool inclusive = false ) = 0;
321 Incidence *mNextAlarmIncidence; 322 Incidence *mNextAlarmIncidence;
322 323
323private: 324private:
324 void init(); 325 void init();
325 326
326 QString mOwner; // who the calendar belongs to 327 QString mOwner; // who the calendar belongs to
327 QString mOwnerEmail; // email address of the owner 328 QString mOwnerEmail; // email address of the owner
328 int mTimeZone; // timezone OFFSET from GMT (MINUTES) 329 int mTimeZone; // timezone OFFSET from GMT (MINUTES)
329 bool mLocalTime; // use local time, not UTC or a time zone 330 bool mLocalTime; // use local time, not UTC or a time zone
330 331
331 CalFilter *mFilter; 332 CalFilter *mFilter;
332 CalFilter *mDefaultFilter; 333 CalFilter *mDefaultFilter;
333 334
334 QString mTimeZoneId; 335 QString mTimeZoneId;
335 336
336 Observer *mObserver; 337 Observer *mObserver;
337 bool mNewObserver; 338 bool mNewObserver;
338 339
339 bool mModified; 340 bool mModified;
340 341
341 QString mLoadedProductId; 342 QString mLoadedProductId;
342 343
343 // This list is used to put together related todos 344 // This list is used to put together related todos
344 QDict<Incidence> mOrphans; 345 QDict<Incidence> mOrphans;
345 QDict<Incidence> mOrphanUids; 346 QDict<Incidence> mOrphanUids;
346}; 347};
347 348
348} 349}
349 350
350#endif 351#endif