period.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-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KCALCORE_PERIOD_H
#define KCALCORE_PERIOD_H

#include "kcalendarcore_export.h"
#include "duration.h"

#include <QDateTime>
#include <QDataStream>
#include <QMetaType>
#include <QVector>

class QTimeZone;

namespace KCalendarCore
{

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

    Period();

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

    Period(const QDateTime &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);

    Q_REQUIRED_RESULT QDateTime start() const;

    Q_REQUIRED_RESULT QDateTime end() const;

    Q_REQUIRED_RESULT Duration duration() const;

    Q_REQUIRED_RESULT Duration duration(Duration::Type type) const;

    Q_REQUIRED_RESULT bool hasDuration() const;

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

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

    friend KCALENDARCORE_EXPORT QDataStream &operator<<(QDataStream &stream,
            const KCalendarCore::Period &period);

    friend KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &stream,
            KCalendarCore::Period &period);
};

KCALENDARCORE_EXPORT QDataStream &operator<<(QDataStream &stream, const KCalendarCore::Period &period);

KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &stream, KCalendarCore::Period &period);

KCALENDARCORE_EXPORT uint qHash(const KCalendarCore::Period &key);
}

//@cond PRIVATE
Q_DECLARE_METATYPE(KCalendarCore::Period)
Q_DECLARE_TYPEINFO(KCalendarCore::Period, Q_MOVABLE_TYPE);
//@endcond

#endif