qabstractspinbox.h

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#ifndef QABSTRACTSPINBOX_H
#define QABSTRACTSPINBOX_H
 
#include <QtWidgets/qtwidgetsglobal.h>
#include <QtWidgets/qwidget.h>
#include <QtGui/qvalidator.h>
 
QT_REQUIRE_CONFIG(spinbox);
 
QT_BEGIN_NAMESPACE
 
class QLineEdit;
 
class QAbstractSpinBoxPrivate;
class QStyleOptionSpinBox;
 
class Q_WIDGETS_EXPORT QAbstractSpinBox : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(bool wrapping READ wrapping WRITE setWrapping)
    Q_PROPERTY(bool frame READ hasFrame WRITE setFrame)
    Q_PROPERTY(Qt::Alignment alignment READ alignment WRITE setAlignment)
    Q_PROPERTY(bool readOnly READ isReadOnly WRITE setReadOnly)
    Q_PROPERTY(ButtonSymbols buttonSymbols READ buttonSymbols WRITE setButtonSymbols)
    Q_PROPERTY(QString specialValueText READ specialValueText WRITE setSpecialValueText)
    Q_PROPERTY(QString text READ text)
    Q_PROPERTY(bool accelerated READ isAccelerated WRITE setAccelerated)
    Q_PROPERTY(CorrectionMode correctionMode READ correctionMode WRITE setCorrectionMode)
    Q_PROPERTY(bool acceptableInput READ hasAcceptableInput)
    Q_PROPERTY(bool keyboardTracking READ keyboardTracking WRITE setKeyboardTracking)
    Q_PROPERTY(bool showGroupSeparator READ isGroupSeparatorShown WRITE setGroupSeparatorShown)
public:
    explicit QAbstractSpinBox(QWidget *parent = nullptr);
    ~QAbstractSpinBox();
 
    enum StepEnabledFlag { StepNone = 0x00, StepUpEnabled = 0x01,
                           StepDownEnabled = 0x02 };
    Q_DECLARE_FLAGS(StepEnabled, StepEnabledFlag)
 
    enum ButtonSymbols { UpDownArrows, PlusMinus, NoButtons };
    Q_ENUM(ButtonSymbols)
 
    ButtonSymbols buttonSymbols() const;
    void setButtonSymbols(ButtonSymbols bs);
 
    enum CorrectionMode  { CorrectToPreviousValue, CorrectToNearestValue };
    Q_ENUM(CorrectionMode)
 
    void setCorrectionMode(CorrectionMode cm);
    CorrectionMode correctionMode() const;
 
    bool hasAcceptableInput() const;
    QString text() const;
 
    QString specialValueText() const;
    void setSpecialValueText(const QString &txt);
 
    bool wrapping() const;
    void setWrapping(bool w);
 
    void setReadOnly(bool r);
    bool isReadOnly() const;
 
    void setKeyboardTracking(bool kt);
    bool keyboardTracking() const;
 
    void setAlignment(Qt::Alignment flag);
    Qt::Alignment alignment() const;
 
    void setFrame(bool);
    bool hasFrame() const;
 
    void setAccelerated(bool on);
    bool isAccelerated() const;
 
    void setGroupSeparatorShown(bool shown);
    bool isGroupSeparatorShown() const;
 
    QSize sizeHint() const override;
    QSize minimumSizeHint() const override;
    void interpretText();
    bool event(QEvent *event) override;
 
    QVariant inputMethodQuery(Qt::InputMethodQuery) const override;
 
    virtual QValidator::State validate(QString &input, int &pos) const;
    virtual void fixup(QString &input) const;
 
    virtual void stepBy(int steps);
 
    enum StepType {
        DefaultStepType,
        AdaptiveDecimalStepType
    };
    Q_ENUM(StepType)
 
public Q_SLOTS:
    void stepUp();
    void stepDown();
    void selectAll();
    virtual void clear();
protected:
    void resizeEvent(QResizeEvent *event) override;
    void keyPressEvent(QKeyEvent *event) override;
    void keyReleaseEvent(QKeyEvent *event) override;
#if QT_CONFIG(wheelevent)
    void wheelEvent(QWheelEvent *event) override;
#endif
    void focusInEvent(QFocusEvent *event) override;
    void focusOutEvent(QFocusEvent *event) override;
#if QT_CONFIG(contextmenu)
    void contextMenuEvent(QContextMenuEvent *event) override;
#endif
    void changeEvent(QEvent *event) override;
    void closeEvent(QCloseEvent *event) override;
    void hideEvent(QHideEvent *event) override;
    void mousePressEvent(QMouseEvent *event) override;
    void mouseReleaseEvent(QMouseEvent *event) override;
    void mouseMoveEvent(QMouseEvent *event) override;
    void timerEvent(QTimerEvent *event) override;
    void paintEvent(QPaintEvent *event) override;
    void showEvent(QShowEvent *event) override;
    virtual void initStyleOption(QStyleOptionSpinBox *option) const;
 
    QLineEdit *lineEdit() const;
    void setLineEdit(QLineEdit *edit);
 
    virtual StepEnabled stepEnabled() const;
Q_SIGNALS:
    void editingFinished();
protected:
    QAbstractSpinBox(QAbstractSpinBoxPrivate &dd, QWidget *parent = nullptr);
 
private:
    Q_DECLARE_PRIVATE(QAbstractSpinBox)
    Q_DISABLE_COPY(QAbstractSpinBox)
    friend class QAccessibleAbstractSpinBox;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(QAbstractSpinBox::StepEnabled)
 
QT_END_NAMESPACE
 
#endif // QABSTRACTSPINBOX_H