alarm.h

/*
    This file is part of libkcal.
 
    Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
    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 <tqstring.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
 
#include "customproperties.h"
#include "duration.h"
#include "person.h"
#include "listbase.h"
#include "libkcal_export.h"
 
#include <tdemacros.h>
 
namespace KCal {
 
class Incidence;

class LIBKCAL_EXPORT Alarm : public CustomProperties
{
  public:
    enum Type { Invalid, Display, Procedure, Email, Audio };
 
    typedef ListBase<Alarm> List;

    explicit Alarm( Incidence *parent );
    virtual ~Alarm();

    Alarm *clone();

    Alarm &operator=( const Alarm & );

    bool operator==( const Alarm & ) const;
    bool operator!=( const Alarm &a ) const { return !operator==( a ); }

    void setType( Type type );

    Type type() const;

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

    void setText( const TQString &text );

    TQString text() const;

    void setAudioAlarm( const TQString &audioFile = TQString() );
    void setAudioFile( const TQString &audioFile );
    TQString audioFile() const;

    void setProcedureAlarm( const TQString &programFile,
                            const TQString &arguments = TQString() );
    void setProgramFile( const TQString &programFile );
    TQString programFile() const;
    void setProgramArguments( const TQString &arguments );
    TQString programArguments() const;

    void setEmailAlarm( const TQString &subject, const TQString &text,
                        const TQValueList<Person> &addressees,
                        const TQStringList &attachments = TQStringList() );

    void setMailAddress( const Person &mailAlarmAddress );
    void setMailAddresses( const TQValueList<Person> &mailAlarmAddresses );
    void addMailAddress( const Person &mailAlarmAddress );
    TQValueList<Person> mailAddresses() const;

    void setMailSubject( const TQString &mailAlarmSubject );
    TQString mailSubject() const;

    void setMailAttachment( const TQString &mailAttachFile );
    void setMailAttachments( const TQStringList &mailAttachFiles );
    void addMailAttachment( const TQString &mailAttachFile );
    TQStringList mailAttachments() const;

    void setMailText( const TQString &text );
    TQString mailText() const;

    void setTime( const TQDateTime &alarmTime );
    TQDateTime time() const;
    TQDateTime endTime() const;
    bool hasTime() const;

    void setStartOffset( const Duration & );
    Duration startOffset() const;
    bool hasStartOffset() const;

    void setEndOffset( const Duration & );
    Duration endOffset() const;
    bool hasEndOffset() const;

    void setSnoozeTime( const Duration &alarmSnoozeTime );

    Duration snoozeTime() const;

    void setRepeatCount( int alarmRepeatCount );
    int repeatCount() const;
    TQDateTime nextRepetition(const TQDateTime& preTime) const;
    TQDateTime previousRepetition(const TQDateTime& afterTime) const;
    Duration duration() const;

    void toggleAlarm();

    void setEnabled(bool enable);
    bool enabled() const;

    void setParent( Incidence * );
    Incidence *parent() const  { return mParent; }
 
  protected:
    virtual void customPropertyUpdated();
 
  private:
    Incidence *mParent;          // the incidence which this alarm belongs to
    Type mType;                  // type of alarm
    TQString mDescription;        // text to display/email body/procedure arguments
    TQString mFile;               // procedure program to run/optional audio file to play
    TQStringList mMailAttachFiles;      // filenames to attach to email
    TQValueList<Person> mMailAddresses; // who to mail for reminder
    TQString mMailSubject;        // subject of email
 
    Duration mAlarmSnoozeTime;   // how long after alarm to snooze before
                                 // triggering again
    int mAlarmRepeatCount;       // number of times for alarm to repeat
                                 // after the initial time
 
    TQDateTime mAlarmTime;        // time at which to trigger the alarm
    Duration mOffset;            // time relative to incidence DTSTART to trigger the alarm
    bool mEndOffset;             // if true, mOffset relates to DTEND, not DTSTART
    bool mHasTime;               // use mAlarmTime, not mOffset
    bool mAlarmEnabled;
 
    class Private;
    Private *d;
};
 
}
 
#endif