period.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>

  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_PERIOD_H
#define KCALCORE_PERIOD_H

#include "kcalcore_export.h"
#include "duration.h"

#include <KDE/KDateTime>

#include <QtCore/QDataStream>
#include <QtCore/QMetaType>
#include <QtCore/QVector>

namespace KCalCore {

class KCALCORE_EXPORT Period
{
public:
    typedef QVector<Period> List;

    Period();

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

    Period(const KDateTime &start, const Duration &duration);

    Period(const Period &period);

    ~Period();

    bool operator<(const Period &other) const;

    bool operator>(const Period &other) const  {
        return other.operator<(*this);
    }

    bool operator==(const Period &other) const;

    bool operator!=(const Period &other) const  {
        return !operator==(other);
    }

    Period &operator=(const Period &other);

    KDateTime start() const;

    KDateTime end() const;

    Duration duration() const;

    Duration duration(Duration::Type type) const;

    bool hasDuration() const;

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

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

    friend KCALCORE_EXPORT QDataStream &operator<<(QDataStream &stream,
            const KCalCore::Period &period);

    friend KCALCORE_EXPORT QDataStream &operator>>(QDataStream &stream,
            KCalCore::Period &period);
};

KCALCORE_EXPORT QDataStream &operator<<(QDataStream &stream, const KCalCore::Period &period);

KCALCORE_EXPORT QDataStream &operator>>(QDataStream &stream, KCalCore::Period &period);
}

KCALCORE_EXPORT uint qHash(const KCalCore::Period &key);

//@cond PRIVATE
Q_DECLARE_METATYPE(KCalCore::Period)
//@endcond

#endif