KCal::Alarm Class Reference
This class represents an alarm notification. More...
#include <alarm.h>
Inherits KCal::CustomProperties.
Public Types
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
Detailed Description
This class represents an alarm notification.
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.
|
|
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.
|
|
Return the type of the alarm.
|
|
Set the alarm to be a display alarm.
|
|
Set the text to be displayed when the alarm is triggered. Ignored if the alarm is not a display alarm. |
|
Return the text string that displays when the alarm is triggered.
|
|
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. |
|
Return the name of the audio file for the alarm.
|
|
Set the alarm to be a procedure alarm.
|
|
Set the program file to execute when the alarm is triggered. Ignored if the alarm is not a procedure alarm. |
|
Return the name of the program file to execute when the alarm is triggered.
|
|
Set the arguments to the program to execute when the alarm is triggered. Ignored if the alarm is not a procedure alarm. |
|
Return the arguments to the program to run when the alarm is triggered.
|
|
Set the alarm to be an email alarm.
|
|
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. |
|
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. |
|
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. |
|
Return the subject line of the mail.
|
|
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. |
|
Add this filename to the list of files to attach to the email. Ignored if the alarm is not an email alarm. |
|
Return the filenames to attach to the email.
|
|
Set the email body text. Ignored if the alarm is not an email alarm. |
|
Return the email body text.
|
|
Set the time to trigger an alarm.
|
|
Return the date/time when an alarm goes off.
|
|
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 true, if the alarm has an explicit date/time.
|
|
Set offset of alarm in time relative to the start of the event.
|
|
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 whether the alarm is defined in terms of an offset relative to the start of the event.
|
|
Set offset of alarm in time relative to the end of the event.
|
|
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 whether the alarm is defined in terms of an offset relative to the end of the event.
|
|
Set the interval between snoozes for the alarm.
|
|
Get how long the alarm snooze interval is.
|
|
Set how many times an alarm is to repeat itself after its initial occurrence (w/snoozes).
|
|
Get how many times an alarm repeats, after its initial occurrence.
|
|
Get the time of the alarm's initial occurrence or its next repetition, after a given time.
|
|
Get the time of the alarm's latest repetition, or its initial occurrence if none, before a given time.
|
|
Get how long between the alarm's initial occurrence and its final repetition.
|
|
Toggles the value of alarm to be either on or off. Set's the alarm time to be x minutes before dtStart time. |
|
Set the alarm enabled status.
|
|
Get the alarm enabled status.
|
|
Set the alarm's parent incidence.
|
|
Get the alarm's parent incidence.
|
The documentation for this class was generated from the following files:
- alarm.h
- alarm.cpp