Wt  4.10.4
Public Member Functions | List of all members
Wt::WSpinBox Class Reference

An input control for integer numbers. More...

#include <Wt/WSpinBox.h>

Inheritance diagram for Wt::WSpinBox:
[legend]

Public Member Functions

 WSpinBox ()
 Creates a spin-box. More...
 
void setMinimum (int minimum)
 Sets the minimum value. More...
 
int minimum () const
 Returns the minimum value. More...
 
void setMaximum (int maximum)
 Sets the maximum value. More...
 
int maximum () const
 Returns the maximum value. More...
 
void setRange (int minimum, int maximum)
 Sets the range. More...
 
void setSingleStep (int step)
 Sets the step value. More...
 
int singleStep () const
 Returns the step value.
 
void setValue (int value)
 Sets the value. More...
 
int value () const
 Returns the value. More...
 
void setWrapAroundEnabled (bool enabled)
 Sets if this spinbox wraps around to stay in the valid range. More...
 
bool wrapAroundEnabled () const
 Returns if the spinbox wraps around. More...
 
Signal< int > & valueChanged ()
 A signal that indicates when the value has changed. More...
 
- Public Member Functions inherited from Wt::WAbstractSpinBox
void setNativeControl (bool nativeControl)
 Configures whether a native HTML5 control should be used. More...
 
bool nativeControl () const
 Returns whether a native HTML5 control is used. More...
 
void setPrefix (const WString &prefix)
 Sets a prefix. More...
 
const WStringprefix () const
 Returns the prefix. More...
 
void setSuffix (const WString &suffix)
 Sets a suffix. More...
 
const WStringsuffix () const
 Returns the suffix. More...
 
virtual void setText (const WString &text) override
 Sets the content of the line edit. More...
 
virtual ValidationState validate () override
 Validates the field. More...
 
virtual void refresh () override
 Refresh the widget. More...
 
- Public Member Functions inherited from Wt::WLineEdit
 WLineEdit ()
 Creates a line edit with empty content.
 
 WLineEdit (const WString &content)
 Creates a line edit with given content.
 
void setTextSize (int chars)
 Specifies the width of the line edit in number of characters. More...
 
int textSize () const
 Returns the current width of the line edit in number of characters. More...
 
const WStringtext () const
 Returns the current content. More...
 
WString displayText () const
 Returns the displayed text. More...
 
void setMaxLength (int length)
 Specifies the maximum length of text that can be entered. More...
 
int maxLength () const
 Returns the maximum length of text that can be entered. More...
 
void setEchoMode (EchoMode echoMode)
 Sets the echo mode. More...
 
EchoMode echoMode () const
 Returns the echo mode. More...
 
void setAutoComplete (bool enabled)
 Sets (built-in browser) autocomplete support. More...
 
bool autoComplete () const
 Returns auto-completion support. More...
 
int selectionStart () const
 Returns the current selection start. More...
 
WString selectedText () const
 Returns the currently selected text. More...
 
bool hasSelectedText () const
 Returns whether there is selected text. More...
 
void setSelection (int start, int length)
 Selects length characters starting from the start position. More...
 
int cursorPosition () const
 Returns the current cursor position. More...
 
virtual WString valueText () const override
 Returns the current value. More...
 
virtual void setValueText (const WString &value) override
 Sets the current value. More...
 
WString inputMask () const
 Returns the input mask. More...
 
void setInputMask (const WString &mask="", WFlags< InputMaskFlag > flags=None)
 Sets the input mask. More...
 
EventSignaltextInput ()
 Event signal emitted when the text in the input field changed. More...
 
- Public Member Functions inherited from Wt::WFormWidget
 WFormWidget ()
 Creates a WFormWidget.
 
 ~WFormWidget ()
 Destructor.
 
WLabellabel () const
 Returns the label associated with this widget. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
 Sets the hidden state of this widget. More...
 
void setValidator (const std::shared_ptr< WValidator > &validator)
 Sets a validator for this field. More...
 
virtual std::shared_ptr< WValidatorvalidator () const
 Returns the validator.
 
void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
virtual void setReadOnly (bool readOnly)
 Sets the element read-only. More...
 
bool isReadOnly () const
 Returns whether the form element is read-only. More...
 
virtual void setPlaceholderText (const WString &placeholder)
 Sets the placeholder text. More...
 
