KCal::Alarm Class Reference
This class represents an alarm notification. More...
#include <alarm.h>
Public Types | |
typedef QValueList< Alarm * > | List |
Public Member Functions | |
Alarm (Incidence *parent) | |
Constructs a new alarm with variables initialized to "sane" values. | |
~Alarm () | |
Destruct Alarm object. | |
void | setAudioFile (const QString &audioAlarmFile) |
set the event to have this file as the noise for the alarm. | |
QString | audioFile () const |
return the name of the audio file for the alarm | |
void | setProgramFile (const QString &programAlarmFile) |
set this program to run when an alarm is triggered | |
QString | programFile () const |
return the name of the program to run when an alarm is triggered | |
void | setMailAddress (const QString &mailAlarmAddress) |
send mail to this address when an alarm goes off | |
void | setMailAddresses (const QStringList &mailAlarmAddresses) |
send mail to these addresses when an alarm goes off | |
void | addMailAddress (const QString &mailAlarmAddress) |
add this address to the list of addresses to send mail to when an alarm goes off | |
QStringList | mailAddresses () const |
return the addresses to send mail to when an alarm goes off | |
void | setMailSubject (const QString &mailAlarmSubject) |
set the subject line of the mail | |
QString | mailSubject () const |
return the subject line of the mail | |
void | setMailAttachment (const QString &mailAttachFile) |
attach this filename to the email | |
void | setMailAttachments (const QStringList &mailAttachFiles) |
attach these filenames to the email | |
void | addMailAttachment (const QString &mailAttachFile) |
add this filename to the list of files to attach to the email | |
QStringList | mailAttachments () const |
return the filenames to attach to the email | |
void | setText (const QString &alarmText) |
set the text to display when an alarm goes off | |
QString | text () const |
return the text string that displays when an alarm goes off | |
void | setTime (const QDateTime &alarmTime) |
set the time to trigger an alarm | |
QDateTime | time () const |
return the date/time when an alarm goes off | |
bool | hasTime () const |
Return true, if the alarm has an explicit date/time. | |
void | setOffset (const Duration &) |
Set offset of alarm in time relative to the start of the event. | |
Duration | offset () const |
Return offset of alarm in time relative to the start of the event. | |
void | setSnoozeTime (int alarmSnoozeTime) |
set the interval between snoozes for the alarm | |
int | snoozeTime () const |
get how long the alarm snooze interval is | |
void | setRepeatCount (int alarmRepeatCount) |
set how many times an alarm is to repeat itself (w/snoozes) | |
int | repeatCount () const |
get how many times an alarm repeats | |
void | toggleAlarm () |
toggles the value of alarm to be either on or off. | |
void | setEnabled (bool enable) |
set the alarm enabled status | |
bool | enabled () const |
get the alarm enabled status | |
void | setParent (Incidence *) |
Set the alarm's parent incidence. | |
Incidence * | parent () const |
get the alarm's parent incidence |
Detailed Description
This class represents an alarm notification.
Definition at line 35 of file alarm.h.
Constructor & Destructor Documentation
|
Constructs a new alarm with variables initialized to "sane" values.
|
|
Destruct Alarm object.
|
Member Function Documentation
|
set the event to have this file as the noise for the alarm.
Definition at line 46 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
return the name of the audio file for the alarm
Definition at line 52 of file alarm.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
set this program to run when an alarm is triggered
Definition at line 57 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
return the name of the program to run when an alarm is triggered
Definition at line 63 of file alarm.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
send mail to this address when an alarm goes off
Definition at line 68 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
send mail to these addresses when an alarm goes off
Definition at line 75 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
add this address to the list of addresses to send mail to when an alarm goes off
Definition at line 81 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
Definition at line 92 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
return the subject line of the mail
|
|
attach this filename to the email
Definition at line 103 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
attach these filenames to the email
Definition at line 110 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
add this filename to the list of files to attach to the email
Definition at line 116 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
return the filenames to attach to the email
|
|
set the text to display when an alarm goes off
Definition at line 127 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
return the text string that displays when an alarm goes off
|
|
set the time to trigger an alarm
Definition at line 138 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
return the date/time when an alarm goes off
Definition at line 146 of file alarm.cpp. References KCal::Todo::dtDue(), KCal::IncidenceBase::dtStart(), hasTime(), and KCal::IncidenceBase::type(). Referenced by KCal::CalendarLocal::appendAlarms(), KCal::CalendarLocal::appendRecurringAlarms(), KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Return true, if the alarm has an explicit date/time.
Definition at line 160 of file alarm.cpp. Referenced by time(). |
|
Set offset of alarm in time relative to the start of the event.
Definition at line 212 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
Return offset of alarm in time relative to the start of the event.
|
|
set the interval between snoozes for the alarm
Definition at line 165 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 176 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 190 of file alarm.cpp. References KCal::IncidenceBase::updated(). |
|
set the alarm enabled status
Definition at line 201 of file alarm.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
get the alarm enabled status
Definition at line 207 of file alarm.cpp. Referenced by KCal::CalendarLocal::appendAlarms(), KCal::CalendarLocal::appendRecurringAlarms(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::Incidence::isAlarmEnabled(). |
|
Set the alarm's parent incidence.
|
|
get the alarm's parent incidence
|
The documentation for this class was generated from the following files: