alarm.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.

  Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
  Copyright (c) 2003 David Jarvie <software@astrojar.org.uk>
  Copyright (c) 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/
#ifndef KCALCORE_ALARM_H
#define KCALCORE_ALARM_H

#include "kcalcore_export.h"
#include "customproperties.h"
#include "duration.h"
#include "person.h"

#include <KDE/KDateTime>

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QVector>
#include <QDataStream>
#include <QMetaType>

namespace KCalCore {

class Incidence;

class KCALCORE_EXPORT Alarm : public CustomProperties
{
public:
    enum Type {
        Invalid,   
        Display,   
        Procedure, 
        Email,     
        Audio      
    };

    typedef QSharedPointer<Alarm> Ptr;

    typedef QVector<Ptr> List;

    // Can't find a way to use a shared pointer here.
    // Inside incidence.cpp, it does alarm->setParent( this )
    explicit Alarm(Incidence *parent);

    Alarm(const Alarm &other);

    virtual ~Alarm();

    Alarm &operator=(const Alarm &);

    bool operator==(const Alarm &a) const;

    bool operator!=(const Alarm &a) const;

    // Is there a way to use QSharedPointer here?
    // although it's safe, Incidence's dtor calls setParent( 0 )
    // se we don't dereference a deleted pointer here.
    // Also, I renamed "Incidence *parent()" to "QString parentUid()"
    // So we don't return raw pointers
    void setParent(Incidence *parent);

    // We don't have a share pointer to return, so return the UID.
    QString parentUid() const;

    void setType(Type type);

    Type type() const;

    void setDisplayAlarm(const QString &text = QString());

    void setText(const QString &text);

    QString text() const;

    void setAudioAlarm(const QString &audioFile = QString());

    void setAudioFile(const QString &audioFile);

    QString audioFile() const;

    void setProcedureAlarm(const QString &programFile,
                           const QString &arguments = QString());

    void setProgramFile(const QString &programFile);

    QString programFile() const;

    void setProgramArguments(const QString &arguments);

    QString programArguments() const;

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

    void setMailAddress(const Person::Ptr &mailAlarmAddress);

    void setMailAddresses(const Person::List &mailAlarmAddresses);

    void addMailAddress(const Person::Ptr &mailAlarmAddress);

    Person::List mailAddresses() const;

    void setMailSubject(const QString &mailAlarmSubject);

    QString mailSubject() const;

    void setMailAttachment(const QString &mailAttachFile);

    void setMailAttachments(const QStringList &mailAttachFiles);

    void addMailAttachment(const QString &mailAttachFile);

    QStringList mailAttachments() const;

    void setMailText(const QString &text);

    QString mailText() const;

    void setTime(const KDateTime &alarmTime);

    KDateTime time() const;

    KDateTime nextTime(const KDateTime &preTime, bool ignoreRepetitions = false) const;

    KDateTime endTime() const;

    bool hasTime() const;

    void setStartOffset(const Duration &offset);

    Duration startOffset() const;

    bool hasStartOffset() const;

    void setEndOffset(const Duration &offset);

    Duration endOffset() const;

    bool hasEndOffset() const;

    void shiftTimes(const KDateTime::Spec &oldSpec,
                    const KDateTime::Spec &newSpec);

    void setSnoozeTime(const Duration &alarmSnoozeTime);

    Duration snoozeTime() const;

    void setRepeatCount(int alarmRepeatCount);

    int repeatCount() const;

    KDateTime nextRepetition(const KDateTime &preTime) const;

    KDateTime previousRepetition(const KDateTime &afterTime) const;

    Duration duration() const;

    void toggleAlarm();

    void setEnabled(bool enable);

    bool enabled() const;

    void setHasLocationRadius(bool hasLocationRadius);

    bool hasLocationRadius() const;

    void setLocationRadius(int locationRadius);

    int locationRadius() const;

protected:
    virtual void customPropertyUpdated();

    virtual void virtual_hook(int id, void *data);

private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
    friend KCALCORE_EXPORT QDataStream &operator<<(QDataStream &s, const KCalCore::Alarm::Ptr &);
    friend KCALCORE_EXPORT QDataStream &operator>>(QDataStream &s, const KCalCore::Alarm::Ptr &);
};
KCALCORE_EXPORT QDataStream &operator<<(QDataStream &out, const KCalCore::Alarm::Ptr &);

KCALCORE_EXPORT QDataStream &operator>>(QDataStream &in, const KCalCore::Alarm::Ptr &);

}

//@cond PRIVATE
Q_DECLARE_TYPEINFO(KCalCore::Alarm::Ptr, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(KCalCore::Alarm::Ptr)
//@endcond

#endif