1. Epic GamesDeveloper
  3. USpinBox

USpinBox

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

API > API/Runtime > API/Runtime/UMG

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

   
Name USpinBox
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/SpinBox.h
Include Path #include "Components/SpinBox.h"

Syntax

UCLASS (MinimalAPI)  
class USpinBox : public UWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

USpinBox ( const FObjectInitializer& ObjectInitializer
)

   Components/SpinBox.h  

Classes

Name Remarks
FOnSpinBoxBeginSliderMovement  
FOnSpinBoxValueChangedEvent  
FOnSpinBoxValueCommittedEvent  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAlwaysUsesDeltaSnap bool Whether this spin box should use the delta snapping logic for typed values - default false Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter=GetAlwaysUsesDeltaSnap
  • Setter=SetAlwaysUsesDeltaSnap
  • BlueprintSetter=SetAlwaysUsesDeltaSnap
  • BlueprintGetter=GetAlwaysUsesDeltaSnap
  • Category="Slider"
bEnableSlider bool Whether this spin box should have slider feature enabled Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetEnableSlider"
  • Setter="SetEnableSlider"
  • Category="Slider"
ClearKeyboardFocusOnCommit bool Whether to remove the keyboard focus from the spin box when the value is committed Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Input"
  • AdvancedDisplay
Delta float The amount by which to change the spin box value as the slider moves. Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetDelta
  • BlueprintGetter=GetDelta
  • Category="Slider"
Font FSlateFontInfo Font color and opacity (overrides style) Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Display"
ForegroundColor FSlateColor   Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetForegroundColor"
  • Category="Style"
Justification TEnumAsByte< ETextJustify::Type > The justification the value text should appear as. Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Display"
KeyboardType TEnumAsByte< EVirtualKeyboardType::Type > If we're on a platform that requires a virtual keyboard, what kind of keyboard should this widget use? Components/SpinBox.h
  • EditAnywhere
  • Category="Input"
  • AdvancedDisplay
MaxFractionalDigits int32 The maximum required fractional digits - default 6 Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetMaxFractionalDigits
  • BlueprintGetter=GetMaxFractionalDigits
  • Category="Slider"
  • Meta=(ClampMin=0, UIMin=0)
MinDesiredWidth float The minimum width of the spin box Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Display"
  • AdvancedDisplay
  • DisplayName="Minimum Desired Width"
MinFractionalDigits int32 The minimum required fractional digits - default 1 Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter=SetMinFractionalDigits
  • BlueprintGetter=GetMinFractionalDigits
  • Category="Slider"
  • Meta=(ClampMin=0, UIMin=0)
OnBeginSliderMovement FOnSpinBoxBeginSliderMovement Called right before the slider begins to move Components/SpinBox.h
  • BlueprintAssignable
  • Category="SpinBox|Events"
OnEndSliderMovement FOnSpinBoxValueChangedEvent Called right after the slider handle is released by the user Components/SpinBox.h
  • BlueprintAssignable
  • Category="SpinBox|Events"
OnValueChanged FOnSpinBoxValueChangedEvent Called when the value is changed interactively by the user Components/SpinBox.h
  • BlueprintAssignable
  • Category="SpinBox|Events"
OnValueCommitted FOnSpinBoxValueCommittedEvent Called when the value is committed. Occurs when the user presses Enter or the text box loses focus. Components/SpinBox.h
  • BlueprintAssignable
  • Category="SpinBox|Events"
SelectAllTextOnCommit bool Whether to select the text in the spin box when the value is committed Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Input"
  • AdvancedDisplay
SliderExponent float The exponent by which to increase the delta as the mouse moves. Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Slider"
Value float Value stored in this spin box Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetValue"
  • BlueprintGetter="GetValue"
  • FieldNotify
  • Category=Content
ValueDelegate FGetFloat A bindable delegate to allow logic to drive the value of the widget Components/SpinBox.h  
WidgetStyle FSpinBoxStyle The Style Components/SpinBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Style"
  • Meta=(DisplayName="Style")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearMaxSliderValue()

 Clear the maximum value that can be specified using the slider. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

void ClearMaxValue()

 Clear the maximum value that can be manually set in the spin box. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

void ClearMinSliderValue()

 Clear the minimum value that can be specified using the slider. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

void ClearMinValue()

 Clear the minimum value that can be manually set in the spin box. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

bool GetAlwaysUsesDeltaSnap()

 Get whether the spin box uses delta snap on type. Components/SpinBox.h
  • BlueprintCallable
  • BlueprintGetter
  • Category="Behavior"

bool GetClearKeyboardFocusOnCommit()

 Get whether the keyboard focus is removed from the spin box when the value is committed. Components/SpinBox.h  

float GetDelta()

 Get the current delta for the spin box. Components/SpinBox.h
  • BlueprintCallable
  • BlueprintGetter
  • Category="Behavior"

