incidence.h

Go to the documentation of this file.

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

#include "kcalcore_export.h"
#include "alarm.h"
#include "attachment.h"
#include "incidencebase.h"
#include "recurrence.h"

#include <QtCore/QMetaType>

//@cond PRIVATE
// Value used to signal invalid/unset latitude or longitude.
#define INVALID_LATLON 255.0
//@endcond

namespace KCalCore {

class KCALCORE_EXPORT Incidence
    : public IncidenceBase, public Recurrence::RecurrenceObserver
{
public:

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

    enum Secrecy {
        SecrecyPublic,      
        SecrecyPrivate,     
        SecrecyConfidential 
    };

    enum RelType {
        RelTypeParent,  
        RelTypeChild,   
        RelTypeSibling  
    };

    typedef QSharedPointer<Incidence> Ptr;

    typedef QVector<Ptr> List;

    Incidence();

    virtual ~Incidence();

    virtual Incidence *clone() const = 0;

    QString instanceIdentifier() const;

    void setReadOnly(bool readonly);

    void setLastModified(const KDateTime &lm);

    void setLocalOnly(bool localonly);

    bool localOnly() const;

    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 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 setRelatedTo(const QString &uid, RelType relType = RelTypeParent);

    QString relatedTo(RelType relType = RelTypeParent) const;

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  Convenience wrappers for property handling
// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    bool hasAltDescription() const;
    void setAltDescription(const QString &altdescription);

    QString altDescription() const;

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  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(const Attachment::Ptr &attachment);

    void deleteAttachment(const Attachment::Ptr &attachment);

    void deleteAttachments(const QString &mime);

    Attachment::List attachments() const;

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

    void clearAttachments();

    QString writeAttachmentToTempFile(const Attachment::Ptr &attachment) const;

    void clearTempFiles();

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

    void setSecrecy(Secrecy secrecy);

    Secrecy secrecy() const;

    void setStatus(Status status);

    void setCustomStatus(const QString &status);

    QString customStatus() const;

    Status status() const;

// %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
// %%%%%  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;

    bool hasRecurrenceId() const;

    void setRecurrenceId(const KDateTime &recurrenceId);

    KDateTime recurrenceId() const;

    void setThisAndFuture(bool thisAndFuture);

    bool thisAndFuture() const;

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

    Alarm::List alarms() const;

    Alarm::Ptr newAlarm();

    void addAlarm(const Alarm::Ptr &alarm);

    void removeAlarm(const Alarm::Ptr &alarm);

    void clearAlarms();

    bool hasEnabledAlarms() const;

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

    void setSchedulingID(const QString &sid,
                         const QString &uid = QString());

    QString schedulingID() const;

    virtual void recurrenceUpdated(Recurrence *recurrence);

    virtual QLatin1String iconName(const KDateTime &recurrenceId = KDateTime()) const = 0;
 //TODO_KDE5: make pure virtual
    bool supportsGroupwareCommunication() const;

    static QStringList mimeTypes();

protected:

    Incidence(const Incidence &other);

    virtual bool equals(const IncidenceBase &incidence) const;

    virtual IncidenceBase &assign(const IncidenceBase &other);

    void serialize(QDataStream &out);
    void deserialize(QDataStream &in);

private:
    Incidence &operator=(const Incidence &other);

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

}

//@cond PRIVATE
inline uint qHash(const QSharedPointer<KCalCore::Incidence> &key)
{
    return qHash<KCalCore::Incidence>(key.data());
}
//@endcond

//@cond PRIVATE
Q_DECLARE_TYPEINFO(KCalCore::Incidence::Ptr, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(KCalCore::Incidence *)
//@endcond

#endif