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>
#include "qgis_sip.h"
#include "qgis_gui.h"

class QgsSpinBoxLineEdit;


#ifdef SIP_RUN
% ModuleHeaderCode
// fix to allow compilation with sip 4.7 that for some reason
// doesn't add this include to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsspinbox.h>
% End
#endif


class GUI_EXPORT QgsSpinBox : public QSpinBox
{

#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsSpinBox *>( sipCpp ) )
      sipType = sipType_QgsSpinBox;
    else
      sipType = NULL;
    SIP_END
#endif

    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 SIP_TRANSFERTHIS = nullptr );

    void setShowClearButton( bool showClearButton );

    bool showClearButton() const {return mShowClearButton;}

    void setExpressionsEnabled( bool enabled );

    bool expressionsEnabled() const {return mExpressionsEnabled;}

    void clear() override;

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

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

    int clearValue() const;

    void setLineEditAlignment( Qt::Alignment alignment );

    void setSpecialValueText( const QString &txt );

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

  protected:

    void changeEvent( QEvent *event ) override;
    void paintEvent( QPaintEvent *event ) override;
    void wheelEvent( QWheelEvent *event ) override;
    // This is required because private implementation of
    // QAbstractSpinBoxPrivate may trigger a second
    // undesired event from the auto-repeat mouse timer
    void timerEvent( QTimerEvent *event ) override;

  private slots:
    void changed( int value );

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

    QgsSpinBoxLineEdit *mLineEdit = nullptr;

    bool mShowClearButton = true;
    ClearValueMode mClearValueMode = MinimumValue;
    int mCustomClearValue = 0;

    bool mExpressionsEnabled = true;

    // This is required because private implementation of
    // QAbstractSpinBoxPrivate checks for specialText emptiness
    // and skips specialText handling if it's empty
    static QString SPECIAL_TEXT_WHEN_EMPTY;

    QString stripped( const QString &originalText ) const;

    friend class TestQgsRangeWidgetWrapper;

};

#endif // QGSSPINBOX_H