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

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

#include "kcal_export.h"
#include "duration.h"

#include <kdatetime.h>
#include <QtCore/QList>

namespace KCal {

class KCAL_DEPRECATED_EXPORT Period
{
  public:
    typedef QList<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
};

}

#endif