QGIS API Documentation  2.99.0-Master (7705179)
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
QgsSpinBox Class Reference

The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. More...

#include <qgsspinbox.h>

Inheritance diagram for QgsSpinBox:
Inheritance graph
[legend]

Public Types

enum  ClearValueMode { MinimumValue, MaximumValue, CustomValue }
 Behavior when widget is cleared. More...
 

Public Member Functions

 QgsSpinBox (QWidget *parent=0)
 Constructor for QgsSpinBox. More...
 
virtual void clear () override
 Set the current value to the value defined by the clear value. More...
 
int clearValue () const
 Returns the value used when clear() is called. More...
 
bool expressionsEnabled () const
 Returns whether the widget will allow entry of simple expressions, which are evaluated and then discarded. More...
 
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. More...
 
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. More...
 
void setExpressionsEnabled (const bool enabled)
 Sets if the widget will allow entry of simple expressions, which are evaluated and then discarded. More...
 
void setShowClearButton (const bool showClearButton)
 Sets whether the widget will show a clear button. More...
 
bool showClearButton () const
 Returns whether the widget is showing a clear button. More...
 
virtual QValidator::State validate (QString &input, int &pos) const override
 
virtual int valueFromText (const QString &text) const override
 

Protected Member Functions

virtual void changeEvent (QEvent *event) override
 
virtual void paintEvent (QPaintEvent *event) override
 
void wheelEvent (QWheelEvent *event) override
 

Properties

bool clearValue
 
bool expressionsEnabled
 
bool showClearButton
 

Detailed Description

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 41 of file qgsspinbox.h.

Member Enumeration Documentation

◆ ClearValueMode

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 61 of file qgsspinbox.h.

Constructor & Destructor Documentation

◆ QgsSpinBox()

QgsSpinBox::QgsSpinBox ( QWidget *  parent = 0)
explicit

Constructor for QgsSpinBox.

Parameters
parentparent widget

Definition at line 29 of file qgsspinbox.cpp.

Member Function Documentation

◆ changeEvent()

void QgsSpinBox::changeEvent ( QEvent *  event)
overrideprotectedvirtual

Definition at line 59 of file qgsspinbox.cpp.

◆ clear()

void QgsSpinBox::clear ( )
overridevirtual

Set the current value to the value defined by the clear value.

Definition at line 97 of file qgsspinbox.cpp.

◆ clearValue()

int QgsSpinBox::clearValue ( ) const

Returns the value used when clear() is called.

See also
setClearValue()

◆ expressionsEnabled()

bool QgsSpinBox::expressionsEnabled ( ) const
inline

Returns whether the widget will allow entry of simple expressions, which are evaluated and then discarded.

Returns
true if spin box allows expression entry
Since
QGIS 2.7

Definition at line 97 of file qgsspinbox.h.

◆ paintEvent()

void QgsSpinBox::paintEvent ( QPaintEvent *  event)
overrideprotectedvirtual

Definition at line 65 of file qgsspinbox.cpp.

◆ setClearValue()

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.

Parameters
customValuedefines the numerical value used as the clear value
clearValueTextis the text displayed when the spin box is at the clear value. If not specified, no special value text is used.
See also
setClearValue()

Definition at line 102 of file qgsspinbox.cpp.

◆ setClearValueMode()

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.

Parameters
modemode to user for clear value
clearValueTextis the text displayed when the spin box is at the clear value. If not specified, no special value text is used.

Definition at line 116 of file qgsspinbox.cpp.

◆ setExpressionsEnabled()

void QgsSpinBox::setExpressionsEnabled ( const bool  enabled)

Sets if the widget will allow entry of simple expressions, which are evaluated and then discarded.

Parameters
enabledset to true to allow expression entry
Since
QGIS 2.7

Definition at line 54 of file qgsspinbox.cpp.

◆ setShowClearButton()

void QgsSpinBox::setShowClearButton ( const 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.

Parameters
showClearButtonset to true to show the clear button, or false to hide it
See also
showClearButton()

Definition at line 48 of file qgsspinbox.cpp.

◆ showClearButton()

bool QgsSpinBox::showClearButton ( ) const
inline

Returns whether the widget is showing a clear button.

See also
setShowClearButton()

Definition at line 83 of file qgsspinbox.h.

◆ validate()

QValidator::State QgsSpinBox::validate ( QString &  input,
int &  pos 
) const
overridevirtual

Definition at line 156 of file qgsspinbox.cpp.

◆ valueFromText()

int QgsSpinBox::valueFromText ( const QString &  text) const
overridevirtual

Definition at line 140 of file qgsspinbox.cpp.

◆ wheelEvent()

void QgsSpinBox::wheelEvent ( QWheelEvent *  event)
overrideprotected

Definition at line 71 of file qgsspinbox.cpp.

Property Documentation

◆ clearValue

int QgsSpinBox::clearValue
readwrite

Definition at line 55 of file qgsspinbox.h.

◆ expressionsEnabled

bool QgsSpinBox::expressionsEnabled
readwrite

Definition at line 56 of file qgsspinbox.h.

◆ showClearButton

bool QgsSpinBox::showClearButton
readwrite

Definition at line 54 of file qgsspinbox.h.


The documentation for this class was generated from the following files: