KCal::Alarm Class Reference
This class represents an alarm notification. More...
#include <alarm.h>
Inheritance diagram for KCal::Alarm:

Public Types | |
typedef ListBase< Alarm > | List |
enum | Type { Invalid, Display, Procedure, Email, Audio } |
Public Methods | |
Alarm (Incidence *parent) | |
~Alarm () | |
bool | operator== (const Alarm &) const |
bool | operator!= (const Alarm &a) const |
void | setType (Type type) |
Type | type () const |
void | setDisplayAlarm (const QString &text) |
void | setText (const QString &text) |
QString | text () const |
void | setAudioAlarm (const QString &audioFile=QString::null) |
void | setAudioFile (const QString &audioFile) |
QString | audioFile () const |
void | setProcedureAlarm (const QString &programFile, const QString &arguments=QString::null) |
void | setProgramFile (const QString &programFile) |
QString | programFile () const |
void | setProgramArguments (const QString &arguments) |
QString | programArguments () const |
void | setEmailAlarm (const QString &subject, const QString &text, const QValueList< Person > &addressees, const QStringList &attachments=QStringList()) |
void | setMailAddress (const Person &mailAlarmAddress) |
void | setMailAddresses (const QValueList< Person > &mailAlarmAddresses) |
void | addMailAddress (const Person &mailAlarmAddress) |
QValueList< Person > | mailAddresses () const |
void | setMailSubject (const QString &mailAlarmSubject) |
QString | mailSubject () const |
void | setMailAttachment (const QString &mailAttachFile) |
void | setMailAttachments (const QStringList &mailAttachFiles) |
void | addMailAttachment (const QString &mailAttachFile) |
QStringList | mailAttachments () const |
void | setMailText (const QString &text) |
QString | mailText () const |
void | setTime (const QDateTime &alarmTime) |
QDateTime | time () const |
bool | hasTime () const |
void | setStartOffset (const Duration &) |
Duration | startOffset () const |
bool | hasStartOffset () const |
void | setEndOffset (const Duration &) |
Duration | endOffset () const |
bool | hasEndOffset () const |
void | setSnoozeTime (int alarmSnoozeTime) |
int | snoozeTime () const |
void | setRepeatCount (int alarmRepeatCount) |
int | repeatCount () const |
void | toggleAlarm () |
void | setEnabled (bool enable) |
bool | enabled () const |
void | setParent (Incidence *) |
Incidence * | parent () const |
Detailed Description
This class represents an alarm notification.
Definition at line 40 of file alarm.h.
Constructor & Destructor Documentation
|
Construct a new alarm with variables initialized to "sane" values.
|
|
Destruct Alarm object.
|
Member Function Documentation
|
Compare this alarm with another one.
Definition at line 49 of file alarm.cpp. References mAlarmEnabled, mAlarmRepeatCount, mAlarmSnoozeTime, mAlarmTime, mDescription, mEndOffset, mFile, mHasTime, mMailAddresses, mMailAttachFiles, mMailSubject, mOffset, and mType. |
|
Set the type of the alarm. If the specified type is different from the current type of the alarm, the alarm's type-specific properties are initialised to null.
Definition at line 90 of file alarm.cpp. References QValueList< Person >::clear(), type(), and KCal::IncidenceBase::updated(). |
|
Return the type of the alarm.
Definition at line 119 of file alarm.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and setType(). |
|
Set the alarm to be a display alarm.
Definition at line 275 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Set the text to be displayed when the alarm is triggered. Ignored if the alarm is not a display alarm. Definition at line 282 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::load(). |
|
Return the text string that displays when the alarm is triggered.
|
|
Set the alarm to be an audio alarm.
Definition at line 124 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Set the file to play when the audio alarm is triggered. Ignored if the alarm is not an audio alarm. Definition at line 131 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return the name of the audio file for the alarm.
Definition at line 139 of file alarm.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Set the alarm to be a procedure alarm.
Definition at line 144 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Set the program file to execute when the alarm is triggered. Ignored if the alarm is not a procedure alarm. Definition at line 152 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return the name of the program file to execute when the alarm is triggered.
Definition at line 160 of file alarm.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Set the arguments to the program to execute when the alarm is triggered. Ignored if the alarm is not a procedure alarm. Definition at line 165 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return the arguments to the program to run when the alarm is triggered.
|
|
Set the alarm to be an email alarm.
Definition at line 178 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Send mail to this address when the alarm is triggered. Ignored if the alarm is not an email alarm. Definition at line 189 of file alarm.cpp. References QValueList< Person >::clear(), and KCal::IncidenceBase::updated(). |
|
Send mail to these addresses when the alarm is triggered. Ignored if the alarm is not an email alarm. Definition at line 198 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Add this address to the list of addresses to send mail to when the alarm is triggered. Ignored if the alarm is not an email alarm. Definition at line 206 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return the addresses to send mail to when an alarm goes off.
|
|
Set the subject line of the mail. Ignored if the alarm is not an email alarm. Definition at line 219 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return the subject line of the mail.
|
|
Attach this filename to the email. Ignored if the alarm is not an email alarm. Definition at line 232 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Attach these filenames to the email. Ignored if the alarm is not an email alarm. Definition at line 241 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Add this filename to the list of files to attach to the email. Ignored if the alarm is not an email alarm. Definition at line 249 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return the filenames to attach to the email.
|
|
Set the email body text. Ignored if the alarm is not an email alarm. Definition at line 262 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return the email body text.
|
|
Set the time to trigger an alarm.
Definition at line 295 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::load(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return the date/time when an alarm goes off.
Definition at line 303 of file alarm.cpp. References KCal::Todo::dtDue(), KCal::Incidence::dtEnd(), KCal::IncidenceBase::dtStart(), KCal::Duration::end(), hasTime(), and KCal::IncidenceBase::type(). Referenced by KCal::CalendarLocal::appendRecurringAlarms(), KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Return true, if the alarm has an explicit date/time.
Definition at line 320 of file alarm.cpp. Referenced by KCal::CalendarLocal::appendRecurringAlarms(), and time(). |
|
Set offset of alarm in time relative to the start of the event.
Definition at line 367 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::load(). |
|
Return offset of alarm in time relative to the start of the event. If the alarm's time is not defined in terms of an offset relative to the start of the event, returns zero. Definition at line 375 of file alarm.cpp. Referenced by KCal::CalendarLocal::appendRecurringAlarms(). |
|
Return whether the alarm is defined in terms of an offset relative to the start of the event.
Definition at line 380 of file alarm.cpp. Referenced by KCal::CalendarLocal::appendRecurringAlarms(). |
|
Set offset of alarm in time relative to the end of the event.
Definition at line 390 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return offset of alarm in time relative to the end of the event. If the alarm's time is not defined in terms of an offset relative to the end of the event, returns zero. Definition at line 398 of file alarm.cpp. Referenced by KCal::CalendarLocal::appendRecurringAlarms(). |
|
Return whether the alarm is defined in terms of an offset relative to the end of the event.
Definition at line 385 of file alarm.cpp. Referenced by KCal::CalendarLocal::appendRecurringAlarms(). |
|
Set the interval between snoozes for the alarm.
Definition at line 325 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Get how long the alarm snooze interval is.
|
|
Set how many times an alarm is to repeat itself (w/snoozes).
Definition at line 336 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Get how many times an alarm repeats.
|
|
Toggles the value of alarm to be either on or off. Set's the alarm time to be x minutes before dtStart time. Definition at line 350 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Set the alarm enabled status.
Definition at line 356 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::load(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Get the alarm enabled status.
Definition at line 362 of file alarm.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Set the alarm's parent incidence.
|
|
Get the alarm's parent incidence.
|
The documentation for this class was generated from the following files: