qgsspinbox.h

Go to the documentation of this file.

/***************************************************************************
    qgsspinbox.h
     --------------------------------------
    Date                 : 09.2014
    Copyright            : (C) 2014 Denis Rouzaud
    Email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSSPINBOX_H
#define QGSSPINBOX_H

#include <QSpinBox>

class QgsSpinBoxLineEdit;

class GUI_EXPORT QgsSpinBox : public QSpinBox
{
    Q_OBJECT
    Q_PROPERTY( bool showClearButton READ showClearButton WRITE setShowClearButton )
    Q_PROPERTY( bool clearValue READ clearValue WRITE setClearValue )
    Q_PROPERTY( bool expressionsEnabled READ expressionsEnabled WRITE setExpressionsEnabled )

  public:

    enum ClearValueMode
    {
      MinimumValue, 
      MaximumValue, 
      CustomValue, 
    };

    explicit QgsSpinBox( QWidget *parent = nullptr );

    void setShowClearButton( const bool showClearButton );

    bool showClearButton() const {return mShowClearButton;}

    void setExpressionsEnabled( const bool enabled );

    bool expressionsEnabled() const {return mExpressionsEnabled;}

    virtual void clear() override;

    void setClearValue( int customValue, const QString& clearValueText = QString() );

    void setClearValueMode( ClearValueMode mode, const QString& clearValueText = QString() );

    int clearValue() const;

    virtual int valueFromText( const QString & text ) const override;
    virtual QValidator::State validate( QString & input, int & pos ) const override;

  protected:

    virtual void changeEvent( QEvent* event ) override;
    virtual void paintEvent( QPaintEvent* event ) override;

  private slots:
    void changed( int value );

  private:
    int frameWidth() const;
    bool shouldShowClearForValue( const int value ) const;

    QgsSpinBoxLineEdit* mLineEdit;

    bool mShowClearButton;
    ClearValueMode mClearValueMode;
    int mCustomClearValue;

    bool mExpressionsEnabled;

    QString stripped( const QString &originalText ) const;
};

#endif // QGSSPINBOX_H