author | zautrix <zautrix> | 2005-04-18 10:41:31 (UTC) |
---|---|---|
committer | zautrix <zautrix> | 2005-04-18 10:41:31 (UTC) |
commit | 409e329447a7d00a93a56855fcddadbb0f793163 (patch) (unidiff) | |
tree | 1c92498d2dfb4c89358c64a6944aca1300a27d11 /libkcal/incidence.h | |
parent | 0ff0dca7ccb94ebb1381351e4e4081fe0bac500a (diff) | |
download | kdepimpi-409e329447a7d00a93a56855fcddadbb0f793163.zip kdepimpi-409e329447a7d00a93a56855fcddadbb0f793163.tar.gz kdepimpi-409e329447a7d00a93a56855fcddadbb0f793163.tar.bz2 |
morefixes
-rw-r--r-- | libkcal/incidence.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/libkcal/incidence.h b/libkcal/incidence.h index 327e7dd..ebd50d0 100644 --- a/libkcal/incidence.h +++ b/libkcal/incidence.h | |||
@@ -58,193 +58,194 @@ class Incidence : public IncidenceBase | |||
58 | virtual ~Visitor() {} | 58 | virtual ~Visitor() {} |
59 | 59 | ||
60 | /** | 60 | /** |
61 | Reimplement this function in your concrete subclass of IncidenceVisitor to perform actions | 61 | Reimplement this function in your concrete subclass of IncidenceVisitor to perform actions |
62 | on an Event object. | 62 | on an Event object. |
63 | */ | 63 | */ |
64 | virtual bool visit(Event *) { return false; } | 64 | virtual bool visit(Event *) { return false; } |
65 | /** | 65 | /** |
66 | Reimplement this function in your concrete subclass of IncidenceVisitor to perform actions | 66 | Reimplement this function in your concrete subclass of IncidenceVisitor to perform actions |
67 | on an Todo object. | 67 | on an Todo object. |
68 | */ | 68 | */ |
69 | virtual bool visit(Todo *) { return false; } | 69 | virtual bool visit(Todo *) { return false; } |
70 | /** | 70 | /** |
71 | Reimplement this function in your concrete subclass of IncidenceVisitor to perform actions | 71 | Reimplement this function in your concrete subclass of IncidenceVisitor to perform actions |
72 | on an Journal object. | 72 | on an Journal object. |
73 | */ | 73 | */ |
74 | virtual bool visit(Journal *) { return false; } | 74 | virtual bool visit(Journal *) { return false; } |
75 | 75 | ||
76 | protected: | 76 | protected: |
77 | /** Constructor is protected to prevent direct creation of visitor base class. */ | 77 | /** Constructor is protected to prevent direct creation of visitor base class. */ |
78 | Visitor() {} | 78 | Visitor() {} |
79 | }; | 79 | }; |
80 | 80 | ||
81 | /** | 81 | /** |
82 | This class implements a visitor for adding an Incidence to a resource | 82 | This class implements a visitor for adding an Incidence to a resource |
83 | supporting addEvent(), addTodo() and addJournal() calls. | 83 | supporting addEvent(), addTodo() and addJournal() calls. |
84 | */ | 84 | */ |
85 | template<class T> | 85 | template<class T> |
86 | class AddVisitor : public Visitor | 86 | class AddVisitor : public Visitor |
87 | { | 87 | { |
88 | public: | 88 | public: |
89 | AddVisitor( T *r ) : mResource( r ) {} | 89 | AddVisitor( T *r ) : mResource( r ) {} |
90 | bool visit( Event *e ) { return mResource->addEvent( e ); } | 90 | bool visit( Event *e ) { return mResource->addEvent( e ); } |
91 | bool visit( Todo *t ) { return mResource->addTodo( t ); } | 91 | bool visit( Todo *t ) { return mResource->addTodo( t ); } |
92 | bool visit( Journal *j ) { return mResource->addJournal( j ); } | 92 | bool visit( Journal *j ) { return mResource->addJournal( j ); } |
93 | 93 | ||
94 | private: | 94 | private: |
95 | T *mResource; | 95 | T *mResource; |
96 | }; | 96 | }; |
97 | 97 | ||
98 | /** enumeration for describing an event's secrecy. */ | 98 | /** enumeration for describing an event's secrecy. */ |
99 | enum { SecrecyPublic = 0, SecrecyPrivate = 1, SecrecyConfidential = 2 }; | 99 | enum { SecrecyPublic = 0, SecrecyPrivate = 1, SecrecyConfidential = 2 }; |
100 | typedef ListBase<Incidence> List; | 100 | typedef ListBase<Incidence> List; |
101 | Incidence(); | 101 | Incidence(); |
102 | Incidence(const Incidence &); | 102 | Incidence(const Incidence &); |
103 | ~Incidence(); | 103 | ~Incidence(); |
104 | 104 | ||
105 | /** | 105 | /** |
106 | Accept IncidenceVisitor. A class taking part in the visitor mechanism has to | 106 | Accept IncidenceVisitor. A class taking part in the visitor mechanism has to |
107 | provide this implementation: | 107 | provide this implementation: |
108 | <pre> | 108 | <pre> |
109 | bool accept(Visitor &v) { return v.visit(this); } | 109 | bool accept(Visitor &v) { return v.visit(this); } |
110 | </pre> | 110 | </pre> |
111 | */ | 111 | */ |
112 | virtual bool accept(Visitor &) { return false; } | 112 | virtual bool accept(Visitor &) { return false; } |
113 | 113 | ||
114 | virtual Incidence *clone() = 0; | 114 | virtual Incidence *clone() = 0; |
115 | virtual void cloneRelations( Incidence * ); | 115 | virtual void cloneRelations( Incidence * ); |
116 | 116 | ||
117 | virtual QDateTime getNextAlarmDateTime( bool * ok, int * offset ) const = 0; | 117 | virtual QDateTime getNextAlarmDateTime( bool * ok, int * offset ) const = 0; |
118 | void setReadOnly( bool ); | 118 | void setReadOnly( bool ); |
119 | 119 | ||
120 | /** | 120 | /** |
121 | Recreate event. The event is made a new unique event, but already stored | 121 | Recreate event. The event is made a new unique event, but already stored |
122 | event information is preserved. Sets uniquie id, creation date, last | 122 | event information is preserved. Sets uniquie id, creation date, last |
123 | modification date and revision number. | 123 | modification date and revision number. |
124 | */ | 124 | */ |
125 | void recreate(); | 125 | void recreate(); |
126 | Incidence* recreateCloneException(QDate); | 126 | Incidence* recreateCloneException(QDate); |
127 | 127 | ||
128 | /** set creation date */ | 128 | /** set creation date */ |
129 | void setCreated(QDateTime); | 129 | void setCreated(QDateTime); |
130 | /** return time and date of creation. */ | 130 | /** return time and date of creation. */ |
131 | QDateTime created() const; | 131 | QDateTime created() const; |
132 | 132 | ||
133 | /** set the number of revisions this event has seen */ | 133 | /** set the number of revisions this event has seen */ |
134 | void setRevision(int rev); | 134 | void setRevision(int rev); |
135 | /** return the number of revisions this event has seen */ | 135 | /** return the number of revisions this event has seen */ |
136 | int revision() const; | 136 | int revision() const; |
137 | 137 | ||
138 | /** Set starting date/time. */ | 138 | /** Set starting date/time. */ |
139 | virtual void setDtStart(const QDateTime &dtStart); | 139 | virtual void setDtStart(const QDateTime &dtStart); |
140 | /** Return the incidence's ending date/time as a QDateTime. */ | 140 | /** Return the incidence's ending date/time as a QDateTime. */ |
141 | virtual QDateTime dtEnd() const { return QDateTime(); } | 141 | virtual QDateTime dtEnd() const { return QDateTime(); } |
142 | 142 | ||
143 | /** sets the event's lengthy description. */ | 143 | /** sets the event's lengthy description. */ |
144 | void setDescription(const QString &description); | 144 | void setDescription(const QString &description); |
145 | /** returns a reference to the event's description. */ | 145 | /** returns a reference to the event's description. */ |
146 | QString description() const; | 146 | QString description() const; |
147 | 147 | ||
148 | /** sets the event's short summary. */ | 148 | /** sets the event's short summary. */ |
149 | void setSummary(const QString &summary); | 149 | void setSummary(const QString &summary); |
150 | /** returns a reference to the event's summary. */ | 150 | /** returns a reference to the event's summary. */ |
151 | QString summary() const; | 151 | QString summary() const; |
152 | 152 | ||
153 | /** set event's applicable categories */ | 153 | /** set event's applicable categories */ |
154 | void setCategories(const QStringList &categories); | 154 | void setCategories(const QStringList &categories, bool setForRelations = false); |
155 | void addCategories(const QStringList &categories, bool addToRelations = false); | ||
155 | /** set event's categories based on a comma delimited string */ | 156 | /** set event's categories based on a comma delimited string */ |
156 | void setCategories(const QString &catStr); | 157 | void setCategories(const QString &catStr); |
157 | /** return categories in a list */ | 158 | /** return categories in a list */ |
158 | QStringList categories() const; | 159 | QStringList categories() const; |
159 | /** return categories as a comma separated string */ | 160 | /** return categories as a comma separated string */ |
160 | QString categoriesStr(); | 161 | QString categoriesStr(); |
161 | QString categoriesStrWithSpace(); | 162 | QString categoriesStrWithSpace(); |
162 | 163 | ||
163 | /** point at some other event to which the event relates. This function should | 164 | /** point at some other event to which the event relates. This function should |
164 | * only be used when constructing a calendar before the related Event | 165 | * only be used when constructing a calendar before the related Event |
165 | * exists. */ | 166 | * exists. */ |
166 | void setRelatedToUid(const QString &); | 167 | void setRelatedToUid(const QString &); |
167 | /** what event does this one relate to? This function should | 168 | /** what event does this one relate to? This function should |
168 | * only be used when constructing a calendar before the related Event | 169 | * only be used when constructing a calendar before the related Event |
169 | * exists. */ | 170 | * exists. */ |
170 | QString relatedToUid() const; | 171 | QString relatedToUid() const; |
171 | /** point at some other event to which the event relates */ | 172 | /** point at some other event to which the event relates */ |
172 | void setRelatedTo(Incidence *relatedTo); | 173 | void setRelatedTo(Incidence *relatedTo); |
173 | /** what event does this one relate to? */ | 174 | /** what event does this one relate to? */ |
174 | Incidence *relatedTo() const; | 175 | Incidence *relatedTo() const; |
175 | /** All events that are related to this event */ | 176 | /** All events that are related to this event */ |
176 | QPtrList<Incidence> relations() const; | 177 | QPtrList<Incidence> relations() const; |
177 | /** Add an event which is related to this event */ | 178 | /** Add an event which is related to this event */ |
178 | void addRelation(Incidence *); | 179 | void addRelation(Incidence *); |
179 | /** Remove event that is related to this event */ | 180 | /** Remove event that is related to this event */ |
180 | void removeRelation(Incidence *); | 181 | void removeRelation(Incidence *); |
181 | 182 | ||
182 | /** returns the list of dates which are exceptions to the recurrence rule */ | 183 | /** returns the list of dates which are exceptions to the recurrence rule */ |
183 | DateList exDates() const; | 184 | DateList exDates() const; |
184 | /** sets the list of dates which are exceptions to the recurrence rule */ | 185 | /** sets the list of dates which are exceptions to the recurrence rule */ |
185 | void setExDates(const DateList &_exDates); | 186 | void setExDates(const DateList &_exDates); |
186 | void setExDates(const char *dates); | 187 | void setExDates(const char *dates); |
187 | /** Add a date to the list of exceptions of the recurrence rule. */ | 188 | /** Add a date to the list of exceptions of the recurrence rule. */ |
188 | void addExDate(const QDate &date); | 189 | void addExDate(const QDate &date); |
189 | 190 | ||
190 | /** returns true if there is an exception for this date in the recurrence | 191 | /** returns true if there is an exception for this date in the recurrence |
191 | rule set, or false otherwise. */ | 192 | rule set, or false otherwise. */ |
192 | bool isException(const QDate &qd) const; | 193 | bool isException(const QDate &qd) const; |
193 | 194 | ||
194 | /** add attachment to this event */ | 195 | /** add attachment to this event */ |
195 | void addAttachment(Attachment *attachment); | 196 | void addAttachment(Attachment *attachment); |
196 | /** remove and delete a specific attachment */ | 197 | /** remove and delete a specific attachment */ |
197 | void deleteAttachment(Attachment *attachment); | 198 | void deleteAttachment(Attachment *attachment); |
198 | /** remove and delete all attachments with this mime type */ | 199 | /** remove and delete all attachments with this mime type */ |
199 | void deleteAttachments(const QString& mime); | 200 | void deleteAttachments(const QString& mime); |
200 | /** return list of all associated attachments */ | 201 | /** return list of all associated attachments */ |
201 | QPtrList<Attachment> attachments() const; | 202 | QPtrList<Attachment> attachments() const; |
202 | /** find a list of attachments with this mime type */ | 203 | /** find a list of attachments with this mime type */ |
203 | QPtrList<Attachment> attachments(const QString& mime) const; | 204 | QPtrList<Attachment> attachments(const QString& mime) const; |
204 | 205 | ||
205 | /** sets the event's status the value specified. See the enumeration | 206 | /** sets the event's status the value specified. See the enumeration |
206 | * above for possible values. */ | 207 | * above for possible values. */ |
207 | void setSecrecy(int); | 208 | void setSecrecy(int); |
208 | /** return the event's secrecy. */ | 209 | /** return the event's secrecy. */ |
209 | int secrecy() const; | 210 | int secrecy() const; |
210 | /** return the event's secrecy in string format. */ | 211 | /** return the event's secrecy in string format. */ |
211 | QString secrecyStr() const; | 212 | QString secrecyStr() const; |
212 | /** return list of all availbale secrecy classes */ | 213 | /** return list of all availbale secrecy classes */ |
213 | static QStringList secrecyList(); | 214 | static QStringList secrecyList(); |
214 | /** return human-readable name of secrecy class */ | 215 | /** return human-readable name of secrecy class */ |
215 | static QString secrecyName(int); | 216 | static QString secrecyName(int); |
216 | 217 | ||
217 | /** returns TRUE if the date specified is one on which the event will | 218 | /** returns TRUE if the date specified is one on which the event will |
218 | * recur. */ | 219 | * recur. */ |
219 | bool recursOn(const QDate &qd) const; | 220 | bool recursOn(const QDate &qd) const; |
220 | 221 | ||
221 | // VEVENT and VTODO, but not VJOURNAL (move to EventBase class?): | 222 | // VEVENT and VTODO, but not VJOURNAL (move to EventBase class?): |
222 | 223 | ||
223 | /** set resources used, such as Office, Car, etc. */ | 224 | /** set resources used, such as Office, Car, etc. */ |
224 | void setResources(const QStringList &resources); | 225 | void setResources(const QStringList &resources); |
225 | /** return list of current resources */ | 226 | /** return list of current resources */ |
226 | QStringList resources() const; | 227 | QStringList resources() const; |
227 | 228 | ||
228 | /** set the event's priority, 0 is undefined, 1 highest (decreasing order) */ | 229 | /** set the event's priority, 0 is undefined, 1 highest (decreasing order) */ |
229 | void setPriority(int priority); | 230 | void setPriority(int priority); |
230 | /** get the event's priority */ | 231 | /** get the event's priority */ |
231 | int priority() const; | 232 | int priority() const; |
232 | 233 | ||
233 | /** All alarms that are associated with this incidence */ | 234 | /** All alarms that are associated with this incidence */ |
234 | QPtrList<Alarm> alarms() const; | 235 | QPtrList<Alarm> alarms() const; |
235 | /** Create a new alarm which is associated with this incidence */ | 236 | /** Create a new alarm which is associated with this incidence */ |
236 | Alarm* newAlarm(); | 237 | Alarm* newAlarm(); |
237 | /** Add an alarm which is associated with this incidence */ | 238 | /** Add an alarm which is associated with this incidence */ |
238 | void addAlarm(Alarm*); | 239 | void addAlarm(Alarm*); |
239 | /** Remove an alarm that is associated with this incidence */ | 240 | /** Remove an alarm that is associated with this incidence */ |
240 | void removeAlarm(Alarm*); | 241 | void removeAlarm(Alarm*); |
241 | /** Remove all alarms that are associated with this incidence */ | 242 | /** Remove all alarms that are associated with this incidence */ |
242 | void clearAlarms(); | 243 | void clearAlarms(); |
243 | /** return whether any alarm associated with this incidence is enabled */ | 244 | /** return whether any alarm associated with this incidence is enabled */ |
244 | bool isAlarmEnabled() const; | 245 | bool isAlarmEnabled() const; |
245 | 246 | ||
246 | /** | 247 | /** |
247 | Return the recurrence rule associated with this incidence. If there is | 248 | Return the recurrence rule associated with this incidence. If there is |
248 | none, returns an appropriate (non-0) object. | 249 | none, returns an appropriate (non-0) object. |
249 | */ | 250 | */ |
250 | Recurrence *recurrence() const; | 251 | Recurrence *recurrence() const; |