-rw-r--r-- | libkcal/alarm.h | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/libkcal/alarm.h b/libkcal/alarm.h index 682b626..ac6ea0d 100644 --- a/libkcal/alarm.h +++ b/libkcal/alarm.h | |||
@@ -1,245 +1,246 @@ | |||
1 | /* | 1 | /* |
2 | This file is part of libkcal. | 2 | This file is part of libkcal. |
3 | Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> | 3 | Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org> |
4 | 4 | ||
5 | This library is free software; you can redistribute it and/or | 5 | This library is free software; you can redistribute it and/or |
6 | modify it under the terms of the GNU Library General Public | 6 | modify it under the terms of the GNU Library General Public |
7 | License as published by the Free Software Foundation; either | 7 | License as published by the Free Software Foundation; either |
8 | version 2 of the License, or (at your option) any later version. | 8 | version 2 of the License, or (at your option) any later version. |
9 | 9 | ||
10 | This library is distributed in the hope that it will be useful, | 10 | This library is distributed in the hope that it will be useful, |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
13 | Library General Public License for more details. | 13 | Library General Public License for more details. |
14 | 14 | ||
15 | You should have received a copy of the GNU Library General Public License | 15 | You should have received a copy of the GNU Library General Public License |
16 | along with this library; see the file COPYING.LIB. If not, write to | 16 | along with this library; see the file COPYING.LIB. If not, write to |
17 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | 17 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
18 | Boston, MA 02111-1307, USA. | 18 | Boston, MA 02111-1307, USA. |
19 | */ | 19 | */ |
20 | 20 | ||
21 | #ifndef KCAL_ALARM_H | 21 | #ifndef KCAL_ALARM_H |
22 | #define KCAL_ALARM_H | 22 | #define KCAL_ALARM_H |
23 | 23 | ||
24 | #include <qstring.h> | 24 | #include <qstring.h> |
25 | #include <qvaluelist.h> | 25 | #include <qvaluelist.h> |
26 | 26 | ||
27 | #include "customproperties.h" | 27 | #include "customproperties.h" |
28 | #include "duration.h" | 28 | #include "duration.h" |
29 | #include "person.h" | 29 | #include "person.h" |
30 | 30 | ||
31 | namespace KCal { | 31 | namespace KCal { |
32 | 32 | ||
33 | class Incidence; | 33 | class Incidence; |
34 | 34 | ||
35 | /** | 35 | /** |
36 | This class represents an alarm notification. | 36 | This class represents an alarm notification. |
37 | */ | 37 | */ |
38 | class Alarm : public CustomProperties | 38 | class Alarm : public CustomProperties |
39 | { | 39 | { |
40 | public: | 40 | public: |
41 | enum Type { Invalid, Display, Procedure, Email, Audio }; | 41 | enum Type { Invalid, Display, Procedure, Email, Audio }; |
42 | typedef QValueList<Alarm *> List; | 42 | typedef QValueList<Alarm *> List; |
43 | 43 | ||
44 | /** Construct a new alarm with variables initialized to "sane" values. */ | 44 | /** Construct a new alarm with variables initialized to "sane" values. */ |
45 | explicit Alarm(Incidence *parent); | 45 | explicit Alarm(Incidence *parent); |
46 | /** Destruct Alarm object. */ | 46 | /** Destruct Alarm object. */ |
47 | ~Alarm(); | 47 | ~Alarm(); |
48 | 48 | ||
49 | /** Compare this alarm with another one. */ | 49 | /** Compare this alarm with another one. */ |
50 | bool operator==(const Alarm &) const; | 50 | bool operator==(const Alarm &) const; |
51 | bool operator!=(const Alarm &a) const { return !operator==(a); } | 51 | bool operator!=(const Alarm &a) const { return !operator==(a); } |
52 | 52 | ||
53 | /** Set the type of the alarm. | 53 | /** Set the type of the alarm. |
54 | If the specified type is different from the current type of the alarm, | 54 | If the specified type is different from the current type of the alarm, |
55 | the alarm's type-specific properties are initialised to null. | 55 | the alarm's type-specific properties are initialised to null. |
56 | @param type type of alarm. | 56 | @param type type of alarm. |
57 | */ | 57 | */ |
58 | void setType(Type type); | 58 | void setType(Type type); |
59 | /** Return the type of the alarm */ | 59 | /** Return the type of the alarm */ |
60 | Type type() const; | 60 | Type type() const; |
61 | int offset(); | 61 | int offset(); |
62 | QString offsetText(); | ||
62 | /** Set the alarm to be a display alarm. | 63 | /** Set the alarm to be a display alarm. |
63 | @param text text to display when the alarm is triggered. | 64 | @param text text to display when the alarm is triggered. |
64 | */ | 65 | */ |
65 | void setDisplayAlarm(const QString &text); | 66 | void setDisplayAlarm(const QString &text); |
66 | /** Set the text to be displayed when the alarm is triggered. | 67 | /** Set the text to be displayed when the alarm is triggered. |
67 | Ignored if the alarm is not a display alarm. | 68 | Ignored if the alarm is not a display alarm. |
68 | */ | 69 | */ |
69 | void setText(const QString &text); | 70 | void setText(const QString &text); |
70 | /** Return the text string that displays when the alarm is triggered. */ | 71 | /** Return the text string that displays when the alarm is triggered. */ |
71 | QString text() const; | 72 | QString text() const; |
72 | 73 | ||
73 | /** Set the alarm to be an audio alarm. | 74 | /** Set the alarm to be an audio alarm. |
74 | @param audioFile optional file to play when the alarm is triggered. | 75 | @param audioFile optional file to play when the alarm is triggered. |
75 | */ | 76 | */ |
76 | void setAudioAlarm(const QString &audioFile = QString::null); | 77 | void setAudioAlarm(const QString &audioFile = QString::null); |
77 | /** Set the file to play when the audio alarm is triggered. | 78 | /** Set the file to play when the audio alarm is triggered. |
78 | Ignored if the alarm is not an audio alarm. | 79 | Ignored if the alarm is not an audio alarm. |
79 | */ | 80 | */ |
80 | void setAudioFile(const QString &audioFile); | 81 | void setAudioFile(const QString &audioFile); |
81 | /** Return the name of the audio file for the alarm. | 82 | /** Return the name of the audio file for the alarm. |
82 | @return The audio file for the alarm, or QString::null if not an audio alarm. | 83 | @return The audio file for the alarm, or QString::null if not an audio alarm. |
83 | */ | 84 | */ |
84 | QString audioFile() const; | 85 | QString audioFile() const; |
85 | 86 | ||
86 | /** Set the alarm to be a procedure alarm. | 87 | /** Set the alarm to be a procedure alarm. |
87 | @param programFile program to execute when the alarm is triggered. | 88 | @param programFile program to execute when the alarm is triggered. |
88 | @param arguments arguments to supply to programFile. | 89 | @param arguments arguments to supply to programFile. |
89 | */ | 90 | */ |
90 | void setProcedureAlarm(const QString &programFile, const QString &arguments = QString::null); | 91 | void setProcedureAlarm(const QString &programFile, const QString &arguments = QString::null); |
91 | /** Set the program file to execute when the alarm is triggered. | 92 | /** Set the program file to execute when the alarm is triggered. |
92 | Ignored if the alarm is not a procedure alarm. | 93 | Ignored if the alarm is not a procedure alarm. |
93 | */ | 94 | */ |
94 | void setProgramFile(const QString &programFile); | 95 | void setProgramFile(const QString &programFile); |
95 | /** Return the name of the program file to execute when the alarm is triggered. | 96 | /** Return the name of the program file to execute when the alarm is triggered. |
96 | @return the program file name, or QString::null if not a procedure alarm. | 97 | @return the program file name, or QString::null if not a procedure alarm. |
97 | */ | 98 | */ |
98 | QString programFile() const; | 99 | QString programFile() const; |
99 | /** Set the arguments to the program to execute when the alarm is triggered. | 100 | /** Set the arguments to the program to execute when the alarm is triggered. |
100 | Ignored if the alarm is not a procedure alarm. | 101 | Ignored if the alarm is not a procedure alarm. |
101 | */ | 102 | */ |
102 | void setProgramArguments(const QString &arguments); | 103 | void setProgramArguments(const QString &arguments); |
103 | /** Return the arguments to the program to run when the alarm is triggered. | 104 | /** Return the arguments to the program to run when the alarm is triggered. |
104 | @return the program arguments, or QString::null if not a procedure alarm. | 105 | @return the program arguments, or QString::null if not a procedure alarm. |
105 | */ | 106 | */ |
106 | QString programArguments() const; | 107 | QString programArguments() const; |
107 | 108 | ||
108 | /** Set the alarm to be an email alarm. | 109 | /** Set the alarm to be an email alarm. |
109 | @param subject subject line of email. | 110 | @param subject subject line of email. |
110 | @param text body of email. | 111 | @param text body of email. |
111 | @param addressees email addresses of recipient(s). | 112 | @param addressees email addresses of recipient(s). |
112 | @param attachments optional names of files to attach to the email. | 113 | @param attachments optional names of files to attach to the email. |
113 | */ | 114 | */ |
114 | void setEmailAlarm(const QString &subject, const QString &text, const QValueList<Person> &addressees, | 115 | void setEmailAlarm(const QString &subject, const QString &text, const QValueList<Person> &addressees, |
115 | const QStringList &attachments = QStringList()); | 116 | const QStringList &attachments = QStringList()); |
116 | 117 | ||
117 | /** Send mail to this address when the alarm is triggered. | 118 | /** Send mail to this address when the alarm is triggered. |
118 | Ignored if the alarm is not an email alarm. | 119 | Ignored if the alarm is not an email alarm. |
119 | */ | 120 | */ |
120 | void setMailAddress(const Person &mailAlarmAddress); | 121 | void setMailAddress(const Person &mailAlarmAddress); |
121 | /** Send mail to these addresses when the alarm is triggered. | 122 | /** Send mail to these addresses when the alarm is triggered. |
122 | Ignored if the alarm is not an email alarm. | 123 | Ignored if the alarm is not an email alarm. |
123 | */ | 124 | */ |
124 | void setMailAddresses(const QValueList<Person> &mailAlarmAddresses); | 125 | void setMailAddresses(const QValueList<Person> &mailAlarmAddresses); |
125 | /** Add this address to the list of addresses to send mail to when the alarm is triggered. | 126 | /** Add this address to the list of addresses to send mail to when the alarm is triggered. |
126 | Ignored if the alarm is not an email alarm. | 127 | Ignored if the alarm is not an email alarm. |
127 | */ | 128 | */ |
128 | void addMailAddress(const Person &mailAlarmAddress); | 129 | void addMailAddress(const Person &mailAlarmAddress); |
129 | /** return the addresses to send mail to when an alarm goes off */ | 130 | /** return the addresses to send mail to when an alarm goes off */ |
130 | QValueList<Person> mailAddresses() const; | 131 | QValueList<Person> mailAddresses() const; |
131 | 132 | ||
132 | /** Set the subject line of the mail. | 133 | /** Set the subject line of the mail. |
133 | Ignored if the alarm is not an email alarm. | 134 | Ignored if the alarm is not an email alarm. |
134 | */ | 135 | */ |
135 | void setMailSubject(const QString &mailAlarmSubject); | 136 | void setMailSubject(const QString &mailAlarmSubject); |
136 | /** return the subject line of the mail */ | 137 | /** return the subject line of the mail */ |
137 | QString mailSubject() const; | 138 | QString mailSubject() const; |
138 | 139 | ||
139 | /** Attach this filename to the email. | 140 | /** Attach this filename to the email. |
140 | Ignored if the alarm is not an email alarm. | 141 | Ignored if the alarm is not an email alarm. |
141 | */ | 142 | */ |
142 | void setMailAttachment(const QString &mailAttachFile); | 143 | void setMailAttachment(const QString &mailAttachFile); |
143 | /** Attach these filenames to the email. | 144 | /** Attach these filenames to the email. |
144 | Ignored if the alarm is not an email alarm. | 145 | Ignored if the alarm is not an email alarm. |
145 | */ | 146 | */ |
146 | void setMailAttachments(const QStringList &mailAttachFiles); | 147 | void setMailAttachments(const QStringList &mailAttachFiles); |
147 | /** Add this filename to the list of files to attach to the email. | 148 | /** Add this filename to the list of files to attach to the email. |
148 | Ignored if the alarm is not an email alarm. | 149 | Ignored if the alarm is not an email alarm. |
149 | */ | 150 | */ |
150 | void addMailAttachment(const QString &mailAttachFile); | 151 | void addMailAttachment(const QString &mailAttachFile); |
151 | /** return the filenames to attach to the email */ | 152 | /** return the filenames to attach to the email */ |
152 | QStringList mailAttachments() const; | 153 | QStringList mailAttachments() const; |
153 | 154 | ||
154 | /** Set the email body text. | 155 | /** Set the email body text. |
155 | Ignored if the alarm is not an email alarm. | 156 | Ignored if the alarm is not an email alarm. |
156 | */ | 157 | */ |
157 | void setMailText(const QString &text); | 158 | void setMailText(const QString &text); |
158 | /** Return the email body text. | 159 | /** Return the email body text. |
159 | @return the body text, or QString::null if not an email alarm. | 160 | @return the body text, or QString::null if not an email alarm. |
160 | */ | 161 | */ |
161 | QString mailText() const; | 162 | QString mailText() const; |
162 | 163 | ||
163 | /** set the time to trigger an alarm */ | 164 | /** set the time to trigger an alarm */ |
164 | void setTime(const QDateTime &alarmTime); | 165 | void setTime(const QDateTime &alarmTime); |
165 | /** return the date/time when an alarm goes off */ | 166 | /** return the date/time when an alarm goes off */ |
166 | QDateTime time() const; | 167 | QDateTime time() const; |
167 | /** Return true, if the alarm has an explicit date/time. */ | 168 | /** Return true, if the alarm has an explicit date/time. */ |
168 | bool hasTime() const; | 169 | bool hasTime() const; |
169 | 170 | ||
170 | /** Set offset of alarm in time relative to the start of the event. */ | 171 | /** Set offset of alarm in time relative to the start of the event. */ |
171 | void setStartOffset(const Duration &); | 172 | void setStartOffset(const Duration &); |
172 | /** Return offset of alarm in time relative to the start of the event. | 173 | /** Return offset of alarm in time relative to the start of the event. |
173 | * If the alarm's time is not defined in terms of an offset relative | 174 | * If the alarm's time is not defined in terms of an offset relative |
174 | * to the start of the event, returns zero. | 175 | * to the start of the event, returns zero. |
175 | */ | 176 | */ |
176 | Duration startOffset() const; | 177 | Duration startOffset() const; |
177 | /** Return whether the alarm is defined in terms of an offset relative | 178 | /** Return whether the alarm is defined in terms of an offset relative |
178 | * to the start of the event. | 179 | * to the start of the event. |
179 | */ | 180 | */ |
180 | bool hasStartOffset() const; | 181 | bool hasStartOffset() const; |
181 | 182 | ||
182 | /** Set offset of alarm in time relative to the end of the event. */ | 183 | /** Set offset of alarm in time relative to the end of the event. */ |
183 | void setEndOffset(const Duration &); | 184 | void setEndOffset(const Duration &); |
184 | /** Return offset of alarm in time relative to the end of the event. | 185 | /** Return offset of alarm in time relative to the end of the event. |
185 | * If the alarm's time is not defined in terms of an offset relative | 186 | * If the alarm's time is not defined in terms of an offset relative |
186 | * to the end of the event, returns zero. | 187 | * to the end of the event, returns zero. |
187 | */ | 188 | */ |
188 | Duration endOffset() const; | 189 | Duration endOffset() const; |
189 | /** Return whether the alarm is defined in terms of an offset relative | 190 | /** Return whether the alarm is defined in terms of an offset relative |
190 | * to the end of the event. | 191 | * to the end of the event. |
191 | */ | 192 | */ |
192 | bool hasEndOffset() const; | 193 | bool hasEndOffset() const; |
193 | 194 | ||
194 | /** Set the interval between snoozes for the alarm. | 195 | /** Set the interval between snoozes for the alarm. |
195 | @param snoozeTime the time in minutes between snoozes. | 196 | @param snoozeTime the time in minutes between snoozes. |
196 | */ | 197 | */ |
197 | void setSnoozeTime(int alarmSnoozeTime); | 198 | void setSnoozeTime(int alarmSnoozeTime); |
198 | /** Get how long the alarm snooze interval is. | 199 | /** Get how long the alarm snooze interval is. |
199 | @return the number of minutes between snoozes. | 200 | @return the number of minutes between snoozes. |
200 | */ | 201 | */ |
201 | int snoozeTime() const; | 202 | int snoozeTime() const; |
202 | 203 | ||
203 | /** set how many times an alarm is to repeat itself (w/snoozes) */ | 204 | /** set how many times an alarm is to repeat itself (w/snoozes) */ |
204 | void setRepeatCount(int alarmRepeatCount); | 205 | void setRepeatCount(int alarmRepeatCount); |
205 | /** get how many times an alarm repeats */ | 206 | /** get how many times an alarm repeats */ |
206 | int repeatCount() const; | 207 | int repeatCount() const; |
207 | 208 | ||
208 | /** toggles the value of alarm to be either on or off. | 209 | /** toggles the value of alarm to be either on or off. |
209 | set's the alarm time to be x minutes before dtStart time. */ | 210 | set's the alarm time to be x minutes before dtStart time. */ |
210 | void toggleAlarm(); | 211 | void toggleAlarm(); |
211 | 212 | ||
212 | /** set the alarm enabled status */ | 213 | /** set the alarm enabled status */ |
213 | void setEnabled(bool enable); | 214 | void setEnabled(bool enable); |
214 | /** get the alarm enabled status */ | 215 | /** get the alarm enabled status */ |
215 | bool enabled() const; | 216 | bool enabled() const; |
216 | 217 | ||
217 | /** Set the alarm's parent incidence */ | 218 | /** Set the alarm's parent incidence */ |
218 | void setParent( Incidence * ); | 219 | void setParent( Incidence * ); |
219 | /** get the alarm's parent incidence */ | 220 | /** get the alarm's parent incidence */ |
220 | Incidence *parent() const { return mParent; } | 221 | Incidence *parent() const { return mParent; } |
221 | 222 | ||
222 | private: | 223 | private: |
223 | Incidence *mParent; // the incidence which this alarm belongs to | 224 | Incidence *mParent; // the incidence which this alarm belongs to |
224 | Type mType; // type of alarm | 225 | Type mType; // type of alarm |
225 | QString mDescription; // text to display/email body/procedure arguments | 226 | QString mDescription; // text to display/email body/procedure arguments |
226 | QString mFile; // procedure program to run/optional audio file to play | 227 | QString mFile; // procedure program to run/optional audio file to play |
227 | QStringList mMailAttachFiles; // filenames to attach to email | 228 | QStringList mMailAttachFiles; // filenames to attach to email |
228 | QValueList<Person> mMailAddresses; // who to mail for reminder | 229 | QValueList<Person> mMailAddresses; // who to mail for reminder |
229 | QString mMailSubject; // subject of email | 230 | QString mMailSubject; // subject of email |
230 | 231 | ||
231 | int mAlarmSnoozeTime; // number of minutes after alarm to | 232 | int mAlarmSnoozeTime; // number of minutes after alarm to |
232 | // snooze before ringing again | 233 | // snooze before ringing again |
233 | int mAlarmRepeatCount; // number of times for alarm to repeat | 234 | int mAlarmRepeatCount; // number of times for alarm to repeat |
234 | // after the initial time | 235 | // after the initial time |
235 | 236 | ||
236 | QDateTime mAlarmTime; // time at which to trigger the alarm | 237 | QDateTime mAlarmTime; // time at which to trigger the alarm |
237 | Duration mOffset; // time relative to incidence DTSTART to trigger the alarm | 238 | Duration mOffset; // time relative to incidence DTSTART to trigger the alarm |
238 | bool mEndOffset; // if true, mOffset relates to DTEND, not DTSTART | 239 | bool mEndOffset; // if true, mOffset relates to DTEND, not DTSTART |
239 | bool mHasTime; // use mAlarmTime, not mOffset | 240 | bool mHasTime; // use mAlarmTime, not mOffset |
240 | bool mAlarmEnabled; | 241 | bool mAlarmEnabled; |
241 | }; | 242 | }; |
242 | 243 | ||
243 | } | 244 | } |
244 | 245 | ||
245 | #endif | 246 | #endif |