libkcal

KCal::Alarm

KCal::Alarm Class Reference

This class represents an alarm notification. More...

#include <alarm.h>

Inheritance diagram for KCal::Alarm:

Inheritance graph
[legend]

List of all members.


Public Types

typedef ListBase< Alarm > List
enum  Type {
  Invalid, Display, Procedure, Email,
  Audio
}

Public Member Functions

void addMailAddress (const Person &mailAlarmAddress)
void addMailAttachment (const QString &mailAttachFile)
 Alarm (Incidence *parent)
QString audioFile () const
int duration () const
bool enabled () const
Duration endOffset () const
QDateTime endTime () const
bool hasEndOffset () const
bool hasStartOffset () const
bool hasTime () const
QValueList< Person > mailAddresses () const
QStringList mailAttachments () const
QString mailSubject () const
QString mailText () const
QDateTime nextRepetition (const QDateTime &preTime) const
bool operator!= (const Alarm &a) const
bool operator== (const Alarm &) const
Incidence * parent () const
QDateTime previousRepetition (const QDateTime &afterTime) const
QString programArguments () const
QString programFile () const
int repeatCount () const
void setAudioAlarm (const QString &audioFile=QString::null)
void setAudioFile (const QString &audioFile)
void setDisplayAlarm (const QString &text=QString::null)
void setEmailAlarm (const QString &subject, const QString &text, const QValueList< Person > &addressees, const QStringList &attachments=QStringList())
void setEnabled (bool enable)
void setEndOffset (const Duration &)
void setMailAddress (const Person &mailAlarmAddress)
void setMailAddresses (const QValueList< Person > &mailAlarmAddresses)
void setMailAttachment (const QString &mailAttachFile)
void setMailAttachments (const QStringList &mailAttachFiles)
void setMailSubject (const QString &mailAlarmSubject)
void setMailText (const QString &text)
void setParent (Incidence *)
void setProcedureAlarm (const QString &programFile, const QString &arguments=QString::null)
void setProgramArguments (const QString &arguments)
void setProgramFile (const QString &programFile)
void setRepeatCount (int alarmRepeatCount)
void setSnoozeTime (int alarmSnoozeTime)
void setStartOffset (const Duration &)
void setText (const QString &text)
void setTime (const QDateTime &alarmTime)
void setType (Type type)
int snoozeTime () const
Duration startOffset () const
QString text () const
QDateTime time () const
void toggleAlarm ()
Type type () const
 ~Alarm ()

Protected Member Functions

virtual void customPropertyUpdated ()

Detailed Description

This class represents an alarm notification.

Definition at line 44 of file alarm.h.

Member Typedef Documentation

typedef ListBase<Alarm> KCal::Alarm::List

Definition at line 49 of file alarm.h.

Member Enumeration Documentation

enum KCal::Alarm::Type

Enumerator:
Invalid 
Display 
Procedure 
Email 
Audio 

Definition at line 47 of file alarm.h.

Constructor & Destructor Documentation

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

Construct a new alarm with variables initialized to "sane" values.

Definition at line 32 of file alarm.cpp.

Alarm::~Alarm (  ) 

Destruct Alarm object.

Definition at line 46 of file alarm.cpp.

Member Function Documentation

void Alarm::addMailAddress ( const Person &  mailAlarmAddress  ) 

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.

Definition at line 207 of file alarm.cpp.

void Alarm::addMailAttachment ( const QString &  mailAttachFile  ) 

Add this filename to the list of files to attach to the email.

Ignored if the alarm is not an email alarm.

Definition at line 250 of file alarm.cpp.

QString Alarm::audioFile (  )  const

Return the name of the audio file for the alarm.

Returns:
The audio file for the alarm, or QString::null if not an audio alarm.

Definition at line 140 of file alarm.cpp.

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

Called when a custom property has been changed.

The default implementation does nothing: override in derived classes to perform change processing.

Reimplemented from KCal::CustomProperties.

Definition at line 456 of file alarm.cpp.

int Alarm::duration (  )  const

