incidencebase.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-FileCopyrightText: 2005 Rafal Rzepecki <[email protected]>
  SPDX-FileCopyrightText: 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
  SPDX-FileContributor: Alvaro Manera <[email protected]>

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

#include "attendee.h"
#include "customproperties.h"
#include "duration.h"
#include "person.h"

#include <QDateTime>
#include <QSharedPointer>
#include <QSet>
#include <QUrl>
#include <QDataStream>

class QUrl;
class QDate;
class QTimeZone;

namespace KCalendarCore {
typedef QList<QDate> DateList;

typedef QList<QDateTime> DateTimeList;

class Event;
class Todo;
class Journal;
class FreeBusy;
class Visitor;

class KCALENDARCORE_EXPORT IncidenceBase : public CustomProperties
{
    Q_GADGET
    Q_PROPERTY(QString uid READ uid WRITE setUid)
    Q_PROPERTY(QDateTime lastModified READ lastModified WRITE setLastModified)
    Q_PROPERTY(QDateTime dtStart READ dtStart WRITE setDtStart)
    Q_PROPERTY(bool allDay READ allDay WRITE setAllDay)
    Q_PROPERTY(KCalendarCore::Person organizer READ organizer WRITE setOrganizer)
    Q_PROPERTY(QVariantList attendees READ attendeesVariant)

public:
    typedef QSharedPointer<IncidenceBase> Ptr;

    enum IncidenceType {
        TypeEvent = 0,           
        TypeTodo,                
        TypeJournal,             
        TypeFreeBusy,            
        TypeUnknown              
    };

    enum DateTimeRole {
        RoleAlarmStartOffset = 0,
        RoleAlarmEndOffset,      
        RoleSort,                
        RoleCalendarHashing,     
        RoleStartTimeZone,       
        RoleEndTimeZone,         
        RoleEndRecurrenceBase,
        RoleEnd,                 
        RoleDisplayEnd,          
        RoleAlarm,               
        RoleRecurrenceStart,     
        RoleDisplayStart,        
        RoleDnD                  
    };

    enum Field {
        FieldDtStart,         
        FieldDtEnd,           
        FieldLastModified,    
        FieldDescription,     
        FieldSummary,         
        FieldLocation,        
        FieldCompleted,       
        FieldPercentComplete, 
        FieldDtDue,           
        FieldCategories,      
        FieldRelatedTo,       
        FieldRecurrence,      
        FieldAttachment,      
        FieldSecrecy,         
        FieldStatus,          
        FieldTransparency,    
        FieldResources,       
        FieldPriority,        
        FieldGeoLatitude,     
        FieldGeoLongitude,    
        FieldRecurrenceId,    
        FieldAlarms,          
        FieldSchedulingId,    
        FieldAttendees,       
        FieldOrganizer,       
        FieldCreated,         
        FieldRevision,        
        FieldDuration,        
        FieldContact,         
        FieldComment,         
        FieldUid,             
        FieldUnknown,         
        FieldUrl              
    };

    class KCALENDARCORE_EXPORT IncidenceObserver
    {
    public:

        virtual ~IncidenceObserver();

        virtual void incidenceUpdate(const QString &uid, const QDateTime &recurrenceId) = 0;

        virtual void incidenceUpdated(const QString &uid, const QDateTime &recurrenceId) = 0;
    };

    IncidenceBase();

    ~IncidenceBase() override;

    IncidenceBase &operator=(const IncidenceBase &other);

    bool operator==(const IncidenceBase &ib) const;

    bool operator!=(const IncidenceBase &ib) const;

    virtual bool accept(Visitor &v, const IncidenceBase::Ptr &incidence);

    virtual IncidenceType type() const = 0;

    virtual QByteArray typeStr() const = 0;

    void setUid(const QString &uid);

    Q_REQUIRED_RESULT QString uid() const;

    Q_REQUIRED_RESULT QUrl uri() const;

    virtual void setLastModified(const QDateTime &lm);

    Q_REQUIRED_RESULT QDateTime lastModified() const;

    void setOrganizer(const Person &organizer);

    void setOrganizer(const QString &organizer);

    Person organizer() const;

    virtual void setReadOnly(bool readOnly);

    Q_REQUIRED_RESULT bool isReadOnly() const;

    virtual void setDtStart(const QDateTime &dtStart);

    virtual QDateTime dtStart() const;

    virtual void setDuration(const Duration &duration);

    Q_REQUIRED_RESULT Duration duration() const;

    void setHasDuration(bool hasDuration);

    Q_REQUIRED_RESULT bool hasDuration() const;

    Q_REQUIRED_RESULT bool allDay() const;

    virtual void setAllDay(bool allDay);

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

    void addComment(const QString &comment);

    Q_REQUIRED_RESULT bool removeComment(const QString &comment);

    void clearComments();

    Q_REQUIRED_RESULT QStringList comments() const;

    void addContact(const QString &contact);

    Q_REQUIRED_RESULT bool removeContact(const QString &contact);

    void clearContacts();

    Q_REQUIRED_RESULT QStringList contacts() const;

    void addAttendee(const Attendee &attendee, bool doUpdate = true);

    void clearAttendees();

    void setAttendees(const Attendee::List &attendees, bool doUpdate = true);

    Q_REQUIRED_RESULT Attendee::List attendees() const;

    Q_REQUIRED_RESULT int attendeeCount() const;

    Attendee attendeeByMail(const QString &email) const;

    Attendee attendeeByMails(const QStringList &emails, const QString &email = QString()) const;

    Attendee attendeeByUid(const QString &uid) const;

    void setUrl(const QUrl &url);

    Q_REQUIRED_RESULT QUrl url() const;

    void registerObserver(IncidenceObserver *observer);

    void unRegisterObserver(IncidenceObserver *observer);

    void update();

    void updated();

    void startUpdates();

    void endUpdates();

    virtual QDateTime dateTime(DateTimeRole role) const = 0;

    virtual void setDateTime(const QDateTime &dateTime, DateTimeRole role) = 0;

    virtual QLatin1String mimeType() const = 0;

    virtual QDateTime recurrenceId() const;

    QSet<IncidenceBase::Field> dirtyFields() const;

    void setDirtyFields(const QSet<IncidenceBase::Field> &);

    void resetDirtyFields();

    Q_REQUIRED_RESULT static quint32 magicSerializationIdentifier();

protected:

    void setFieldDirty(IncidenceBase::Field field);

    void customPropertyUpdate() override;

    void customPropertyUpdated() override;

    IncidenceBase(const IncidenceBase &ib);

    virtual bool equals(const IncidenceBase &incidenceBase) const;

    virtual IncidenceBase &assign(const IncidenceBase &other);

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

    enum VirtualHook {};

    virtual void virtual_hook(VirtualHook id, void *data) = 0;

    bool mReadOnly;

private:
    //@cond PRIVATE
    class Private;
    Private *const d;

    Q_DECL_HIDDEN QVariantList attendeesVariant() const;
    //@endcond

    friend KCALENDARCORE_EXPORT QDataStream &operator<<(QDataStream &stream, const KCalendarCore::IncidenceBase::Ptr &);

    friend KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &stream, KCalendarCore::IncidenceBase::Ptr &);
};

KCALENDARCORE_EXPORT QDataStream &operator<<(QDataStream &out, const KCalendarCore::IncidenceBase::Ptr &);

KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &in, KCalendarCore::IncidenceBase::Ptr &);
}

Q_DECLARE_METATYPE(KCalendarCore::IncidenceBase *)
Q_DECLARE_METATYPE(KCalendarCore::IncidenceBase::Ptr)

#endif