KCal Library
alarm.cpp
Go to the documentation of this file.
This file is part of the API for handling calendar data and defines the Alarm class.
bool hasStartOffset() const
Returns whether the alarm is defined in terms of an offset relative to the start of the parent Incide...
Definition alarm.cpp:606
QString programFile() const
Returns the program file name for a Procedure alarm type.
Definition alarm.cpp:258
void setMailAddress(const Person &mailAlarmAddress)
Sets the email address of an Email type alarm.
Definition alarm.cpp:292
void setRepeatCount(int alarmRepeatCount)
Sets how many times an alarm is to repeat itself after its initial occurrence (w/snoozes).
Definition alarm.cpp:480
void setDisplayAlarm(const QString &text=QString())
Sets the Display type for this alarm.
Definition alarm.cpp:394
void addMailAddress(const Person &mailAlarmAddress)
Adds an address to the list of email addresses to send mail to when the alarm is triggered.
Definition alarm.cpp:313
void setMailAttachment(const QString &mailAttachFile)
Sets the filename to attach to a mail message for an Email alarm type.
Definition alarm.cpp:343
Duration endOffset() const
Returns offset of alarm in time relative to the end of the event.
Definition alarm.cpp:626
bool hasEndOffset() const
Returns whether the alarm is defined in terms of an offset relative to the end of the event.
Definition alarm.cpp:611
QString programArguments() const
Returns the program arguments string for a Procedure alarm type.
Definition alarm.cpp:273
KDateTime previousRepetition(const KDateTime &afterTime) const
Returns the date/time of the alarm's latest repetition or, if none, its initial occurrence before a g...
Definition alarm.cpp:529
void setText(const QString &text)
Sets the description text to be displayed when the alarm is triggered.
Definition alarm.cpp:405
Duration startOffset() const
Returns offset of alarm in time relative to the start of the parent Incidence.
Definition alarm.cpp:601
void setSnoozeTime(const Duration &alarmSnoozeTime)
Sets the snooze time interval for the alarm.
Definition alarm.cpp:465
QList< Person > mailAddresses() const
Returns the list of addresses for an Email alarm type.
Definition alarm.cpp:323
void setProgramFile(const QString &programFile)
Sets the program file to execute when the alarm is triggered.
Definition alarm.cpp:248
QStringList mailAttachments() const
Returns the list of attachment filenames for an Email alarm type.
Definition alarm.cpp:374
Incidence * parent() const
Returns a pointer to the parent incidence of the alarm.
Definition alarm.cpp:636
void setMailSubject(const QString &mailAlarmSubject)
Sets the subject line of a mail message for an Email alarm type.
Definition alarm.cpp:328
QString audioFile() const
Returns the audio file name for an Audio alarm type.
Definition alarm.cpp:232
void setAudioFile(const QString &audioFile)
Sets the name of the audio file to play when the audio alarm is triggered.
Definition alarm.cpp:222
Duration duration() const
Returns the interval between the alarm's initial occurrence and its final repetition.
Definition alarm.cpp:493
QString mailSubject() const
Returns the subject line string for an Email alarm type.
Definition alarm.cpp:338
void setAudioAlarm(const QString &audioFile=QString())
Sets the Audio type for this alarm and the name of the audio file to play when the alarm is triggered...
Definition alarm.cpp:213
void setProgramArguments(const QString &arguments)
Sets the program arguments string when the alarm is triggered.
Definition alarm.cpp:263
Alarm(Incidence *parent)
Constructs an alarm belonging to the parent Incidence.
Definition alarm.cpp:99
bool enabled() const
Returns the alarm enabled status: true (enabled) or false (disabled).
Definition alarm.cpp:586
QString text() const
Returns the display text string for a Display alarm type.
Definition alarm.cpp:415
void addMailAttachment(const QString &mailAttachFile)
Adds a filename to the list of files to attach to a mail message for an Email alarm type.
Definition alarm.cpp:364
void toggleAlarm()
Toggles the alarm status, i.e, an enable alarm becomes disabled and a disabled alarm becomes enabled.
Definition alarm.cpp:570
void setStartOffset(const Duration &offset)
Sets the alarm offset relative to the start of the parent Incidence.
Definition alarm.cpp:591
void shiftTimes(const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
Shift the times of the alarm so that they appear at the same clock time as before but in a new time z...
Definition alarm.cpp:455
KDateTime nextRepetition(const KDateTime &preTime) const
Returns the date/time of the alarm's initial occurrence or its next repetition after a given time.
Definition alarm.cpp:499
void setMailAddresses(const QList< Person > &mailAlarmAddresses)
Sets a list of email addresses of an Email type alarm.
Definition alarm.cpp:303
void setMailAttachments(const QStringList &mailAttachFiles)
Sets a list of filenames to attach to a mail message for an Email alarm type.
Definition alarm.cpp:354
KDateTime endTime() const
Returns the date/time when the last repetition of the alarm goes off.
Definition alarm.cpp:558
void setEndOffset(const Duration &offset)
Sets the alarm offset relative to the end of the parent Incidence.
Definition alarm.cpp:616
int repeatCount() const
Returns how many times an alarm may repeats after its initial occurrence.
Definition alarm.cpp:488
void setEmailAlarm(const QString &subject, const QString &text, const QList< Person > &addressees, const QStringList &attachments=QStringList())
Sets the Email type for this alarm and the email subject, text, addresses, and attachments that make ...
Definition alarm.cpp:278
void setProcedureAlarm(const QString &programFile, const QString &arguments=QString())
Sets the Procedure type for this alarm and the program (with arguments) to execute when the alarm is ...
Definition alarm.cpp:237
void setMailText(const QString &text)
Sets the body text for an Email alarm type.
Definition alarm.cpp:379
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition incidence.h:70
This file is part of the API for handling calendar data and defines the Incidence class.
This file is part of the API for handling calendar data and defines the Todo class.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.