libkcal Library API Documentation

KCal::Alarm Class Reference

This class represents an alarm notification. More...

#include <alarm.h>

List of all members.

Public Types

typedef QValueList< Alarm * > List

Public Member Functions

 Alarm (Incidence *parent)
 Constructs a new alarm with variables initialized to "sane" values.

 ~Alarm ()
 Destruct Alarm object.

void setAudioFile (const QString &audioAlarmFile)
 set the event to have this file as the noise for the alarm.

QString audioFile () const
 return the name of the audio file for the alarm

void setProgramFile (const QString &programAlarmFile)
 set this program to run when an alarm is triggered

QString programFile () const
 return the name of the program to run when an alarm is triggered

void setMailAddress (const QString &mailAlarmAddress)
 send mail to this address when an alarm goes off

void setMailAddresses (const QStringList &mailAlarmAddresses)
 send mail to these addresses when an alarm goes off

void addMailAddress (const QString &mailAlarmAddress)
 add this address to the list of addresses to send mail to when an alarm goes off

QStringList mailAddresses () const
 return the addresses to send mail to when an alarm goes off

void setMailSubject (const QString &mailAlarmSubject)
 set the subject line of the mail

QString mailSubject () const
 return the subject line of the mail

void setMailAttachment (const QString &mailAttachFile)
 attach this filename to the email

void setMailAttachments (const QStringList &mailAttachFiles)
 attach these filenames to the email

void addMailAttachment (const QString &mailAttachFile)
 add this filename to the list of files to attach to the email

QStringList mailAttachments () const
 return the filenames to attach to the email

void setText (const QString &alarmText)
 set the text to display when an alarm goes off

QString text () const
 return the text string that displays when an alarm goes off

void setTime (const QDateTime &alarmTime)
 set the time to trigger an alarm

QDateTime time () const
 return the date/time when an alarm goes off

bool hasTime () const
 Return true, if the alarm has an explicit date/time.

void setOffset (const Duration &)
 Set offset of alarm in time relative to the start of the event.

Duration offset () const
 Return offset of alarm in time relative to the start of the event.

void setSnoozeTime (int alarmSnoozeTime)
 set the interval between snoozes for the alarm

int snoozeTime () const
 get how long the alarm snooze interval is

void setRepeatCount (int alarmRepeatCount)
 set how many times an alarm is to repeat itself (w/snoozes)

int repeatCount () const
 get how many times an alarm repeats

void toggleAlarm ()
 toggles the value of alarm to be either on or off.

void setEnabled (bool enable)
 set the alarm enabled status

bool enabled () const
 get the alarm enabled status

void setParent (Incidence *)
 Set the alarm's parent incidence.

Incidenceparent () const
 get the alarm's parent incidence


Detailed Description

This class represents an alarm notification.

Definition at line 35 of file alarm.h.


Constructor & Destructor Documentation

Alarm::Alarm Incidence parent  ) 
 

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

Definition at line 31 of file alarm.cpp.

Alarm::~Alarm  ) 
 

Destruct Alarm object.

Definition at line 42 of file alarm.cpp.


Member Function Documentation

void Alarm::setAudioFile const QString audioAlarmFile  ) 
 

set the event to have this file as the noise for the alarm.

Definition at line 46 of file alarm.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QString Alarm::audioFile  )  const
 

return the name of the audio file for the alarm

Definition at line 52 of file alarm.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void Alarm::setProgramFile const QString programAlarmFile  ) 
 

set this program to run when an alarm is triggered

Definition at line 57 of file alarm.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QString Alarm::programFile  )  const
 

return the name of the program to run when an alarm is triggered

Definition at line 63 of file alarm.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void Alarm::setMailAddress const QString mailAlarmAddress  ) 
 

send mail to this address when an alarm goes off

Definition at line 68 of file alarm.cpp.

References KCal::IncidenceBase::updated().

void Alarm::setMailAddresses const QStringList mailAlarmAddresses  ) 
 

send mail to these addresses when an alarm goes off

Definition at line 75 of file alarm.cpp.

References KCal::IncidenceBase::updated().