Get how long between the alarm's initial occurrence and its final repetition.

Returns:
the number of seconds between the initial occurrence and final repetition.

Definition at line 351 of file alarm.cpp.

bool Alarm::enabled (  )  const

Get the alarm enabled status.

Definition at line 410 of file alarm.cpp.

Duration Alarm::endOffset (  )  const

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.

Definition at line 446 of file alarm.cpp.

QDateTime Alarm::endTime (  )  const

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().

Definition at line 390 of file alarm.cpp.

bool Alarm::hasEndOffset (  )  const

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

Definition at line 433 of file alarm.cpp.

bool Alarm::hasStartOffset (  )  const

Return whether the alarm is defined in terms of an offset relative to the start of the event.

Definition at line 428 of file alarm.cpp.

bool Alarm::hasTime (  )  const

Return true, if the alarm has an explicit date/time.

Definition at line 322 of file alarm.cpp.

QValueList< Person > Alarm::mailAddresses (  )  const

Return the addresses to send mail to when an alarm goes off.

Definition at line 215 of file alarm.cpp.

QStringList Alarm::mailAttachments (  )  const

Return the filenames to attach to the email.

Definition at line 258 of file alarm.cpp.

QString Alarm::mailSubject (  )  const

Return the subject line of the mail.

Definition at line 228 of file alarm.cpp.

QString Alarm::mailText (  )  const

Return the email body text.

Returns:
the body text, or QString::null if not an email alarm.

Definition at line 271 of file alarm.cpp.

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

Get the time of the alarm's initial occurrence or its next repetition, after a given time.

Parameters:
preTime the date and time after which to find the next repetition.
Returns:
the date and time of the next repetition, or an invalid date/time if the specified time is at or after the alarm's last repetition.

Definition at line 356 of file alarm.cpp.

bool KCal::Alarm::operator!= ( const Alarm &  a  )  const [inline]

Definition at line 64 of file alarm.h.

bool Alarm::operator== ( const Alarm &  rhs  )  const

Compare this alarm with another one.

Definition at line 50 of file alarm.cpp.

Incidence* KCal::Alarm::parent (  )  const [inline]

Get the alarm's parent incidence.

Definition at line 335 of file alarm.h.

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

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

Parameters:
afterTime the date and 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.

Definition at line 373 of file alarm.cpp.

QString Alarm::programArguments (  )  const

Return the arguments to the program to run when the alarm is triggered.

Returns:
the program arguments, or QString::null if not a procedure alarm.

Definition at line 174 of file alarm.cpp.

QString Alarm::programFile (  )  const

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

Returns:
the program file name, or QString::null if not a procedure alarm.

Definition at line 161 of file alarm.cpp.

int Alarm::repeatCount (  )  const

Get how many times an alarm repeats, after its initial occurrence.

Definition at line 346 of file alarm.cpp.

void Alarm::setAudioAlarm ( const QString &  audioFile = QString::null  ) 

Set the alarm to be an audio alarm.

Parameters:
audioFile optional file to play when the alarm is triggered.

Definition at line 125 of file alarm.cpp.

void Alarm::setAudioFile ( const QString &  audioFile  ) 

Set the file to play when the audio alarm is triggered.

Ignored if the alarm is not an audio alarm.

Definition at line 132 of file alarm.cpp.

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

Set the alarm to be a display alarm.

Parameters:
text text to display when the alarm is triggered.

Definition at line 276 of file alarm.cpp.

void Alarm::setEmailAlarm ( const QString &  subject,
const QString &  text,
const QValueList< Person > &  addressees,
const QStringList &  attachments = QStringList() 
)

Set the alarm to be an email alarm.

Parameters:
subject subject line of email.
text body of email.
addressees email addresses of recipient(s).
attachments optional names of files to attach to the email.

Definition at line 179 of file alarm.cpp.

void Alarm::setEnabled ( bool  enable  ) 

Set the alarm enabled status.

Definition at line 404 of file alarm.cpp.

void Alarm::setEndOffset ( const Duration &  offset  ) 

