KCalendarCore::Alarm Class

Member Function Documentation

[explicit] Alarm::Alarm(KCalendarCore::Incidence *parent)

Constructs an alarm belonging to the parent Incidence.

parent is the Incidence this alarm will belong to.

Alarm::Alarm(const KCalendarCore::Alarm &other)

Copy constructor.

other is the alarm to copy.

[override virtual noexcept] Alarm::~Alarm()

Destroys the alarm.

void Alarm::addMailAddress(const KCalendarCore::Person &mailAlarmAddress)

Adds an address to the list of email addresses to send mail to when the alarm is triggered. Ignored if the alarm is not an Email type.

mailAlarmAddress is a Person to add to the list of addresses to receive a mail message when an Email type alarm is triggered.

See also setMailAddress(), setMailAddresses(), and mailAddresses().

void Alarm::addMailAttachment(const QString &mailAttachFile)

Adds a filename to the list of files to attach to a mail message for an Email alarm type. Ignored if the alarm is not an Email type.

mailAttachFile is a string containing a filename to be attached to an email message to send when the Email type alarm is triggered.

See also setMailAttachment(), setMailAttachments(), and mailAttachments().

QString Alarm::audioFile() const

Returns the audio file name for an Audio alarm type. Returns an empty string if the alarm is not an Audio type.

See also setAudioAlarm() and setAudioFile().

[override virtual protected] void Alarm::customPropertyUpdated()

Reimplements: CustomProperties::customPropertyUpdated().

KCalendarCore::Duration Alarm::duration() const

Returns the interval between the alarm's initial occurrence and its final repetition.

bool Alarm::enabled() const

Returns the alarm enabled status: true (enabled) or false (disabled).

See also setEnabled() and toggleAlarm().

KCalendarCore::Duration Alarm::endOffset() const

Returns 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.

See also setEndOffset() and hasEndOffset().

QDateTime Alarm::endTime() const

Returns the date/time when the last repetition of the alarm goes off. If the alarm does not repeat this is equivalent to calling time().

See also setTime().

bool Alarm::hasEndOffset() const

Returns whether the alarm is defined in terms of an offset relative to the end of the event.

See also endOffset() and setEndOffset().

bool Alarm::hasLocationRadius() const

Returns true if alarm has location radius defined.

See also setHasLocationRadius() and setLocationRadius().

bool Alarm::hasStartOffset() const

Returns whether the alarm is defined in terms of an offset relative to the start of the parent Incidence.

See also startOffset() and setStartOffset().

bool Alarm::hasTime() const

Returns true if the alarm has a trigger date/time.

int Alarm::locationRadius() const

Returns the location radius in meters.

See also setLocationRadius().

KCalendarCore::Person::List Alarm::mailAddresses() const

Returns the list of addresses for an Email alarm type. Returns an empty list if the alarm is not an Email type.

See also addMailAddress(), setMailAddress(), and setMailAddresses().

QStringList Alarm::mailAttachments() const

Returns the list of attachment filenames for an Email alarm type. Returns an empty list if the alarm is not an Email type.

See also addMailAttachment(), setMailAttachment(), and setMailAttachments().

QString Alarm::mailSubject() const

Returns the subject line string for an Email alarm type. Returns an empty string if the alarm is not an Email type.

See also setMailSubject().

QString Alarm::mailText() const

Returns the body text for an Email alarm type. Returns an empty string if the alarm is not an Email type.

See also setMailText().

QDateTime Alarm::nextRepetition(const QDateTime &preTime) const

Returns the date/time of the alarm's initial occurrence or its next repetition after a given time.

preTime the date/time after which to find the next repetition.

Returns the date/time of the next repetition, or an invalid date/time if the specified time is at or after the alarm's last repetition.

See also previousRepetition().

QDateTime Alarm::nextTime(const QDateTime &preTime, bool ignoreRepetitions = false) const

Returns the next alarm trigger date/time after given date/time. Takes recurrent incidences into account.

preTime date/time from where to start

ignoreRepetitions don't take repetitions into account

See also nextRepetition().

QString Alarm::parentUid() const

Returns the parent's incidence UID of the alarm.

See also setParent().

QDateTime Alarm::previousRepetition(const QDateTime &afterTime) const

Returns the date/time of the alarm's latest repetition or, if none, its initial occurrence before a given time.

afterTime is the date/time before which to find the latest repetition.

Returns the date and time of the latest repetition, or an invalid date/time if the specified time is at or before the alarm's initial occurrence.

See also nextRepetition().

QString Alarm::programArguments() const

Returns the program arguments string for a Procedure alarm type. Returns an empty string if the alarm is not a Procedure type.

