alarm.h

Go to the documentation of this file.

/*
  This file is part of the kcal 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 KCAL_ALARM_H
#define KCAL_ALARM_H

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QList>

#include <kdatetime.h>

#include "customproperties.h"
#include "duration.h"
#include "person.h"
#include "listbase.h"
#include "kcal_export.h"

#include <kpimutils/supertrait.h>

namespace boost {
  template <typename T> class shared_ptr;
}

namespace KCal {

class Incidence;

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

    typedef ListBase<Alarm> List;

    typedef boost::shared_ptr<Alarm> Ptr;

    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 { return !operator==( a ); }

    void setParent( Incidence *parent );

    Incidence *parent() 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 QList<Person> &addressees,
                        const QStringList &attachments = QStringList() );

    void setMailAddress( const Person &mailAlarmAddress );

    void setMailAddresses( const QList<Person> &mailAlarmAddresses );

    void addMailAddress( const Person &mailAlarmAddress );

    QList<Person> 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 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;

  protected:
    virtual void customPropertyUpdated();

  private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

}

#endif