Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QAbstractSpinBox Class Reference

The QAbstractSpinBox class provides a spinbox and a line edit to display values. More...

#include <qabstractspinbox.h>

+ Inheritance diagram for QAbstractSpinBox:
+ Collaboration diagram for QAbstractSpinBox:

Public Types

enum  StepEnabledFlag { StepNone = 0x00 , StepUpEnabled = 0x01 , StepDownEnabled = 0x02 }
 \value StepNone \value StepUpEnabled \value StepDownEnabled More...
 
enum  ButtonSymbols { UpDownArrows , PlusMinus , NoButtons }
 This enum type describes the symbols that can be displayed on the buttons in a spin box. More...
 
enum  CorrectionMode { CorrectToPreviousValue , CorrectToNearestValue }
 This enum type describes the mode the spinbox will use to correct an \l{QValidator::}{Intermediate} value if editing finishes. More...
 
enum  StepType { DefaultStepType , AdaptiveDecimalStepType }
 \value DefaultStepType \value AdaptiveDecimalStepType More...
 
- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
 This enum describes how to render the widget when calling QWidget::render(). More...
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM ,
  PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY ,
  PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled
}
 

Public Slots

void stepUp ()
 Steps up by one linestep Calling this slot is analogous to calling stepBy(1);.
 
void stepDown ()
 Steps down by one linestep Calling this slot is analogous to calling stepBy(-1);.
 
void selectAll ()
 Selects all the text in the spinbox except the prefix and suffix.
 
virtual void clear ()
 Clears the lineedit of all text but prefix and suffix.
 
- Public Slots inherited from QWidget
void setEnabled (bool)
 
void setDisabled (bool)
 Disables widget input events if disable is true; otherwise enables input events.
 
void setWindowModified (bool)
 
void setWindowTitle (const QString &)
 
void setStyleSheet (const QString &styleSheet)
 
void setFocus ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
void update ()
 Updates the widget unless updates are disabled or the widget is hidden.
 
void repaint ()
 Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.
 
virtual void setVisible (bool visible)
 
void setHidden (bool hidden)
 Convenience function, equivalent to setVisible(!hidden).
 
void show ()
 Shows the widget and its child widgets.
 
void hide ()
 Hides the widget.
 
void showMinimized ()
 Shows the widget minimized, as an icon.
 
void showMaximized ()
 Shows the widget maximized.
 
void showFullScreen ()
 Shows the widget in full-screen mode.
 
void showNormal ()
 Restores the widget after it has been maximized or minimized.
 
bool close ()
 Closes this widget.
 
void raise ()
 Raises this widget to the top of the parent widget's stack.
 
void lower ()
 Lowers the widget to the bottom of the parent widget's stack.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void editingFinished ()
 This signal is emitted editing is finished.
 
- Signals inherited from QWidget
void windowTitleChanged (const QString &title)
 This signal is emitted when the window's title has changed, with the new title as an argument.
 
void windowIconChanged (const QIcon &icon)
 This signal is emitted when the window's icon has changed, with the new icon as an argument.
 
void windowIconTextChanged (const QString &iconText)
 This signal is emitted when the window's icon text has changed, with the new iconText as an argument.
 
void customContextMenuRequested (const QPoint &pos)
 This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QAbstractSpinBox (QWidget *parent=nullptr)
 Constructs an abstract spinbox with the given parent with default \l wrapping, and \l alignment properties.
 
 ~QAbstractSpinBox ()
 Called when the QAbstractSpinBox is destroyed.
 
ButtonSymbols buttonSymbols () const
 
void setButtonSymbols (ButtonSymbols bs)
 
void setCorrectionMode (CorrectionMode cm)
 
CorrectionMode correctionMode () const
 
bool hasAcceptableInput () const
 
QString text () const
 
QString specialValueText () const
 
void setSpecialValueText (const QString &txt)
 
bool wrapping () const
 
void setWrapping (bool w)
 
void setReadOnly (bool r)
 
bool isReadOnly () const
 
void setKeyboardTracking (bool kt)
 
bool keyboardTracking () const
 
void setAlignment (Qt::Alignment flag)
 
Qt::Alignment alignment () const
 
void setFrame (bool)
 
bool hasFrame () const
 
void setAccelerated (bool on)
 
bool isAccelerated () const
 
void setGroupSeparatorShown (bool shown)
 
bool isGroupSeparatorShown () const
 
QSize sizeHint () const override
 \reimp
 
QSize minimumSizeHint () const override
 \reimp
 
void interpretText ()
 This function interprets the text of the spin box.
 
bool event (QEvent *event) override
 \reimp
 
QVariant inputMethodQuery (Qt::InputMethodQuery) const override
 \reimp
 
virtual QValidator::State validate (QString &input, int &pos) const
 This virtual function is called by the QAbstractSpinBox to determine whether input is valid.
 
virtual void fixup (QString &input) const
 This virtual function is called by the QAbstractSpinBox if the input is not validated to QValidator::Acceptable when Return is pressed or interpretText() is called.
 
virtual void stepBy (int steps)
 Virtual function that is called whenever the user triggers a step.
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 Constructs a widget which is a child of parent, with widget flags set to f.
 
 ~QWidget ()
 Destroys the widget.
 
int devType () const override
 
WId winId () const
 Returns the window system identifier of the widget.
 
void createWinId ()
 
WId internalWinId () const
 
WId effectiveWinId () const
 
QStylestyle () const
 
void setStyle (QStyle *)
 Sets the widget's GUI style to style.
 
bool isWindow () const
 Returns true if the widget is an independent window, otherwise returns false.
 
bool isModal () const
 
Qt::WindowModality windowModality () const
 
void setWindowModality (Qt::WindowModality windowModality)
 
bool isEnabled () const
 
bool isEnabledTo (const QWidget *) const
 Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false.
 
QRect frameGeometry () const
 
const QRectgeometry () const
 
QRect normalGeometry () const
 
int x () const
 
int y () const
 
QPoint pos () const
 
QSize frameSize () const
 
QSize size () const
 
int width () const
 
int height () const
 
QRect rect () const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
QSize minimumSize () const
 
QSize maximumSize () const
 
int minimumWidth () const
 
int minimumHeight () const
 
int maximumWidth () const
 
int maximumHeight () const
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)).
 
void setMinimumWidth (int minw)
 
void setMinimumHeight (int minh)
 
void setMaximumWidth (int maxw)
 
void setMaximumHeight (int maxh)
 
QSize sizeIncrement () const
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.
 
QSize baseSize () const
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).
 
void setFixedSize (const QSize &)
 Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.
 
void setFixedSize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.
 
