freebusy.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) 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_FREEBUSY_H
#define KCALCORE_FREEBUSY_H

#include "kcalcore_export.h"
#include "event.h"
#include "freebusyperiod.h"
#include "incidencebase.h"
#include "period.h"

#include <QtCore/QMetaType>

namespace KCalCore {

class FreeBusy;

class KCALCORE_EXPORT FreeBusy : public IncidenceBase
{
    friend KCALCORE_EXPORT QDataStream &operator<<(QDataStream &s,
            const KCalCore::FreeBusy::Ptr &freebusy);
    friend KCALCORE_EXPORT QDataStream &operator>>(QDataStream &s,
            KCalCore::FreeBusy::Ptr &freebusy);

public:

    typedef QSharedPointer<FreeBusy> Ptr;

    typedef QVector<Ptr> List;

    FreeBusy();

    FreeBusy(const FreeBusy &other);

    explicit FreeBusy(const Period::List &busyPeriods);

    explicit FreeBusy(const FreeBusyPeriod::List &busyPeriods);

    FreeBusy(const KDateTime &start, const KDateTime &end);

    FreeBusy(const Event::List &events, const KDateTime &start, const KDateTime &end);

    ~FreeBusy();

    IncidenceType type() const;

    QByteArray typeStr() const;

    virtual void setDtStart(const KDateTime &start);

    void setDtEnd(const KDateTime &end);

    virtual KDateTime dtEnd() const;

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

    Period::List busyPeriods() const;

    FreeBusyPeriod::List fullBusyPeriods() const;

    void addPeriod(const KDateTime &start, const KDateTime &end);

    void addPeriod(const KDateTime &start, const Duration &duration);

    void addPeriods(const Period::List &list);

    void addPeriods(const FreeBusyPeriod::List &list);

    void sortList();

    void merge(FreeBusy::Ptr freebusy);

    KDateTime dateTime(DateTimeRole role) const;

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

    QLatin1String mimeType() const;

    static QLatin1String freeBusyMimeType();

protected:
    virtual bool equals(const IncidenceBase &freebusy) const;

    virtual IncidenceBase &assign(const IncidenceBase &other);

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

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

    FreeBusy &operator=(const FreeBusy &other);

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

KCALCORE_EXPORT QDataStream &operator<<(QDataStream &stream,
                                        const KCalCore::FreeBusy::Ptr &freebusy);
KCALCORE_EXPORT QDataStream &operator>>(QDataStream &stream,
                                        KCalCore::FreeBusy::Ptr &freebusy);
}

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

#endif