KCalCore Library

period.h

00001 /*
00002   This file is part of the kcalcore library.
00003 
00004   Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
00005 
00006   This library is free software; you can redistribute it and/or
00007   modify it under the terms of the GNU Library General Public
00008   License as published by the Free Software Foundation; either
00009   version 2 of the License, or (at your option) any later version.
00010 
00011   This library is distributed in the hope that it will be useful,
00012   but WITHOUT ANY WARRANTY; without even the implied warranty of
00013   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014   Library General Public License for more details.
00015 
00016   You should have received a copy of the GNU Library General Public License
00017   along with this library; see the file COPYING.LIB.  If not, write to
00018   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00019   Boston, MA 02110-1301, USA.
00020 */
00031 #ifndef KCALCORE_PERIOD_H
00032 #define KCALCORE_PERIOD_H
00033 
00034 #include "kcalcore_export.h"
00035 #include "duration.h"
00036 
00037 #include <KDE/KDateTime>
00038 
00039 #include <QtCore/QDataStream>
00040 #include <QtCore/QMetaType>
00041 #include <QtCore/QVector>
00042 
00043 namespace KCalCore {
00044 
00049 class KCALCORE_EXPORT Period
00050 {
00051   public:
00055     typedef QVector<Period> List;
00056 
00060     Period();
00061 
00068     Period( const KDateTime &start, const KDateTime &end );
00069 
00076     Period( const KDateTime &start, const Duration &duration );
00077 
00084     Period( const Period &period );
00085 
00089     ~Period();
00090 
00097     bool operator<( const Period &other ) const;
00098 
00105     bool operator>( const Period &other ) const  { return other.operator<( *this ); }
00106 
00115     bool operator==( const Period &other ) const;
00116 
00123     bool operator!=( const Period &other ) const  { return !operator==( other ); }
00124 
00130     Period &operator=( const Period &other );
00131 
00135     KDateTime start() const;
00136 
00140     KDateTime end() const;
00141 
00154     Duration duration() const;
00155 
00167     Duration duration( Duration::Type type ) const;
00168 
00173     bool hasDuration() const;
00174 
00189     void shiftTimes( const KDateTime::Spec &oldSpec,
00190                      const KDateTime::Spec &newSpec );
00191 
00192   private:
00193     //@cond PRIVATE
00194     class Private;
00195     Private *const d;
00196     //@endcond
00197 
00198     friend KCALCORE_EXPORT QDataStream &operator<<( QDataStream &stream,
00199                                                     const KCalCore::Period &period );
00200 
00201     friend KCALCORE_EXPORT QDataStream &operator>>( QDataStream &stream,
00202                                                     KCalCore::Period &period );
00203 };
00204 
00206 KCALCORE_EXPORT QDataStream &operator<<( QDataStream &stream, const KCalCore::Period &period );
00207 
00209 KCALCORE_EXPORT QDataStream &operator>>( QDataStream &stream, KCalCore::Period &period );
00210 }
00211 
00216 KCALCORE_EXPORT uint qHash( const KCalCore::Period &key );
00217 
00218 //@cond PRIVATE
00219 Q_DECLARE_METATYPE( KCalCore::Period )
00220 //@endcond
00221 
00222 #endif
KCalCore Library

period.h

KCalCore Library

KDE-PIM Libraries
