incidencebase.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>
  Copyright (c) 2005 Rafal Rzepecki <divide@users.sourceforge.net>

  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 KCAL_INCIDENCEBASE_H
#define KCAL_INCIDENCEBASE_H

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

#include <kdatetime.h>

#include <QtCore/QStringList>
#include <QtCore/QByteArray>

class KUrl;

namespace KCal {

typedef SortableList<QDate> DateList;
typedef SortableList<KDateTime> DateTimeList;
class Event;
class Todo;
class Journal;
class FreeBusy;

class KCAL_DEPRECATED_EXPORT IncidenceBase : public CustomProperties
{
  public:
    class KCAL_DEPRECATED_EXPORT Visitor //krazy:exclude=dpointer
    {
      public:
        virtual ~Visitor() {}

        virtual bool visit( Event *event );

        virtual bool visit( Todo *todo );

        virtual bool visit( Journal *journal );

        virtual bool visit( FreeBusy *freebusy );

      protected:
        Visitor() {}
    };

    class IncidenceObserver
    {
      public:

        virtual ~IncidenceObserver() {}

        virtual void incidenceUpdated( IncidenceBase *incidenceBase ) = 0;
    };

    IncidenceBase();

    IncidenceBase( const IncidenceBase &ib );

    virtual ~IncidenceBase();

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

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

    virtual bool accept( Visitor &v )
    {
      Q_UNUSED( v );
      return false;
    }

    virtual QByteArray type() const = 0;

    //KDE5: virtual QString typeStr() const = 0;

    void setUid( const QString &uid );

    QString uid() const;

    KUrl uri() const;

    void setLastModified( const KDateTime &lm );

    KDateTime lastModified() const;

    void setOrganizer( const Person &organizer );

    void setOrganizer( const QString &organizer );

    Person organizer() const;

    virtual void setReadOnly( bool readOnly );

    bool isReadOnly() const { return mReadOnly; }

    virtual void setDtStart( const KDateTime &dtStart );

    virtual KDateTime dtStart() const;

    virtual KCAL_DEPRECATED QString dtStartTimeStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    virtual KCAL_DEPRECATED QString dtStartDateStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) const;

    virtual KCAL_DEPRECATED QString dtStartStr(
      bool shortfmt = true, const KDateTime::Spec &spec = KDateTime::Spec() ) 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 addAttendee( Attendee *attendee, bool doUpdate = true );

    void clearAttendees();

    const Attendee::List &attendees() const;

    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 registerObserver( IncidenceObserver *observer );

    void unRegisterObserver( IncidenceObserver *observer );

    void updated();

    void startUpdates();

    void endUpdates();

  protected:
    virtual void customPropertyUpdated();

    bool mReadOnly;

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

}

#endif