-rw-r--r-- | libkcal/calendar.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/libkcal/calendar.h b/libkcal/calendar.h index 2f2c3aa..ab40970 100644 --- a/libkcal/calendar.h +++ b/libkcal/calendar.h | |||
@@ -46,193 +46,196 @@ namespace KCal { | |||
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 | */ |
60 | class Calendar : public QObject, public CustomProperties, | 60 | class Calendar : public QObject, public CustomProperties, |
61 | public IncidenceBase::Observer | 61 | public IncidenceBase::Observer |
62 | { | 62 | { |
63 | Q_OBJECT | 63 | Q_OBJECT |
64 | public: | 64 | public: |
65 | Calendar(); | 65 | Calendar(); |
66 | Calendar(const QString &timeZoneId); | 66 | Calendar(const QString &timeZoneId); |
67 | virtual ~Calendar(); | 67 | virtual ~Calendar(); |
68 | Incidence * undoIncidence() { return mUndoIncidence; }; | 68 | Incidence * undoIncidence() { return mUndoIncidence; }; |
69 | bool undoDeleteIncidence(); | 69 | bool undoDeleteIncidence(); |
70 | void deleteIncidence(Incidence *in); | 70 | void deleteIncidence(Incidence *in); |
71 | void resetTempSyncStat(); | 71 | void resetTempSyncStat(); |
72 | void resetPilotStat(int id); | 72 | void resetPilotStat(int id); |
73 | /** | 73 | /** |
74 | Clears out the current calendar, freeing all used memory etc. | 74 | Clears out the current calendar, freeing all used memory etc. |
75 | */ | 75 | */ |
76 | virtual void close() = 0; | 76 | virtual void close() = 0; |
77 | 77 | ||
78 | /** | 78 | /** |
79 | Sync changes in memory to persistant storage. | 79 | Sync changes in memory to persistant storage. |
80 | */ | 80 | */ |
81 | virtual void save() = 0; | 81 | virtual void save() = 0; |
82 | virtual QPtrList<Event> getExternLastSyncEvents() = 0; | 82 | virtual QPtrList<Event> getExternLastSyncEvents() = 0; |
83 | virtual void removeSyncInfo( QString syncProfile) = 0; | 83 | virtual void removeSyncInfo( QString syncProfile) = 0; |
84 | virtual bool isSaving() { return false; } | 84 | virtual bool isSaving() { return false; } |
85 | 85 | ||
86 | /** | 86 | /** |
87 | Return the owner of the calendar's full name. | 87 | Return the owner of the calendar's full name. |
88 | */ | 88 | */ |
89 | const QString &getOwner() const; | 89 | const QString &getOwner() const; |
90 | /** | 90 | /** |
91 | Set the owner of the calendar. Should be owner's full name. | 91 | Set the owner of the calendar. Should be owner's full name. |
92 | */ | 92 | */ |
93 | void setOwner( const QString &os ); | 93 | void setOwner( const QString &os ); |
94 | /** | 94 | /** |
95 | Return the email address of the calendar owner. | 95 | Return the email address of the calendar owner. |
96 | */ | 96 | */ |
97 | const QString &getEmail(); | 97 | const QString &getEmail(); |
98 | /** | 98 | /** |
99 | Set the email address of the calendar owner. | 99 | Set the email address of the calendar owner. |
100 | */ | 100 | */ |
101 | void setEmail( const QString & ); | 101 | void setEmail( const QString & ); |
102 | 102 | ||
103 | /** | 103 | /** |
104 | Set time zone from a timezone string (e.g. -2:00) | 104 | Set time zone from a timezone string (e.g. -2:00) |
105 | */ | 105 | */ |
106 | void setTimeZone( const QString &tz ); | 106 | void setTimeZone( const QString &tz ); |
107 | /** | 107 | /** |
108 | Set time zone from a minutes value (e.g. -60) | 108 | Set time zone from a minutes value (e.g. -60) |
109 | */ | 109 | */ |
110 | void setTimeZone( int tz ); | 110 | void setTimeZone( int tz ); |
111 | /** | 111 | /** |
112 | Return time zone as offest in minutes. | 112 | Return time zone as offest in minutes. |
113 | */ | 113 | */ |
114 | int getTimeZone() const; | 114 | int getTimeZone() const; |
115 | /** | 115 | /** |
116 | Compute an ISO 8601 format string from the time zone. | 116 | Compute an ISO 8601 format string from the time zone. |
117 | */ | 117 | */ |
118 | QString getTimeZoneStr() const; | 118 | QString getTimeZoneStr() const; |
119 | /** | 119 | /** |
120 | Set time zone id (see /usr/share/zoneinfo/zone.tab for list of legal | 120 | Set time zone id (see /usr/share/zoneinfo/zone.tab for list of legal |
121 | values). | 121 | values). |
122 | */ | 122 | */ |
123 | void setTimeZoneId( const QString & ); | 123 | void setTimeZoneId( const QString & ); |
124 | /** | 124 | /** |
125 | Return time zone id. | 125 | Return time zone id. |
126 | */ | 126 | */ |
127 | QString timeZoneId() const; | 127 | QString timeZoneId() const; |
128 | /** | 128 | /** |
129 | Use local time, not UTC or a time zone. | 129 | Use local time, not UTC or a time zone. |
130 | */ | 130 | */ |
131 | void setLocalTime(); | 131 | void setLocalTime(); |
132 | /** | 132 | /** |
133 | Return whether local time is being used. | 133 | Return whether local time is being used. |
134 | */ | 134 | */ |
135 | bool isLocalTime() const; | 135 | bool isLocalTime() const; |
136 | 136 | ||
137 | /** | 137 | /** |
138 | Add an incidence to calendar. | 138 | Add an incidence to calendar. |
139 | 139 | ||
140 | @return true on success, false on error. | 140 | @return true on success, false on error. |
141 | */ | 141 | */ |
142 | virtual bool addIncidence( Incidence * ); | 142 | virtual bool addIncidence( Incidence * ); |
143 | |||
144 | // Adds an incidence and all relatedto incidences to the cal | ||
145 | void addIncidenceBranch( Incidence * ); | ||
143 | /** | 146 | /** |
144 | Return filtered list of all incidences of this calendar. | 147 | Return filtered list of all incidences of this calendar. |
145 | */ | 148 | */ |
146 | virtual QPtrList<Incidence> incidences(); | 149 | virtual QPtrList<Incidence> incidences(); |
147 | 150 | ||
148 | /** | 151 | /** |
149 | Return unfiltered list of all incidences of this calendar. | 152 | Return unfiltered list of all incidences of this calendar. |
150 | */ | 153 | */ |
151 | virtual QPtrList<Incidence> rawIncidences(); | 154 | virtual QPtrList<Incidence> rawIncidences(); |
152 | 155 | ||
153 | /** | 156 | /** |
154 | Adds a Event to this calendar object. | 157 | Adds a Event to this calendar object. |
155 | @param anEvent a pointer to the event to add | 158 | @param anEvent a pointer to the event to add |
156 | 159 | ||
157 | @return true on success, false on error. | 160 | @return true on success, false on error. |
158 | */ | 161 | */ |
159 | virtual bool addEventNoDup( Event *event ) = 0; | 162 | virtual bool addEventNoDup( Event *event ) = 0; |
160 | virtual bool addAnniversaryNoDup( Event *event ) = 0; | 163 | virtual bool addAnniversaryNoDup( Event *event ) = 0; |
161 | virtual bool addEvent( Event *anEvent ) = 0; | 164 | virtual bool addEvent( Event *anEvent ) = 0; |
162 | /** | 165 | /** |
163 | Delete event from calendar. | 166 | Delete event from calendar. |
164 | */ | 167 | */ |
165 | virtual void deleteEvent( Event * ) = 0; | 168 | virtual void deleteEvent( Event * ) = 0; |
166 | /** | 169 | /** |
167 | Retrieves an event on the basis of the unique string ID. | 170 | Retrieves an event on the basis of the unique string ID. |
168 | */ | 171 | */ |
169 | virtual Event *event( const QString &UniqueStr ) = 0; | 172 | virtual Event *event( const QString &UniqueStr ) = 0; |
170 | virtual Event *event( QString, QString ) = 0; | 173 | virtual Event *event( QString, QString ) = 0; |
171 | /** | 174 | /** |
172 | Builds and then returns a list of all events that match for the | 175 | Builds and then returns a list of all events that match for the |
173 | date specified. useful for dayView, etc. etc. | 176 | date specified. useful for dayView, etc. etc. |
174 | The calendar filter is applied. | 177 | The calendar filter is applied. |
175 | */ | 178 | */ |
176 | QPtrList<Event> events( const QDate &date, bool sorted = false); | 179 | QPtrList<Event> events( const QDate &date, bool sorted = false); |
177 | /** | 180 | /** |
178 | Get events, which occur on the given date. | 181 | Get events, which occur on the given date. |
179 | The calendar filter is applied. | 182 | The calendar filter is applied. |
180 | */ | 183 | */ |
181 | QPtrList<Event> events( const QDateTime &qdt ); | 184 | QPtrList<Event> events( const QDateTime &qdt ); |
182 | /** | 185 | /** |
183 | Get events in a range of dates. If inclusive is set to true, only events | 186 | Get events in a range of dates. If inclusive is set to true, only events |
184 | are returned, which are completely included in the range. | 187 | are returned, which are completely included in the range. |
185 | The calendar filter is applied. | 188 | The calendar filter is applied. |
186 | */ | 189 | */ |
187 | QPtrList<Event> events( const QDate &start, const QDate &end, | 190 | QPtrList<Event> events( const QDate &start, const QDate &end, |
188 | bool inclusive = false); | 191 | bool inclusive = false); |
189 | /** | 192 | /** |
190 | Return filtered list of all events in calendar. | 193 | Return filtered list of all events in calendar. |
191 | */ | 194 | */ |
192 | virtual QPtrList<Event> events(); | 195 | virtual QPtrList<Event> events(); |
193 | /** | 196 | /** |
194 | Return unfiltered list of all events in calendar. | 197 | Return unfiltered list of all events in calendar. |
195 | */ | 198 | */ |
196 | virtual QPtrList<Event> rawEvents() = 0; | 199 | virtual QPtrList<Event> rawEvents() = 0; |
197 | 200 | ||
198 | /** | 201 | /** |
199 | Add a todo to the todolist. | 202 | Add a todo to the todolist. |
200 | 203 | ||
201 | @return true on success, false on error. | 204 | @return true on success, false on error. |
202 | */ | 205 | */ |
203 | virtual bool addTodo( Todo *todo ) = 0; | 206 | virtual bool addTodo( Todo *todo ) = 0; |
204 | virtual bool addTodoNoDup( Todo *todo ) = 0; | 207 | virtual bool addTodoNoDup( Todo *todo ) = 0; |
205 | /** | 208 | /** |
206 | Remove a todo from the todolist. | 209 | Remove a todo from the todolist. |
207 | */ | 210 | */ |
208 | virtual void deleteTodo( Todo * ) = 0; | 211 | virtual void deleteTodo( Todo * ) = 0; |
209 | virtual void deleteJournal( Journal * ) = 0; | 212 | virtual void deleteJournal( Journal * ) = 0; |
210 | /** | 213 | /** |
211 | Return filterd list of todos. | 214 | Return filterd list of todos. |
212 | */ | 215 | */ |
213 | virtual QPtrList<Todo> todos(); | 216 | virtual QPtrList<Todo> todos(); |
214 | /** | 217 | /** |
215 | Searches todolist for an event with this unique string identifier, | 218 | Searches todolist for an event with this unique string identifier, |
216 | returns a pointer or null. | 219 | returns a pointer or null. |
217 | */ | 220 | */ |
218 | virtual Todo *todo( const QString &uid ) = 0; | 221 | virtual Todo *todo( const QString &uid ) = 0; |
219 | virtual Todo *todo( QString, QString ) = 0; | 222 | virtual Todo *todo( QString, QString ) = 0; |
220 | /** | 223 | /** |
221 | Returns list of todos due on the specified date. | 224 | Returns list of todos due on the specified date. |
222 | */ | 225 | */ |
223 | virtual QPtrList<Todo> todos( const QDate &date ) = 0; | 226 | virtual QPtrList<Todo> todos( const QDate &date ) = 0; |
224 | /** | 227 | /** |
225 | Return unfiltered list of todos. | 228 | Return unfiltered list of todos. |
226 | */ | 229 | */ |
227 | virtual QPtrList<Todo> rawTodos() = 0; | 230 | virtual QPtrList<Todo> rawTodos() = 0; |
228 | 231 | ||
229 | /** | 232 | /** |
230 | Add a Journal entry to calendar. | 233 | Add a Journal entry to calendar. |
231 | 234 | ||
232 | @return true on success, false on error. | 235 | @return true on success, false on error. |
233 | */ | 236 | */ |
234 | virtual bool addJournal( Journal * ) = 0; | 237 | virtual bool addJournal( Journal * ) = 0; |
235 | /** | 238 | /** |
236 | Return Journal for given date. | 239 | Return Journal for given date. |
237 | */ | 240 | */ |
238 | virtual Journal *journal( const QDate & ) = 0; | 241 | virtual Journal *journal( const QDate & ) = 0; |