incidence.h

/*
    This file is part of libkcal.
 
    Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
    Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
 
    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 INCIDENCE_H
#define INCIDENCE_H
 
#include <tqdatetime.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
 
#include "recurrence.h"
#include "alarm.h"
#include "attachment.h"
#include "libkcal_export.h"
 
#include "incidencebase.h"
#include <tdemacros.h>
 
namespace KCal {
 
class Calendar;
 
typedef TQStringList IncidenceList;
typedef TQStringList::iterator IncidenceListIterator;

class LIBKCAL_EXPORT Incidence : public IncidenceBase, public Recurrence::Observer
{
  public:
    template<class T>
    class AddVisitor : public IncidenceBase::Visitor
    {
      public:
        AddVisitor( T *r ) : mResource( r ) {}
 
        bool visit( Event *e ) { return mResource->addEvent( e ); }
        bool visit( Todo *t ) { return mResource->addTodo( t ); }
        bool visit( Journal *j ) { return mResource->addJournal( j ); }
 
      private:
        T *mResource;
    };

    template<class T>
    class AddSubResourceVisitor : public IncidenceBase::Visitor
    {
      public:
        AddSubResourceVisitor( T *r, const TQString &subResource )
          : mResource( r ), mSubResource( subResource ) {}
 
      protected:
        bool visit( Event *e )
        {
          return mResource->addEvent( e, mSubResource );
        }
        bool visit( Todo *t )
        {
          return mResource->addTodo( t, mSubResource );
        }
        bool visit( Journal *j )
        {
          return mResource->addJournal( j, mSubResource );
        }
 
      private:
        T *mResource;
        TQString mSubResource;
    };

    template<class T>
    class DeleteVisitor : public IncidenceBase::Visitor
    {
      public:
        DeleteVisitor( T *r ) : mResource( r ) {}
 
        bool visit( Event *e ) { mResource->deleteEvent( e ); return true; }
        bool visit( Todo *t ) { mResource->deleteTodo( t ); return true; }
        bool visit( Journal *j ) { mResource->deleteJournal( j ); return true; }
 
      private:
        T *mResource;
    };

    enum Status {
        StatusNone, StatusTentative, StatusConfirmed, StatusCompleted,
        StatusNeedsAction, StatusCanceled, StatusInProcess, StatusDraft,
        StatusFinal,
        StatusX   // indicates a non-standard status string
    };

    enum { SecrecyPublic = 0, SecrecyPrivate = 1, SecrecyConfidential = 2 };
 
    typedef ListBase<Incidence> List;
 
    Incidence();
    Incidence( const Incidence & );
    ~Incidence();
 
    Incidence& operator=( const Incidence &i );
    bool operator==( const Incidence & ) const;

    virtual Incidence *clone() = 0;

    void setReadOnly( bool readonly );

    void setFloats( bool f );

    void recreate();

    void setCreated( const TQDateTime & );
    TQDateTime created() const;

    void setRevision( int rev );
    int revision() const;

    virtual void setDtStart( const TQDateTime &dtStart );
    virtual TQDateTime dtEnd() const  { return TQDateTime(); }

    void setDescription( const TQString &description );
    TQString description() const;

    void setSummary( const TQString &summary );
    TQString summary() const;

    void setCategories( const TQStringList &categories );
    void setCategories(const TQString &catStr);
    TQStringList categories() const;
    TQString categoriesStr() const;

    void setRelatedToUid(const TQString &);
    TQString relatedToUid() const;
    void setRelatedTo(Incidence *relatedTo);
    Incidence *relatedTo() const;
    Incidence::List relations() const;
    void addRelation(Incidence *);
    void removeRelation(Incidence *);
 
 
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Recurrence-related methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    Recurrence *recurrence() const;

    void clearRecurrence();

    bool doesRecur() const;
    uint recurrenceType() const;

    virtual bool recursOn( const TQDate &qd ) const;
    bool recursAt( const TQDateTime &qdt ) const;

    virtual bool recursOn( const TQDate &qd, Calendar *cal ) const;
    bool recursAt( const TQDateTime &qdt, Calendar *cal ) const;

    virtual TQValueList<TQDateTime> startDateTimesForDate( const TQDate &date ) const;

    virtual TQValueList<TQDateTime> startDateTimesForDateTime( const TQDateTime &datetime ) const;

    virtual TQDateTime endDateForStart( const TQDateTime &startDt ) const;
 
 
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Attachment-related methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    void addAttachment( Attachment *attachment );
    void deleteAttachment( Attachment *attachment );
    void deleteAttachments( const TQString &mime );
    Attachment::List attachments() const;
    Attachment::List attachments( const TQString &mime ) const;
    void clearAttachments();
 
 
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Secrecy and Status methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    void setSecrecy( int );
    int secrecy() const;
    TQString secrecyStr() const;
    static TQStringList secrecyList();
    static TQString secrecyName( int );

    void setStatus( Status status );
    void setCustomStatus( const TQString &status );
    Status status() const;
    TQString statusStr() const;
    static TQString statusName( Status );
 
 
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Other methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    void setResources( const TQStringList &resources );
    TQStringList resources() const;

    void setPriority( int priority );
    int priority() const;

    bool hasRecurrenceID() const;

    void setHasRecurrenceID( bool hasRecurrenceID );

    void setRecurrenceID( const TQDateTime &recurrenceID );

    TQDateTime recurrenceID() const;

    void addChildIncidence( TQString childIncidence );

    void deleteChildIncidence( TQString childIncidence );

    IncidenceList childIncidences() const;
 
 
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Alarm-related methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    const Alarm::List &alarms() const;
    Alarm *newAlarm();
    void addAlarm( Alarm * );
    void removeAlarm( Alarm * );
    void clearAlarms();
    bool isAlarmEnabled() const;
 
 
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Other methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 

    void setLocation(const TQString &location);
    TQString location() const;

    void setSchedulingID( const TQString& sid );
    TQString schedulingID() const;

    virtual void recurrenceUpdated( Recurrence * );
  protected:
    virtual TQDateTime endDateRecurrenceBase() const { return dtStart(); }
 
  private:
    int mRevision;
 
    // base components of jounal, event and todo
    TQDateTime mCreated;
    TQString mDescription;
    TQString mSummary;
    TQStringList mCategories;
    Incidence *mRelatedTo;
    TQString mRelatedToUid;
    Incidence::List mRelations;
    Attachment::List mAttachments;
    TQStringList mResources;
 
    TQString mStatusString;
    Status  mStatus;
    int mSecrecy;
    int mPriority;                        // 1 = highest, 2 = less, etc.
 
    Alarm::List mAlarms;
    Recurrence *mRecurrence;
 
    TQString mLocation;
 
    // Scheduling ID - used only to identify between scheduling mails
    TQString mSchedulingID;
 
    TQDateTime mRecurrenceID;         // recurrenceID
    bool mHasRecurrenceID;           // if incidence has recurrenceID
 
    IncidenceList mChildRecurrenceEvents;
 
    class Private;
    Private *d;
};
 
}
 
#endif