const WStringplaceholderText () const
 Returns the placeholder text. More...
 
EventSignalchanged ()
 Signal emitted when the value was changed. More...
 
Signal< WValidator::Result > & validated ()
 Signal emitted when the widget is being validated. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
 Sets a tooltip. More...
 
virtual bool canReceiveFocus () const override
 Returns whether the widget can receive focus. More...
 
virtual int tabIndex () const override
 Returns the tab index. More...
 
- Public Member Functions inherited from Wt::WInteractWidget
 WInteractWidget ()
 Create an InteractWidget.
 
EventSignal< WKeyEvent > & keyWentDown ()
 Event signal emitted when a keyboard key is pushed down. More...
 
EventSignal< WKeyEvent > & keyPressed ()
 Event signal emitted when a "character" was entered. More...
 
EventSignal< WKeyEvent > & keyWentUp ()
 Event signal emitted when a keyboard key is released. More...
 
EventSignalenterPressed ()
 Event signal emitted when enter was pressed. More...
 
EventSignalescapePressed ()
 Event signal emitted when escape was pressed. More...
 
EventSignal< WMouseEvent > & clicked ()
 Event signal emitted when the primary mouse button was clicked on this widget. More...
 
EventSignal< WMouseEvent > & doubleClicked ()
 Event signal emitted when the primary mouse button was double clicked on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentDown ()
 Event signal emitted when a mouse button was pushed down on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentUp ()
 Event signal emitted when a mouse button was released on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentOut ()
 Event signal emitted when the mouse went out of this widget. More...
 
EventSignal< WMouseEvent > & mouseWentOver ()
 Event signal emitted when the mouse entered this widget. More...
 
EventSignal< WMouseEvent > & mouseMoved ()
 Event signal emitted when the mouse moved over this widget. More...
 
EventSignal< WMouseEvent > & mouseDragged ()
 Event signal emitted when the mouse is dragged over this widget. More...
 
EventSignal< WMouseEvent > & mouseWheel ()
 Event signal emitted when the mouse scroll wheel was used. More...
 
EventSignal< WTouchEvent > & touchStarted ()
 Event signal emitted when a finger is placed on the screen. More...
 
EventSignal< WTouchEvent > & touchEnded ()
 Event signal emitted when a finger is removed from the screen. More...
 
EventSignal< WTouchEvent > & touchMoved ()
 Event signal emitted when a finger, which is already placed on the screen, is moved across the screen. More...
 
EventSignal< WGestureEvent > & gestureStarted ()
 Event signal emitted when a gesture is started. More...
 
EventSignal< WGestureEvent > & gestureChanged ()
 Event signal emitted when a gesture is changed. More...
 
EventSignal< WGestureEvent > & gestureEnded ()
 Event signal emitted when a gesture is ended. More...
 
void setDraggable (const std::string &mimeType, WWidget *dragWidget=nullptr, bool isDragWidgetOnly=false, WObject *sourceWidget=nullptr)
 Configure dragging for drag and drop. More...
 
void unsetDraggable ()
 Disable drag & drop for this widget. More...
 
void setMouseOverDelay (int delay)
 Sets a delay for the mouse over event. More...
 
int mouseOverDelay () const
 Returns the mouse over signal delay. More...
 
virtual void setPopup (bool popup) override
 Lets the widget overlay over other sibling widgets. More...
 
virtual void load () override
 Loads content just before the widget is used. More...
 
virtual bool isEnabled () const override
 Returns whether the widget is enabled. More...
 
- Public Member Functions inherited from Wt::WWebWidget
 WWebWidget ()
 Construct a WebWidget.
 
virtual std::vector< WWidget * > children () const override
 Returns child widgets. More...
 
SignalchildrenChanged ()
 Signal emitted when children have been added or removed. More...
 
virtual void setPositionScheme (PositionScheme scheme) override
 Sets the CSS position scheme. More...
 
virtual PositionScheme positionScheme () const override
 Returns the CSS position scheme. More...
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
 Sets CSS offsets for a non-statically positioned widget. More...
 
virtual WLength offset (Side s) const override
 Returns a CSS offset. More...
 
virtual void resize (const WLength &width, const WLength &height) override
 Resizes the widget. More...
 
virtual WLength width () const override
 Returns the width. More...
 
virtual WLength height () const override
 Returns the height. More...
 