void setFixedWidth (int w)
 Sets both the minimum and maximum width of the widget to w without changing the heights.
 
void setFixedHeight (int h)
 Sets both the minimum and maximum heights of the widget to h without changing the widths.
 
QPointF mapToGlobal (const QPointF &) const
 Translates the widget coordinate pos to global screen coordinates.
 
QPoint mapToGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromGlobal (const QPointF &) const
 Translates the global screen coordinate pos to widget coordinates.
 
QPoint mapFromGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapToParent (const QPointF &) const
 Translates the widget coordinate pos to a coordinate in the parent widget.
 
QPoint mapToParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromParent (const QPointF &) const
 Translates the parent widget coordinate pos to widget coordinates.
 
QPoint mapFromParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapTo (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos to the coordinate system of parent.
 
QPoint mapTo (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFrom (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.
 
QPoint mapFrom (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QWidgetwindow () const
 Returns the window for this widget, i.e.
 
QWidgetnativeParentWidget () const
 
QWidgettopLevelWidget () const
 
const QPalettepalette () const
 
void setPalette (const QPalette &)
 
void setBackgroundRole (QPalette::ColorRole)
 Sets the background role of the widget to role.
 
QPalette::ColorRole backgroundRole () const
 Returns the background role of the widget.
 
void setForegroundRole (QPalette::ColorRole)
 Sets the foreground role of the widget to role.
 
QPalette::ColorRole foregroundRole () const
 Returns the foreground role.
 
const QFontfont () const
 
void setFont (const QFont &)
 
QFontMetrics fontMetrics () const
 Returns the font metrics for the widget's current font.
 
QFontInfo fontInfo () const
 Returns the font info for the widget's current font.
 
QCursor cursor () const
 
void setCursor (const QCursor &)
 
void unsetCursor ()
 
void setMouseTracking (bool enable)
 
bool hasMouseTracking () const
 
bool underMouse () const
 Returns true if the widget is under the mouse cursor; otherwise returns false.
 
void setTabletTracking (bool enable)
 
bool hasTabletTracking () const
 
void setMask (const QBitmap &)
 Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.
 
void setMask (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.
 
QRegion mask () const
 Returns the mask currently set on a widget.
 
void clearMask ()
 Removes any mask set by setMask().
 
void render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 
void render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().
 
Q_INVOKABLE QPixmap grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))
 
void grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
 Subscribes the widget to a given gesture with specific flags.
 
void ungrabGesture (Qt::GestureType type)
 Unsubscribes the widget from a given gesture type.
 
QString styleSheet () const
 
QString windowTitle () const
 
void setWindowIcon (const QIcon &icon)
 
QIcon windowIcon () const
 
void setWindowIconText (const QString &)
 
QString windowIconText () const
 
void setWindowRole (const QString &)
 Sets the window's role to role.
 
QString windowRole () const
 Returns the window's role, or an empty string.
 
void setWindowFilePath (const QString &filePath)
 
QString windowFilePath () const
 
void setWindowOpacity (qreal level)
 
qreal windowOpacity () const
 
bool isWindowModified () const
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
Qt::LayoutDirection layoutDirection () const
 
void unsetLayoutDirection ()
 
void setLocale (const QLocale &locale)
 
QLocale locale () const
 
void unsetLocale ()
 
bool isRightToLeft () const
 
bool isLeftToRight () const
 
bool isActiveWindow () const
 
void activateWindow ()
 Sets the top-level widget containing this widget to be the active window.
 
void clearFocus ()
 Takes keyboard input focus from the widget.
 
void setFocus (Qt::FocusReason reason)
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
bool hasFocus () const
 
void setFocusProxy (QWidget *)
 Sets the widget's focus proxy to widget w.
 
QWidgetfocusProxy () const
 Returns the focus proxy, or \nullptr if there is no focus proxy.
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void grabMouse ()
 Grabs the mouse input.
 
void grabMouse (const QCursor &)
 
void releaseMouse ()
 Releases the mouse grab.
 
void grabKeyboard ()
 Grabs the keyboard input.
 
void releaseKeyboard ()
 Releases the keyboard grab.
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.
 
void releaseShortcut (int id)
 Removes the shortcut with the given id from Qt's shortcut system.
 
void setShortcutEnabled (int id, bool enable=true)
 If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.
 
void setShortcutAutoRepeat (int id, bool enable=true)
 
bool updatesEnabled () const
 
void setUpdatesEnabled (bool enable)
 
void update (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.
 
void update (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.
 
void update (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void repaint (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.
 
void repaint (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.
 
void repaint (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void stackUnder (QWidget *)
 Places the widget under w in the parent widget's stack.
 
void move (int x, int y)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).
 
void move (const QPoint &)
 
void resize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).
 
void resize (const QSize &)
 
void setGeometry (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).
 
void setGeometry (const QRect &)
 
QByteArray saveGeometry () const
 
bool restoreGeometry (const QByteArray &geometry)
 
void adjustSize ()
 Adjusts the size of the widget to fit its contents.
 
bool isVisible () const
 
bool isVisibleTo (const QWidget *) const
 Returns true if this widget would become visible if ancestor is shown; otherwise returns false.
 
bool isHidden () const
 Returns true if the widget is hidden, otherwise returns false.
 
bool isMinimized () const
 
bool isMaximized () const
 
bool isFullScreen () const
 
Qt::WindowStates windowState () const
 Returns the current window state.
 
void setWindowState (Qt::WindowStates state)
 Sets the window state to windowState.
 
void overrideWindowState (Qt::WindowStates state)
 
QSizePolicy sizePolicy () const
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.
 
virtual int heightForWidth (int) const
 Returns the preferred height for this widget, given the width w.
 
virtual bool hasHeightForWidth () const
 
QRegion visibleRegion () const
 Returns the unobscured region where paint events can occur.
 
void setContentsMargins (int left, int top, int right, int bottom)
 Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.
 
void setContentsMargins (const QMargins &margins)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QMargins contentsMargins () const
 The contentsMargins function returns the widget's contents margins.
 
QRect contentsRect () const
 Returns the area inside the widget's margins.
 
QLayoutlayout () const
 Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.
 
void setLayout (QLayout *)
 Sets the layout manager for this widget to layout.
 
void updateGeometry ()
 Notifies the layout system that this widget has changed and may need to change geometry.
 
void setParent (QWidget *parent)
 Sets the parent of the widget to parent, and resets the window flags.
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.
 
void scroll (int dx, int dy)
 Scrolls the widget including its children dx pixels to the right and dy downward.
 
void scroll (int dx, int dy, const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.
 
QWidgetfocusWidget () const
 Returns the last child of this widget that setFocus had been called on.
 
QWidgetnextInFocusChain () const
 Returns the next widget in this widget's focus chain.
 
QWidgetpreviousInFocusChain () const
 The previousInFocusChain function returns the previous widget in this widget's focus chain.
 
bool acceptDrops () const
 
void setAcceptDrops (bool on)
 
void addAction (QAction *action)
 Appends the action action to this widget's list of actions.
 
void addActions (const QList< QAction * > &actions)
 Appends the actions actions to this widget's list of actions.
 
void insertActions (QAction *before, const QList< QAction * > &actions)
 Inserts the actions actions to this widget's list of actions, before the action before.
 
void insertAction (QAction *before, QAction *action)
 Inserts the action action to this widget's list of actions, before the action before.
 
void removeAction (QAction *action)
 Removes the action action from this widget's list of actions.
 
QList< QAction * > actions () const
 Returns the (possibly empty) list of this widget's actions.
 
QActionaddAction (const QString &text)
 
QActionaddAction (const QIcon &icon, const QString &text)
 
QActionaddAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
QActionaddAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QActionaddAction (const QString &text, Args &&...args)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QActionaddAction (const QIcon &icon, const QString &text, Args &&...args)
 
QWidgetparentWidget () const
 Returns the parent of this widget, or \nullptr if it does not have any parent widget.
 
void setWindowFlags (Qt::WindowFlags type)
 
Qt::WindowFlags windowFlags () const
 Window flags are a combination of a type (e.g.
 
void setWindowFlag (Qt::WindowType, bool on=true)
 
void overrideWindowFlags (Qt::WindowFlags type)
 Sets the window flags for the widget to flags, without telling the window system.
 
Qt::WindowType windowType () const
 Returns the window type of this widget.
 
QWidgetchildAt (int x, int y) const
 Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.
 
QWidgetchildAt (const QPoint &p) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.
 
void setAttribute (Qt::WidgetAttribute, bool on=true)
 Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.
 
bool testAttribute (Qt::WidgetAttribute) const
 Returns true if attribute attribute is set on this widget; otherwise returns false.
 
QPaintEnginepaintEngine () const override
 Returns the widget's paint engine.
 
void ensurePolished () const
 Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).
 
bool isAncestorOf (const QWidget *child) const
 Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false.
 
bool autoFillBackground () const
 
void setAutoFillBackground (bool enabled)
 
QBackingStorebackingStore () const
 
QWindowwindowHandle () const
 If this is a native widget, return the associated QWindow.
 
QScreenscreen () const
 Returns the screen the widget is on.
 
void setScreen (QScreen *)
 Sets the screen on which the widget should be shown to screen.
 
Qt::InputMethodHints inputMethodHints () const
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QPaintDevice
virtual ~QPaintDevice ()
 
bool paintingActive () const
 
int width () const
 
int height () const
 
int widthMM () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
qreal devicePixelRatio () const
 
qreal devicePixelRatioF () const
 
int colorCount () const
 
int depth () const
 

Protected Member Functions

void resizeEvent (QResizeEvent *event) override
 \reimp
 
void keyPressEvent (QKeyEvent *event) override
 \reimp
 
void keyReleaseEvent (QKeyEvent *event) override
 \reimp
 
void focusInEvent (QFocusEvent *event) override
 \reimp
 
void focusOutEvent (QFocusEvent *event) override
 \reimp
 
void changeEvent (QEvent *event) override
 \reimp
 
void closeEvent (QCloseEvent *event) override
 \reimp
 
void hideEvent (QHideEvent *event) override
 \reimp
 
void mousePressEvent (QMouseEvent *event) override
 \reimp
 
void mouseReleaseEvent (QMouseEvent *event) override
 \reimp
 
void mouseMoveEvent (QMouseEvent *event) override
 \reimp
 
void timerEvent (QTimerEvent *event) override
 \reimp
 
void paintEvent (QPaintEvent *event) override
 \reimp
 
void showEvent (QShowEvent *event) override
 \reimp
 
virtual void initStyleOption (QStyleOptionSpinBox *option) const
 Initialize option with the values from this QSpinBox.
 
QLineEditlineEdit () const
 This function returns a pointer to the line edit of the spin box.
 
void setLineEdit (QLineEdit *edit)
 Sets the line edit of the spinbox to be lineEdit instead of the current line edit widget.
 
virtual StepEnabled stepEnabled () const
 Virtual function that determines whether stepping up and down is legal at any given time.
 
 QAbstractSpinBox (QAbstractSpinBoxPrivate &dd, QWidget *parent=nullptr)
 
- Protected Member Functions inherited from QWidget
bool event (QEvent *event) override
 This is the main event handler; it handles event event.
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.
 
virtual void enterEvent (QEnterEvent *event)
 This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.
 
virtual void leaveEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.
 
virtual void moveEvent (QMoveEvent *event)
 This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.
 
virtual void contextMenuEvent (QContextMenuEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events.
 
virtual void actionEvent (QActionEvent *event)
 This event handler is called with the given event whenever the widget's actions are changed.
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.
 
int metric (PaintDeviceMetric) const override
 Internal implementation of the virtual QPaintDevice::metric() function.
 
void initPainter (QPainter *painter) const override
 Initializes the painter pen, background and font to the same as the given widget's.
 
QPaintDeviceredirected (QPoint *offset) const override
 
QPaintersharedPainter () const override
 
virtual void inputMethodEvent (QInputMethodEvent *)
 This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.
 
void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 Creates a new widget window.
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 Frees up window system resources.
 
virtual bool focusNextPrevChild (bool next)
 Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusNextChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusPreviousChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
 QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice () noexcept
 

Properties

bool wrapping
 whether the spin box is circular.
 
bool frame
 whether the spin box draws itself with a frame
 
Qt::Alignment alignment
 the alignment of the spin box
 
bool readOnly
 whether the spin box is read only.
 
ButtonSymbols buttonSymbols
 the current button symbol mode
 
QString specialValueText
 the special-value text
 
QString text
 the spin box's text, including any prefix and suffix
 
bool accelerated
 whether the spin box will accelerate the frequency of the steps when pressing the step Up/Down buttons.
 
CorrectionMode correctionMode
 the mode to correct an \l{QValidator::}{Intermediate} value if editing finishes
 
bool acceptableInput
 whether the input satisfies the current validation
 
bool keyboardTracking
 whether keyboard tracking is enabled for the spinbox.
 
bool showGroupSeparator
 whether a thousands separator is enabled. By default this property is false.
 
- Properties inherited from QWidget
bool modal
 whether the widget is a modal widget
 
Qt::WindowModality windowModality
 which windows are blocked by the modal widget
 
bool enabled
 whether the widget is enabled
 
QRect geometry
 the geometry of the widget relative to its parent and excluding the window frame
 
QRect frameGeometry
 geometry of the widget relative to its parent including any window frame
 
QRect normalGeometry
 the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget
 
int x
 the x coordinate of the widget relative to its parent including any window frame
 
int y
 the y coordinate of the widget relative to its parent and including any window frame
 
QPoint pos
 the position of the widget within its parent widget
 
QSize frameSize
 the size of the widget including any window frame
 
QSize size
 the size of the widget excluding any window frame
 
int width
 the width of the widget excluding any window frame
 
int height
 the height of the widget excluding any window frame
 
QRect rect
 the internal geometry of the widget excluding any window frame
 
QRect childrenRect
 the bounding rectangle of the widget's children
 
QRegion childrenRegion
 the combined region occupied by the widget's children
 
QSizePolicy sizePolicy
 the default layout behavior of the widget
 
QSize minimumSize
 the widget's minimum size
 
QSize maximumSize
 the widget's maximum size in pixels
 
int minimumWidth
 the widget's minimum width in pixels
 
int minimumHeight
 the widget's minimum height in pixels
 
int maximumWidth
 the widget's maximum width in pixels
 
int maximumHeight
 the widget's maximum height in pixels
 
QSize sizeIncrement
 the size increment of the widget
 
QSize baseSize
 the base size of the widget
 
QPalette palette
 the widget's palette
 
QFont font
 the font currently set for the widget
 
QCursor cursor
 the cursor shape for this widget
 
bool mouseTracking
 whether mouse tracking is enabled for the widget
 
bool tabletTracking
 whether tablet tracking is enabled for the widget
 
bool isActiveWindow
 whether this widget's window is the active window
 
Qt::FocusPolicy focusPolicy
 the way the widget accepts keyboard focus
 
bool focus
 whether this widget (or its focus proxy) has the keyboard input focus
 
Qt::ContextMenuPolicy contextMenuPolicy
 how the widget shows a context menu
 
bool updatesEnabled
 whether updates are enabled
 
bool visible
 whether the widget is visible
 
bool minimized
 whether this widget is minimized (iconified)
 
bool maximized
 whether this widget is maximized
 
bool fullScreen
 whether the widget is shown in full screen mode
 
QSize sizeHint
 the recommended size for the widget
 
QSize minimumSizeHint
 the recommended minimum size for the widget
 
bool acceptDrops
 whether drop events are enabled for this widget
 
QString windowTitle
 the window title (caption)
 
QIcon windowIcon
 the widget's icon
 
QString windowIconText
 the text to be displayed on the icon of a minimized window
 
double windowOpacity
 The level of opacity for the window.
 
bool windowModified
 whether the document shown in the window has unsaved changes
 
Qt::LayoutDirection layoutDirection
 the layout direction for this widget.
 
bool autoFillBackground
 whether the widget background is filled automatically
 
QString styleSheet
 the widget's style sheet
 
QLocale locale
 the widget's locale
 
QString windowFilePath
 the file path associated with a widget
 
Qt::InputMethodHints inputMethodHints
 What input method specific hints the widget has.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QAccessibleAbstractSpinBox
 

Additional Inherited Members

- Static Public Member Functions inherited from QWidget
static void setTabOrder (QWidget *, QWidget *)
 Puts the second widget after the first widget in the focus order.
 
static void setTabOrder (std::initializer_list< QWidget * > widgets)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
static QWidgetmouseGrabber ()
 Returns the widget that is currently grabbing the mouse input.
 
static QWidgetkeyboardGrabber ()
 Returns the widget that is currently grabbing the keyboard input.
 
static QWidgetfind (WId)
 Returns a pointer to the widget with window identifier/handle id.
 
static QWidgetcreateWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 Creates a QWidget that makes it possible to embed window into a QWidget-based application.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Static Public Member Functions inherited from QPaintDevice
static qreal devicePixelRatioFScale ()
 
- Protected Slots inherited from QWidget
void updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
 Updates the widget's micro focus and informs input methods that the state specified by query has changed.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Attributes inherited from QPaintDevice
ushort painters
 

Detailed Description

The QAbstractSpinBox class provides a spinbox and a line edit to display values.

\inmodule QtWidgets

The class is designed as a common super class for widgets like QSpinBox, QDoubleSpinBox and QDateTimeEdit

Here are the main properties of the class:

\list 1

  • \l wrapping: Whether the QAbstractSpinBox wraps from the minimum value to the maximum value and vice versa.

\endlist

QAbstractSpinBox provides a virtual stepBy() function that is called whenever the user triggers a step. This function takes an integer value to signify how many steps were taken. E.g. Pressing Qt::Key_Down will trigger a call to stepBy(-1).

When the user triggers a step whilst holding the Qt::ControlModifier, QAbstractSpinBox steps by 10 instead of making a single step. This step modifier affects wheel events, key events and interaction with the spinbox buttons. Note that on macOS, Control corresponds to the Command key.

Since Qt 5.12, QStyle::SH_SpinBox_StepModifier can be used to select which Qt::KeyboardModifier increases the step rate. Qt::NoModifier disables this feature.

QAbstractSpinBox also provide a virtual function stepEnabled() to determine whether stepping up/down is allowed at any point. This function returns a bitset of StepEnabled.

See also
QAbstractSlider, QSpinBox, QDoubleSpinBox, QDateTimeEdit, {Spin Boxes Example}

Definition at line 20 of file qabstractspinbox.h.

Member Enumeration Documentation

◆ ButtonSymbols

This enum type describes the symbols that can be displayed on the buttons in a spin box.

\inlineimage qspinbox-updown.png \inlineimage qspinbox-plusminus.png

\value UpDownArrows Little arrows in the classic style. \value PlusMinus {+} and {-} symbols. \value NoButtons Don't display buttons.

See also
QAbstractSpinBox::buttonSymbols
Enumerator
UpDownArrows 
PlusMinus 
NoButtons 

Definition at line 44 of file qabstractspinbox.h.

◆ CorrectionMode

This enum type describes the mode the spinbox will use to correct an \l{QValidator::}{Intermediate} value if editing finishes.

\value CorrectToPreviousValue The spinbox will revert to the last valid value.

\value CorrectToNearestValue The spinbox will revert to the nearest valid value.

See also
correctionMode
Enumerator
CorrectToPreviousValue 
CorrectToNearestValue 

Definition at line 50 of file qabstractspinbox.h.

◆ StepEnabledFlag

\value StepNone \value StepUpEnabled \value StepDownEnabled

Enumerator
StepNone 
StepUpEnabled 
StepDownEnabled 

Definition at line 40 of file qabstractspinbox.h.

◆ StepType

\value DefaultStepType \value AdaptiveDecimalStepType

Enumerator
DefaultStepType 
AdaptiveDecimalStepType 

Definition at line 95 of file qabstractspinbox.h.

Constructor & Destructor Documentation

◆ QAbstractSpinBox() [1/2]

QAbstractSpinBox::QAbstractSpinBox ( QWidget * parent = nullptr)
explicit

Constructs an abstract spinbox with the given parent with default \l wrapping, and \l alignment properties.

Definition at line 116 of file qabstractspinbox.cpp.

◆ ~QAbstractSpinBox()

QAbstractSpinBox::~QAbstractSpinBox ( )

Called when the QAbstractSpinBox is destroyed.

Definition at line 137 of file qabstractspinbox.cpp.

◆ QAbstractSpinBox() [2/2]

QAbstractSpinBox::QAbstractSpinBox ( QAbstractSpinBoxPrivate & dd,
QWidget * parent = nullptr )
protected

Definition at line 126 of file qabstractspinbox.cpp.

Member Function Documentation

◆ alignment()

Qt::Alignment QAbstractSpinBox::alignment ( ) const

Definition at line 475 of file qabstractspinbox.cpp.

References d.

◆ buttonSymbols()

QAbstractSpinBox::ButtonSymbols QAbstractSpinBox::buttonSymbols ( ) const

Definition at line 171 of file qabstractspinbox.cpp.

References d.

◆ changeEvent()

void QAbstractSpinBox::changeEvent ( QEvent * event)
overrideprotectedvirtual

◆ clear

void QAbstractSpinBox::clear ( )
virtualslot

Clears the lineedit of all text but prefix and suffix.

Reimplemented in QDateTimeEdit.

Definition at line 510 of file qabstractspinbox.cpp.

References d.

Referenced by keyPressEvent().

+ Here is the caller graph for this function:

◆ closeEvent()

void QAbstractSpinBox::closeEvent ( QCloseEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1203 of file qabstractspinbox.cpp.

References QWidget::closeEvent(), d, and EmitIfChanged.

+ Here is the call graph for this function:

◆ correctionMode()

QAbstractSpinBox::CorrectionMode QAbstractSpinBox::correctionMode ( ) const

Definition at line 440 of file qabstractspinbox.cpp.

References d.

◆ editingFinished

void QAbstractSpinBox::editingFinished ( )
signal

This signal is emitted editing is finished.

This happens when the spinbox loses focus and when enter is pressed.

Referenced by QInputDialogDoubleSpinBox::QInputDialogDoubleSpinBox(), QInputDialogSpinBox::QInputDialogSpinBox(), event(), focusOutEvent(), keyPressEvent(), and QDateTimeEdit::keyPressEvent().

+ Here is the caller graph for this function:

◆ event()

bool QAbstractSpinBox::event ( QEvent * event)
overridevirtual

\reimp

Reimplemented from QObject.

Reimplemented in QDateTimeEdit, and QSpinBox.

Definition at line 751 of file qabstractspinbox.cpp.

References QEvent::ApplicationLayoutDirectionChange, d, editingFinished(), emit, QWidget::event(), QEvent::FontChange, QEvent::HoverEnter, QEvent::HoverLeave, QEvent::HoverMove, QEvent::InputMethod, QEvent::LayoutDirectionChange, position(), QEvent::ShortcutOverride, and QEvent::StyleChange.

Referenced by QDateTimeEdit::event(), and QSpinBox::event().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fixup()

void QAbstractSpinBox::fixup ( QString & input) const
virtual

This virtual function is called by the QAbstractSpinBox if the input is not validated to QValidator::Acceptable when Return is pressed or interpretText() is called.

It will try to change the text so it is valid. Reimplemented in the various subclasses.

Reimplemented in QDateTimeEdit, QSpinBox, and QDoubleSpinBox.

Definition at line 573 of file qabstractspinbox.cpp.

Referenced by QSpinBoxValidator::fixup().

+ Here is the caller graph for this function:

◆ focusInEvent()

void QAbstractSpinBox::focusInEvent ( QFocusEvent * event)
overrideprotectedvirtual

\reimp

\reimp

Reimplemented from QWidget.

Reimplemented in QDateTimeEdit.

Definition at line 1165 of file qabstractspinbox.cpp.

References Qt::BacktabFocusReason, d, QWidget::focusInEvent(), selectAll(), and Qt::TabFocusReason.

Referenced by QDateTimeEdit::focusInEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ focusOutEvent()

void QAbstractSpinBox::focusOutEvent ( QFocusEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1180 of file qabstractspinbox.cpp.

References d, editingFinished(), emit, EmitIfChanged, and QWidget::focusOutEvent().

+ Here is the call graph for this function:

◆ hasAcceptableInput()

bool QAbstractSpinBox::hasAcceptableInput ( ) const

Definition at line 455 of file qabstractspinbox.cpp.

References d.

Referenced by QWizardPage::isComplete(), QInputDialogSpinBox::keyPressEvent(), QInputDialogDoubleSpinBox::keyPressEvent(), and QInputDialogPrivate::setInputWidget().

+ Here is the caller graph for this function:

◆ hasFrame()

bool QAbstractSpinBox::hasFrame ( ) const

Definition at line 348 of file qabstractspinbox.cpp.

References d.

◆ hideEvent()

void QAbstractSpinBox::hideEvent ( QHideEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1217 of file qabstractspinbox.cpp.

References d, EmitIfChanged, and QWidget::hideEvent().

+ Here is the call graph for this function:

◆ initStyleOption()

void QAbstractSpinBox::initStyleOption ( QStyleOptionSpinBox * option) const
protectedvirtual

Initialize option with the values from this QSpinBox.

This method is useful for subclasses when they need a QStyleOptionSpinBox, but don't want to fill in all the information themselves.

See also
QStyleOption::initFrom()

Reimplemented in QDateTimeEdit.

Definition at line 1670 of file qabstractspinbox.cpp.

References d, Down, NoButtons, QStyle::SC_None, QStyle::SC_SpinBoxDown, QStyle::SC_SpinBoxEditField, QStyle::SC_SpinBoxFrame, QStyle::SC_SpinBoxUp, QStyle::SH_SpinBox_ButtonsInsideFrame, QStyle::SH_SpinControls_DisableOnBounds, QStyle::State_Sunken, StepDownEnabled, stepEnabled(), StepUpEnabled, QWidget::style(), QStyle::styleHint(), and Up.

Referenced by QDateTimeEdit::initStyleOption(), minimumSizeHint(), paintEvent(), and sizeHint().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ inputMethodQuery()

QVariant QAbstractSpinBox::inputMethodQuery ( Qt::InputMethodQuery query) const
overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 732 of file qabstractspinbox.cpp.

References d, Qt::ImHints, and QWidget::inputMethodHints.

◆ interpretText()

void QAbstractSpinBox::interpretText ( )

This function interprets the text of the spin box.

If the value has changed since last interpretation it will emit signals.

Definition at line 720 of file qabstractspinbox.cpp.

References d, and EmitIfChanged.

Referenced by SpinBoxDelegate::setModelData().

+ Here is the caller graph for this function:

◆ isAccelerated()

bool QAbstractSpinBox::isAccelerated ( ) const

Definition at line 379 of file qabstractspinbox.cpp.

References d.

◆ isGroupSeparatorShown()

bool QAbstractSpinBox::isGroupSeparatorShown ( ) const

Definition at line 393 of file qabstractspinbox.cpp.

References d.

Referenced by QSpinBox::fixup().

+ Here is the caller graph for this function:

◆ isReadOnly()

bool QAbstractSpinBox::isReadOnly ( ) const

Definition at line 292 of file qabstractspinbox.cpp.

References d.

Referenced by keyPressEvent().

+ Here is the caller graph for this function:

◆ keyboardTracking()

bool QAbstractSpinBox::keyboardTracking ( ) const

Definition at line 328 of file qabstractspinbox.cpp.

References d.

◆ keyPressEvent()

void QAbstractSpinBox::keyPressEvent ( QKeyEvent * event)
overrideprotectedvirtual

\reimp

This function handles keyboard input.

The following keys are handled specifically: \table \row

  • Enter/Return
  • This will reinterpret the text and emit a signal even if the value has not changed since last time a signal was emitted. \row
  • Up
  • This will invoke stepBy(1) \row
  • Down
  • This will invoke stepBy(-1) \row
  • Page up
  • This will invoke stepBy(10) \row
  • Page down
  • This will invoke stepBy(-10) \endtable
See also
stepBy()

Reimplemented from QWidget.

Reimplemented in QInputDialogSpinBox, QInputDialogDoubleSpinBox, and QDateTimeEdit.

Definition at line 977 of file qabstractspinbox.cpp.

References AlwaysEmit, clear(), Qt::ControlModifier, d, Down, editingFinished(), emit, EmitIfChanged, isReadOnly(), QWidget::isVisible(), Qt::Key_Back, Qt::Key_Down, Qt::Key_End, Qt::Key_Enter, Qt::Key_Home, Qt::Key_Left, Qt::Key_PageDown, Qt::Key_PageUp, Qt::Key_Return, Qt::Key_Right, Qt::Key_Select, Qt::Key_U, Qt::Key_Up, Keyboard, QGuiApplication::platformName, Q_FALLTHROUGH, QKeySequence::SelectAll, selectAll(), QStyle::SH_SpinBox_AnimateButton, Qt::ShiftModifier, QString::size(), stepBy(), StepDownEnabled, stepEnabled(), StepUpEnabled, QWidget::style(), QStyle::styleHint(), text, and Up.

Referenced by QDateTimeEdit::keyPressEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ keyReleaseEvent()

void QAbstractSpinBox::keyReleaseEvent ( QKeyEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1119 of file qabstractspinbox.cpp.

References d, and Keyboard.

◆ lineEdit()

QLineEdit * QAbstractSpinBox::lineEdit ( ) const
protected

This function returns a pointer to the line edit of the spin box.

Definition at line 649 of file qabstractspinbox.cpp.

References d.

Referenced by QInputDialogDoubleSpinBox::QInputDialogDoubleSpinBox(), QInputDialogSpinBox::QInputDialogSpinBox(), setLineEdit(), and text().

+ Here is the caller graph for this function:

◆ minimumSizeHint()

QSize QAbstractSpinBox::minimumSizeHint ( ) const
overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 904 of file qabstractspinbox.cpp.

References QStyle::CT_SpinBox, d, QWidget::ensurePolished(), QWidget::fontMetrics(), hint(), initStyleOption(), opt, qMax(), QStyle::sizeFromContents(), QWidget::style(), and QString::truncate().

+ Here is the call graph for this function:

◆ mouseMoveEvent()

void QAbstractSpinBox::mouseMoveEvent ( QMouseEvent * event)
overrideprotectedvirtual

\reimp

\reimp

Reimplemented from QWidget.

Definition at line 1329 of file qabstractspinbox.cpp.

References d, NoButtons, QStyle::SC_SpinBoxDown, QStyle::SC_SpinBoxUp, StepDownEnabled, stepEnabled(), and StepUpEnabled.

+ Here is the call graph for this function:

◆ mousePressEvent()

void QAbstractSpinBox::mousePressEvent ( QMouseEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QInputDialogSpinBox, QInputDialogDoubleSpinBox, and QDateTimeEdit.

Definition at line 1353 of file qabstractspinbox.cpp.

References d, Qt::LeftButton, NoButtons, None, QStyle::SC_SpinBoxDown, QStyle::SC_SpinBoxUp, StepDownEnabled, stepEnabled(), StepNone, and StepUpEnabled.

Referenced by QDateTimeEdit::mousePressEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mouseReleaseEvent()

void QAbstractSpinBox::mouseReleaseEvent ( QMouseEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 1378 of file qabstractspinbox.cpp.

References d, and Mouse.

◆ paintEvent()

void QAbstractSpinBox::paintEvent ( QPaintEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QDateTimeEdit.

Definition at line 945 of file qabstractspinbox.cpp.

References QStyle::CC_SpinBox, initStyleOption(), and opt.

Referenced by QDateTimeEdit::paintEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ resizeEvent()

void QAbstractSpinBox::resizeEvent ( QResizeEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 853 of file qabstractspinbox.cpp.

References d, QWidget::resizeEvent(), and QWidget::update().

+ Here is the call graph for this function:

◆ selectAll

void QAbstractSpinBox::selectAll ( )
slot

Selects all the text in the spinbox except the prefix and suffix.

Definition at line 493 of file qabstractspinbox.cpp.

References d.

Referenced by QCalendarWidgetPrivate::_q_yearClicked(), focusInEvent(), keyPressEvent(), QDateTimeEdit::keyPressEvent(), and stepBy().

+ Here is the caller graph for this function:

◆ setAccelerated()

void QAbstractSpinBox::setAccelerated ( bool on)

Definition at line 373 of file qabstractspinbox.cpp.

References d.

◆ setAlignment()

void QAbstractSpinBox::setAlignment ( Qt::Alignment flag)

Definition at line 482 of file qabstractspinbox.cpp.

References d.

◆ setButtonSymbols()

void QAbstractSpinBox::setButtonSymbols ( ButtonSymbols bs)

Definition at line 177 of file qabstractspinbox.cpp.

References buttonSymbols, d, QWidget::update(), and QWidget::updateGeometry().

+ Here is the call graph for this function:

◆ setCorrectionMode()

void QAbstractSpinBox::setCorrectionMode ( CorrectionMode cm)

Definition at line 434 of file qabstractspinbox.cpp.

References correctionMode, and d.

◆ setFrame()

void QAbstractSpinBox::setFrame ( bool enable)

Definition at line 355 of file qabstractspinbox.cpp.

References d, and QWidget::update().

Referenced by QCalendarWidgetPrivate::createNavigationBar().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setGroupSeparatorShown()

void QAbstractSpinBox::setGroupSeparatorShown ( bool shown)

Definition at line 399 of file qabstractspinbox.cpp.

References d, EmitIfChanged, and QWidget::updateGeometry().

+ Here is the call graph for this function:

◆ setKeyboardTracking()

void QAbstractSpinBox::setKeyboardTracking ( bool kt)

Definition at line 334 of file qabstractspinbox.cpp.

References d.

◆ setLineEdit()

void QAbstractSpinBox::setLineEdit ( QLineEdit * lineEdit)
protected

Sets the line edit of the spinbox to be lineEdit instead of the current line edit widget.

lineEdit cannot be \nullptr.

QAbstractSpinBox takes ownership of the new lineEdit

If QLineEdit::validator() for the lineEdit returns \nullptr, the internal validator of the spinbox will be set on the line edit.

Definition at line 669 of file qabstractspinbox.cpp.

References QObject::connect(), QObjectPrivate::connect(), QLineEdit::cursorPositionChanged(), d, QAbstractSpinBoxPrivate::editorCursorPositionChanged(), QAbstractSpinBoxPrivate::editorTextChanged(), QWidget::isVisible(), lineEdit(), Qt::NoContextMenu, Q_ASSERT, setProperty, QStyle::SH_SpinBox_ButtonsInsideFrame, QWidget::style(), QLineEdit::textChanged(), QMetaType::UnknownType, and QWidgetLineControl::updateMicroFocus().

+ Here is the call graph for this function:

◆ setReadOnly()

void QAbstractSpinBox::setReadOnly ( bool r)

Definition at line 298 of file qabstractspinbox.cpp.

References d, QEvent::ReadOnlyChange, QCoreApplication::sendEvent(), and QWidget::update().

+ Here is the call graph for this function:

◆ setSpecialValueText()

void QAbstractSpinBox::setSpecialValueText ( const QString & txt)

Definition at line 241 of file qabstractspinbox.cpp.

References d, and specialValueText.

◆ setWrapping()

void QAbstractSpinBox::setWrapping ( bool w)

Definition at line 271 of file qabstractspinbox.cpp.

References d, and wrapping.

◆ showEvent()

void QAbstractSpinBox::showEvent ( QShowEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 797 of file qabstractspinbox.cpp.

References d.

◆ sizeHint()

QSize QAbstractSpinBox::sizeHint ( ) const
overridevirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QDateTimeEdit.

Definition at line 866 of file qabstractspinbox.cpp.

References QStyle::CT_SpinBox, d, QWidget::ensurePolished(), QWidget::fontMetrics(), hint(), initStyleOption(), opt, qMax(), QStyle::sizeFromContents(), QWidget::style(), and QString::truncate().

Referenced by QCalendarWidgetPrivate::_q_yearClicked().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ specialValueText()

QString QAbstractSpinBox::specialValueText ( ) const

Definition at line 235 of file qabstractspinbox.cpp.

References d.

◆ stepBy()

void QAbstractSpinBox::stepBy ( int steps)
virtual

Virtual function that is called whenever the user triggers a step.

The steps parameter indicates how many steps were taken. For example, pressing Qt::Key_Down will trigger a call to stepBy(-1), whereas pressing Qt::Key_PageUp will trigger a call to stepBy(10).

If you subclass QAbstractSpinBox you must reimplement this function. Note that this function is called even if the resulting value will be outside the bounds of minimum and maximum. It's this function's job to handle these situations.

See also
stepUp(), stepDown(), keyPressEvent()

Reimplemented in QDateTimeEdit.

Definition at line 612 of file qabstractspinbox.cpp.

References QValidator::Acceptable, AdaptiveDecimalStepType, AlwaysEmit, d, EmitIfChanged, NeverEmit, selectAll(), QVariant::setValue(), QStyle::SH_SpinBox_SelectOnStep, QWidget::style(), validate(), and QVariant::value().

Referenced by keyPressEvent(), stepDown(), stepUp(), and timerEvent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ stepDown

void QAbstractSpinBox::stepDown ( )
slot

Steps down by one linestep Calling this slot is analogous to calling stepBy(-1);.

See also
stepBy(), stepUp()

Definition at line 594 of file qabstractspinbox.cpp.

References stepBy().

+ Here is the call graph for this function:

◆ stepEnabled()

QAbstractSpinBox::StepEnabled QAbstractSpinBox::stepEnabled ( ) const
protectedvirtual

Virtual function that determines whether stepping up and down is legal at any given time.

The up arrow will be painted as disabled unless (stepEnabled() & StepUpEnabled) != 0.

The default implementation will return (StepUpEnabled| StepDownEnabled) if wrapping is turned on. Else it will return StepDownEnabled if value is > minimum() or'ed with StepUpEnabled if value < maximum().

If you subclass QAbstractSpinBox you will need to reimplement this function.

See also
QSpinBox::minimum(), QSpinBox::maximum(), wrapping()

Reimplemented in QDateTimeEdit.

Definition at line 537 of file qabstractspinbox.cpp.

References d, ret, StepDownEnabled, StepNone, StepUpEnabled, QMetaType::UnknownType, and QAbstractSpinBoxPrivate::variantCompare().

Referenced by initStyleOption(), keyPressEvent(), mouseMoveEvent(), mousePressEvent(), timerEvent(), QQC2::QStyleHelper::uniqueName(), and QStyleHelper::uniqueName().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ stepUp

void QAbstractSpinBox::stepUp ( )
slot

Steps up by one linestep Calling this slot is analogous to calling stepBy(1);.

See also
stepBy(), stepDown()

Definition at line 583 of file qabstractspinbox.cpp.

References stepBy().

+ Here is the call graph for this function:

◆ text()

QString QAbstractSpinBox::text ( ) const

Definition at line 196 of file qabstractspinbox.cpp.

References QLineEdit::displayText, and lineEdit().

+ Here is the call graph for this function:

◆ timerEvent()

void QAbstractSpinBox::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 1231 of file qabstractspinbox.cpp.

References d, Down, Keyboard, QObject::killTimer(), QObject::startTimer(), stepBy(), StepDownEnabled, stepEnabled(), StepUpEnabled, QGuiApplication::styleHints(), QObject::timerEvent(), and Up.

+ Here is the call graph for this function:

◆ validate()

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

This virtual function is called by the QAbstractSpinBox to determine whether input is valid.

The pos parameter indicates the position in the string. Reimplemented in the various subclasses.

Reimplemented in QDateTimeEdit, QSpinBox, QDoubleSpinBox, and QPdfPageSelectorSpinBox.

Definition at line 561 of file qabstractspinbox.cpp.

References QValidator::Acceptable.

Referenced by stepBy(), and QSpinBoxValidator::validate().

+ Here is the caller graph for this function:

◆ wrapping()

bool QAbstractSpinBox::wrapping ( ) const

Definition at line 265 of file qabstractspinbox.cpp.

References d.

Friends And Related Symbol Documentation

◆ QAccessibleAbstractSpinBox

friend class QAccessibleAbstractSpinBox
friend

Definition at line 141 of file qabstractspinbox.h.

Property Documentation

◆ accelerated

QAbstractSpinBox::accelerated
readwrite

whether the spin box will accelerate the frequency of the steps when pressing the step Up/Down buttons.

Since
4.2

If enabled the spin box will increase/decrease the value faster the longer you hold the button down.

Definition at line 31 of file qabstractspinbox.h.

◆ acceptableInput

QAbstractSpinBox::acceptableInput
read

whether the input satisfies the current validation

Since
4.2
See also
validate(), fixup(), correctionMode

Definition at line 33 of file qabstractspinbox.h.

◆ alignment

QAbstractSpinBox::alignment
readwrite

the alignment of the spin box

Possible Values are Qt::AlignLeft, Qt::AlignRight, and Qt::AlignHCenter.

By default, the alignment is Qt::AlignLeft

Attempting to set the alignment to an illegal flag combination does nothing.

See also
Qt::Alignment

Definition at line 26 of file qabstractspinbox.h.

◆ buttonSymbols

QAbstractSpinBox::buttonSymbols
readwrite

the current button symbol mode

The possible values can be either UpDownArrows or PlusMinus. The default is UpDownArrows.

Note that some styles might render PlusMinus and UpDownArrows identically.

See also
ButtonSymbols

Definition at line 28 of file qabstractspinbox.h.

Referenced by setButtonSymbols(), QQC2::QStyleHelper::uniqueName(), and QStyleHelper::uniqueName().

◆ correctionMode

QAbstractSpinBox::correctionMode
readwrite

the mode to correct an \l{QValidator::}{Intermediate} value if editing finishes

Since
4.2

The default mode is QAbstractSpinBox::CorrectToPreviousValue.

See also
acceptableInput, validate(), fixup()

Definition at line 32 of file qabstractspinbox.h.

Referenced by setCorrectionMode().

◆ frame

QAbstractSpinBox::frame
readwrite

whether the spin box draws itself with a frame

If enabled (the default) the spin box draws itself inside a frame, otherwise the spin box draws itself without any frame.

Definition at line 25 of file qabstractspinbox.h.

Referenced by QQC2::QStyleHelper::uniqueName(), and QStyleHelper::uniqueName().

◆ keyboardTracking

QAbstractSpinBox::keyboardTracking
readwrite

whether keyboard tracking is enabled for the spinbox.

Since
4.3

If keyboard tracking is enabled (the default), the spinbox emits the valueChanged() and textChanged() signals while the new value is being entered from the keyboard.

E.g. when the user enters the value 600 by typing 6, 0, and 0, the spinbox emits 3 signals with the values 6, 60, and 600 respectively.

If keyboard tracking is disabled, the spinbox doesn't emit the valueChanged() and textChanged() signals while typing. It emits the signals later, when the return key is pressed, when keyboard focus is lost, or when other spinbox functionality is used, e.g. pressing an arrow key.

Definition at line 34 of file qabstractspinbox.h.

◆ readOnly

QAbstractSpinBox::readOnly
readwrite

whether the spin box is read only.

In read-only mode, the user can still copy the text to the clipboard, or drag and drop the text; but cannot edit it.

The QLineEdit in the QAbstractSpinBox does not show a cursor in read-only mode.

See also
QLineEdit::readOnly

Definition at line 27 of file qabstractspinbox.h.

◆ showGroupSeparator

QAbstractSpinBox::showGroupSeparator
readwrite

whether a thousands separator is enabled. By default this property is false.

Since
5.3

Definition at line 35 of file qabstractspinbox.h.

◆ specialValueText

QAbstractSpinBox::specialValueText
readwrite

the special-value text

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.

For example, if your spin box allows the user to choose a scale factor (or zoom level) for displaying an image, and your application is able to automatically choose one that will enable the image to fit completely within the display window, you can set up the spin box like this:

The user will then be able to choose a scale from 1% to 1000% or select "Auto" to leave it up to the application to choose. Your code must then interpret the spin box value of 0 as a request from the user to scale the image to fit inside the window.

All values are displayed with the prefix and suffix (if set), except for the special value, which only shows the special value text. This special text is passed in the QSpinBox::textChanged() signal that passes a QString.

To turn off the special-value text display, call this function with an empty string. The default is no special-value text, i.e. the numeric value is shown as usual.

If no special-value text is set, specialValueText() returns an empty string.

Definition at line 29 of file qabstractspinbox.h.

Referenced by setSpecialValueText().

◆ text

◆ wrapping

QAbstractSpinBox::wrapping
readwrite

whether the spin box is circular.

If wrapping is true stepping up from maximum() value will take you to the minimum() value and vice versa. Wrapping only make sense if you have minimum() and maximum() values set.

QSpinBox *spinBox = new QSpinBox(this);
spinBox->setRange(0, 100);
// value is 0
virtual void stepBy(int steps)
Virtual function that is called whenever the user triggers a step.
The QSpinBox class provides a spin box widget.
Definition qspinbox.h:16
void setValue(int val)
Definition qspinbox.cpp:192
void setRange(int min, int max)
Convenience function to set the minimum, and maximum values with a single function call.
Definition qspinbox.cpp:381
QSpinBox * spinBox
[0]
See also
QSpinBox::minimum(), QSpinBox::maximum()

Definition at line 24 of file qabstractspinbox.h.

Referenced by setWrapping().


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