Set offset of alarm in time relative to the end of the event.

Definition at line 438 of file alarm.cpp.

void Alarm::setMailAddress ( const Person &  mailAlarmAddress  ) 

Send mail to this address when the alarm is triggered.

Ignored if the alarm is not an email alarm.

Definition at line 190 of file alarm.cpp.

void Alarm::setMailAddresses ( const QValueList< Person > &  mailAlarmAddresses  ) 

Send mail to these addresses when the alarm is triggered.

Ignored if the alarm is not an email alarm.

Definition at line 199 of file alarm.cpp.

void Alarm::setMailAttachment ( const QString &  mailAttachFile  ) 

Attach this filename to the email.

Ignored if the alarm is not an email alarm.

Definition at line 233 of file alarm.cpp.

void Alarm::setMailAttachments ( const QStringList &  mailAttachFiles  ) 

Attach these filenames to the email.

Ignored if the alarm is not an email alarm.

Definition at line 242 of file alarm.cpp.

void Alarm::setMailSubject ( const QString &  mailAlarmSubject  ) 

Set the subject line of the mail.

Ignored if the alarm is not an email alarm.

Definition at line 220 of file alarm.cpp.

void Alarm::setMailText ( const QString &  text  ) 

Set the email body text.

Ignored if the alarm is not an email alarm.

Definition at line 263 of file alarm.cpp.

void Alarm::setParent ( Incidence *  parent  ) 

Set the alarm's parent incidence.

Definition at line 451 of file alarm.cpp.

void Alarm::setProcedureAlarm ( const QString &  programFile,
const QString &  arguments = QString::null 
)

Set the alarm to be a procedure alarm.

Parameters:
programFile program to execute when the alarm is triggered.
arguments arguments to supply to programFile.

Definition at line 145 of file alarm.cpp.

void Alarm::setProgramArguments ( const QString &  arguments  ) 

Set the arguments to the program to execute when the alarm is triggered.

Ignored if the alarm is not a procedure alarm.

Definition at line 166 of file alarm.cpp.

void Alarm::setProgramFile ( const QString &  programFile  ) 

Set the program file to execute when the alarm is triggered.

Ignored if the alarm is not a procedure alarm.

Definition at line 153 of file alarm.cpp.

void Alarm::setRepeatCount ( int  alarmRepeatCount  ) 

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

Definition at line 340 of file alarm.cpp.

void Alarm::setSnoozeTime ( int  alarmSnoozeTime  ) 

Set the interval between snoozes for the alarm.

Parameters:
alarmSnoozeTime the time in minutes between snoozes.

Definition at line 327 of file alarm.cpp.

void Alarm::setStartOffset ( const Duration &  offset  ) 

Set offset of alarm in time relative to the start of the event.

Definition at line 415 of file alarm.cpp.

void Alarm::setText ( const QString &  text  ) 

Set the text to be displayed when the alarm is triggered.

Ignored if the alarm is not a display alarm.

Definition at line 284 of file alarm.cpp.

void Alarm::setTime ( const QDateTime &  alarmTime  ) 

Set the time to trigger an alarm.

Definition at line 297 of file alarm.cpp.

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

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.

Parameters:
type type of alarm.

Definition at line 91 of file alarm.cpp.

int Alarm::snoozeTime (  )  const

Get how long the alarm snooze interval is.

Returns:
the number of minutes between snoozes.

Definition at line 335 of file alarm.cpp.

Duration Alarm::startOffset (  )  const

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.

Definition at line 423 of file alarm.cpp.

QString Alarm::text (  )  const

Return the text string that displays when the alarm is triggered.

Definition at line 292 of file alarm.cpp.

QDateTime Alarm::time (  )  const

Return the date/time when an alarm goes off.

Definition at line 305 of file alarm.cpp.

void Alarm::toggleAlarm (  ) 

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 398 of file alarm.cpp.

Alarm::Type Alarm::type (  )  const

Return the type of the alarm.

Definition at line 120 of file alarm.cpp.

The documentation for this class was generated from the following files: