summaryrefslogtreecommitdiffabout
path: root/libkcal/calendar.h
authorzautrix <zautrix>2004-10-17 18:08:43 (UTC)
committer zautrix <zautrix>2004-10-17 18:08:43 (UTC)
commit6f6d1d58938539215bb4fcb5b97cf9fb089a11ef (patch) (unidiff)
tree9937fe24c3fa3f29421b39a58b393e893a11636a /libkcal/calendar.h
parentd92f58ffa1937af8a4240b9d235da15f5f352769 (diff)
downloadkdepimpi-6f6d1d58938539215bb4fcb5b97cf9fb089a11ef.zip
kdepimpi-6f6d1d58938539215bb4fcb5b97cf9fb089a11ef.tar.gz
kdepimpi-6f6d1d58938539215bb4fcb5b97cf9fb089a11ef.tar.bz2
more KDE sync fixes
Diffstat (limited to 'libkcal/calendar.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libkcal/calendar.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/libkcal/calendar.h b/libkcal/calendar.h
index d5294eb..b801186 100644
--- a/libkcal/calendar.h
+++ b/libkcal/calendar.h
@@ -1,352 +1,352 @@
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#include "calfilter.h" 35#include "calfilter.h"
36 36
37//#define _TIME_ZONE "-0500" /* hardcoded, overridden in config file. */ 37//#define _TIME_ZONE "-0500" /* hardcoded, overridden in config file. */
38 38
39class KConfig; 39class KConfig;
40 40
41namespace KCal { 41namespace KCal {
42 42
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 void resetTempSyncStat();
70 void resetPilotStat(); 70 void resetPilotStat(int id);
71 /** 71 /**
72 Clears out the current calendar, freeing all used memory etc. 72 Clears out the current calendar, freeing all used memory etc.
73 */ 73 */
74 virtual void close() = 0; 74 virtual void close() = 0;
75 75
76 /** 76 /**
77 Sync changes in memory to persistant storage. 77 Sync changes in memory to persistant storage.
78 */ 78 */
79 virtual void save() = 0; 79 virtual void save() = 0;
80 virtual QPtrList<Event> getExternLastSyncEvents() = 0; 80 virtual QPtrList<Event> getExternLastSyncEvents() = 0;
81 virtual bool isSaving() { return false; } 81 virtual bool isSaving() { return false; }
82 82
83 /** 83 /**
84 Return the owner of the calendar's full name. 84 Return the owner of the calendar's full name.
85 */ 85 */
86 const QString &getOwner() const; 86 const QString &getOwner() const;
87 /** 87 /**
88 Set the owner of the calendar. Should be owner's full name. 88 Set the owner of the calendar. Should be owner's full name.
89 */ 89 */
90 void setOwner( const QString &os ); 90 void setOwner( const QString &os );
91 /** 91 /**
92 Return the email address of the calendar owner. 92 Return the email address of the calendar owner.
93 */ 93 */
94 const QString &getEmail(); 94 const QString &getEmail();
95 /** 95 /**
96 Set the email address of the calendar owner. 96 Set the email address of the calendar owner.
97 */ 97 */
98 void setEmail( const QString & ); 98 void setEmail( const QString & );
99 99
100 /** 100 /**
101 Set time zone from a timezone string (e.g. -2:00) 101 Set time zone from a timezone string (e.g. -2:00)
102 */ 102 */
103 void setTimeZone( const QString &tz ); 103 void setTimeZone( const QString &tz );
104 /** 104 /**
105 Set time zone from a minutes value (e.g. -60) 105 Set time zone from a minutes value (e.g. -60)
106 */ 106 */
107 void setTimeZone( int tz ); 107 void setTimeZone( int tz );
108 /** 108 /**
109 Return time zone as offest in minutes. 109 Return time zone as offest in minutes.
110 */ 110 */
111 int getTimeZone() const; 111 int getTimeZone() const;
112 /** 112 /**
113 Compute an ISO 8601 format string from the time zone. 113 Compute an ISO 8601 format string from the time zone.
114 */ 114 */
115 QString getTimeZoneStr() const; 115 QString getTimeZoneStr() const;
116 /** 116 /**
117 Set time zone id (see /usr/share/zoneinfo/zone.tab for list of legal 117 Set time zone id (see /usr/share/zoneinfo/zone.tab for list of legal
118 values). 118 values).
119 */ 119 */
120 void setTimeZoneId( const QString & ); 120 void setTimeZoneId( const QString & );
121 /** 121 /**
122 Return time zone id. 122 Return time zone id.
123 */ 123 */
124 QString timeZoneId() const; 124 QString timeZoneId() const;
125 /** 125 /**
126 Use local time, not UTC or a time zone. 126 Use local time, not UTC or a time zone.
127 */ 127 */
128 void setLocalTime(); 128 void setLocalTime();
129 /** 129 /**
130 Return whether local time is being used. 130 Return whether local time is being used.
131 */ 131 */
132 bool isLocalTime() const; 132 bool isLocalTime() const;
133 133
134 /** 134 /**
135 Add an incidence to calendar. 135 Add an incidence to calendar.
136 136
137 @return true on success, false on error. 137 @return true on success, false on error.
138 */ 138 */
139 virtual bool addIncidence( Incidence * ); 139 virtual bool addIncidence( Incidence * );
140 /** 140 /**
141 Return filtered list of all incidences of this calendar. 141 Return filtered list of all incidences of this calendar.
142 */ 142 */
143 virtual QPtrList<Incidence> incidences(); 143 virtual QPtrList<Incidence> incidences();
144 144
145 /** 145 /**
146 Return unfiltered list of all incidences of this calendar. 146 Return unfiltered list of all incidences of this calendar.
147 */ 147 */
148 virtual QPtrList<Incidence> rawIncidences(); 148 virtual QPtrList<Incidence> rawIncidences();
149 149
150 /** 150 /**
151 Adds a Event to this calendar object. 151 Adds a Event to this calendar object.
152 @param anEvent a pointer to the event to add 152 @param anEvent a pointer to the event to add
153 153
154 @return true on success, false on error. 154 @return true on success, false on error.
155 */ 155 */
156 virtual bool addEventNoDup( Event *event ) = 0; 156 virtual bool addEventNoDup( Event *event ) = 0;
157 virtual bool addAnniversaryNoDup( Event *event ) = 0; 157 virtual bool addAnniversaryNoDup( Event *event ) = 0;
158 virtual bool addEvent( Event *anEvent ) = 0; 158 virtual bool addEvent( Event *anEvent ) = 0;
159 /** 159 /**
160 Delete event from calendar. 160 Delete event from calendar.
161 */ 161 */
162 virtual void deleteEvent( Event * ) = 0; 162 virtual void deleteEvent( Event * ) = 0;
163 /** 163 /**
164 Retrieves an event on the basis of the unique string ID. 164 Retrieves an event on the basis of the unique string ID.
165 */ 165 */
166 virtual Event *event( const QString &UniqueStr ) = 0; 166 virtual Event *event( const QString &UniqueStr ) = 0;
167 virtual Event *event( QString, QString ) = 0; 167 virtual Event *event( QString, QString ) = 0;
168 /** 168 /**
169 Builds and then returns a list of all events that match for the 169 Builds and then returns a list of all events that match for the
170 date specified. useful for dayView, etc. etc. 170 date specified. useful for dayView, etc. etc.
171 The calendar filter is applied. 171 The calendar filter is applied.
172 */ 172 */
173 QPtrList<Event> events( const QDate &date, bool sorted = false); 173 QPtrList<Event> events( const QDate &date, bool sorted = false);
174 /** 174 /**
175 Get events, which occur on the given date. 175 Get events, which occur on the given date.
176 The calendar filter is applied. 176 The calendar filter is applied.
177 */ 177 */
178 QPtrList<Event> events( const QDateTime &qdt ); 178 QPtrList<Event> events( const QDateTime &qdt );
179 /** 179 /**
180 Get events in a range of dates. If inclusive is set to true, only events 180 Get events in a range of dates. If inclusive is set to true, only events
181 are returned, which are completely included in the range. 181 are returned, which are completely included in the range.
182 The calendar filter is applied. 182 The calendar filter is applied.
183 */ 183 */
184 QPtrList<Event> events( const QDate &start, const QDate &end, 184 QPtrList<Event> events( const QDate &start, const QDate &end,
185 bool inclusive = false); 185 bool inclusive = false);
186 /** 186 /**
187 Return filtered list of all events in calendar. 187 Return filtered list of all events in calendar.
188 */ 188 */
189 virtual QPtrList<Event> events(); 189 virtual QPtrList<Event> events();
190 /** 190 /**
191 Return unfiltered list of all events in calendar. 191 Return unfiltered list of all events in calendar.
192 */ 192 */
193 virtual QPtrList<Event> rawEvents() = 0; 193 virtual QPtrList<Event> rawEvents() = 0;
194 194
195 /** 195 /**
196 Add a todo to the todolist. 196 Add a todo to the todolist.
197 197
198 @return true on success, false on error. 198 @return true on success, false on error.
199 */ 199 */
200 virtual bool addTodo( Todo *todo ) = 0; 200 virtual bool addTodo( Todo *todo ) = 0;
201 virtual bool addTodoNoDup( Todo *todo ) = 0; 201 virtual bool addTodoNoDup( Todo *todo ) = 0;
202 /** 202 /**
203 Remove a todo from the todolist. 203 Remove a todo from the todolist.
204 */ 204 */
205 virtual void deleteTodo( Todo * ) = 0; 205 virtual void deleteTodo( Todo * ) = 0;
206 virtual void deleteJournal( Journal * ) = 0; 206 virtual void deleteJournal( Journal * ) = 0;
207 /** 207 /**
208 Return filterd list of todos. 208 Return filterd list of todos.
209 */ 209 */
210 virtual QPtrList<Todo> todos(); 210 virtual QPtrList<Todo> todos();
211 /** 211 /**
212 Searches todolist for an event with this unique string identifier, 212 Searches todolist for an event with this unique string identifier,
213 returns a pointer or null. 213 returns a pointer or null.
214 */ 214 */
215 virtual Todo *todo( const QString &uid ) = 0; 215 virtual Todo *todo( const QString &uid ) = 0;
216 virtual Todo *todo( QString, QString ) = 0; 216 virtual Todo *todo( QString, QString ) = 0;
217 /** 217 /**
218 Returns list of todos due on the specified date. 218 Returns list of todos due on the specified date.
219 */ 219 */
220 virtual QPtrList<Todo> todos( const QDate &date ) = 0; 220 virtual QPtrList<Todo> todos( const QDate &date ) = 0;
221 /** 221 /**
222 Return unfiltered list of todos. 222 Return unfiltered list of todos.
223 */ 223 */
224 virtual QPtrList<Todo> rawTodos() = 0; 224 virtual QPtrList<Todo> rawTodos() = 0;
225 225
226 /** 226 /**
227 Add a Journal entry to calendar. 227 Add a Journal entry to calendar.
228 228
229 @return true on success, false on error. 229 @return true on success, false on error.
230 */ 230 */
231 virtual bool addJournal( Journal * ) = 0; 231 virtual bool addJournal( Journal * ) = 0;
232 /** 232 /**
233 Return Journal for given date. 233 Return Journal for given date.
234 */ 234 */
235 virtual Journal *journal( const QDate & ) = 0; 235 virtual Journal *journal( const QDate & ) = 0;
236 /** 236 /**
237 Return Journal with given UID. 237 Return Journal with given UID.
238 */ 238 */
239 virtual Journal *journal( const QString &UID ) = 0; 239 virtual Journal *journal( const QString &UID ) = 0;
240 /** 240 /**
241 Return list of all Journal entries. 241 Return list of all Journal entries.
242 */ 242 */
243 virtual QPtrList<Journal> journals() = 0; 243 virtual QPtrList<Journal> journals() = 0;
244 244
245 /** 245 /**
246 Searches all incidence types for an incidence with this unique 246 Searches all incidence types for an incidence with this unique
247 string identifier, returns a pointer or null. 247 string identifier, returns a pointer or null.
248 */ 248 */
249 Incidence* incidence( const QString&UID ); 249 Incidence* incidence( const QString&UID );
250 250
251 /** 251 /**
252 Setup relations for an incidence. 252 Setup relations for an incidence.
253 */ 253 */
254 virtual void setupRelations( Incidence * ); 254 virtual void setupRelations( Incidence * );
255 /** 255 /**
256 Remove all relations to an incidence 256 Remove all relations to an incidence
257 */ 257 */
258 virtual void removeRelations( Incidence * ); 258 virtual void removeRelations( Incidence * );
259 259
260 /** 260 /**
261 Set calendar filter, which filters events for the events() functions. 261 Set calendar filter, which filters events for the events() functions.
262 The Filter object is owned by the caller. 262 The Filter object is owned by the caller.
263 */ 263 */
264 void setFilter( CalFilter * ); 264 void setFilter( CalFilter * );
265 /** 265 /**
266 Return calendar filter. 266 Return calendar filter.
267 */ 267 */
268 CalFilter *filter(); 268 CalFilter *filter();
269 virtual QDateTime nextAlarm( int daysTo ) = 0; 269 virtual QDateTime nextAlarm( int daysTo ) = 0;
270 virtual QString nextSummary( ) const = 0; 270 virtual QString nextSummary( ) const = 0;
271 virtual void reInitAlarmSettings() = 0; 271 virtual void reInitAlarmSettings() = 0;
272 virtual QDateTime nextAlarmEventDateTime() const = 0; 272 virtual QDateTime nextAlarmEventDateTime() const = 0;
273 virtual void checkAlarmForIncidence( Incidence *, bool ) = 0; 273 virtual void checkAlarmForIncidence( Incidence *, bool ) = 0;
274 /** 274 /**
275 Return all alarms, which ocur in the given time interval. 275 Return all alarms, which ocur in the given time interval.
276 */ 276 */
277 virtual Alarm::List alarms( const QDateTime &from, 277 virtual Alarm::List alarms( const QDateTime &from,
278 const QDateTime &to ) = 0; 278 const QDateTime &to ) = 0;
279 279
280 class Observer { 280 class Observer {
281 public: 281 public:
282 virtual void calendarModified( bool, Calendar * ) = 0; 282 virtual void calendarModified( bool, Calendar * ) = 0;
283 }; 283 };
284 284
285 void registerObserver( Observer * ); 285 void registerObserver( Observer * );
286 286
287 void setModified( bool ); 287 void setModified( bool );
288 288
289 /** 289 /**
290 Set product id returned by loadedProductId(). This function is only 290 Set product id returned by loadedProductId(). This function is only
291 useful for the calendar loading code. 291 useful for the calendar loading code.
292 */ 292 */
293 void setLoadedProductId( const QString & ); 293 void setLoadedProductId( const QString & );
294 /** 294 /**
295 Return product id taken from file that has been loaded. Returns 295 Return product id taken from file that has been loaded. Returns
296 QString::null, if no calendar has been loaded. 296 QString::null, if no calendar has been loaded.
297 */ 297 */
298 QString loadedProductId(); 298 QString loadedProductId();
299 299
300 signals: 300 signals:
301 void calendarChanged(); 301 void calendarChanged();
302 void calendarSaved(); 302 void calendarSaved();
303 void calendarLoaded(); 303 void calendarLoaded();
304 void addAlarm(const QDateTime &qdt, const QString &noti ); 304 void addAlarm(const QDateTime &qdt, const QString &noti );
305 void removeAlarm(const QDateTime &qdt, const QString &noti ); 305 void removeAlarm(const QDateTime &qdt, const QString &noti );
306 306
307 protected: 307 protected:
308 /** 308 /**
309 Get unfiltered events, which occur on the given date. 309 Get unfiltered events, which occur on the given date.
310 */ 310 */
311 virtual QPtrList<Event> rawEventsForDate( const QDateTime &qdt ) = 0; 311 virtual QPtrList<Event> rawEventsForDate( const QDateTime &qdt ) = 0;
312 /** 312 /**
313 Get unfiltered events, which occur on the given date. 313 Get unfiltered events, which occur on the given date.
314 */ 314 */
315 virtual QPtrList<Event> rawEventsForDate( const QDate &date, 315 virtual QPtrList<Event> rawEventsForDate( const QDate &date,
316 bool sorted = false ) = 0; 316 bool sorted = false ) = 0;
317 /** 317 /**
318 Get events in a range of dates. If inclusive is set to true, only events 318 Get events in a range of dates. If inclusive is set to true, only events
319 are returned, which are completely included in the range. 319 are returned, which are completely included in the range.
320 */ 320 */
321 virtual QPtrList<Event> rawEvents( const QDate &start, const QDate &end, 321 virtual QPtrList<Event> rawEvents( const QDate &start, const QDate &end,
322 bool inclusive = false ) = 0; 322 bool inclusive = false ) = 0;
323 Incidence *mNextAlarmIncidence; 323 Incidence *mNextAlarmIncidence;
324 324
325private: 325private:
326 void init(); 326 void init();
327 327
328 QString mOwner; // who the calendar belongs to 328 QString mOwner; // who the calendar belongs to
329 QString mOwnerEmail; // email address of the owner 329 QString mOwnerEmail; // email address of the owner
330 int mTimeZone; // timezone OFFSET from GMT (MINUTES) 330 int mTimeZone; // timezone OFFSET from GMT (MINUTES)
331 bool mLocalTime; // use local time, not UTC or a time zone 331 bool mLocalTime; // use local time, not UTC or a time zone
332 332
333 CalFilter *mFilter; 333 CalFilter *mFilter;
334 CalFilter *mDefaultFilter; 334 CalFilter *mDefaultFilter;
335 335
336 QString mTimeZoneId; 336 QString mTimeZoneId;
337 337
338 Observer *mObserver; 338 Observer *mObserver;
339 bool mNewObserver; 339 bool mNewObserver;
340 340
341 bool mModified; 341 bool mModified;
342 342
343 QString mLoadedProductId; 343 QString mLoadedProductId;
344 344
345 // This list is used to put together related todos 345 // This list is used to put together related todos
346 QDict<Incidence> mOrphans; 346 QDict<Incidence> mOrphans;
347 QDict<Incidence> mOrphanUids; 347 QDict<Incidence> mOrphanUids;
348}; 348};
349 349
350} 350}
351 351
352#endif 352#endif