bool GetEnableSlider()

 Get whether the spin box uses the slider feature. Components/SpinBox.h  

const FSlateFontInfo & GetFont()

 Get the font color and opacity that overrides the style font. Components/SpinBox.h  

FSlateColor GetForegroundColor()

 Get the foreground color of the spin box. Components/SpinBox.h  

const ETextJustify::Type GetJustification()

 Get the justification for value text. Components/SpinBox.h  

int32 GetMaxFractionalDigits()

 Get the current Max Fractional Digits for the spin box. Components/SpinBox.h
  • BlueprintCallable
  • BlueprintGetter
  • Category="Behavior"

float GetMaxSliderValue()

 Get the current maximum value that can be specified using the slider. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

float GetMaxValue()

 Get the current maximum value that can be manually set in the spin box. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

float GetMinDesiredWidth()

 Get the minimum width of the spin box. Components/SpinBox.h  

int32 GetMinFractionalDigits()

 Get the current Min Fractional Digits for the spin box. Components/SpinBox.h
  • BlueprintCallable
  • BlueprintGetter
  • Category="Behavior"

float GetMinSliderValue()

 Get the current minimum value that can be specified using the slider. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

float GetMinValue()

 Get the current minimum value that can be manually set in the spin box. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

bool GetSelectAllTextOnCommit()

 Get whether to select the text in the spin box when the value is committed. Components/SpinBox.h  

float GetSliderExponent()

 Get the current slider exponent for the spin box. Components/SpinBox.h  

float GetValue()

 Get the current value of the spin box. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

const FSpinBoxStyle & GetWidgetStyle()

 Set the style for the spin box. Components/SpinBox.h  

void SetAlwaysUsesDeltaSnap ( bool bNewValue
)

 Set whether the spin box uses delta snap on type. Components/SpinBox.h
  • BlueprintCallable
  • BlueprintSetter
  • Category="Behavior"

void SetClearKeyboardFocusOnCommit ( bool bNewValue
)

 Set whether the keyboard focus is removed from the spin box when the value is committed. Components/SpinBox.h  

void SetDelta ( float NewValue
)

 Set the delta for the spin box. Components/SpinBox.h
  • BlueprintCallable
  • BlueprintSetter
  • Category="Behavior"

void SetEnableSlider ( bool bNewValue
)

 Set whether the spin box uses the slider feature. Components/SpinBox.h  

void SetFont ( const FSlateFontInfo& InFont
)

 Set the font color and opacity that overrides the style font. Components/SpinBox.h  

void SetForegroundColor ( FSlateColor InForegroundColor
)

   Components/SpinBox.h
  • BlueprintCallable
  • Category="Appearance"

void SetJustification ( ETextJustify::Type InJustification
)

 Set the justification for value text. Components/SpinBox.h  

void SetMaxFractionalDigits ( int32 NewValue
)

 Set the Max Fractional Digits for the spin box. Components/SpinBox.h
  • BlueprintCallable
  • BlueprintSetter
  • Category="Behavior"

void SetMaxSliderValue ( float NewValue
)

 Set the maximum value that can be specified using the slider. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

void SetMaxValue ( float NewValue
)

 Set the maximum value that can be manually set in the spin box. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

void SetMinDesiredWidth ( float NewValue
)

 Set the minimum width of the spin box. Components/SpinBox.h  

void SetMinFractionalDigits ( int32 NewValue
)

 Set the Min Fractional Digits for the spin box. Components/SpinBox.h
  • BlueprintCallable
  • BlueprintSetter
  • Category="Behavior"

void SetMinSliderValue ( float NewValue
)

 Set the minimum value that can be specified using the slider. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

void SetMinValue ( float NewValue
)

 Set the minimum value that can be manually set in the spin box. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

void SetSelectAllTextOnCommit ( bool bNewValue
)

 Set whether to select the text in the spin box when the value is committed. Components/SpinBox.h  

void SetSliderExponent ( float NewValue
)

 Set the slider exponent for the spin box. Components/SpinBox.h  

void SetValue ( float NewValue
)

 Set the value of the spin box. Components/SpinBox.h
  • BlueprintCallable
  • Category="Behavior"

void SetWidgetStyle ( const FSpinBoxStyle& InWidgetStyle
)

 Get the style for the spin box. Components/SpinBox.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/SpinBox.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/SpinBox.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/SpinBox.h  

Protected

Name Remarks Include Path Unreal Specifiers

void HandleOnBeginSliderMovement()

   Components/SpinBox.h  

void HandleOnEndSliderMovement ( float InValue
)

   Components/SpinBox.h  

void HandleOnValueChanged ( float InValue
)

   Components/SpinBox.h  

void HandleOnValueCommitted ( float InValue,
ETextCommit::Type CommitMethod
)

   Components/SpinBox.h  

float K2_Gate_Value()

   Components/SpinBox.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page