incidencebase.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>
  Copyright (c) 2005 Rafal Rzepecki <divide@users.sourceforge.net>
  Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
  Contact: Alvaro Manera <alvaro.manera@nokia.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_INCIDENCEBASE_H
#define KCALCORE_INCIDENCEBASE_H

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

#include <KDE/KDateTime>

#include <QtCore/QSet>
#include <QtCore/QUrl>
#include <QDataStream>

class KUrl;
class QDate;

namespace KCalCore {

typedef SortableList<QDate> DateList;

typedef SortableList<KDateTime> DateTimeList;

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

class KCALCORE_EXPORT IncidenceBase : public CustomProperties
{
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 KCALCORE_EXPORT IncidenceObserver
    {
    public:

        virtual ~IncidenceObserver();

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

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

    IncidenceBase();

    virtual ~IncidenceBase();

    IncidenceBase &operator=(const IncidenceBase &other);

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

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

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

    virtual IncidenceType type() const = 0;

    virtual QByteArray typeStr() const = 0;

    void setUid(const QString &uid);

    QString uid() const;

    KUrl uri() const;

    virtual void setLastModified(const KDateTime &lm);

    KDateTime lastModified() const;

    void setOrganizer(const Person::Ptr &organizer);

    void setOrganizer(const QString &organizer);

    Person::Ptr organizer() const;

    virtual void setReadOnly(bool readOnly);

    bool isReadOnly() const;

    virtual void setDtStart(const KDateTime &dtStart);

    virtual KDateTime dtStart() const;

    virtual void setDuration(const Duration &duration);

    Duration duration() const;

    void setHasDuration(bool hasDuration);

    bool hasDuration() const;

    bool allDay() const;

    void setAllDay(bool allDay);

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

    void addComment(const QString &comment);

    bool removeComment(const QString &comment);

    void clearComments();

    QStringList comments() const;

    void addContact(const QString &contact);

    bool removeContact(const QString &contact);

    void clearContacts();

    QStringList contacts() const;

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

    void clearAttendees();

    void deleteAttendee(const Attendee::Ptr &attendee,
                        bool doUpdate = true);

    Attendee::List attendees() const;

    int attendeeCount() const;

    Attendee::Ptr attendeeByMail(const QString &email) const;

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

    Attendee::Ptr attendeeByUid(const QString &uid) const;

    void setUrl(const QUrl &url);

    QUrl url() const;

    void registerObserver(IncidenceObserver *observer);

    void unRegisterObserver(IncidenceObserver *observer);

    void update();

    void updated();

    void startUpdates();

    void endUpdates();

    virtual KDateTime dateTime(DateTimeRole role) const = 0;

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

    virtual QLatin1String mimeType() const = 0;

    virtual KDateTime recurrenceId() const;

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

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

    void resetDirtyFields();

    static quint32 magicSerializationIdentifier();

protected:

    void setFieldDirty(IncidenceBase::Field field);

    virtual void customPropertyUpdate();

    virtual void customPropertyUpdated();

    IncidenceBase(const IncidenceBase &ib);

    virtual bool equals(const IncidenceBase &incidenceBase) const;

    virtual IncidenceBase &assign(const IncidenceBase &other);

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

    enum VirtualHook {
        SerializerHook,
        DeserializerHook
    };

    bool mReadOnly;

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

    friend KCALCORE_EXPORT QDataStream &operator<<(QDataStream &stream,
            const KCalCore::IncidenceBase::Ptr &);

    friend KCALCORE_EXPORT QDataStream &operator>>(QDataStream &stream,
            const KCalCore::IncidenceBase::Ptr &);
};

KCALCORE_EXPORT QDataStream &operator<<(QDataStream &out, const KCalCore::IncidenceBase::Ptr &);

KCALCORE_EXPORT QDataStream &operator>>(QDataStream &in, const KCalCore::IncidenceBase::Ptr &);

}

Q_DECLARE_METATYPE(KCalCore::IncidenceBase *)
Q_DECLARE_METATYPE(KCalCore::IncidenceBase::Ptr)

#endif