virtual void setMinimumSize (const WLength &width, const WLength &height) override
 Sets a minimum size. More...
 
virtual WLength minimumWidth () const override
 Returns the minimum width. More...
 
virtual WLength minimumHeight () const override
 Returns the minimum height. More...
 
virtual void setMaximumSize (const WLength &width, const WLength &height) override
 Sets a maximum size. More...
 
virtual WLength maximumWidth () const override
 Returns the maximum width. More...
 
virtual WLength maximumHeight () const override
 Returns the maximum height. More...
 
virtual void setLineHeight (const WLength &height) override
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const override
 Returns the CSS line height for contained text. More...
 
virtual void setFloatSide (Side s) override
 Specifies a CSS float side. More...
 
virtual Side floatSide () const override
 Returns the CSS float side. More...
 
virtual void setClearSides (WFlags< Side > sides) override
 Sets the sides that should be cleared of floats. More...
 
virtual WFlags< SideclearSides () const override
 Returns the sides that should remain empty. More...
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
 Sets CSS margins around the widget. More...
 
virtual WLength margin (Side side) const override
 Returns a CSS margin set. More...
 
virtual void setHiddenKeepsGeometry (bool enabled) override
 Sets whether the widget keeps its geometry when hidden. More...
 
virtual bool hiddenKeepsGeometry () const override
 Returns whether the widget keeps its geometry when hidden. More...
 
virtual bool isHidden () const override
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const override
 Returns whether the widget is visible. More...
 
virtual void setDisabled (bool disabled) override
 Sets whether the widget is disabled. More...
 
virtual bool isDisabled () const override
 Returns whether the widget is set disabled. More...
 
virtual bool isPopup () const override
 Returns whether the widget is overlayed. More...
 
virtual void setInline (bool isInline) override
 Sets whether the widget is displayed inline or as a block. More...
 
virtual bool isInline () const override
 Returns whether the widget is displayed inline or as block. More...
 
virtual void setDecorationStyle (const WCssDecorationStyle &style) override
 Sets a CSS decoration style. More...
 
virtual WCssDecorationStyledecorationStyle () override
 Returns the decoration style of this widget. More...
 
virtual void setStyleClass (const WString &styleClass) override
 Sets (one or more) CSS style classes. More...
 
virtual WString styleClass () const override
 Returns the CSS style class. More...
 
virtual void addStyleClass (const WString &styleClass, bool force=false) override
 Adds a CSS style class. More...
 
virtual void removeStyleClass (const WString &styleClass, bool force=false) override
 Removes a CSS style class. More...
 
virtual bool hasStyleClass (const WString &styleClass) const override
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength()) override
 Sets the vertical alignment. More...
 
virtual AlignmentFlag verticalAlignment () const override
 Returns the vertical alignment. More...
 
virtual WLength verticalAlignmentLength () const override
 Returns the fixed vertical alignment that was set. More...
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
 Enable deferred tooltip. More...
 
virtual WString toolTip () const override
 Returns the tooltip.
 
virtual void setAttributeValue (const std::string &name, const WString &value) override
 Sets an attribute value. More...
 
virtual WString attributeValue (const std::string &name) const override
 Returns an attribute value. More...
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value) override
 Sets a JavaScript member. More...
 
virtual std::string javaScriptMember (const std::string &name) const override
 Returns the value of a JavaScript member. More...
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args) override
 Calls a JavaScript member. More...
 
virtual bool loaded () const override
 Returns whether this widget has been loaded. More...
 
virtual void setId (const std::string &id) override
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name) override
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &id) override
 Finds a descendent widget by id.
 
virtual void setSelectable (bool selectable) override
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &javascript) override
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual const std::string id () const override
 Returns the (unique) identifier for this object. More...
 
void setLoadLaterWhenInvisible (bool)
 Change the way the widget is loaded when invisible. More...
 
std::string htmlTagName () const
 returns the current html tag name More...
 
void setHtmlTagName (const std::string &tag)
 set the custom HTML tag name More...
 
virtual void setCanReceiveFocus (bool enabled) override
 Sets whether the widget can receive focus. More...
 
virtual bool setFirstFocus () override
 Set focus on the widget's first descendant. More...
 
virtual void setFocus (bool focus) override
 Sets focus. More...
 
virtual bool hasFocus () const override
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index) override
 Sets the tab index. More...
 