See also setProcedureAlarm(), setProgramFile(), programFile(), and setProgramArguments().

QString Alarm::programFile() const

Returns the program file name for a Procedure alarm type. Returns an empty string if the alarm is not a Procedure type.

See also setProcedureAlarm(), setProgramFile(), setProgramArguments(), and programArguments().

int Alarm::repeatCount() const

Returns how many times an alarm may repeats after its initial occurrence.

See also setRepeatCount().

void Alarm::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.

audioFile is the name of the audio file to play when the alarm is triggered.

See also setAudioFile() and audioFile().

void Alarm::setAudioFile(const QString &audioFile)

Sets the name of the audio file to play when the audio alarm is triggered. Ignored if the alarm is not an Audio type.

audioFile is the name of the audio file to play when the alarm is triggered.

See also setAudioAlarm() and audioFile().

void Alarm::setDisplayAlarm(const QString &text = QString())

Sets the Display type for this alarm. If text is specified non-empty, then it is used as the description text to display when the alarm is triggered.

text is the description to display when the alarm is triggered.

See also setText() and text().

void Alarm::setEmailAlarm(const QString &subject, const QString &text, const KCalendarCore::Person::List &addressees, const QStringList &attachments = QStringList())

Sets the Email type for this alarm and the email subject, text, addressees, and attachments that make up an email message to be sent when the alarm is triggered.

subject is the email subject.

text is a string containing the body of the email message.

addressees is Person list of email addresses.

attachments is a a QStringList of optional file names of email attachments.

See also setMailSubject(), setMailText(), setMailAddresses(), and setMailAttachments().

void Alarm::setEnabled(bool enable)

Sets the enabled status of the alarm.

enable if true, then enable the alarm; else disable the alarm.

See also enabled() and toggleAlarm().

void Alarm::setEndOffset(const KCalendarCore::Duration &offset)

Sets the alarm offset relative to the end of the parent Incidence.

offset is a Duration to be used as a time relative to the end of the parent Incidence to be used as the alarm trigger.

See also setStartOffset(), startOffset(), and endOffset().

void Alarm::setHasLocationRadius(bool hasLocationRadius)

Set if the location radius for the alarm has been defined.

hasLocationRadius if true, then this alarm has a location radius.

See also hasLocationRadius() and setLocationRadius().

void Alarm::setLocationRadius(int locationRadius)

Set location radius for the alarm. This means that alarm will be triggered when user approaches the location. Given value will be stored into custom properties as X-LOCATION-RADIUS.

locationRadius radius in meters

See also locationRadius().

void Alarm::setMailAddress(const KCalendarCore::Person &mailAlarmAddress)

Sets the email address of an Email type alarm. Ignored if the alarm is not an Email type.

mailAlarmAddress is a Person to receive a mail message when an Email type alarm is triggered.

See also setMailSubject(), setMailText(), setMailAddresses(), setMailAttachment(), setMailAttachments(), and mailAddresses().

void Alarm::setMailAddresses(const KCalendarCore::Person::List &mailAlarmAddresses)

Sets a list of email addresses of an Email type alarm. Ignored if the alarm is not an Email type.

mailAlarmAddresses is a Person list to receive a mail message when an Email type alarm is triggered.

See also setMailSubject(), setMailText(), setMailAddress(), setMailAttachments(), setMailAttachment(), and mailAddresses().

void Alarm::setMailAttachment(const QString &mailAttachFile)

Sets the filename to attach to a mail message for an Email alarm type. Ignored if the alarm is not an Email type.

mailAttachFile is a string containing a filename to be attached to an email message to send when the Email type alarm is triggered.

See also setMailSubject(), setMailText(), setMailAddress(), setMailAddresses(), setMailAttachments(), and mailAttachments().

void Alarm::setMailAttachments(const QStringList &mailAttachFiles)

Sets a list of filenames to attach to a mail message for an Email alarm type. Ignored if the alarm is not an Email type.

mailAttachFiles is a QString list of filenames to attach to a mail message when an Email type alarm is triggered.

See also mailAttachments(), setMailSubject(), setMailText(), setMailAttachment(), setMailAddress(), and setMailAddresses().

void Alarm::setMailSubject(const QString &mailAlarmSubject)

Sets the subject line of a mail message for an Email alarm type. Ignored if the alarm is not an Email type.

mailAlarmSubject is a string to be used as a subject line of an email message to send when the Email type alarm is triggered.

See also setMailText(), setMailAddress(), setMailAddresses(), setMailAttachment(), setMailAttachments(), and mailSubject().

void Alarm::setMailText(const QString &text)

