libkcal
KCal::Alarm Class Reference
#include <alarm.h>
Inheritance diagram for KCal::Alarm:

Detailed Description
This class represents an alarm notification.
Definition at line 44 of file alarm.h.
Public Types | |
typedef ListBase< Alarm > | List |
enum | Type { Invalid, Display, Procedure, Email, Audio } |
Public Member Functions | |
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=QString::null) |
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 |
QDateTime | endTime () 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 |
QDateTime | nextRepetition (const QDateTime &preTime) const |
QDateTime | previousRepetition (const QDateTime &afterTime) const |
int | duration () const |
void | toggleAlarm () |
void | setEnabled (bool enable) |
bool | enabled () const |
void | setParent (Incidence *) |
Incidence * | parent () const |
Constructor & Destructor Documentation
|
Construct a new alarm with variables initialized to "sane" values.
|
|
Destruct Alarm object.
|
Member Function Documentation
|
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. |
|
Add this filename to the list of files to attach to the email. Ignored if the alarm is not an email alarm. |
|
Return the name of the audio file for the alarm.
|
|
Get how long between the alarm's initial occurrence and its final repetition.
|
|
Get the alarm enabled status.
|
|
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. |
|
Return the date/time when the last repetition of the alarm goes off. If the alarm does not repeat, this is equivalent to calling time(). |
|
Return whether the alarm is defined in terms of an offset relative to the end of the event.
|
|
Return whether the alarm is defined in terms of an offset relative to the start of the event.
|
|
Return true, if the alarm has an explicit date/time.
|
|
Return the addresses to send mail to when an alarm goes off.
|
|
Return the filenames to attach to the email.
|
|
Return the subject line of the mail.
|
|
Return the email body text.
|
|
Get the time of the alarm's initial occurrence or its next repetition, after a given time.
|
|
Compare this alarm with another one.
|
|
Get the alarm's parent incidence.
|
|
Get the time of the alarm's latest repetition, or its initial occurrence if none, before a given time.
|
|
Return the arguments to the program to run when the alarm is triggered.
|
|
Return the name of the program file to execute when the alarm is triggered.
|
|
Get how many times an alarm repeats, after its initial occurrence.
|
|
Set the alarm to be an audio alarm.
|
|
Set the file to play when the audio alarm is triggered. Ignored if the alarm is not an audio alarm. |
|
Set the alarm to be a display alarm.
|
|
Set the alarm to be an email alarm.
|
|
Set the alarm enabled status.
|
|
Set offset of alarm in time relative to the end of the event.
|
|
Send mail to this address when the alarm is triggered. Ignored if the alarm is not an email alarm. |
|
Send mail to these addresses when the alarm is triggered. Ignored if the alarm is not an email alarm. |
|
Attach this filename to the email. Ignored if the alarm is not an email alarm. |
|
Attach these filenames to the email. Ignored if the alarm is not an email alarm. |
|
Set the subject line of the mail. Ignored if the alarm is not an email alarm. |
|
Set the email body text. Ignored if the alarm is not an email alarm. |
|
Set the alarm's parent incidence.
|
|
Set the alarm to be a procedure alarm.
|
|
Set the arguments to the program to execute when the alarm is triggered. Ignored if the alarm is not a procedure alarm. |
|
Set the program file to execute when the alarm is triggered. Ignored if the alarm is not a procedure alarm. |
|
Set how many times an alarm is to repeat itself after its initial occurrence (w/snoozes).
|
|
Set the interval between snoozes for the alarm.
|
|
Set offset of alarm in time relative to the start of the event.
|
|
Set the text to be displayed when the alarm is triggered. Ignored if the alarm is not a display alarm. |
|
Set the time to trigger an alarm.
|
|
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.
|
|
Get how long the alarm snooze interval is.
|
|
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. |
|
Return the text string that displays when the alarm is triggered.
|
|
Return the date/time when an alarm goes off.
|
|
Toggles the value of alarm to be either on or off. Set's the alarm time to be x minutes before dtStart time. |
|
Return the type of the alarm.
|
The documentation for this class was generated from the following files: