alarm.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.

  SPDX-FileCopyrightText: 2001-2003 Cornelius Schumacher <[email protected]>
  SPDX-FileCopyrightText: 2003 David Jarvie <[email protected]>
  SPDX-FileCopyrightText: 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>

  SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KCALCORE_ALARM_H
#define KCALCORE_ALARM_H

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

#include <QDateTime>
#include <QString>
#include <QStringList>
#include <QVector>
#include <QDataStream>
#include <QMetaType>
#include <QSharedPointer>

class QTimeZone;

namespace KCalendarCore
{

class Incidence;

class KCALENDARCORE_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);

    ~Alarm() override;

    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.
    Q_REQUIRED_RESULT QString parentUid() const;

    void setType(Type type);

    Q_REQUIRED_RESULT Type type() const;

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

    void setText(const QString &text);

    Q_REQUIRED_RESULT QString text() const;

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

    void setAudioFile(const QString &audioFile);

    Q_REQUIRED_RESULT QString audioFile() const;

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

    void setProgramFile(const QString &programFile);

    Q_REQUIRED_RESULT QString programFile() const;

    void setProgramArguments(const QString &arguments);

    Q_REQUIRED_RESULT QString programArguments() const;

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

    void setMailAddress(const Person &mailAlarmAddress);

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

    void addMailAddress(const Person &mailAlarmAddress);

    Q_REQUIRED_RESULT Person::List mailAddresses() const;

    void setMailSubject(const QString &mailAlarmSubject);

    Q_REQUIRED_RESULT QString mailSubject() const;

    void setMailAttachment(const QString &mailAttachFile);

    void setMailAttachments(const QStringList &mailAttachFiles);

    void addMailAttachment(const QString &mailAttachFile);

    Q_REQUIRED_RESULT QStringList mailAttachments() const;

    void setMailText(const QString &text);

    Q_REQUIRED_RESULT QString mailText() const;

    void setTime(const QDateTime &alarmTime);

    Q_REQUIRED_RESULT QDateTime time() const;

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

    Q_REQUIRED_RESULT QDateTime endTime() const;

    Q_REQUIRED_RESULT bool hasTime() const;

    void setStartOffset(const Duration &offset);

    Q_REQUIRED_RESULT Duration startOffset() const;

    bool hasStartOffset() const;

    void setEndOffset(const Duration &offset);

    Q_REQUIRED_RESULT Duration endOffset() const;

    bool hasEndOffset() const;

    void shiftTimes(const QTimeZone &oldZone, const QTimeZone &newZone);

    void setSnoozeTime(const Duration &alarmSnoozeTime);

    Q_REQUIRED_RESULT Duration snoozeTime() const;

    void setRepeatCount(int alarmRepeatCount);

    Q_REQUIRED_RESULT int repeatCount() const;

    Q_REQUIRED_RESULT QDateTime nextRepetition(const QDateTime &preTime) const;

    Q_REQUIRED_RESULT QDateTime previousRepetition(const QDateTime &afterTime) const;

    Q_REQUIRED_RESULT Duration duration() const;

    void toggleAlarm();

    void setEnabled(bool enable);

    Q_REQUIRED_RESULT bool enabled() const;

    void setHasLocationRadius(bool hasLocationRadius);

    Q_REQUIRED_RESULT bool hasLocationRadius() const;

    void setLocationRadius(int locationRadius);

    Q_REQUIRED_RESULT int locationRadius() const;

protected:
    void customPropertyUpdated() override;

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

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

KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &in, const KCalendarCore::Alarm::Ptr &);

}

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

#endif