34#include <QtCore/QString>
35#include <QtCore/QStringList>
36#include <QtCore/QList>
44#include "kcal_export.h"
46#include <kpimutils/supertrait.h>
49 template <
typename T>
class shared_ptr;
88 typedef boost::shared_ptr<Alarm>
Ptr;
118 bool operator==(
const Alarm &a )
const;
152 void setType( Type type );
170 void setDisplayAlarm(
const QString &text = QString() );
180 void setText(
const QString &text );
188 QString text()
const;
199 void setAudioAlarm(
const QString &audioFile = QString() );
210 void setAudioFile(
const QString &audioFile );
218 QString audioFile()
const;
231 void setProcedureAlarm(
const QString &programFile,
232 const QString &arguments = QString() );
244 void setProgramFile(
const QString &programFile );
253 QString programFile()
const;
264 void setProgramArguments(
const QString &arguments );
273 QString programArguments()
const;
289 void setEmailAlarm(
const QString &subject,
const QString &text,
290 const QList<Person> &addressees,
291 const QStringList &attachments = QStringList() );
303 void setMailAddress(
const Person &mailAlarmAddress );
315 void setMailAddresses(
const QList<Person> &mailAlarmAddresses );
327 void addMailAddress(
const Person &mailAlarmAddress );
335 QList<Person> mailAddresses()
const;
347 void setMailSubject(
const QString &mailAlarmSubject );
355 QString mailSubject()
const;
367 void setMailAttachment(
const QString &mailAttachFile );
379 void setMailAttachments(
const QStringList &mailAttachFiles );
390 void addMailAttachment(
const QString &mailAttachFile );
398 QStringList mailAttachments()
const;
410 void setMailText(
const QString &text );
418 QString mailText()
const;
427 void setTime(
const KDateTime &alarmTime );
434 KDateTime time()
const;
442 KDateTime endTime()
const;
447 bool hasTime()
const;
457 void setStartOffset(
const Duration &offset );
474 bool hasStartOffset()
const;
484 void setEndOffset(
const Duration &offset );
501 bool hasEndOffset()
const;
517 void shiftTimes(
const KDateTime::Spec &oldSpec,
518 const KDateTime::Spec &newSpec );
527 void setSnoozeTime(
const Duration &alarmSnoozeTime );
545 void setRepeatCount(
int alarmRepeatCount );
552 int repeatCount()
const;
565 KDateTime nextRepetition(
const KDateTime &preTime )
const;
580 KDateTime previousRepetition(
const KDateTime &afterTime )
const;
603 void setEnabled(
bool enable );
610 bool enabled()
const;
617 virtual void customPropertyUpdated();
Represents an alarm notification.
Type
The different types of alarms.
@ Display
Display a dialog box.
@ Invalid
Invalid, or no alarm.
@ Procedure
Call a script.
ListBase< Alarm > List
List of alarms.
bool operator!=(const Alarm &a) const
Compares two alarms for inequality.
boost::shared_ptr< Alarm > Ptr
A shared pointer to a Alarm object.
A class to manage custom calendar properties.
Represents a span of time measured in seconds or days.
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
This class provides a template for lists of pointers.
Represents a person, by name ane email address.
This file is part of the API for handling calendar data and defines the CustomProperties class.
This file is part of the API for handling calendar data and defines the Duration class.
This file is part of the API for handling calendar data and defines the ListBase class.
This file is part of the API for handling calendar data and defines the Person class.