Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Input > SSpinBox

Light Theme

Dark Theme

SSpinBox

A Slate SpinBox resembles traditional spin boxes in that it is a widget that provides keyboard-based and mouse-based manipulation of a numeric value.

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SSpinBox

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Input/SSpinBox.h
Include	#include "Widgets/Input/SSpinBox.h"

Syntax

template<typename NumericType>
class SSpinBox : public SCompoundWidget

Remarks

A Slate SpinBox resembles traditional spin boxes in that it is a widget that provides keyboard-based and mouse-based manipulation of a numeric value. Mouse-based manipulation: drag anywhere on the spinbox to change the value. Keyboard-based manipulation: click on the spinbox to enter text mode.

Constructors

	Name	Description
	SSpinBox()

Functions

	Name	Description
void	ApplySliderMaxValueChanged ( float SliderDeltaToAdd, bool UpdateOnlyIfHigher )
void	ApplySliderMinValueChanged ( float SliderDeltaToAdd, bool UpdateOnlyIfLower )
void	CommitValue ( double NewValue, ECommitMethod CommitMethod, ETextCommit::Type OriginalCommitInf... )	Call this method when the user's interaction has changed the value
void	Construct ( const FArguments& InArgs )	Construct the widget
void	EnterTextMode()	Make the spinbox switch to keyboard-based input mode.
void	ExitTextMode()	Make the spinbox switch to mouse-based input mode.
float	Fraction ( double InValue, NumericType InMinValue, NumericType InMaxValue )	Calculates range fraction. Possible to use on full numeric range
bool	GetAlwaysUsesDeltaSnap()	See the AlwaysUsesDeltaSnap attribute
NumericType	GetDelta()	See the Delta attribute
int32	GetMaxFractionalDigits()	See the MaxFractionalDigits attribute
NumericType	GetMaxSliderValue()
NumericType	GetMaxValue()	See the MaxValue attribute
float	GetMinDesiredWidth()	See the MinDesiredWidth attribute
int32	GetMinFractionalDigits()	See the MinFractionalDigits attribute
NumericType	GetMinSliderValue()
NumericType	GetMinValue()	See the MinValue attribute
float	GetSliderExponent()	See the SliderExponent attribute
float	GetValue()	See the Value attribute
FString	GetValueAsString()
FText	GetValueAsText()
TAttribute< ...	GetValueAttribute()	Return the Value attribute
bool	IsInTextMode()
bool	IsMaxSliderValueBound()	See the MaxSliderValue attribute
bool	IsMinSliderValueBound()	See the MinSliderValue attribute
void	NotifyValueCommitted()
void	SetAlwaysUsesDeltaSnap ( bool bNewValue )
void	SetDelta ( NumericType InDelta )
void	SetMaxFractionalDigits ( const TAttribute< TOptional< int32 ... )
void	SetMaxSliderValue ( const TAttribute< TOptional< Numeri... )
void	SetMaxValue ( const TAttribute< TOptional< Numeri... )
void	SetMinDesiredWidth ( const TAttribute< float >& InMinDe... )
void	SetMinFractionalDigits ( const TAttribute< TOptional< int32 ... )
void	SetMinSliderValue ( const TAttribute< TOptional< Numeri... )
void	SetMinValue ( const TAttribute< TOptional< Numeri... )
void	SetSliderExponent ( const TAttribute< float >& InSlide... )
void	SetValue ( const TAttribute< NumericType >& I... )
double	Snap ( double InValue, double InGrid )	Snaps value to a nearest grid multiple. Clamps value if it's outside numeric range
void	TextField_OnTextChanged ( const FText& NewText )	Invoked when the text in the text field changes
void	TextField_OnTextCommitted ( const FText& NewText, ETextCommit::Type CommitInfo )	Invoked when the text field commits its text.

Overridden from SWidget

	Name	Description
bool	HasKeyboardFocus()	Checks to see if this widget currently has the keyboard focus
FCursorReply	OnCursorQuery ( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent )	The system asks each widget under the mouse to provide a cursor. This event is bubbled.
FReply	OnFocusReceived ( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent )	KEY INPUT Called when focus is given to this widget. This event does not bubble.
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was pressed within it.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

	Name	Description
	FArguments

Enums

	Name	Description
	ECommitMethod	How user changed the value in the spinbox

Typedefs

Name	Description
FOnDynamicSliderMinMaxValueChanged	Notification when the max/min spinner values are changed (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)
FOnValueChanged	Notification for numeric value change
FOnValueCommitted	Notification for numeric value committed

Constants

Name	Description
DefaultMaxFractionalDigits	The default maximum fractional digits
DefaultMinFractionalDigits	The default minimum fractional digits

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss