SpinBox.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Fonts/SlateFontInfo.h"
#include "Styling/SlateColor.h"
#include "Styling/SlateTypes.h"
#include "Widgets/SWidget.h"
#include "Widgets/Input/SSpinBox.h"
#include "Components/Widget.h"
#include "SpinBox.generated.h"
 
UCLASS(MinimalAPI)
class USpinBox : public UWidget
{
    GENERATED_UCLASS_BODY()
 
public:
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnSpinBoxValueChangedEvent, float, InValue);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSpinBoxValueCommittedEvent, float, InValue, ETextCommit::Type, CommitMethod);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnSpinBoxBeginSliderMovement);
 
public:
 
    UE_DEPRECATED(5.2, "Direct access to Value is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetValue", BlueprintGetter = "GetValue", FieldNotify, Category = Content)
    float Value;
 
    UPROPERTY()
    FGetFloat ValueDelegate;
 
public:
    UE_DEPRECATED(5.2, "Direct access to WidgetStyle is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Style", meta=( DisplayName="Style" ))
    FSpinBoxStyle WidgetStyle;
 
    UE_DEPRECATED(5.2, "Direct access to MinFractionalDigits is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = SetMinFractionalDigits, BlueprintGetter = GetMinFractionalDigits, Category = "Slider", meta = (ClampMin = 0, UIMin = 0))
    int32 MinFractionalDigits;
 
    UE_DEPRECATED(5.2, "Direct access to MaxFractionalDigits is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = SetMaxFractionalDigits, BlueprintGetter = GetMaxFractionalDigits, Category = "Slider", meta = (ClampMin = 0, UIMin = 0))
    int32 MaxFractionalDigits;
 
    UE_DEPRECATED(5.2, "Direct access to bAlwaysUsesDeltaSnap is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = GetAlwaysUsesDeltaSnap, Setter = SetAlwaysUsesDeltaSnap, BlueprintSetter = SetAlwaysUsesDeltaSnap, BlueprintGetter = GetAlwaysUsesDeltaSnap, Category = "Slider")
    bool bAlwaysUsesDeltaSnap;
 
    UE_DEPRECATED(5.2, "Direct access to bEnableSlider is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "GetEnableSlider", Setter = "SetEnableSlider", Category = "Slider")
    bool bEnableSlider = true;
 
    UE_DEPRECATED(5.2, "Direct access to Delta is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = SetDelta, BlueprintGetter = GetDelta, Category = "Slider")
    float Delta;
 
    UE_DEPRECATED(5.2, "Direct access to SliderExponent is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Slider")
    float SliderExponent;
    
    UE_DEPRECATED(5.2, "Direct access to Font is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Display")
    FSlateFontInfo Font;
 
    UE_DEPRECATED(5.2, "Direct access to Justification is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = "Display")
    TEnumAsByte<ETextJustify::Type> Justification;
 
    UE_DEPRECATED(5.2, "Direct access to MinDesiredWidth is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Display", AdvancedDisplay, DisplayName = "Minimum Desired Width")
    float MinDesiredWidth;
    
    UPROPERTY(EditAnywhere, Category = "Input", AdvancedDisplay)
    TEnumAsByte<EVirtualKeyboardType::Type> KeyboardType;
 
    UE_DEPRECATED(5.2, "Direct access to ClearKeyboardFocusOnCommit is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Input", AdvancedDisplay)
    bool ClearKeyboardFocusOnCommit;
 
    UE_DEPRECATED(5.2, "Direct access to SelectAllTextOnCommit is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Input", AdvancedDisplay)
    bool SelectAllTextOnCommit;
 
    UE_DEPRECATED(5.2, "Direct access to ForegroundColor is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetForegroundColor", Category = "Style")
    FSlateColor ForegroundColor;
 
public:
    UPROPERTY(BlueprintAssignable, Category="SpinBox|Events")
    FOnSpinBoxValueChangedEvent OnValueChanged;
 
    UPROPERTY(BlueprintAssignable, Category="SpinBox|Events")
    FOnSpinBoxValueCommittedEvent OnValueCommitted;
 
    UPROPERTY(BlueprintAssignable, Category="SpinBox|Events")
    FOnSpinBoxBeginSliderMovement OnBeginSliderMovement;
 
    UPROPERTY(BlueprintAssignable, Category="SpinBox|Events")
    FOnSpinBoxValueChangedEvent OnEndSliderMovement;
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    UMG_API float GetValue() const;
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    UMG_API void SetValue(float NewValue);
 
public:
 
    UMG_API const FSpinBoxStyle& GetWidgetStyle() const;
 
    UMG_API void SetWidgetStyle(const FSpinBoxStyle& InWidgetStyle);
 
    UFUNCTION(BlueprintCallable, BlueprintGetter, Category = "Behavior")
    UMG_API int32 GetMinFractionalDigits() const;
 
    UFUNCTION(BlueprintCallable, BlueprintSetter, Category = "Behavior")
    UMG_API void SetMinFractionalDigits(int32 NewValue);
 
    UFUNCTION(BlueprintCallable, BlueprintGetter, Category = "Behavior")
    UMG_API int32 GetMaxFractionalDigits() const;
 
    UFUNCTION(BlueprintCallable, BlueprintSetter, Category = "Behavior")
    UMG_API void SetMaxFractionalDigits(int32 NewValue);
 
    UFUNCTION(BlueprintCallable, BlueprintGetter, Category = "Behavior")
    UMG_API bool GetAlwaysUsesDeltaSnap() const;
 
    UFUNCTION(BlueprintCallable, BlueprintSetter, Category = "Behavior")
    UMG_API void SetAlwaysUsesDeltaSnap(bool bNewValue);
 
    UMG_API bool GetEnableSlider() const;
 
    UMG_API void SetEnableSlider(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, BlueprintGetter, Category = "Behavior")
    UMG_API float GetDelta() const;
 
    UFUNCTION(BlueprintCallable, BlueprintSetter, Category = "Behavior")
    UMG_API void SetDelta(float NewValue);
 
    UMG_API float GetSliderExponent() const;
 
    UMG_API void SetSliderExponent(float NewValue);
 
    UMG_API const FSlateFontInfo& GetFont() const;
 
    UMG_API void SetFont(const FSlateFontInfo& InFont);
 
    UMG_API const ETextJustify::Type GetJustification() const;
 
    UMG_API void SetJustification(ETextJustify::Type InJustification);
 
    UMG_API float GetMinDesiredWidth() const;
 
    UMG_API void SetMinDesiredWidth(float NewValue);
 
    UMG_API bool GetClearKeyboardFocusOnCommit() const;
 
    UMG_API void SetClearKeyboardFocusOnCommit(bool bNewValue);
 
    UMG_API bool GetSelectAllTextOnCommit() const;
 
    UMG_API void SetSelectAllTextOnCommit(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    UMG_API float GetMinValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void SetMinValue(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void ClearMinValue();
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API float GetMaxValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void SetMaxValue(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void ClearMaxValue();
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API float GetMinSliderValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void SetMinSliderValue(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void ClearMinSliderValue();
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API float GetMaxSliderValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void SetMaxSliderValue(float NewValue);
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void ClearMaxSliderValue();
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    UMG_API void SetForegroundColor(FSlateColor InForegroundColor);
 
    UMG_API FSlateColor GetForegroundColor() const;
 
public:
 
    //~ Begin UWidget Interface
    UMG_API virtual void SynchronizeProperties() override;
    //~ End UWidget Interface
 
    //~ Begin UVisual Interface
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
    //~ End UVisual Interface
 
#if WITH_EDITOR
    UMG_API virtual const FText GetPaletteCategory() override;
#endif
    //~ End UWidget Interface
 
protected:
    //~ Begin UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    // End of UWidget
 
    UMG_API void HandleOnValueChanged(float InValue);
    UMG_API void HandleOnValueCommitted(float InValue, ETextCommit::Type CommitMethod);
    UMG_API void HandleOnBeginSliderMovement();
    UMG_API void HandleOnEndSliderMovement(float InValue);
 
protected:
    UPROPERTY(EditAnywhere, Category = Content, meta = (InlineEditConditionToggle))
    uint32 bOverride_MinValue : 1;
 
    UPROPERTY(EditAnywhere, Category = Content, meta=(InlineEditConditionToggle))
    uint32 bOverride_MaxValue : 1;
 
    UPROPERTY(EditAnywhere, Category = Content, meta = (InlineEditConditionToggle))
    uint32 bOverride_MinSliderValue : 1;
 
    UPROPERTY(EditAnywhere, Category = Content, meta=(InlineEditConditionToggle))
    uint32 bOverride_MaxSliderValue : 1;
 
    UE_DEPRECATED(5.2, "Direct access to MinValue is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetMinValue", BlueprintGetter = "GetMinValue", Category = Content, DisplayName = "Minimum Value", meta = (editcondition = "bOverride_MinValue"))
    float MinValue;
 
    UE_DEPRECATED(5.2, "Direct access to MaxValue is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetMaxValue", BlueprintGetter = "GetMaxValue", Category = Content, DisplayName = "Maximum Value", meta = (editcondition = "bOverride_MaxValue"))
    float MaxValue;
 
    UE_DEPRECATED(5.2, "Direct access to MinSliderValue is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetMinSliderValue", BlueprintGetter = "GetMinSliderValue", Category = Content, DisplayName = "Minimum Slider Value", meta = (editcondition = "bOverride_MinSliderValue"))
    float MinSliderValue;
 
    UE_DEPRECATED(5.2, "Direct access to MaxSliderValue is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetMaxSliderValue", BlueprintGetter = "GetMaxSliderValue", Category = Content, DisplayName = "Maximum Slider Value", meta = (editcondition = "bOverride_MaxSliderValue"))
    float MaxSliderValue;
 
protected:
    TSharedPtr<SSpinBox<float>> MySpinBox;
 
    PROPERTY_BINDING_IMPLEMENTATION(float, Value);
};