1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
/*
This file is part of libkcal.
Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KCAL_INCIDENCEBASE_H
#define KCAL_INCIDENCEBASE_H
#include <tqdatetime.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
#include <tqptrlist.h>
#include "customproperties.h"
#include "attendee.h"
namespace KCal {
typedef TQValueList<TQDate> DateList;
typedef TQValueList<TQDateTime> DateTimeList;
class Event;
class Todo;
class Journal;
class FreeBusy;
/**
This class provides the base class common to all calendar components.
*/
class LIBKCAL_EXPORT IncidenceBase : public CustomProperties
{
public:
/**
This class provides the interface for a visitor of calendar components. It
serves as base class for concrete visitors, which implement certain actions on
calendar components. It allows to add functions, which operate on the concrete
types of calendar components, without changing the calendar component classes.
*/
class Visitor
{
public:
/** Destruct Incidence::Visitor */
virtual ~Visitor() {}
/**
Reimplement this function in your concrete subclass of IncidenceBase::Visitor to perform actions
on an Event object.
*/
virtual bool visit(Event *) { return false; }
/**
Reimplement this function in your concrete subclass of IncidenceBase::Visitor to perform actions
on a Todo object.
*/
virtual bool visit(Todo *) { return false; }
/**
Reimplement this function in your concrete subclass of IncidenceBase::Visitor to perform actions
on an Journal object.
*/
virtual bool visit(Journal *) { return false; }
/**
Reimplement this function in your concrete subclass of IncidenceBase::Visitor to perform actions
on a FreeBusy object.
*/
virtual bool visit(FreeBusy *) { return false; }
protected:
/** Constructor is protected to prevent direct creation of visitor base class. */
Visitor() {}
};
class Observer {
public:
virtual ~Observer() {}
virtual void incidenceUpdated( IncidenceBase * ) = 0;
virtual void incidenceUpdatedSilent( IncidenceBase * ) {};
};
IncidenceBase();
IncidenceBase( const IncidenceBase & );
virtual ~IncidenceBase();
IncidenceBase& operator=( const IncidenceBase &i );
bool operator==( const IncidenceBase & ) const;
/**
Accept IncidenceVisitor. A class taking part in the visitor mechanism has to
provide this implementation:
<pre>
bool accept(Visitor &v) { return v.visit(this); }
</pre>
*/
virtual bool accept(Visitor &) { return false; }
virtual TQCString type() const = 0;
/** Set the unique id for the event */
void setUid( const TQString & );
/** Return the unique id for the event */
TQString uid() const;
/** Sets the time the incidence was last modified. */
void setLastModified( const TQDateTime &lm );
/** Return the time the incidence was last modified. */
TQDateTime lastModified() const;
/** sets the organizer for the event */
void setOrganizer( const Person &o );
void setOrganizer( const TQString &o );
Person organizer() const;
/** Set readonly status. */
virtual void setReadOnly( bool );
/** Return if the object is read-only. */
bool isReadOnly() const { return mReadOnly; }
/** for setting the event's starting date/time with a TQDateTime. */
virtual void setDtStart( const TQDateTime &dtStart );
/** returns an event's starting date/time as a TQDateTime. */
virtual TQDateTime dtStart() const;
/** returns an event's starting time as a string formatted according to the
users locale settings */
virtual TQString dtStartTimeStr() const;
/** returns an event's starting date as a string formatted according to the
users locale settings */
virtual TQString dtStartDateStr( bool shortfmt = true ) const;
/** returns an event's starting date and time as a string formatted according
to the users locale settings */
virtual TQString dtStartStr() const;
virtual void setDuration( int seconds );
int duration() const;
void setHasDuration( bool );
bool hasDuration() const;
/** Return true or false depending on whether the incidence "floats,"
* i.e. has a date but no time attached to it. */
bool doesFloat() const;
/** Set whether the incidence floats, i.e. has a date but no time attached to it. */
void setFloats( bool f );
//
// Comments
//
/**
* Add a comment to this incidence.
*
* Does not add a linefeed character. Just appends the text as passed in.
*
* @param comment The comment to add.
*/
void addComment(const TQString& comment);
/**
* Remove a comment from the event.
*
* Removes first comment whose string is an exact match for the string
* passed in.
*
* @return true if match found, false otherwise.
*/
bool removeComment( const TQString& comment );
/** Delete all comments associated with this incidence. */
void clearComments();
/** Return all comments associated with this incidence. */
TQStringList comments() const;
/**
Add Attendee to this incidence. IncidenceBase takes ownership of the
Attendee object.
@param attendee a pointer to the attendee to add
@param doUpdate If true the Observers are notified, if false they are not.
*/
void addAttendee( Attendee *attendee, bool doUpdate = true );
/**
Remove all Attendees.
*/
void clearAttendees();
/**
Return list of attendees.
*/
const Attendee::List &attendees() const { return mAttendees; };
/**
Return number of attendees.
*/
int attendeeCount() const { return mAttendees.count(); };
/**
Return the Attendee with this email address.
*/
Attendee *attendeeByMail( const TQString & ) const;
/**
Return first Attendee with one of the given email addresses.
*/
Attendee *attendeeByMails( const TQStringList &,
const TQString &email = TQString::null ) const;
/**
Return attendee with given uid.
*/
Attendee *attendeeByUid( const TQString &uid ) const;
/**
Pilot synchronization states
*/
enum { SYNCNONE = 0, SYNCMOD = 1, SYNCDEL = 3 };
/**
Set synchronisation satus.
*/
void setSyncStatus( int status );
void setSyncStatusSilent( int status );
/**
Return synchronisation status.
*/
int syncStatus() const;
/**
Set Pilot Id.
*/
void setPilotId( unsigned long id );
/**
Return Pilot Id.
*/
unsigned long pilotId() const;
/**
Register observer. The observer is notified when the observed object
changes.
*/
void registerObserver( Observer * );
/**
Unregister observer. It isn't notified anymore about changes.
*/
void unRegisterObserver( Observer * );
/**
Call this to notify the observers after the IncidenceBas object has
changed.
*/
void updated();
void updatedSilent();
protected:
/**
@copydoc
CustomProperties::customPropertyUpdated()
*/
virtual void customPropertyUpdated();
bool mReadOnly;
private:
// base components
TQDateTime mDtStart;
Person mOrganizer;
TQString mUid;
TQDateTime mLastModified;
Attendee::List mAttendees;
TQStringList mComments;
bool mFloats;
int mDuration;
bool mHasDuration;
// PILOT SYNCHRONIZATION STUFF
unsigned long mPilotId; // unique id for pilot sync
int mSyncStatus; // status (for sync)
TQPtrList<Observer> mObservers;
class Private;
Private *d;
};
}
#endif
|