ktimecombobox.h

Go to the documentation of this file.

/*
    Copyright 2011 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 KTIMECOMBOBOX_H
#define KTIMECOMBOBOX_H

#include <kdeui_export.h>

#include <QtGui/QWidget>

#include "kcombobox.h"
#include "klocale.h"

class KTimeComboBoxPrivate;

class KDEUI_EXPORT KTimeComboBox : public KComboBox
{
    Q_OBJECT

    Q_PROPERTY(QTime time READ time WRITE setTime NOTIFY timeChanged USER true)
    Q_PROPERTY(QTime minimumTime READ minimumTime WRITE setMinimumTime RESET resetMinimumTime)
    Q_PROPERTY(QTime maximumTime READ maximumTime WRITE setMaximumTime RESET resetMaximumTime)
    Q_PROPERTY(int timeListInterval READ timeListInterval WRITE setTimeListInterval)
    Q_PROPERTY(Options options READ options WRITE setOptions)
    Q_FLAGS(Options)

public:

    enum Option {
        EditTime         = 0x0001,  
        SelectTime       = 0x0002,  
        ForceTime        = 0x0004,  
        WarnOnInvalid    = 0x0008   
    };
    Q_DECLARE_FLAGS(Options, Option)

    
    explicit KTimeComboBox(QWidget *parent = 0);

    virtual ~KTimeComboBox();

    QTime time() const;

    bool isValid() const;

    bool isNull() const;

    Options options() const;

    KLocale::TimeFormatOptions displayFormat() const;

    QTime minimumTime() const;

    void resetMinimumTime();

    QTime maximumTime() const;

    void resetMaximumTime();

    void setTimeRange(const QTime &minTime,
                      const QTime &maxTime,
                      const QString &minWarnMsg = QString(),
                      const QString &maxWarnMsg = QString());

    void resetTimeRange();

    int timeListInterval() const;

    QList<QTime> timeList() const;

Q_SIGNALS:

    void timeEntered(const QTime &time);

    void timeChanged(const QTime &time);

    void timeEdited(const QTime &time);

public Q_SLOTS:

    void setTime(const QTime &time);

    void setOptions(Options options);

    void setDisplayFormat(KLocale::TimeFormatOptions formatOptions);

    void setMinimumTime(const QTime &minTime, const QString &minWarnMsg = QString());

    void setMaximumTime(const QTime &maxTime, const QString &maxWarnMsg = QString());

    void setTimeListInterval(int minutes);

    void setTimeList(QList<QTime> timeList,
                     const QString &minWarnMsg = QString(),
                     const QString &maxWarnMsg = QString());

protected:

    virtual bool eventFilter(QObject *object, QEvent *event);
    virtual void showPopup();
    virtual void hidePopup();
    virtual void mousePressEvent(QMouseEvent *event);
    virtual void wheelEvent(QWheelEvent *event);
    virtual void keyPressEvent(QKeyEvent *event);
    virtual void focusInEvent(QFocusEvent *event);
    virtual void focusOutEvent(QFocusEvent *event);
    virtual void resizeEvent(QResizeEvent *event);

    virtual void assignTime(const QTime &time);

private:

    friend class KTimeComboBoxPrivate;
    KTimeComboBoxPrivate *const d;

    Q_PRIVATE_SLOT(d, void selectTime(int index))
    Q_PRIVATE_SLOT(d, void editTime(const QString&))
    Q_PRIVATE_SLOT(d, void enterTime(const QTime&))
    Q_PRIVATE_SLOT(d, void parseTime())

};

Q_DECLARE_OPERATORS_FOR_FLAGS(KTimeComboBox::Options)

#endif // KTIMECOMBOBOX_H