QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
qgsspinbox.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsspinbox.h
3 --------------------------------------
4 Date : 09.2014
5 Copyright : (C) 2014 Denis Rouzaud
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSSPINBOX_H
17#define QGSSPINBOX_H
18
19#include <QSpinBox>
20#include "qgis_sip.h"
21#include "qgis_gui.h"
22
23class QgsSpinBoxLineEdit;
24
25
26#ifdef SIP_RUN
27% ModuleHeaderCode
28// fix to allow compilation with sip 4.7 that for some reason
29// doesn't add this include to the file where the code from
30// ConvertToSubClassCode goes.
31#include <qgsspinbox.h>
32% End
33#endif
34
35
42class GUI_EXPORT QgsSpinBox : public QSpinBox
43{
44
45#ifdef SIP_RUN
47 if ( qobject_cast<QgsSpinBox *>( sipCpp ) )
48 sipType = sipType_QgsSpinBox;
49 else
50 sipType = NULL;
52#endif
53
54 Q_OBJECT
55 Q_PROPERTY( bool showClearButton READ showClearButton WRITE setShowClearButton )
56 Q_PROPERTY( bool clearValue READ clearValue WRITE setClearValue )
57 Q_PROPERTY( bool expressionsEnabled READ expressionsEnabled WRITE setExpressionsEnabled )
58
59 public:
60
68
73 explicit QgsSpinBox( QWidget *parent SIP_TRANSFERTHIS = nullptr );
74
81 void setShowClearButton( bool showClearButton );
82
87 bool showClearButton() const {return mShowClearButton;}
88
94 void setExpressionsEnabled( bool enabled );
95
101 bool expressionsEnabled() const {return mExpressionsEnabled;}
102
104 void clear() override;
105
112 void setClearValue( int customValue, const QString &clearValueText = QString() );
113
119 void setClearValueMode( ClearValueMode mode, const QString &clearValueText = QString() );
120
125 int clearValue() const;
126
131 void setLineEditAlignment( Qt::Alignment alignment );
132
138 void setSpecialValueText( const QString &txt );
139
140 int valueFromText( const QString &text ) const override;
141 QValidator::State validate( QString &input, int &pos ) const override;
142 void stepBy( int steps ) override;
143
144 protected:
145
146 void changeEvent( QEvent *event ) override;
147 void paintEvent( QPaintEvent *event ) override;
148 void wheelEvent( QWheelEvent *event ) override;
149 // This is required because private implementation of
150 // QAbstractSpinBoxPrivate may trigger a second
151 // undesired event from the auto-repeat mouse timer
152 void timerEvent( QTimerEvent *event ) override;
153
154 private slots:
155 void changed( int value );
156
157 private:
158 int frameWidth() const;
159 bool shouldShowClearForValue( int value ) const;
160
161 QgsSpinBoxLineEdit *mLineEdit = nullptr;
162
163 bool mShowClearButton = true;
164 ClearValueMode mClearValueMode = MinimumValue;
165 int mCustomClearValue = 0;
166
167 bool mExpressionsEnabled = true;
168
169 QString stripped( const QString &originalText ) const;
170
171 friend class TestQgsRangeWidgetWrapper;
172
173};
174
175#endif // QGSSPINBOX_H
The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value.
Definition qgsspinbox.h:43
ClearValueMode
Behavior when widget is cleared.
Definition qgsspinbox.h:63
@ MaximumValue
Reset value to maximum()
Definition qgsspinbox.h:65
@ MinimumValue
Reset value to minimum()
Definition qgsspinbox.h:64
@ CustomValue
Reset value to custom value (see setClearValue() )
Definition qgsspinbox.h:66
bool showClearButton() const
Returns whether the widget is showing a clear button.
Definition qgsspinbox.h:87
bool expressionsEnabled() const
Returns whether the widget will allow entry of simple expressions, which are evaluated and then disca...
Definition qgsspinbox.h:101
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:191
#define SIP_TRANSFERTHIS
Definition qgis_sip.h:53
#define SIP_END
Definition qgis_sip.h:208