EventSignalblurred ()
 Signal emitted when the widget lost focus. More...
 
EventSignalfocussed ()
 Signal emitted when the widget recieved focus. More...
 
virtual bool scrollVisibilityEnabled () const final override
 Returns whether scroll visibility detection is enabled for this widget. More...
 
virtual void setScrollVisibilityEnabled (bool enabled) final override
 Sets whether scroll visibility detection is enabled for this widget. More...
 
virtual int scrollVisibilityMargin () const final override
 Returns the margin around the viewport within which the widget is considered visible. More...
 
virtual void setScrollVisibilityMargin (int margin) final override
 Sets the margin around the viewport within which the widget is considered visible. More...
 
virtual Signal< bool > & scrollVisibilityChanged () final override
 Signal triggered when the scroll visibility of this widget changes. More...
 
virtual bool isScrollVisible () const final override
 Returns whether this widget is currently considered scroll visible. More...
 
virtual void setThemeStyleEnabled (bool enabled) final override
 Sets whether theme styling for a widget is enabled or disabled. More...
 
virtual bool isThemeStyleEnabled () const final override
 Returns whether this widget is currently styled by the chosen theme. More...
 
virtual void setObjectName (const std::string &name) override
 Sets an object name. More...
 
void setFocus ()
 Sets focus. More...
 
virtual void setFocus (bool focus)=0
 Sets focus. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget.
 
virtual std::unique_ptr< WWidgetremoveWidget (WWidget *widget)
 Removes a child widget.
 
template<typename Widget >
std::unique_ptr< Widget > removeWidget (Widget *widget)
 Removes a child widget. More...
 
std::unique_ptr< WWidgetremoveFromParent ()
 Removes the widget from its parent. More...
 
void setWidth (const WLength &width)
 Sets the width. More...
 
void setHeight (const WLength &height)
 Sets the height. More...
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical)
 Positions a widget next to another widget. More...
 
virtual void toggleStyleClass (const WString &styleClass, bool add, bool force=false)
 Toggles a CSS style class.
 
std::string jsRef () const
 Returns a JavaScript expression to the corresponding DOM node. More...
 
void setFocus ()
 Sets focus. More...
 
virtual void acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
 Sets a mime type to be accepted for dropping. More...
 
virtual void stopAcceptDrops (const std::string &mimeType)
 Indicates that a mime type is no longer accepted for dropping. More...
 
virtual void htmlText (std::ostream &out)
 Streams the (X)HTML representation. More...
 
bool isRendered () const
 Returns whether the widget is rendered. More...
 
void hide ()
 Hides the widget. More...
 
void animateHide (const WAnimation &animation)
 Hides the widget using an animation. More...
 
void show ()
 Shows the widget. More...
 
void animateShow (const WAnimation &animation)
 Shows the widget using an animation. More...
 
void enable ()
 Enables the widget. More...
 
void disable ()
 Disable thes widget. More...
 
bool layoutSizeAware () const
 Returns whether the widget is layout size aware. More...
 
- Public Member Functions inherited from Wt::WObject
void addChild (std::unique_ptr< WObject > child)
 Add a child WObject whose lifetime is determined by this WObject.
 
template<typename Child >
Child * addChild (std::unique_ptr< Child > child)
 Add a child WObject, returning a raw pointer. More...
 
std::unique_ptr< WObjectremoveChild (WObject *child)
 Remove a child WObject, so its lifetime is no longer determined by this WObject.
 
template<typename Child >
std::unique_ptr< Child > removeChild (Child *child)
 Remove a child WObject, so its lifetime is no longer determined by this WObject. More...
 
virtual std::string objectName () const
 Returns the object name. More...
 
void resetLearnedSlots ()
 Resets learned stateless slot implementations. More...
 
template<class T >
void resetLearnedSlot (void(T::*method)())
 Resets a learned stateless slot implementation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)())
 Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 Declares a slot to be stateless and learn client-side behaviour in advance. More...
 
void isNotStateless ()
 Marks the current function as not stateless. More...
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method. More...
 
- Public Member Functions inherited from Wt::Core::observable
 observable () noexcept
 Default constructor.
 
virtual ~observable ()
 Destructor. More...
 
template<typename... Args, typename C >
auto bindSafe (void(C::*method)(Args...)) noexcept
 Protects a method call against object destruction. More...
 
