knuminput.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
 *  Copyright (c) 1997 Patrick Dowler <dowler@morgul.fsh.uvic.ca>
 *  Copyright (c) 2000 Dirk Mueller <mueller@kde.org>
 *  Copyright (c) 2002 Marc Mutz <mutz@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 K_NUMINPUT_H
#define K_NUMINPUT_H

#include <kdeui_export.h>

#include <QtGui/QWidget>
#include <QtGui/QSpinBox>

class QSlider;
class QSpinBox;
class QValidator;

class KIntSpinBox;
class KNumInputPrivate;
class KLocalizedString;

class KDEUI_EXPORT KNumInput : public QWidget
{
    Q_OBJECT
    Q_PROPERTY( QString label READ label WRITE setLabel )
public:
    explicit KNumInput(QWidget* parent=0);

#ifndef KDE_NO_DEPRECATED
    KDE_CONSTRUCTOR_DEPRECATED KNumInput(QWidget *parent, KNumInput* below);
#endif

    ~KNumInput();

    virtual void setLabel(const QString & label, Qt::Alignment a = Qt::AlignLeft | Qt::AlignTop);

    QString label() const;

    bool showSlider() const;

    void setSteps(int minor, int major);

    virtual QSize sizeHint() const;

protected:
    QSlider *slider() const;

    void layout(bool deep);

    virtual void doLayout() = 0;

private:
    friend class KNumInputPrivate;
    KNumInputPrivate * const d;

    Q_DISABLE_COPY(KNumInput)
};

/* ------------------------------------------------------------------------ */

class KDEUI_EXPORT KIntNumInput : public KNumInput
{
    Q_OBJECT
    Q_PROPERTY( int value READ value WRITE setValue NOTIFY valueChanged USER true )
    Q_PROPERTY( int minimum READ minimum WRITE setMinimum )
    Q_PROPERTY( int maximum READ maximum WRITE setMaximum )
    Q_PROPERTY( int singleStep READ singleStep WRITE setSingleStep )
    Q_PROPERTY( int referencePoint READ referencePoint WRITE setReferencePoint )
    Q_PROPERTY( double relativeValue READ relativeValue WRITE setRelativeValue )
    Q_PROPERTY( QString suffix READ suffix WRITE setSuffix )
    Q_PROPERTY( QString prefix READ prefix WRITE setPrefix )
    Q_PROPERTY( QString specialValueText READ specialValueText WRITE setSpecialValueText )
    Q_PROPERTY( bool sliderEnabled READ showSlider WRITE setSliderEnabled )

public:
    explicit KIntNumInput(QWidget *parent=0);
    explicit KIntNumInput(int value, QWidget *parent=0,int base = 10);

#ifndef KDE_NO_DEPRECATED
    KDE_CONSTRUCTOR_DEPRECATED KIntNumInput(KNumInput* below, int value, QWidget *parent, int base = 10);
#endif

    virtual ~KIntNumInput();

    int value() const;

    double relativeValue() const;

    int referencePoint() const;

    QString suffix() const;
    QString prefix() const;
    QString specialValueText() const;

    void setRange(int min, int max, int singleStep=1);

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setRange(int min, int max, int singleStep, bool slider);
#endif

    void setSliderEnabled(bool enabled=true);

    void setMinimum(int min);
    int minimum() const;
    void setMaximum(int max);
    int maximum() const;

    int singleStep() const;

    void setSingleStep(int step);

    void setSpecialValueText(const QString& text);

    virtual void setLabel(const QString & label, Qt::Alignment a = Qt::AlignLeft | Qt::AlignTop);

    virtual QSize minimumSizeHint() const;

public Q_SLOTS:
    void setValue(int);

    void setRelativeValue(double);

    void setReferencePoint(int);

    void setSuffix(const QString &suffix);

    void setSuffix(const KLocalizedString &suffix);

    void setPrefix(const QString &prefix);

    void setEditFocus( bool mark = true );

Q_SIGNALS:
    void valueChanged(int);

    void relativeValueChanged(double);

private Q_SLOTS:
    void spinValueChanged(int);
    void slotEmitRelativeValueChanged(int);

protected:
    QSpinBox *spinBox() const;

    virtual void doLayout();
    void resizeEvent ( QResizeEvent * );

private:
    void init(int value, int _base);

private:
    class KIntNumInputPrivate;
    friend class KIntNumInputPrivate;
    KIntNumInputPrivate * const d;

    Q_DISABLE_COPY(KIntNumInput)
};


/* ------------------------------------------------------------------------ */

