incidence.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-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 "kcal_export.h"
#include "incidencebase.h"
#include "alarm.h"
#include "attachment.h"
#include "recurrence.h"

#include <QtCore/QList>
#include <QtCore/QMetaType>

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

namespace KCal {

class KCAL_DEPRECATED_EXPORT Incidence //krazy:exclude=dpointer since nested class templates confuse krazy
  : public IncidenceBase, public Recurrence::RecurrenceObserver
{
  public:
    //@cond PRIVATE
    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 );
        }
        bool visit( FreeBusy * )
        {
          return false;
        }

      private:
        T *mResource;
    };
    //@endcond

    //@cond PRIVATE
    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;
        }
        bool visit( FreeBusy * )
        {
          return false;
        }

      private:
        T *mResource;
    };
    //@endcond

    enum Status {
      StatusNone,           
      StatusTentative,      
      StatusConfirmed,      
      StatusCompleted,      
      StatusNeedsAction,    
      StatusCanceled,       
      StatusInProcess,      
      StatusDraft,          
      StatusFinal,          
      StatusX               
    };

    enum Secrecy {
      SecrecyPublic=0,      
      SecrecyPrivate=1,     
      SecrecyConfidential=2 
    };

    typedef ListBase<Incidence> List;

    typedef boost::shared_ptr<Incidence> Ptr;

    typedef boost::shared_ptr<const Incidence> ConstPtr;

    Incidence();

    Incidence( const Incidence &other );

    ~Incidence();

    virtual Incidence *clone() = 0; //TODO KDE5: make this const

    void setReadOnly( bool readonly );

    void setAllDay( bool allDay );

    void recreate();

    void setCreated( const KDateTime &dt );

    KDateTime created() const;

    void setRevision( int rev );

    int revision() const;

    virtual void setDtStart( const KDateTime &dt );

    virtual KDateTime dtEnd() const;

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

    void setDescription( const QString &description, bool isRich );

    void setDescription( const QString &description );

    QString description() const;

    QString richDescription() const;

    bool descriptionIsRich() const;

    void setSummary( const QString &summary, bool isRich );

    void setSummary( const QString &summary );

    QString summary() const;

    QString richSummary() const;

    bool summaryIsRich() const;

    void setLocation( const QString &location, bool isRich );

    void setLocation( const QString &location );

    QString location() const;

    QString richLocation() const;

    bool locationIsRich() const;

    void setCategories( const QStringList &categories );

    void setCategories( const QString &catStr );

    QStringList categories() const;

    QString categoriesStr() const;

    void setRelatedToUid( const QString &uid );

    QString relatedToUid() const;

    void setRelatedTo( Incidence *incidence );

    Incidence *relatedTo() const;

    Incidence::List relations() const;

    void addRelation( Incidence *incidence );

    void removeRelation( Incidence *incidence );

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Recurrence-related methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    Recurrence *recurrence() const;

    void clearRecurrence();

    bool recurs() const;

    ushort recurrenceType() const;

    virtual bool recursOn( const QDate &date, const KDateTime::Spec &timeSpec ) const;

    bool recursAt( const KDateTime &dt ) const;

    virtual QList<KDateTime> startDateTimesForDate(
      const QDate &date,
      const KDateTime::Spec &timeSpec = KDateTime::LocalZone ) const;

    virtual QList<KDateTime> startDateTimesForDateTime(
      const KDateTime &datetime ) const;

    virtual KDateTime endDateForStart( const KDateTime &startDt ) const;

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Attachment-related methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    void addAttachment( Attachment *attachment );

    void deleteAttachment( Attachment *attachment );

    void deleteAttachments( const QString &mime );

    Attachment::List attachments() const;

    Attachment::List attachments( const QString &mime ) const;

    void clearAttachments();

    QString writeAttachmentToTempFile( Attachment *attachment ) const;

    void clearTempFiles();

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Secrecy and Status methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    void setSecrecy( Secrecy secrecy );

    Secrecy secrecy() const;

    QString secrecyStr() const;

    static QStringList secrecyList();

    static QString secrecyName( Secrecy secrecy );

    void setStatus( Status status );

    void setCustomStatus( const QString &status );

    Status status() const;

    QString statusStr() const;

    static QString statusName( Status status );

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Other methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    void setResources( const QStringList &resources );

    QStringList resources() const;

    void setPriority( int priority );

    int priority() const;

    bool hasGeo() const;

    void setHasGeo( bool hasGeo );

    void setGeoLatitude( float geolatitude );

    float &geoLatitude() const;

    void setGeoLongitude( float geolongitude );

    float &geoLongitude() const;

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Alarm-related methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    const Alarm::List &alarms() const;

    Alarm *newAlarm();

    void addAlarm( Alarm *alarm );

    void removeAlarm( Alarm *alarm );

    void clearAlarms();

    bool isAlarmEnabled() const;

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Other methods
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    void setSchedulingID( const QString &sid );

    QString schedulingID() const;

    virtual void recurrenceUpdated( Recurrence *recurrence );

    Incidence &operator=( const Incidence &other ); // KDE5: make protected to
                                                    // prevent accidental usage

    bool operator==( const Incidence &incidence ) const; // KDE5: make protected to
                                                         // prevent accidental usage

  protected:
    virtual KDateTime endDateRecurrenceBase() const
    {
      return dtStart();
    }

  private:
    void init( const Incidence &other );
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

}

#define KCAL_INCIDENCE_METATYPE_DEFINED 1
Q_DECLARE_METATYPE( KCal::Incidence* )

#endif