template<typename... Args, typename C >
auto bindSafe (void(C::*method)(Args...) const) const noexcept
 Protects a const method call against object destruction. More...
 
template<typename Function >
auto bindSafe (const Function &function) noexcept
 Protects a function against object destruction. More...
 

Additional Inherited Members

- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 
- Static Public Member Functions inherited from Wt::WWebWidget
static std::string jsStringLiteral (const std::string &v, char delimiter='\'')
 Turn a CharEncoding::UTF8 encoded string into a JavaScript string literal. More...
 
- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 Short hand for WString::tr() More...
 
- Protected Member Functions inherited from Wt::WAbstractSpinBox
 WAbstractSpinBox ()
 Constructor.
 
virtual void render (WFlags< RenderFlag > flags) override
 Renders the widget. More...
 
virtual int boxPadding (Orientation orientation) const override
 Returns the widget's built-in padding. More...
 
- Protected Member Functions inherited from Wt::WLineEdit
virtual int boxBorder (Orientation orientation) const override
 Returns the widget's built-in border width. More...
 
- Protected Member Functions inherited from Wt::WFormWidget
virtual void enableAjax () override
 Progresses to an Ajax-enabled widget. More...
 
virtual void propagateSetEnabled (bool enabled) override
 Propagates that a widget was enabled or disabled through children. More...
 
- Protected Member Functions inherited from Wt::WWebWidget
virtual WStatelessSlot * getStateless (Method method) override
 On-demand stateless slot implementation. More...
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 Sets the widget to be aware of its size set by a layout manager. More...
 
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change. More...
 
 WWidget ()
 Creates a widget.
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. More...
 
void scheduleRender (WFlags< RepaintFlag > flags=None)
 Schedules rerendering of the widget. More...
 

Detailed Description

An input control for integer numbers.

The spin box provides a control for entering an integer number. It consists of a line edit, and buttons which allow to increase or decrease the value. If you rather need input of a fractional number, use WDoubleSpinBox instead.

WSpinBox is an inline widget.

See also
WDoubleSpinBox
Note
A spinbox configures a validator for validating the input. Therefore you cannot set a validator yourself.

Constructor & Destructor Documentation

◆ WSpinBox()

Wt::WSpinBox::WSpinBox ( )

Creates a spin-box.

The range is (0 - 99) and the step size 1.

The initial value is 0.

Member Function Documentation

◆ maximum()

int Wt::WSpinBox::maximum ( ) const

Returns the maximum value.

See also
setMaximum()

◆ minimum()

int Wt::WSpinBox::minimum ( ) const

Returns the minimum value.

See also
setMinimum()

◆ setMaximum()

void Wt::WSpinBox::setMaximum ( int  maximum)

Sets the maximum value.

The default value is 99.

◆ setMinimum()

void Wt::WSpinBox::setMinimum ( int  minimum)

Sets the minimum value.

The default value is 0.

◆ setRange()

void Wt::WSpinBox::setRange ( int  minimum,
int  maximum 
)

Sets the range.

See also
setMinimum(), setMaximum()

◆ setSingleStep()

void Wt::WSpinBox::setSingleStep ( int  step)

Sets the step value.

The default value is 1.

◆ setValue()

void Wt::WSpinBox::setValue ( int  value)

Sets the value.

value must be a value between minimum() and maximum().

The default value is 0

◆ setWrapAroundEnabled()

void Wt::WSpinBox::setWrapAroundEnabled ( bool  enabled)

Sets if this spinbox wraps around to stay in the valid range.

Note
Not supported by the native controls.

◆ value()

int Wt::WSpinBox::value ( ) const

Returns the value.

Note
This value may not correctly reflect the valueText() of the spin box if valueText() is empty or if the contents are not in a valid state.

◆ valueChanged()

Signal<int>& Wt::WSpinBox::valueChanged ( )

A signal that indicates when the value has changed.

This signal is emitted when changed() is emitted, but supplies the new value as an argument. The changed() signal is emitted when the user changes the value of the spinbox by pressing the up/down arrow, or entering a different value and pressing enter or moving focus.

See also
changed()

◆ wrapAroundEnabled()

bool Wt::WSpinBox::wrapAroundEnabled ( ) const

Returns if the spinbox wraps around.

See also
setWrapAroundEnabled()