datetime.h

/*
 *  datetime.h  -  date/time with start-of-day time for date-only values
 *  This file is part of kalarmcal library, which provides access to KAlarm
 *  calendar data.
 *  Copyright © 2003,2005-2007,2009,2011 by 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 KALARM_DATETIME_H
#define KALARM_DATETIME_H

#include "kalarmcal_export.h"

#include <kdatetime.h>

namespace KAlarmCal
{

class KALARMCAL_EXPORT DateTime
{
    public:
        DateTime();
        DateTime(const QDate& d, const KDateTime::Spec& spec);
        DateTime(const QDate& d, const QTime& t, const KDateTime::Spec& spec);
        DateTime(const QDateTime& dt, const KDateTime::Spec& spec);
        DateTime(const KDateTime& dt);
        DateTime(const DateTime& dt);

        ~DateTime();
        DateTime& operator=(const DateTime& dt);
        DateTime& operator=(const KDateTime& dt);

        bool isNull() const;
        bool isValid() const;
        bool isDateOnly() const;
        void setDateOnly(bool d);

        QDate date() const;
        void setDate(const QDate& d);

        QDateTime rawDateTime() const;
        KDateTime kDateTime() const;
        QTime effectiveTime() const;
        void setTime(const QTime& t);
        QDateTime effectiveDateTime() const;
        void setDateTime(const QDateTime& dt);

        KDateTime effectiveKDateTime() const;
        KDateTime calendarKDateTime() const;

        KTimeZone timeZone() const;
        KDateTime::Spec timeSpec() const;
        void setTimeSpec(const KDateTime::Spec &spec);
        KDateTime::SpecType timeType() const;
        bool isLocalZone() const;
        bool isClockTime() const;
        bool isUtc() const;
        bool isOffsetFromUtc() const;
        int utcOffset() const;

        bool isSecondOccurrence() const;
        void setSecondOccurrence(bool second);

        DateTime toUtc() const;
        DateTime toOffsetFromUtc() const;
        DateTime toOffsetFromUtc(int utcOffset) const;
        DateTime toLocalZone() const;
        DateTime toClockTime() const;
        DateTime toZone(const KTimeZone& zone) const;
        DateTime toTimeSpec(const KDateTime::Spec &spec) const;

        uint toTime_t() const;
        void setTime_t(uint secs);

        DateTime addSecs(qint64 n) const;
        DateTime addMins(qint64 n) const;
        DateTime addDays(int n) const;
        DateTime addMonths(int n) const;
        DateTime addYears(int n) const;

        int daysTo(const DateTime& dt) const;
        int minsTo(const DateTime& dt) const;
        int secsTo(const DateTime& dt) const;
        qint64 secsTo_long(const DateTime& dt) const;

        QString toString(Qt::DateFormat f = Qt::TextDate) const;
        QString toString(const QString& format) const;
        QString formatLocale(bool shortFormat = true) const;

        static void setStartOfDay(const QTime& sod);

        static QTime startOfDay();

        KDateTime::Comparison compare(const DateTime &other) const;

        KALARMCAL_EXPORT friend bool operator==(const KAlarmCal::DateTime& dt1, const KAlarmCal::DateTime& dt2);
        KALARMCAL_EXPORT friend bool operator==(const KDateTime& dt1, const KAlarmCal::DateTime& dt2);
        KALARMCAL_EXPORT friend bool operator<(const KAlarmCal::DateTime& dt1, const KAlarmCal::DateTime& dt2);
        friend bool operator<(const KDateTime& dt1, const KAlarmCal::DateTime& dt2);

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

KALARMCAL_EXPORT bool operator==(const DateTime& dt1, const DateTime& dt2);
KALARMCAL_EXPORT bool operator==(const KDateTime& dt1, const DateTime& dt2);

inline bool operator!=(const DateTime& dt1, const DateTime& dt2)   { return !operator==(dt1, dt2); }
inline bool operator!=(const KDateTime& dt1, const DateTime& dt2)  { return !operator==(dt1, dt2); }

KALARMCAL_EXPORT bool operator<(const DateTime& dt1, const DateTime& dt2);
inline bool operator<(const KDateTime& dt1, const DateTime& dt2)   { return operator<(DateTime(dt1), dt2); }

inline bool operator>(const DateTime& dt1, const DateTime& dt2)    { return operator<(dt2, dt1); }
inline bool operator>(const KDateTime& dt1, const DateTime& dt2)   { return operator<(dt2, DateTime(dt1)); }

inline bool operator>=(const DateTime& dt1, const DateTime& dt2)   { return !operator<(dt1, dt2); }
inline bool operator>=(const KDateTime& dt1, const DateTime& dt2)  { return !operator<(DateTime(dt1), dt2); }

inline bool operator<=(const DateTime& dt1, const DateTime& dt2)   { return !operator<(dt2, dt1); }
inline bool operator<=(const KDateTime& dt1, const DateTime& dt2)  { return !operator<(dt2, DateTime(dt1)); }

} // namespace KAlarmCal

#endif // KALARM_DATETIME_H

// vim: et sw=4: