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 > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/SpinBox.h
Include #include "Components/SpinBox.h"

Syntax

UCLASS (MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter bool bAlwaysUsesDeltaSnap Whether this spin box should use the delta snapping logic for typed values - default false
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bEnableSlider Whether this spin box should have slider feature enabled
Protected variable UProperty Category, EditAnywhere, Meta uint32: 1 bOverride_MaxSliderValue Whether the optional MaxSliderValue attribute of the widget is set
Protected variable UProperty Category, EditAnywhere, Meta uint32: 1 bOverride_MaxValue Whether the optional MaxValue attribute of the widget is set
Protected variable UProperty Category, EditAnywhere, Meta uint32: 1 bOverride_MinSliderValue Whether the optional MinSliderValue attribute of the widget is set
Protected variable UProperty Category, EditAnywhere, Meta uint32: 1 bOverride_MinValue Whether the optional MinValue attribute of the widget is set
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool ClearKeyboardFocusOnCommit Whether to remove the keyboard focus from the spin box when the value is committed
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter float Delta The amount by which to change the spin box value as the slider moves.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter FSlateFontInfo Font Font color and opacity (overrides style)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FSlateColor ForegroundColor  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter TEnumAsByte< ETextJustify::Type > Justification The justification the value text should appear as.
Protected variable float K2_Cache_Value  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay TEnumAsByte< EVirtualKeyboardType::Type > KeyboardType If we're on a platform that requires a virtual keyboard, what kind of keyboard should this widget use?
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter int32 MaxFractionalDigits The maximum required fractional digits - default 6
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, displayname, getter, setter float MaxSliderValue The maximum allowable value that can be specified using the slider
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, displayname, getter, setter float MaxValue The maximum allowable value that can be manually entered into the spin box
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite displayname, getter, setter float MinDesiredWidth The minimum width of the spin box
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, getter, setter int32 MinFractionalDigits The minimum required fractional digits - default 1
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, displayname, getter, setter float MinSliderValue The minimum allowable value that can be specified using the slider
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintgetter, blueprintsetter, displayname, getter, setter float MinValue The minimum allowable value that can be manually entered into the spin box
Protected variable TSharedPtr< SSpinBox< float > > MySpinBox  
Public variable UProperty Category BlueprintAssignable FOnSpinBoxBeginSliderMovement OnBeginSliderMovement Called right before the slider begins to move
Public variable UProperty Category BlueprintAssignable FOnSpinBoxValueChangedEvent OnEndSliderMovement Called right after the slider handle is released by the user
Public variable UProperty Category BlueprintAssignable FOnSpinBoxValueChangedEvent OnValueChanged Called when the value is changed interactively by the user
Public variable UProperty Category BlueprintAssignable FOnSpinBoxValueCommittedEvent OnValueCommitted Called when the value is committed. Occurs when the user presses Enter or the text box loses focus.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite getter, setter bool SelectAllTextOnCommit Whether to select the text in the spin box when the value is committed
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter float SliderExponent The exponent by which to increase the delta as the mouse moves.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintgetter, blueprintsetter, fieldnotify, getter, setter float Value Value stored in this spin box
Public variable UProperty FGetFloat ValueDelegate A bindable delegate to allow logic to drive the value of the widget
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FSpinBoxStyle WidgetStyle The Style

Constructors

  Type Name Description
Public function  

USpinBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Clear the maximum value that can be specified using the slider.
Public function UFunction BlueprintCallable, Category void Clear the maximum value that can be manually set in the spin box.
Public function UFunction BlueprintCallable, Category void Clear the minimum value that can be specified using the slider.
Public function UFunction BlueprintCallable, Category void Clear the minimum value that can be manually set in the spin box.
Public function Const UFunction BlueprintCallable, Category blueprintgetter bool Get whether the spin box uses delta snap on type.
Public function Const bool Get whether the keyboard focus is removed from the spin box when the value is committed.
Public function Const UFunction BlueprintCallable, Category blueprintgetter float Get the current delta for the spin box.
Public function Const bool Get whether the spin box uses the slider feature.
Public function Const const FSlateFontInfo &

GetFont ()

 Get the font color and opacity that overrides the style font.
Public function Const FSlateColor Get the foreground color of the spin box.
Public function Const const ETextJustify::Type Get the justification for value text.
Public function Const UFunction BlueprintCallable, Category blueprintgetter int32 Get the current Max Fractional Digits for the spin box.
Public function Const UFunction BlueprintCallable, Category float Get the current maximum value that can be specified using the slider.
Public function Const UFunction BlueprintCallable, Category float Get the current maximum value that can be manually set in the spin box.
Public function Const float Get the minimum width of the spin box.
Public function Const UFunction BlueprintCallable, Category blueprintgetter int32 Get the current Min Fractional Digits for the spin box.
Public function Const UFunction BlueprintCallable, Category float Get the current minimum value that can be specified using the slider.
Public function Const UFunction BlueprintCallable, Category float Get the current minimum value that can be manually set in the spin box.
Public function Const bool Get whether to select the text in the spin box when the value is committed.
Public function Const float Get the current slider exponent for the spin box.
Public function Const UFunction BlueprintCallable, Category float Get the current value of the spin box.
Public function Const const FSpinBoxStyle & Set the style for the spin box.
Protected function void  
Protected function void

HandleOnEndSliderMovement ( float InValue
)

  
Protected function void

HandleOnValueChanged ( float InValue
)

  
Protected function void

HandleOnValueCommitted ( float InValue,
ETextCommit::Type CommitMethod
)

  
Protected function float  
Public function UFunction BlueprintCallable, Category blueprintsetter void

SetAlwaysUsesDeltaSnap ( bool bNewValue
)

 Set whether the spin box uses delta snap on type.
Public function void

SetClearKeyboardFocusOnCommit ( bool bNewValue
)

 Set whether the keyboard focus is removed from the spin box when the value is committed.
Public function UFunction BlueprintCallable, Category blueprintsetter void

SetDelta ( float NewValue
)

 Set the delta for the spin box.
Public function void

SetEnableSlider ( bool bNewValue
)

 Set whether the spin box uses the slider feature.
Public function void

SetFont ( const FSlateFontInfo& InFont
)

 Set the font color and opacity that overrides the style font.
Public function UFunction BlueprintCallable, Category void

SetForegroundColor ( FSlateColor InForegroundColor
)

  
Public function void

SetJustification ( ETextJustify::Type InJustification
)

 Set the justification for value text.
Public function UFunction BlueprintCallable, Category blueprintsetter void

SetMaxFractionalDigits ( int32 NewValue
)

 Set the Max Fractional Digits for the spin box.
Public function UFunction BlueprintCallable, Category void

SetMaxSliderValue ( float NewValue
)

 Set the maximum value that can be specified using the slider.
Public function UFunction BlueprintCallable, Category void

SetMaxValue ( float NewValue
)

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

SetMinDesiredWidth ( float NewValue
)

 Set the minimum width of the spin box.
Public function UFunction BlueprintCallable, Category blueprintsetter void

SetMinFractionalDigits ( int32 NewValue
)

 Set the Min Fractional Digits for the spin box.
Public function UFunction BlueprintCallable, Category void

SetMinSliderValue ( float NewValue
)

 Set the minimum value that can be specified using the slider.
Public function UFunction BlueprintCallable, Category void

SetMinValue ( float NewValue
)

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

SetSelectAllTextOnCommit ( bool bNewValue
)

 Set whether to select the text in the spin box when the value is committed.
Public function void

SetSliderExponent ( float NewValue
)

 Set the slider exponent for the spin box.
Public function UFunction BlueprintCallable, Category void

SetValue ( float NewValue
)

 Set the value of the spin box.
Public function void

SetWidgetStyle ( const FSpinBoxStyle& InWidgetStyle
)

 Get the style for the spin box.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FOnSpinBoxBeginSliderMovement    
Public class FOnSpinBoxValueChangedEvent    
Public class FOnSpinBoxValueCommittedEvent    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page