kdayperiod_p.h

Go to the documentation of this file.

/*
    Copyright (c) 2010 John Layt <john@layt.net>

    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 KDAYPERIOD_H
#define KDAYPERIOD_H

#include <QtCore/QSharedDataPointer>

#include "klocale.h"
#include <kdecore_export.h>

class QDate;
class QString;
class QTime;

class KDayPeriodPrivate;

class KDayPeriod
{
public:
    KDayPeriod(const QString &periodCode,
               const QString &longName,
               const QString &shortName,
               const QString &narrowName,
               const QTime &periodStart,
               const QTime &periodEnd,
               int offsetFromStart,
               int offsetIfZero);

    explicit KDayPeriod();

    KDayPeriod(const KDayPeriod &rhs);

    virtual ~KDayPeriod();

    KDayPeriod& operator=(const KDayPeriod &rhs);

    QString periodCode() const;

    QTime periodStart() const;

    QTime periodEnd() const;

    QString periodName(KLocale::DateTimeComponentFormat format = KLocale::ShortName) const;

    int hourInPeriod(const QTime &time) const;

    QTime time(int hourInPeriod, int minute, int second, int millisecond = 0) const;

    bool isValid() const;

    bool isValid(const QTime &time) const;

private:
    QSharedDataPointer<KDayPeriodPrivate> d;
};

#endif // KDAYPERIOD_H