incidence.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.

  SPDX-FileCopyrightText: 2001-2003 Cornelius Schumacher <[email protected]>
  SPDX-FileCopyrightText: 2003-2004 Reinhold Kainhofer <[email protected]>

  SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KCALCORE_INCIDENCE_H
#define KCALCORE_INCIDENCE_H

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

#include <QMetaType>

//@cond PRIVATE
// Value used to signal invalid/unset latitude or longitude.
#define INVALID_LATLON 255.0 //krazy:exclude=defines (part of the API)
//@endcond

namespace KCalendarCore
{

class KCALENDARCORE_EXPORT Incidence
    : public IncidenceBase, public Recurrence::RecurrenceObserver
{
    Q_GADGET
    Q_PROPERTY(QString description READ description WRITE setDescription)
    Q_PROPERTY(QString summary READ summary WRITE setSummary)
    Q_PROPERTY(QString location READ location WRITE setLocation)
    Q_PROPERTY(bool hasGeo READ hasGeo WRITE setHasGeo)
    Q_PROPERTY(float geoLatitude READ geoLatitude WRITE setGeoLatitude)
    Q_PROPERTY(float geoLongitude READ geoLongitude WRITE setGeoLongitude)
    Q_PROPERTY(QStringList categories READ categories WRITE setCategories)
    Q_PROPERTY(int priority READ priority WRITE setPriority)
    Q_PROPERTY(QDateTime created READ created WRITE setCreated)
    Q_PROPERTY(KCalendarCore::Incidence::Secrecy secrecy READ secrecy WRITE setSecrecy)
    Q_PROPERTY(KCalendarCore::Incidence::Status status READ status WRITE setStatus)
    Q_PROPERTY(QVariantList attachments READ attachmentsVariant)
public:

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

    
    enum Secrecy {
        SecrecyPublic,      
        SecrecyPrivate,     
        SecrecyConfidential 
    };
    Q_ENUM(Secrecy)

    
    enum RelType {
        RelTypeParent,  
        RelTypeChild,   
        RelTypeSibling  
    };

    typedef QSharedPointer<Incidence> Ptr;

    typedef QVector<Ptr> List;

    Incidence();

    ~Incidence() override;

    virtual Incidence *clone() const = 0;

    Q_REQUIRED_RESULT QString instanceIdentifier() const;

    void setReadOnly(bool readonly) override;

    void setLastModified(const QDateTime &lm) override;

    void setLocalOnly(bool localonly);

    Q_REQUIRED_RESULT bool localOnly() const;

    void setAllDay(bool allDay) override;

    void recreate();

    void setCreated(const QDateTime &dt);

    Q_REQUIRED_RESULT QDateTime created() const;

    void setRevision(int rev);

    Q_REQUIRED_RESULT int revision() const;

    void setDtStart(const QDateTime &dt) override;

    void shiftTimes(const QTimeZone &oldZone, const QTimeZone &newZone) override;

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

    void setDescription(const QString &description);

    Q_REQUIRED_RESULT QString description() const;

    Q_REQUIRED_RESULT QString richDescription() const;

    Q_REQUIRED_RESULT bool descriptionIsRich() const;

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

    void setSummary(const QString &summary);

    Q_REQUIRED_RESULT QString summary() const;

    Q_REQUIRED_RESULT QString richSummary() const;

    Q_REQUIRED_RESULT bool summaryIsRich() const;

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

    void setLocation(const QString &location);

    Q_REQUIRED_RESULT QString location() const;

    Q_REQUIRED_RESULT QString richLocation() const;

    Q_REQUIRED_RESULT bool locationIsRich() const;

    void setCategories(const QStringList &categories);

    void setCategories(const QString &catStr);

    Q_REQUIRED_RESULT QStringList categories() const;

    Q_REQUIRED_RESULT QString categoriesStr() const;

    void setRelatedTo(const QString &uid, RelType relType = RelTypeParent);

    Q_REQUIRED_RESULT QString relatedTo(RelType relType = RelTypeParent) const;

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

    Q_REQUIRED_RESULT QString altDescription() const;

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

    Recurrence *recurrence() const;

    void clearRecurrence();

    Q_REQUIRED_RESULT bool recurs() const;

    Q_REQUIRED_RESULT ushort recurrenceType() const;

    virtual bool recursOn(const QDate &date, const QTimeZone &timeZone) const;

    Q_REQUIRED_RESULT bool recursAt(const QDateTime &dt) const;

    virtual QList<QDateTime> startDateTimesForDate(const QDate &date,
                                                   const QTimeZone &timeZone) const;

    Q_REQUIRED_RESULT virtual QList<QDateTime> startDateTimesForDateTime(const QDateTime &datetime) const;

    Q_REQUIRED_RESULT virtual QDateTime endDateForStart(const QDateTime &startDt) const;

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

    void addAttachment(const Attachment &attachment);

    void deleteAttachments(const QString &mime);

    Q_REQUIRED_RESULT Attachment::List attachments() const;

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

    void clearAttachments();

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

    void setSecrecy(Secrecy secrecy);

    Q_REQUIRED_RESULT Secrecy secrecy() const;

    void setStatus(Status status);

    void setCustomStatus(const QString &status);

    Q_REQUIRED_RESULT QString customStatus() const;

    Q_REQUIRED_RESULT Status status() const;

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

    void setResources(const QStringList &resources);

    Q_REQUIRED_RESULT QStringList resources() const;

    void setPriority(int priority);

    Q_REQUIRED_RESULT int priority() const;

    Q_REQUIRED_RESULT bool hasGeo() const;

    void setHasGeo(bool hasGeo);

    void setGeoLatitude(float geolatitude);

    Q_REQUIRED_RESULT float geoLatitude() const;

    void setGeoLongitude(float geolongitude);

    Q_REQUIRED_RESULT float geoLongitude() const;

    Q_REQUIRED_RESULT bool hasRecurrenceId() const;

    void setRecurrenceId(const QDateTime &recurrenceId);

    Q_REQUIRED_RESULT QDateTime recurrenceId() const override;

    void setThisAndFuture(bool thisAndFuture);

    Q_REQUIRED_RESULT bool thisAndFuture() const;

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

    Q_REQUIRED_RESULT Alarm::List alarms() const;

    Alarm::Ptr newAlarm();

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

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

    void clearAlarms();

    Q_REQUIRED_RESULT bool hasEnabledAlarms() const;

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

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

    Q_REQUIRED_RESULT QString schedulingID() const;

    void recurrenceUpdated(Recurrence *recurrence) override;

    virtual QLatin1String iconName(const QDateTime &recurrenceId = {}) const = 0;

    virtual bool supportsGroupwareCommunication() const = 0;

    Q_REQUIRED_RESULT static QStringList mimeTypes();

protected:

    Incidence(const Incidence &other);

    bool equals(const IncidenceBase &incidence) const override;

    IncidenceBase &assign(const IncidenceBase &other) override;

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

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

    Q_DECL_HIDDEN QVariantList attachmentsVariant() const;

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

}

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

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

#endif