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:

Public Types
enum	ClearValueMode { MinimumValue, MaximumValue, CustomValue }
	Behaviour when widget is cleared. More...

Public Member Functions
	QgsSpinBox (QWidget *parent=nullptr)
	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

Public Member Functions inherited from QSpinBox
	QSpinBox (QWidget *parent)

	QSpinBox (QWidget parent, const char name)

	QSpinBox (int minimum, int maximum, int step, QWidget parent, const char name)

QString	cleanText () const

int	maximum () const

int	maxValue () const

int	minimum () const

int	minValue () const

QString	prefix () const

void	setLineStep (int step)

void	setMaximum (int max)

void	setMaxValue (int value)

void	setMinimum (int min)

void	setMinValue (int value)

void	setPrefix (const QString &prefix)

void	setRange (int minimum, int maximum)

void	setSingleStep (int val)

void	setSuffix (const QString &suffix)

void	setValue (int val)

int	singleStep () const

QString	suffix () const

int	value () const

void	valueChanged (int i)

void	valueChanged (const QString &text)

Public Member Functions inherited from QAbstractSpinBox
	QAbstractSpinBox (QWidget *parent)

	~QAbstractSpinBox ()

Qt::Alignment	alignment () const

ButtonSymbols	buttonSymbols () const

CorrectionMode	correctionMode () const

void	editingFinished ()

bool	hasAcceptableInput () const

bool	hasFrame () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	interpretText ()

bool	isAccelerated () const

bool	isReadOnly () const

bool	keyboardTracking () const

virtual QSize	minimumSizeHint () const

void	selectAll ()

void	setAccelerated (bool on)

void	setAlignment (QFlags< Qt::AlignmentFlag > flag)

void	setButtonSymbols (ButtonSymbols bs)

void	setCorrectionMode (CorrectionMode cm)

void	setFrame (bool)

void	setKeyboardTracking (bool kt)

void	setReadOnly (bool r)

void	setSpecialValueText (const QString &txt)

void	setWrapping (bool w)

virtual QSize	sizeHint () const

QString	specialValueText () const

virtual void	stepBy (int steps)

void	stepDown ()

void	stepUp ()

QString	text () const

bool	wrapping () const

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const=0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

Protected Member Functions
virtual void	changeEvent (QEvent *event) override

virtual void	paintEvent (QPaintEvent *event) override

Protected Member Functions inherited from QSpinBox
virtual bool	event (QEvent *event)

virtual void	fixup (QString &input) const

virtual QString	textFromValue (int value) const

Protected Member Functions inherited from QAbstractSpinBox
virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	hideEvent (QHideEvent *event)

void	initStyleOption (QStyleOptionSpinBox *option) const

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

QLineEdit *	lineEdit () const

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

void	setLineEdit (QLineEdit *lineEdit)

virtual void	showEvent (QShowEvent *event)

virtual StepEnabled	stepEnabled () const

virtual void	timerEvent (QTimerEvent *event)

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

bool	focusPreviousChild ()

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Properties
bool	clearValue

bool	expressionsEnabled

bool	showClearButton

Properties inherited from QSpinBox
	cleanText

	maximum

	minimum

	prefix

	singleStep

	suffix

	value

Properties inherited from QAbstractSpinBox
	accelerated

	acceptableInput

	alignment

	buttonSymbols

	correctionMode

	frame

	keyboardTracking

	readOnly

	specialValueText

	text

	wrapping

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QAbstractSpinBox
typedef	StepEnabled

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

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

Member Enumeration Documentation

◆ ClearValueMode

enum QgsSpinBox::ClearValueMode

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

Constructor & Destructor Documentation

◆ QgsSpinBox()

QgsSpinBox::QgsSpinBox ( QWidget * parent = nullptr )

explicit

Constructor for QgsSpinBox.

Parameters

parent parent widget

Definition at line 29 of file qgsspinbox.cpp.

Member Function Documentation

◆ changeEvent()

void QgsSpinBox::changeEvent ( QEvent * event )

overrideprotectedvirtual

Reimplemented from QAbstractSpinBox.

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.

Reimplemented from QAbstractSpinBox.

Definition at line 76 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

Note: added in QGIS 2.7

Definition at line 74 of file qgsspinbox.h.

◆ paintEvent()

void QgsSpinBox::paintEvent ( QPaintEvent * event )

overrideprotectedvirtual

Reimplemented from QAbstractSpinBox.

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

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.

See also: setClearValue()

Definition at line 81 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

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 95 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

enabled set to true to allow expression entry

Note: added in 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

showClearButton set 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 60 of file qgsspinbox.h.

◆ validate()

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

overridevirtual

Reimplemented from QSpinBox.

Definition at line 135 of file qgsspinbox.cpp.

◆ valueFromText()

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

overridevirtual

Reimplemented from QSpinBox.

Definition at line 119 of file qgsspinbox.cpp.

Property Documentation

◆ clearValue

int QgsSpinBox::clearValue

readwrite

Definition at line 32 of file qgsspinbox.h.

◆ expressionsEnabled

bool QgsSpinBox::expressionsEnabled

readwrite

Definition at line 33 of file qgsspinbox.h.

◆ showClearButton

bool QgsSpinBox::showClearButton

readwrite

Definition at line 31 of file qgsspinbox.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/qgsspinbox.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/qgsspinbox.cpp

Public Types

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ClearValueMode

Constructor & Destructor Documentation

◆ QgsSpinBox()

Member Function Documentation

◆ changeEvent()

◆ clear()

◆ clearValue()

◆ expressionsEnabled()

◆ paintEvent()

◆ setClearValue()

◆ setClearValueMode()

◆ setExpressionsEnabled()

◆ setShowClearButton()

◆ showClearButton()

◆ validate()

◆ valueFromText()

Property Documentation

◆ clearValue

◆ expressionsEnabled

◆ showClearButton