QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. More...
#include <qgsspinbox.h>
Public Types | |
enum | ClearValueMode { MinimumValue , MaximumValue , CustomValue } |
Behavior when widget is cleared. More... | |
Signals | |
void | returnPressed () |
Emitted when the Return or Enter key is used in the line edit. | |
void | textEdited (const QString &text) |
Emitted when the the value has been manually edited via line edit. | |
Public Member Functions | |
QgsSpinBox (QWidget *parent=nullptr) | |
Constructor for QgsSpinBox. | |
void | clear () override |
Sets the current value to the value defined by the clear value. | |
int | clearValue () const |
Returns the value used when clear() is called. | |
bool | expressionsEnabled () const |
Returns whether the widget will allow entry of simple expressions, which are evaluated and then discarded. | |
void | setClearValue (int customValue, const QString &clearValueText=QString()) |
Defines the clear value as a custom value and will automatically set the clear value mode to CustomValue. | |
void | setClearValueMode (ClearValueMode mode, const QString &clearValueText=QString()) |
Defines if the clear value should be the minimum or maximum values of the widget or a custom value. | |
void | setExpressionsEnabled (bool enabled) |
Sets if the widget will allow entry of simple expressions, which are evaluated and then discarded. | |
void | setLineEditAlignment (Qt::Alignment alignment) |
Set alignment in the embedded line edit widget. | |
void | setShowClearButton (bool showClearButton) |
Sets whether the widget will show a clear button. | |
void | setSpecialValueText (const QString &txt) |
Set the special-value text to be txt If set, the spin box will display this text instead of a numeric value whenever the current value is equal to minimum(). | |
bool | showClearButton () const |
Returns whether the widget is showing a clear button. | |
void | stepBy (int steps) override |
QValidator::State | validate (QString &input, int &pos) const override |
int | valueFromText (const QString &text) const override |
Protected Member Functions | |
void | changeEvent (QEvent *event) override |
void | paintEvent (QPaintEvent *event) override |
void | timerEvent (QTimerEvent *event) override |
void | wheelEvent (QWheelEvent *event) override |
Properties | |
bool | clearValue |
bool | expressionsEnabled |
bool | showClearButton |
Friends | |
class | TestQgsRangeWidgetWrapper |
The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value.
The clear value can be either the minimum or the maiximum value of the spin box or a custom value. This value can then be handled by a special value text.
Definition at line 42 of file qgsspinbox.h.
Behavior when widget is cleared.
Enumerator | |
---|---|
MinimumValue | Reset value to minimum() |
MaximumValue | Reset value to maximum() |
CustomValue | Reset value to custom value (see setClearValue() ) |
Definition at line 60 of file qgsspinbox.h.
|
explicit |
Constructor for QgsSpinBox.
parent | parent widget |
Definition at line 39 of file qgsspinbox.cpp.
|
overrideprotected |
Definition at line 65 of file qgsspinbox.cpp.
|
override |
Sets the current value to the value defined by the clear value.
Definition at line 120 of file qgsspinbox.cpp.
int QgsSpinBox::clearValue | ( | ) | const |
Returns the value used when clear() is called.
Definition at line 165 of file qgsspinbox.cpp.
|
inline |
Returns whether the widget will allow entry of simple expressions, which are evaluated and then discarded.
true
if spin box allows expression entry Definition at line 99 of file qgsspinbox.h.
|
overrideprotected |
Definition at line 77 of file qgsspinbox.cpp.
|
signal |
Emitted when the Return or Enter key is used in the line edit.
void QgsSpinBox::setClearValue | ( | int | customValue, |
const QString & | clearValueText = QString() |
||
) |
Defines the clear value as a custom value and will automatically set the clear value mode to CustomValue.
customValue | defines the numerical value used as the clear value |
clearValueText | is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. |
Definition at line 127 of file qgsspinbox.cpp.
void QgsSpinBox::setClearValueMode | ( | QgsSpinBox::ClearValueMode | mode, |
const QString & | clearValueText = QString() |
||
) |
Defines if the clear value should be the minimum or maximum values of the widget or a custom value.
mode | mode to user for clear value |
clearValueText | is the text displayed when the spin box is at the clear value. If not specified, no special value text is used. |
Definition at line 146 of file qgsspinbox.cpp.
void QgsSpinBox::setExpressionsEnabled | ( | bool | enabled | ) |
Sets if the widget will allow entry of simple expressions, which are evaluated and then discarded.
enabled | set to true to allow expression entry |
Definition at line 60 of file qgsspinbox.cpp.
void QgsSpinBox::setLineEditAlignment | ( | Qt::Alignment | alignment | ) |
Set alignment in the embedded line edit widget.
alignment |
Definition at line 175 of file qgsspinbox.cpp.
void QgsSpinBox::setShowClearButton | ( | bool | showClearButton | ) |
Sets whether the widget will show a clear button.
The clear button allows users to reset the widget to a default or empty state.
showClearButton | set to true to show the clear button, or false to hide it |
Definition at line 54 of file qgsspinbox.cpp.
void QgsSpinBox::setSpecialValueText | ( | const QString & | txt | ) |
Set the special-value text to be txt If set, the spin box will display this text instead of a numeric value whenever the current value is equal to minimum().
Typical use is to indicate that this choice has a special (default) meaning.
Definition at line 180 of file qgsspinbox.cpp.
|
inline |
Returns whether the widget is showing a clear button.
Definition at line 85 of file qgsspinbox.h.
|
override |
Definition at line 221 of file qgsspinbox.cpp.
|
signal |
Emitted when the the value has been manually edited via line edit.
|
overrideprotected |
Definition at line 104 of file qgsspinbox.cpp.
|
override |
Definition at line 210 of file qgsspinbox.cpp.
|
override |
Definition at line 194 of file qgsspinbox.cpp.
|
overrideprotected |
Definition at line 83 of file qgsspinbox.cpp.
|
friend |
Definition at line 182 of file qgsspinbox.h.
|
readwrite |
Definition at line 55 of file qgsspinbox.h.
|
readwrite |
Definition at line 56 of file qgsspinbox.h.
|
readwrite |
Definition at line 54 of file qgsspinbox.h.