summaryrefslogtreecommitdiffabout
path: root/libkcal/alarm.h
Unidiff
Diffstat (limited to 'libkcal/alarm.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libkcal/alarm.h2
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
@@ -29,65 +29,65 @@
29#include "person.h" 29#include "person.h"
30 30
31namespace KCal { 31namespace KCal {
32 32
33class Incidence; 33class Incidence;
34 34
35/** 35/**
36 This class represents an alarm notification. 36 This class represents an alarm notification.
37*/ 37*/
38class Alarm : public CustomProperties 38class 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 */