duration.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) 2007 David Jarvie <djarvie@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_DURATION_H
#define KCALCORE_DURATION_H

#include "kcalcore_export.h"

#include <QDataStream>
#include <QMetaType>

class KDateTime;

namespace KCalCore {

class KCALCORE_EXPORT Duration
{
public:
    enum Type {
        Seconds,   
        Days       
    };

    Duration();

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

    Duration(const KDateTime &start, const KDateTime &end, Type type);

    // Keep the following implicit since instances are often used in integer evaluations.
    Duration(int duration, Type type = Seconds);   //krazy:exclude=explicit

    Duration(const Duration &duration);

    ~Duration();

    Duration &operator=(const Duration &duration);

    operator bool() const;

    bool operator!() const  {
        return !operator bool();
    }

    bool operator<(const Duration &other) const;

    bool operator<=(const Duration &other) const
    {
        return !other.operator<(*this);
    }

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

    bool operator>=(const Duration &other) const
    {
        return !operator<(other);
    }

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

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

    Duration &operator+=(const Duration &other);

    Duration operator+(const Duration &other) const
    {
        return Duration(*this) += other;
    }

    Duration operator-() const;

    Duration &operator-=(const Duration &other);

    Duration operator-(const Duration &other) const
    {
        return Duration(*this) += other;
    }

    Duration &operator*=(int value);

    Duration operator*(int value) const
    {
        return Duration(*this) *= value;
    }

    Duration &operator/=(int value);

    Duration operator/(int value) const
    {
        return Duration(*this) /= value;
    }

    KDateTime end(const KDateTime &start) const;

    Type type() const;

    bool isDaily() const;

    int asSeconds() const;

    int asDays() const;

    int value() const;

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

    friend KCALCORE_EXPORT QDataStream &operator<<(QDataStream &s, const KCalCore::Duration &);
    friend KCALCORE_EXPORT QDataStream &operator>>(QDataStream &s, KCalCore::Duration &);
};

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

KCALCORE_EXPORT QDataStream &operator>>(QDataStream &in, KCalCore::Duration &);

}

Q_DECLARE_METATYPE(KCalCore::Duration)

#endif