class KDoubleLine;

class KDEUI_EXPORT KDoubleNumInput : public KNumInput
{
    Q_OBJECT
    Q_PROPERTY( double value READ value WRITE setValue NOTIFY valueChanged USER true )
    Q_PROPERTY( double minimum READ minimum WRITE setMinimum )
    Q_PROPERTY( double maximum READ maximum WRITE setMaximum )
    Q_PROPERTY( double singleStep READ singleStep WRITE setSingleStep )
    Q_PROPERTY( QString suffix READ suffix WRITE setSuffix )
    Q_PROPERTY( QString prefix READ prefix WRITE setPrefix )
    Q_PROPERTY( QString specialValueText READ specialValueText WRITE setSpecialValueText )
    Q_PROPERTY( int decimals READ decimals WRITE setDecimals )
    Q_PROPERTY( double referencePoint READ referencePoint WRITE setReferencePoint )
    Q_PROPERTY( double relativeValue READ relativeValue  WRITE setRelativeValue )
    Q_PROPERTY( bool sliderEnabled READ showSlider WRITE setSliderEnabled )
    Q_PROPERTY( double exponentRatio READ exponentRatio WRITE setExponentRatio )

public:
    explicit KDoubleNumInput(QWidget *parent = 0);

    KDoubleNumInput(double lower, double upper, double value, QWidget *parent=0,double singleStep=0.01,
            int precision=2);

    virtual ~KDoubleNumInput();


#ifndef KDE_NO_DEPRECATED
    KDE_CONSTRUCTOR_DEPRECATED KDoubleNumInput(KNumInput* below,
            double lower, double upper, double value, QWidget *parent=0,double singleStep=0.02,
            int precision=2);
#endif

    double value() const;

    QString suffix() const;

    QString prefix() const;

    int decimals() const;

    QString specialValueText() const;

    void setRange(double min, double max, double singleStep=1, bool slider=true);

    void setSliderEnabled(bool enabled);

    void setMinimum(double min);
    double minimum() const;
    void setMaximum(double max);
    double maximum() const;

    double singleStep() const;

    void setSingleStep(double singleStep);

    void setDecimals(int decimals);

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setPrecision(int precision) { setDecimals(precision); }
#endif

    double referencePoint() const;

    double relativeValue() const;

    void setSpecialValueText(const QString& text);

    virtual void setLabel(const QString & label, Qt::Alignment a = Qt::AlignLeft | Qt::AlignTop);
    virtual QSize minimumSizeHint() const;

    double exponentRatio() const;

    void setExponentRatio(double dbl);
public Q_SLOTS:
    void setValue(double);

    void setRelativeValue(double);

    void setReferencePoint(double ref);

    void setSuffix(const QString &suffix);

    void setPrefix(const QString &prefix);

Q_SIGNALS:
    void valueChanged(double);
    void relativeValueChanged(double);

private Q_SLOTS:
    void sliderMoved(int);
    void spinBoxChanged(double);
    void slotEmitRelativeValueChanged(double);

protected:
    virtual void doLayout();
    void resizeEvent ( QResizeEvent * );

    friend class KDoubleLine;
private:
    void init(double value, double lower, double upper,
    double singleStep, int precision);
    double mapSliderToSpin(int) const;
    void updateLegacyMembers();

private:
    class KDoubleNumInputPrivate;
    friend class KDoubleNumInputPrivate;
    KDoubleNumInputPrivate * const d;

    Q_DISABLE_COPY(KDoubleNumInput)
};


/* ------------------------------------------------------------------------ */

class KDEUI_EXPORT KIntSpinBox : public QSpinBox
{
    Q_OBJECT
    Q_PROPERTY( int base READ base WRITE setBase )

public:

    explicit KIntSpinBox( QWidget *parent = 0 );

    KIntSpinBox(int lower, int upper, int singleStep, int value, QWidget *parent,int base = 10);

    virtual ~KIntSpinBox();

    void setBase(int base);
    int base() const;
    void setEditFocus(bool mark);

    void setSuffix(const KLocalizedString &suffix);

    using QSpinBox::setSuffix;

protected:

    virtual QString textFromValue(int) const;

    virtual int valueFromText(const QString &text) const;

private:
    class KIntSpinBoxPrivate;
    friend class KIntSpinBoxPrivate;
    KIntSpinBoxPrivate *const d;

    Q_DISABLE_COPY(KIntSpinBox)
    Q_PRIVATE_SLOT(d, void updateSuffix(int))
};

#endif // K_NUMINPUT_H