-rw-r--r-- | libkcal/alarm.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/libkcal/alarm.h b/libkcal/alarm.h index ae2eca3..682b626 100644 --- a/libkcal/alarm.h +++ b/libkcal/alarm.h | |||
@@ -1,157 +1,157 @@ | |||
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 | 61 | int offset(); | |
62 | /** Set the alarm to be a display alarm. | 62 | /** Set the alarm to be a display alarm. |
63 | @param text text to display when the alarm is triggered. | 63 | @param text text to display when the alarm is triggered. |
64 | */ | 64 | */ |
65 | void setDisplayAlarm(const QString &text); | 65 | void setDisplayAlarm(const QString &text); |
66 | /** Set the text to be displayed when the alarm is triggered. | 66 | /** Set the text to be displayed when the alarm is triggered. |
67 | Ignored if the alarm is not a display alarm. | 67 | Ignored if the alarm is not a display alarm. |
68 | */ | 68 | */ |
69 | void setText(const QString &text); | 69 | void setText(const QString &text); |
70 | /** Return the text string that displays when the alarm is triggered. */ | 70 | /** Return the text string that displays when the alarm is triggered. */ |
71 | QString text() const; | 71 | QString text() const; |
72 | 72 | ||
73 | /** Set the alarm to be an audio alarm. | 73 | /** Set the alarm to be an audio alarm. |
74 | @param audioFile optional file to play when the alarm is triggered. | 74 | @param audioFile optional file to play when the alarm is triggered. |
75 | */ | 75 | */ |
76 | void setAudioAlarm(const QString &audioFile = QString::null); | 76 | void setAudioAlarm(const QString &audioFile = QString::null); |
77 | /** Set the file to play when the audio alarm is triggered. | 77 | /** Set the file to play when the audio alarm is triggered. |
78 | Ignored if the alarm is not an audio alarm. | 78 | Ignored if the alarm is not an audio alarm. |
79 | */ | 79 | */ |
80 | void setAudioFile(const QString &audioFile); | 80 | void setAudioFile(const QString &audioFile); |
81 | /** Return the name of the audio file for the alarm. | 81 | /** 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. | 82 | @return The audio file for the alarm, or QString::null if not an audio alarm. |
83 | */ | 83 | */ |
84 | QString audioFile() const; | 84 | QString audioFile() const; |
85 | 85 | ||
86 | /** Set the alarm to be a procedure alarm. | 86 | /** Set the alarm to be a procedure alarm. |
87 | @param programFile program to execute when the alarm is triggered. | 87 | @param programFile program to execute when the alarm is triggered. |
88 | @param arguments arguments to supply to programFile. | 88 | @param arguments arguments to supply to programFile. |
89 | */ | 89 | */ |
90 | void setProcedureAlarm(const QString &programFile, const QString &arguments = QString::null); | 90 | void setProcedureAlarm(const QString &programFile, const QString &arguments = QString::null); |
91 | /** Set the program file to execute when the alarm is triggered. | 91 | /** Set the program file to execute when the alarm is triggered. |
92 | Ignored if the alarm is not a procedure alarm. | 92 | Ignored if the alarm is not a procedure alarm. |
93 | */ | 93 | */ |
94 | void setProgramFile(const QString &programFile); | 94 | void setProgramFile(const QString &programFile); |
95 | /** Return the name of the program file to execute when the alarm is triggered. | 95 | /** 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. | 96 | @return the program file name, or QString::null if not a procedure alarm. |
97 | */ | 97 | */ |
98 | QString programFile() const; | 98 | QString programFile() const; |
99 | /** Set the arguments to the program to execute when the alarm is triggered. | 99 | /** Set the arguments to the program to execute when the alarm is triggered. |
100 | Ignored if the alarm is not a procedure alarm. | 100 | Ignored if the alarm is not a procedure alarm. |
101 | */ | 101 | */ |
102 | void setProgramArguments(const QString &arguments); | 102 | void setProgramArguments(const QString &arguments); |
103 | /** Return the arguments to the program to run when the alarm is triggered. | 103 | /** 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. | 104 | @return the program arguments, or QString::null if not a procedure alarm. |
105 | */ | 105 | */ |
106 | QString programArguments() const; | 106 | QString programArguments() const; |
107 | 107 | ||
108 | /** Set the alarm to be an email alarm. | 108 | /** Set the alarm to be an email alarm. |
109 | @param subject subject line of email. | 109 | @param subject subject line of email. |
110 | @param text body of email. | 110 | @param text body of email. |
111 | @param addressees email addresses of recipient(s). | 111 | @param addressees email addresses of recipient(s). |
112 | @param attachments optional names of files to attach to the email. | 112 | @param attachments optional names of files to attach to the email. |
113 | */ | 113 | */ |
114 | void setEmailAlarm(const QString &subject, const QString &text, const QValueList<Person> &addressees, | 114 | void setEmailAlarm(const QString &subject, const QString &text, const QValueList<Person> &addressees, |
115 | const QStringList &attachments = QStringList()); | 115 | const QStringList &attachments = QStringList()); |
116 | 116 | ||
117 | /** Send mail to this address when the alarm is triggered. | 117 | /** Send mail to this address when the alarm is triggered. |
118 | Ignored if the alarm is not an email alarm. | 118 | Ignored if the alarm is not an email alarm. |
119 | */ | 119 | */ |
120 | void setMailAddress(const Person &mailAlarmAddress); | 120 | void setMailAddress(const Person &mailAlarmAddress); |
121 | /** Send mail to these addresses when the alarm is triggered. | 121 | /** Send mail to these addresses when the alarm is triggered. |
122 | Ignored if the alarm is not an email alarm. | 122 | Ignored if the alarm is not an email alarm. |
123 | */ | 123 | */ |
124 | void setMailAddresses(const QValueList<Person> &mailAlarmAddresses); | 124 | void setMailAddresses(const QValueList<Person> &mailAlarmAddresses); |
125 | /** Add this address to the list of addresses to send mail to when the alarm is triggered. | 125 | /** 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. | 126 | Ignored if the alarm is not an email alarm. |
127 | */ | 127 | */ |
128 | void addMailAddress(const Person &mailAlarmAddress); | 128 | void addMailAddress(const Person &mailAlarmAddress); |
129 | /** return the addresses to send mail to when an alarm goes off */ | 129 | /** return the addresses to send mail to when an alarm goes off */ |
130 | QValueList<Person> mailAddresses() const; | 130 | QValueList<Person> mailAddresses() const; |
131 | 131 | ||
132 | /** Set the subject line of the mail. | 132 | /** Set the subject line of the mail. |
133 | Ignored if the alarm is not an email alarm. | 133 | Ignored if the alarm is not an email alarm. |
134 | */ | 134 | */ |
135 | void setMailSubject(const QString &mailAlarmSubject); | 135 | void setMailSubject(const QString &mailAlarmSubject); |
136 | /** return the subject line of the mail */ | 136 | /** return the subject line of the mail */ |
137 | QString mailSubject() const; | 137 | QString mailSubject() const; |
138 | 138 | ||
139 | /** Attach this filename to the email. | 139 | /** Attach this filename to the email. |
140 | Ignored if the alarm is not an email alarm. | 140 | Ignored if the alarm is not an email alarm. |
141 | */ | 141 | */ |
142 | void setMailAttachment(const QString &mailAttachFile); | 142 | void setMailAttachment(const QString &mailAttachFile); |
143 | /** Attach these filenames to the email. | 143 | /** Attach these filenames to the email. |
144 | Ignored if the alarm is not an email alarm. | 144 | Ignored if the alarm is not an email alarm. |
145 | */ | 145 | */ |
146 | void setMailAttachments(const QStringList &mailAttachFiles); | 146 | void setMailAttachments(const QStringList &mailAttachFiles); |
147 | /** Add this filename to the list of files to attach to the email. | 147 | /** Add this filename to the list of files to attach to the email. |
148 | Ignored if the alarm is not an email alarm. | 148 | Ignored if the alarm is not an email alarm. |
149 | */ | 149 | */ |
150 | void addMailAttachment(const QString &mailAttachFile); | 150 | void addMailAttachment(const QString &mailAttachFile); |
151 | /** return the filenames to attach to the email */ | 151 | /** return the filenames to attach to the email */ |
152 | QStringList mailAttachments() const; | 152 | QStringList mailAttachments() const; |
153 | 153 | ||
154 | /** Set the email body text. | 154 | /** Set the email body text. |
155 | Ignored if the alarm is not an email alarm. | 155 | Ignored if the alarm is not an email alarm. |
156 | */ | 156 | */ |
157 | void setMailText(const QString &text); | 157 | void setMailText(const QString &text); |