Sets the body text for an Email alarm type. Ignored if the alarm is not an Email type.

text is a string containing the body text of a mail message when an Email type alarm is triggered.

See also mailText(), setMailSubject(), setMailAddress(), setMailAddresses(), setMailAttachment(), and setMailAttachments().

void Alarm::setParent(KCalendarCore::Incidence *parent)

Sets the parent Incidence of the alarm.

parent is alarm parent Incidence to set.

See also parentUid().

void Alarm::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 triggered.

programFile is the name of the program file to execute when the alarm is triggered.

arguments is a string of arguments to supply to programFile.

See also setProgramFile(), programFile(), setProgramArguments(), and programArguments().

void Alarm::setProgramArguments(const QString &arguments)

Sets the program arguments string when the alarm is triggered. Ignored if the alarm is not a Procedure type.

arguments is a string of arguments to supply to the program.

See also setProcedureAlarm(), setProgramFile(), programFile(), and programArguments().

void Alarm::setProgramFile(const QString &programFile)

Sets the program file to execute when the alarm is triggered. Ignored if the alarm is not a Procedure type.

programFile is the name of the program file to execute when the alarm is triggered.

See also setProcedureAlarm(), programFile(), setProgramArguments(), and programArguments().

void Alarm::setRepeatCount(int alarmRepeatCount)

Sets how many times an alarm is to repeat itself after its initial occurrence (w/snoozes).

alarmRepeatCount is the number of times an alarm may repeat, excluding the initial occurrence.

See also repeatCount().

void Alarm::setSnoozeTime(const KCalendarCore::Duration &alarmSnoozeTime)

Sets the snooze time interval for the alarm.

alarmSnoozeTime the time between snoozes.

See also snoozeTime().

void Alarm::setStartOffset(const KCalendarCore::Duration &offset)

Sets the alarm offset relative to the start of the parent Incidence.

offset is a Duration to be used as a time relative to the start of the parent Incidence to be used as the alarm trigger.

See also setEndOffset(), startOffset(), and endOffset().

void Alarm::setText(const QString &text)

Sets the description text to be displayed when the alarm is triggered. Ignored if the alarm is not a display alarm.

text is the description to display when the alarm is triggered.

See also setDisplayAlarm() and text().

void Alarm::setTime(const QDateTime &alarmTime)

Sets the trigger time of the alarm.

alarmTime is the QDateTime alarm trigger.

See also time().

void Alarm::setType(KCalendarCore::Alarm::Type type)

Sets the type for this alarm to type. If the specified type is different from the current type of the alarm, then the alarm's type-specific properties are re-initialized.

type is the alarm type to set.

See also type().

void Alarm::shiftTimes(const QTimeZone &oldZone, const QTimeZone &newZone)

Shift the times of the alarm so that they appear at the same clock time as before but in a new time zone. The shift is done from a viewing time zone rather than from the actual alarm time zone.

For example, shifting an alarm whose start time is 09:00 America/New York, using an old viewing time zone (oldZone) of Europe/London, to a new time zone (newZone) of Europe/Paris, will result in the time being shifted from 14:00 (which is the London time of the alarm start) to 14:00 Paris time.

oldZone the time zone which provides the clock times

newZone the new time zone

KCalendarCore::Duration Alarm::snoozeTime() const

Returns the snooze time interval.

See also setSnoozeTime().

KCalendarCore::Duration Alarm::startOffset() const

Returns offset of alarm in time relative to the start of the parent Incidence. If the alarm's time is not defined in terms of an offset relative to the start of the event, returns zero.

See also setStartOffset() and hasStartOffset().

QString Alarm::text() const

Returns the display text string for a Display alarm type. Returns an empty string if the alarm is not a Display type.

See also setDisplayAlarm() and setText().

QDateTime Alarm::time() const

Returns the alarm trigger date/time.

See also setTime().

void Alarm::toggleAlarm()

Toggles the alarm status, i.e, an enable alarm becomes disabled and a disabled alarm becomes enabled.

See also enabled() and setEnabled().

KCalendarCore::Alarm::Type Alarm::type() const

Returns the type of the alarm.

See also setType().

bool Alarm::operator!=(const KCalendarCore::Alarm &a) const

Compares two alarms for inequality.

a is the comparison alarm.

Returns true if a is not equal to this object, or false if they are equal.

KCalendarCore::Alarm &Alarm::operator=(const KCalendarCore::Alarm &)

Copy operator.

bool Alarm::operator==(const KCalendarCore::Alarm &a) const

Compares two alarms for equality.

a is the comparison alarm.

Returns true if a is equal to this object, or false if they are different.