void Alarm::addMailAddress const QString mailAlarmAddress  ) 
 

add this address to the list of addresses to send mail to when an alarm goes off

Definition at line 81 of file alarm.cpp.

References KCal::IncidenceBase::updated().

QStringList Alarm::mailAddresses  )  const
 

return the addresses to send mail to when an alarm goes off

Definition at line 87 of file alarm.cpp.

void Alarm::setMailSubject const QString mailAlarmSubject  ) 
 

set the subject line of the mail

Definition at line 92 of file alarm.cpp.

References KCal::IncidenceBase::updated().

QString Alarm::mailSubject  )  const
 

return the subject line of the mail

Definition at line 98 of file alarm.cpp.

void Alarm::setMailAttachment const QString mailAttachFile  ) 
 

attach this filename to the email

Definition at line 103 of file alarm.cpp.

References KCal::IncidenceBase::updated().

void Alarm::setMailAttachments const QStringList mailAttachFiles  ) 
 

attach these filenames to the email

Definition at line 110 of file alarm.cpp.

References KCal::IncidenceBase::updated().

void Alarm::addMailAttachment const QString mailAttachFile  ) 
 

add this filename to the list of files to attach to the email

Definition at line 116 of file alarm.cpp.

References KCal::IncidenceBase::updated().

QStringList Alarm::mailAttachments  )  const
 

return the filenames to attach to the email

Definition at line 122 of file alarm.cpp.

void Alarm::setText const QString alarmText  ) 
 

set the text to display when an alarm goes off

Definition at line 127 of file alarm.cpp.

References KCal::IncidenceBase::updated().

QString Alarm::text  )  const
 

return the text string that displays when an alarm goes off

Definition at line 133 of file alarm.cpp.

void Alarm::setTime const QDateTime alarmTime  ) 
 

set the time to trigger an alarm

Definition at line 138 of file alarm.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QDateTime Alarm::time  )  const
 

return the date/time when an alarm goes off

Definition at line 146 of file alarm.cpp.

References KCal::Todo::dtDue(), KCal::IncidenceBase::dtStart(), hasTime(), and KCal::IncidenceBase::type().

Referenced by KCal::CalendarLocal::appendAlarms(), KCal::CalendarLocal::appendRecurringAlarms(), KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

bool Alarm::hasTime  )  const
 

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

Definition at line 160 of file alarm.cpp.

Referenced by time().

void Alarm::setOffset const Duration &   ) 
 

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

Definition at line 212 of file alarm.cpp.

References KCal::IncidenceBase::updated().

Duration Alarm::offset  )  const
 

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

Definition at line 220 of file alarm.cpp.

void Alarm::setSnoozeTime int  alarmSnoozeTime  ) 
 

set the interval between snoozes for the alarm

Definition at line 165 of file alarm.cpp.

References KCal::IncidenceBase::updated().

int Alarm::snoozeTime  )  const
 

get how long the alarm snooze interval is

Definition at line 171 of file alarm.cpp.

void Alarm::setRepeatCount int  alarmRepeatCount  ) 
 

set how many times an alarm is to repeat itself (w/snoozes)

Definition at line 176 of file alarm.cpp.

References KCal::IncidenceBase::updated().

int Alarm::repeatCount  )  const
 

get how many times an alarm repeats

Definition at line 184 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 190 of file alarm.cpp.

References KCal::IncidenceBase::updated().

void Alarm::setEnabled bool  enable  ) 
 

set the alarm enabled status

Definition at line 201 of file alarm.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

bool Alarm::enabled  )  const
 

get the alarm enabled status

Definition at line 207 of file alarm.cpp.

Referenced by KCal::CalendarLocal::appendAlarms(), KCal::CalendarLocal::appendRecurringAlarms(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::Incidence::isAlarmEnabled().

void Alarm::setParent Incidence  ) 
 

Set the alarm's parent incidence.

Definition at line 225 of file alarm.cpp.

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

get the alarm's parent incidence

Definition at line 116 of file alarm.h.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sat Oct 18 02:47:03 2003 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001