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.

Unreal Engine C++ API Reference > Runtime > UMG > Components

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

  Type Name Description
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
Protected variable float K2_Cache_Value  
Public variable TEnumAsByte< EVirtualKeyboardType::Type > KeyboardType If we're on a platform that requires a virtual keyboard, what kind of keyboard should this widget use?
Protected variable TSharedPtr< SSpinBox< float > > MySpinBox  
Public variable FOnSpinBoxBeginSliderMovement OnBeginSliderMovement Called right before the slider begins to move
Public variable FOnSpinBoxValueChangedEvent OnEndSliderMovement Called right after the slider handle is released by the user
Public variable FOnSpinBoxValueChangedEvent OnValueChanged Called when the value is changed interactively by the user
Public variable FOnSpinBoxValueCommittedEvent OnValueCommitted Called when the value is committed. Occurs when the user presses Enter or the text box loses focus.
Public variable FGetFloat ValueDelegate A bindable delegate to allow logic to drive the value of the widget

Constructors

  Type Name Description
Public function  

USpinBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Clear the maximum value that can be specified using the slider.
Public function void Clear the maximum value that can be manually set in the spin box.
Public function void Clear the minimum value that can be specified using the slider.
Public function void Clear the minimum value that can be manually set in the spin box.
Public function Const 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 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 int32 Get the current Max Fractional Digits for the spin box.
Public function Const float Get the current maximum value that can be specified using the slider.
Public function Const 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 int32 Get the current Min Fractional Digits for the spin box.
Public function Const float Get the current minimum value that can be specified using the slider.
Public function Const 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 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 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 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 void

SetForegroundColor ( FSlateColor InForegroundColor
)

  
Public function void

SetJustification ( ETextJustify::Type InJustification
)

 Set the justification for value text.
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

SetMinDesiredWidth ( float NewValue
)

 Set the minimum width of 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

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 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    

Deprecated Variables

  Type Name Description
Public variable bool bAlwaysUsesDeltaSnap Direct access to bAlwaysUsesDeltaSnap is deprecated. Please use the getter or setter.
Public variable bool bEnableSlider Direct access to bEnableSlider is deprecated. Please use the getter or setter.
Public variable bool ClearKeyboardFocusOnCommit Direct access to ClearKeyboardFocusOnCommit is deprecated. Please use the getter or setter.
Public variable float Delta Direct access to Delta is deprecated. Please use the getter or setter.
Public variable FSlateFontInfo Font Direct access to Font is deprecated. Please use the getter or setter.
Public variable FSlateColor ForegroundColor Direct access to ForegroundColor is deprecated. Please use the getter or setter.
Public variable TEnumAsByte< ETextJustify::Type > Justification Direct access to Justification is deprecated. Please use the getter or setter.
Public variable int32 MaxFractionalDigits Direct access to MaxFractionalDigits is deprecated. Please use the getter or setter.
Protected variable float MaxSliderValue Direct access to MaxSliderValue is deprecated. Please use the getter or setter.
Protected variable float MaxValue Direct access to MaxValue is deprecated. Please use the getter or setter.
Public variable float MinDesiredWidth Direct access to MinDesiredWidth is deprecated. Please use the getter or setter.
Public variable int32 MinFractionalDigits Direct access to MinFractionalDigits is deprecated. Please use the getter or setter.
Protected variable float MinSliderValue Direct access to MinSliderValue is deprecated. Please use the getter or setter.
Protected variable float MinValue Direct access to MinValue is deprecated. Please use the getter or setter.
Public variable bool SelectAllTextOnCommit Direct access to SelectAllTextOnCommit is deprecated. Please use the getter or setter.
Public variable float SliderExponent Direct access to SliderExponent is deprecated. Please use the getter or setter.
Public variable float Value Direct access to Value is deprecated. Please use the getter or setter.
Public variable FSpinBoxStyle WidgetStyle Direct access to WidgetStyle is deprecated. Please use the getter or setter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page