USpinBox

A numerical entry box that allows for direct entry of the number or allows the user to click and slide the number.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Components/SpinBox.h

Include

#include "Components/SpinBox.h"

Syntax

class USpinBox : public UWidget

Remarks

A numerical entry box that allows for direct entry of the number or allows the user to click and slide the number.

Variables

Name Description

Public variable

bool

 

bAlwaysUsesDeltaSnap

Whether this spin box should use the delta snapping logic for typed values - default false

Protected variable

uint32: 1

 

bOverride_MaxSliderValue

Whether the optional MaxSliderValue attribute of the widget is set

Protected variable

uint32: 1

 

bOverride_MaxValue

Whether the optional MaxValue attribute of the widget is set

Protected variable

uint32: 1

 

bOverride_MinSliderValue

Whether the optional MinSliderValue attribute of the widget is set

Protected variable

uint32: 1

 

bOverride_MinValue

Whether the optional MinValue attribute of the widget is set

Public variable

bool

 

ClearKeyboardFocusOnCommit

Whether to remove the keyboard focus from the spin box when the value is committed

Public variable

float

 

Delta

The amount by which to change the spin box value as the slider moves.

Public variable

FSlateFontInfo

 

Font

Font color and opacity (overrides style)

Public variable

FSlateColor

 

ForegroundColor

Public variable

TEnumAsByte< ET...

 

Justification

The justification the value text should appear as.

Protected variable

float

 

K2_Cache_Value

Public variable

int32

 

MaxFractionalDigits

The maximume required fractional digits - default 6

Protected variable

float

 

MaxSliderValue

The maximum allowable value that can be specified using the slider

Protected variable

float

 

MaxValue

The maximum allowable value that can be manually entered into the spin box

Public variable

float

 

MinDesiredWidth

The minimum width of the spin box

Public variable

int32

 

MinFractionalDigits

The minimum required fractional digits - default 1

Protected variable

float

 

MinSliderValue

The minimum allowable value that can be specified using the slider

Protected variable

float

 

MinValue

The minimum allowable value that can be manually entered into the spin box

Protected variable

TSharedPtr< SSp...

 

MySpinBox

Public variable

FOnSpinBoxBegin...

 

OnBeginSliderMovement

Called right before the slider begins to move

Public variable

FOnSpinBoxValue...

 

OnEndSliderMovement

Called right after the slider handle is released by the user

Public variable

FOnSpinBoxValue...

 

OnValueChanged

Called when the value is changed interactively by the user

Public variable

FOnSpinBoxValue...

 

OnValueCommitted

Called when the value is committed. Occurs when the user presses Enter or the text box loses focus.

Public variable

bool

 

SelectAllTextOnCommit

Whether to select the text in the spin box when the value is committed

Public variable

float

 

SliderExponent

The exponent by which to increase the delta as the mouse moves.

Public variable

float

 

Value

Value stored in this spin box

Public variable

FGetFloat

 

ValueDelegate

A bindable delegate to allow logic to drive the value of the widget

Public variable

FSpinBoxStyle

 

WidgetStyle

The Style

Constructors

Name Description

Public function

USpinBox

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

ClearMaxSliderValue()

Clear the maximum value that can be specified using the slider.

Public function

void

 

ClearMaxValue()

Clear the maximum value that can be manually set in the spin box.

Public function

void

 

ClearMinSliderValue()

Clear the minimum value that can be specified using the slider.

Public function

void

 

ClearMinValue()

Clear the minimum value that can be manually set in the spin box.

Public function Const

bool

 

GetAlwaysUsesDeltaSnap()

Get whether the spin box uses delta snap on type.

Public function Const

float

 

GetDelta()

Get the current delta for the spin box.

Public function Const

int32

 

GetMaxFractionalDigits()

Get the current Max Fractional Digits for the spin box.

Public function Const

float

 

GetMaxSliderValue()

Get the current maximum value that can be specified using the slider.

Public function Const

float

 

GetMaxValue()

Get the current maximum value that can be manually set in the spin box.

Public function Const

int32

 

GetMinFractionalDigits()

Get the current Min Fractional Digits for the spin box.

Public function Const

float

 

GetMinSliderValue()

Get the current minimum value that can be specified using the slider.

Public function Const

float

 

GetMinValue()

Get the current minimum value that can be manually set in the spin box.

Public function Const

float

 

GetValue()

Get the current value of the spin box.

Protected function

void

 

HandleOnBeginSliderMovement()

Protected function

void

 

HandleOnEndSliderMovement

(
    float InValue
)

Protected function

void

 

HandleOnValueChanged

(
    float InValue
)

Protected function

void

 

HandleOnValueCommitted

(
    float InValue,
    ETextCommit::Type CommitMethod
)

Protected function

float

 

K2_Gate_Value()

Public function

void

 

SetAlwaysUsesDeltaSnap

(
    bool bNewValue
)

Set whether the spin box uses delta snap on type.

Public function

void

 

SetDelta

(
    float NewValue
)

Set the delta for the spin box.

Public function

void

 

SetForegroundColor

(
    FSlateColor InForegroundColor
)

Public function

void

 

SetMaxFractionalDigits

(
    int32 NewValue
)

Set the Max Fractional Digits for the spin box.

Public function

void

 

SetMaxSliderValue

(
    float NewValue
)

Set the maximum value that can be specified using the slider.

Public function

void

 

SetMaxValue

(
    float NewValue
)

Set the maximum value that can be manually set in the spin box.

Public function

void

 

SetMinFractionalDigits

(
    int32 NewValue
)

Set the Min Fractional Digits for the spin box.

Public function

void

 

SetMinSliderValue

(
    float NewValue
)

Set the minimum value that can be specified using the slider.

Public function

void

 

SetMinValue

(
    float NewValue
)

Set the minimum value that can be manually set in the spin box.

Public function

void

 

SetValue

(
    float NewValue
)

Set the value of the spin box.

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Classes

Deprecated Variables

Name Description

Public variable

TObjectPtr< USl...

 

Style_DEPRECATED