summaryrefslogtreecommitdiffabout
path: root/libkcal/incidence.h
Unidiff
Diffstat (limited to 'libkcal/incidence.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libkcal/incidence.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/libkcal/incidence.h b/libkcal/incidence.h
index d1972cb..7dc6f10 100644
--- a/libkcal/incidence.h
+++ b/libkcal/incidence.h
@@ -120,179 +120,179 @@ class Incidence : public IncidenceBase
120 Recreate event. The event is made a new unique event, but already stored 120 Recreate event. The event is made a new unique event, but already stored
121 event information is preserved. Sets uniquie id, creation date, last 121 event information is preserved. Sets uniquie id, creation date, last
122 modification date and revision number. 122 modification date and revision number.
123 */ 123 */
124 void recreate(); 124 void recreate();
125 125
126 /** set creation date */ 126 /** set creation date */
127 void setCreated(QDateTime); 127 void setCreated(QDateTime);
128 /** return time and date of creation. */ 128 /** return time and date of creation. */
129 QDateTime created() const; 129 QDateTime created() const;
130 130
131 /** set the number of revisions this event has seen */ 131 /** set the number of revisions this event has seen */
132 void setRevision(int rev); 132 void setRevision(int rev);
133 /** return the number of revisions this event has seen */ 133 /** return the number of revisions this event has seen */
134 int revision() const; 134 int revision() const;
135 135
136 /** Set starting date/time. */ 136 /** Set starting date/time. */
137 virtual void setDtStart(const QDateTime &dtStart); 137 virtual void setDtStart(const QDateTime &dtStart);
138 /** Return the incidence's ending date/time as a QDateTime. */ 138 /** Return the incidence's ending date/time as a QDateTime. */
139 virtual QDateTime dtEnd() const { return QDateTime(); } 139 virtual QDateTime dtEnd() const { return QDateTime(); }
140 140
141 /** sets the event's lengthy description. */ 141 /** sets the event's lengthy description. */
142 void setDescription(const QString &description); 142 void setDescription(const QString &description);
143 /** returns a reference to the event's description. */ 143 /** returns a reference to the event's description. */
144 QString description() const; 144 QString description() const;
145 145
146 /** sets the event's short summary. */ 146 /** sets the event's short summary. */
147 void setSummary(const QString &summary); 147 void setSummary(const QString &summary);
148 /** returns a reference to the event's summary. */ 148 /** returns a reference to the event's summary. */
149 QString summary() const; 149 QString summary() const;
150 150
151 /** set event's applicable categories */ 151 /** set event's applicable categories */
152 void setCategories(const QStringList &categories); 152 void setCategories(const QStringList &categories);
153 /** set event's categories based on a comma delimited string */ 153 /** set event's categories based on a comma delimited string */
154 void setCategories(const QString &catStr); 154 void setCategories(const QString &catStr);
155 /** return categories in a list */ 155 /** return categories in a list */
156 QStringList categories() const; 156 QStringList categories() const;
157 /** return categories as a comma separated string */ 157 /** return categories as a comma separated string */
158 QString categoriesStr(); 158 QString categoriesStr();
159 159
160 /** point at some other event to which the event relates. This function should 160 /** point at some other event to which the event relates. This function should
161 * only be used when constructing a calendar before the related Event 161 * only be used when constructing a calendar before the related Event
162 * exists. */ 162 * exists. */
163 void setRelatedToUid(const QString &); 163 void setRelatedToUid(const QString &);
164 /** what event does this one relate to? This function should 164 /** what event does this one relate to? This function should
165 * only be used when constructing a calendar before the related Event 165 * only be used when constructing a calendar before the related Event
166 * exists. */ 166 * exists. */
167 QString relatedToUid() const; 167 QString relatedToUid() const;
168 /** point at some other event to which the event relates */ 168 /** point at some other event to which the event relates */
169 void setRelatedTo(Incidence *relatedTo); 169 void setRelatedTo(Incidence *relatedTo);
170 /** what event does this one relate to? */ 170 /** what event does this one relate to? */
171 Incidence *relatedTo() const; 171 Incidence *relatedTo() const;
172 /** All events that are related to this event */ 172 /** All events that are related to this event */
173 QPtrList<Incidence> relations() const; 173 QPtrList<Incidence> relations() const;
174 /** Add an event which is related to this event */ 174 /** Add an event which is related to this event */
175 void addRelation(Incidence *); 175 void addRelation(Incidence *);
176 /** Remove event that is related to this event */ 176 /** Remove event that is related to this event */
177 void removeRelation(Incidence *); 177 void removeRelation(Incidence *);
178 178
179 /** returns the list of dates which are exceptions to the recurrence rule */ 179 /** returns the list of dates which are exceptions to the recurrence rule */
180 DateList exDates() const; 180 DateList exDates() const;
181 /** sets the list of dates which are exceptions to the recurrence rule */ 181 /** sets the list of dates which are exceptions to the recurrence rule */
182 void setExDates(const DateList &_exDates); 182 void setExDates(const DateList &_exDates);
183 void setExDates(const char *dates); 183 void setExDates(const char *dates);
184 /** Add a date to the list of exceptions of the recurrence rule. */ 184 /** Add a date to the list of exceptions of the recurrence rule. */
185 void addExDate(const QDate &date); 185 void addExDate(const QDate &date);
186 186
187 /** returns true if there is an exception for this date in the recurrence 187 /** returns true if there is an exception for this date in the recurrence
188 rule set, or false otherwise. */ 188 rule set, or false otherwise. */
189 bool isException(const QDate &qd) const; 189 bool isException(const QDate &qd) const;
190 190
191 /** add attachment to this event */ 191 /** add attachment to this event */
192 void addAttachment(Attachment *attachment); 192 void addAttachment(Attachment *attachment);
193 /** remove and delete a specific attachment */ 193 /** remove and delete a specific attachment */
194 void deleteAttachment(Attachment *attachment); 194 void deleteAttachment(Attachment *attachment);
195 /** remove and delete all attachments with this mime type */ 195 /** remove and delete all attachments with this mime type */
196 void deleteAttachments(const QString& mime); 196 void deleteAttachments(const QString& mime);
197 /** return list of all associated attachments */ 197 /** return list of all associated attachments */
198 QPtrList<Attachment> attachments() const; 198 QPtrList<Attachment> attachments() const;
199 /** find a list of attachments with this mime type */ 199 /** find a list of attachments with this mime type */
200 QPtrList<Attachment> attachments(const QString& mime) const; 200 QPtrList<Attachment> attachments(const QString& mime) const;
201 201
202 /** sets the event's status the value specified. See the enumeration 202 /** sets the event's status the value specified. See the enumeration
203 * above for possible values. */ 203 * above for possible values. */
204 void setSecrecy(int); 204 void setSecrecy(int);
205 /** return the event's secrecy. */ 205 /** return the event's secrecy. */
206 int secrecy() const; 206 int secrecy() const;
207 /** return the event's secrecy in string format. */ 207 /** return the event's secrecy in string format. */
208 QString secrecyStr() const; 208 QString secrecyStr() const;
209 /** return list of all availbale secrecy classes */ 209 /** return list of all availbale secrecy classes */
210 static QStringList secrecyList(); 210 static QStringList secrecyList();
211 /** return human-readable name of secrecy class */ 211 /** return human-readable name of secrecy class */
212 static QString secrecyName(int); 212 static QString secrecyName(int);
213 213
214 /** returns TRUE if the date specified is one on which the event will 214 /** returns TRUE if the date specified is one on which the event will
215 * recur. */ 215 * recur. */
216 bool recursOn(const QDate &qd) const; 216 bool recursOn(const QDate &qd) const;
217 217
218 // VEVENT and VTODO, but not VJOURNAL (move to EventBase class?): 218 // VEVENT and VTODO, but not VJOURNAL (move to EventBase class?):
219 219
220 /** set resources used, such as Office, Car, etc. */ 220 /** set resources used, such as Office, Car, etc. */
221 void setResources(const QStringList &resources); 221 void setResources(const QStringList &resources);
222 /** return list of current resources */ 222 /** return list of current resources */
223 QStringList resources() const; 223 QStringList resources() const;
224 224
225 /** set the event's priority, 0 is undefined, 1 highest (decreasing order) */ 225 /** set the event's priority, 0 is undefined, 1 highest (decreasing order) */
226 void setPriority(int priority); 226 void setPriority(int priority);
227 /** get the event's priority */ 227 /** get the event's priority */
228 int priority() const; 228 int priority() const;
229 229
230 /** All alarms that are associated with this incidence */ 230 /** All alarms that are associated with this incidence */
231 QPtrList<Alarm> alarms() const; 231 QPtrList<Alarm> alarms() const;
232 /** Create a new alarm which is associated with this incidence */ 232 /** Create a new alarm which is associated with this incidence */
233 Alarm* newAlarm(); 233 Alarm* newAlarm();
234 /** Add an alarm which is associated with this incidence */ 234 /** Add an alarm which is associated with this incidence */
235 void addAlarm(Alarm*); 235 void addAlarm(Alarm*);
236 /** Remove an alarm that is associated with this incidence */ 236 /** Remove an alarm that is associated with this incidence */
237 void removeAlarm(Alarm*); 237 void removeAlarm(Alarm*);
238 /** Remove all alarms that are associated with this incidence */ 238 /** Remove all alarms that are associated with this incidence */
239 void clearAlarms(); 239 void clearAlarms();
240 /** return whether any alarm associated with this incidence is enabled */ 240 /** return whether any alarm associated with this incidence is enabled */
241 bool isAlarmEnabled() const; 241 bool isAlarmEnabled() const;
242 242
243 /** 243 /**
244 Return the recurrence rule associated with this incidence. If there is 244 Return the recurrence rule associated with this incidence. If there is
245 none, returns an appropriate (non-0) object. 245 none, returns an appropriate (non-0) object.
246 */ 246 */
247 Recurrence *recurrence() const; 247 Recurrence *recurrence() const;
248 248 void setRecurrence(Recurrence * r);
249 /** 249 /**
250 Forward to Recurrence::doesRecur(). 250 Forward to Recurrence::doesRecur().
251 */ 251 */
252 ushort doesRecur() const; 252 ushort doesRecur() const;
253 253
254 /** set the event's/todo's location. Do _not_ use it with journal */ 254 /** set the event's/todo's location. Do _not_ use it with journal */
255 void setLocation(const QString &location); 255 void setLocation(const QString &location);
256 /** return the event's/todo's location. Do _not_ use it with journal */ 256 /** return the event's/todo's location. Do _not_ use it with journal */
257 QString location() const; 257 QString location() const;
258 /** returns TRUE or FALSE depending on whether the todo has a start date */ 258 /** returns TRUE or FALSE depending on whether the todo has a start date */
259 bool hasStartDate() const; 259 bool hasStartDate() const;
260 /** sets the event's hasStartDate value. */ 260 /** sets the event's hasStartDate value. */
261 void setHasStartDate(bool f); 261 void setHasStartDate(bool f);
262 QDateTime getNextOccurence( const QDateTime& dt, bool* yes ) const; 262 QDateTime getNextOccurence( const QDateTime& dt, bool* yes ) const;
263 bool cancelled() const; 263 bool cancelled() const;
264 void setCancelled( bool b ); 264 void setCancelled( bool b );
265 265
266protected: 266protected:
267 QPtrList<Alarm> mAlarms; 267 QPtrList<Alarm> mAlarms;
268 private: 268 private:
269 int mRevision; 269 int mRevision;
270 bool mCancelled; 270 bool mCancelled;
271 271
272 // base components of jounal, event and todo 272 // base components of jounal, event and todo
273 QDateTime mCreated; 273 QDateTime mCreated;
274 QString mDescription; 274 QString mDescription;
275 QString mSummary; 275 QString mSummary;
276 QStringList mCategories; 276 QStringList mCategories;
277 Incidence *mRelatedTo; 277 Incidence *mRelatedTo;
278 QString mRelatedToUid; 278 QString mRelatedToUid;
279 QPtrList<Incidence> mRelations; 279 QPtrList<Incidence> mRelations;
280 DateList mExDates; 280 DateList mExDates;
281 QPtrList<Attachment> mAttachments; 281 QPtrList<Attachment> mAttachments;
282 QStringList mResources; 282 QStringList mResources;
283 bool mHasStartDate; // if todo has associated start date 283 bool mHasStartDate; // if todo has associated start date
284 284
285 int mSecrecy; 285 int mSecrecy;
286 int mPriority; // 1 = highest, 2 = less, etc. 286 int mPriority; // 1 = highest, 2 = less, etc.
287 287
288 //QPtrList<Alarm> mAlarms; 288 //QPtrList<Alarm> mAlarms;
289 Recurrence *mRecurrence; 289 Recurrence *mRecurrence;
290 290
291 QString mLocation; 291 QString mLocation;
292}; 292};
293 293
294bool operator==( const Incidence&, const Incidence& ); 294bool operator==( const Incidence&, const Incidence& );
295 295
296} 296}
297 297
298#endif 298#endif