Slider.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 "Styling/SlateTypes.h"
#include "Widgets/SWidget.h"
#include "Components/Widget.h"
#include "Slider.generated.h"
 
class SSlider;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnMouseCaptureBeginEvent);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnMouseCaptureEndEvent);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnControllerCaptureBeginEvent);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnControllerCaptureEndEvent);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnFloatValueChangedEvent, float, Value);
 
UCLASS(MinimalAPI)
class USlider : public UWidget
{
    GENERATED_UCLASS_BODY()
 
public:
    UE_DEPRECATED(5.1, "Direct access to Value is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, FieldNotify, BlueprintGetter="GetValue", BlueprintSetter="SetValue", Category="Appearance", meta=(UIMin="0", UIMax="1"))
    float Value;
 
    UPROPERTY()
    FGetFloat ValueDelegate;
 
    UE_DEPRECATED(5.1, "Direct access to MinValue is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetMinValue", Category="Appearance")
    float MinValue;
 
    UE_DEPRECATED(5.1, "Direct access to MaxValue is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetMaxValue", Category="Appearance")
    float MaxValue;
 
public:
    UE_DEPRECATED(5.1, "Direct access to WidgetStyle is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Style", meta=( DisplayName="Style" ))
    FSliderStyle WidgetStyle;
 
    UE_DEPRECATED(5.1, "Direct access to Orientation is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category=Appearance)
    TEnumAsByte<EOrientation> Orientation;
 
    UE_DEPRECATED(5.1, "Direct access to SliderBarColor is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetSliderBarColor", Category="Appearance")
    FLinearColor SliderBarColor;
 
    UE_DEPRECATED(5.1, "Direct access to SliderHandleColor is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetSliderHandleColor", Category="Appearance")
    FLinearColor SliderHandleColor;
 
    UE_DEPRECATED(5.1, "Direct access to IndentHandle is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter="HasIndentHandle", Setter, BlueprintSetter="SetIndentHandle", Category="Appearance", AdvancedDisplay)
    bool IndentHandle;
 
    UE_DEPRECATED(5.1, "Direct access to Locked is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter="IsLocked", Setter, BlueprintSetter="SetLocked", Category="Appearance", AdvancedDisplay)
    bool Locked;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Appearance, AdvancedDisplay)
    bool MouseUsesStep;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Appearance, AdvancedDisplay)
    bool RequiresControllerLock;
 
    UE_DEPRECATED(5.1, "Direct access to StepSize is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere,BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetStepSize", Category="Appearance", meta=(UIMin="0", UIMax="1"))
    float StepSize;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Interaction")
    bool IsFocusable;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Interaction")
    bool bPreventThrottling = false;
 
public:
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event")
    FOnMouseCaptureBeginEvent OnMouseCaptureBegin;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event")
    FOnMouseCaptureEndEvent OnMouseCaptureEnd;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Event")
    FOnControllerCaptureBeginEvent OnControllerCaptureBegin;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Event")
    FOnControllerCaptureEndEvent OnControllerCaptureEnd;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event")
    FOnFloatValueChangedEvent OnValueChanged;
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    UMG_API float GetValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API float GetNormalizedValue() const;
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    UMG_API void SetValue(float InValue);
 
    UMG_API float GetMinValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void SetMinValue(float InValue);
 
    UMG_API float GetMaxValue() const;
 
    UFUNCTION(BlueprintCallable, Category = "Behavior")
    UMG_API void SetMaxValue(float InValue);
 
    UMG_API const FSliderStyle& GetWidgetStyle() const;
 
    UMG_API void SetWidgetStyle(const FSliderStyle& InStyle);
 
    UMG_API EOrientation GetOrientation() const;
 
    UMG_API void SetOrientation(EOrientation InOrientation);
 
    UMG_API bool HasIndentHandle() const;
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    UMG_API void SetIndentHandle(bool InValue);
 
    UMG_API bool IsLocked() const;
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    UMG_API void SetLocked(bool InValue);
 
    UMG_API float GetStepSize() const;
 
    UFUNCTION(BlueprintCallable, Category="Behavior")
    UMG_API void SetStepSize(float InValue);
 
    UMG_API FLinearColor GetSliderBarColor() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetSliderBarColor(FLinearColor InValue);
 
    UMG_API FLinearColor GetSliderHandleColor() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetSliderHandleColor(FLinearColor InValue);
    
    // UWidget interface
    UMG_API virtual void SynchronizeProperties() override;
    // End of UWidget interface
 
    // UVisual interface
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
    // End of UVisual interface
 
#if WITH_EDITOR
    UMG_API virtual const FText GetPaletteCategory() override;
#endif
 
protected:
    TSharedPtr<SSlider> MySlider;
 
    // UWidget interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    // End of UWidget interface
 
    UMG_API void HandleOnValueChanged(float InValue);
    UMG_API void HandleOnMouseCaptureBegin();
    UMG_API void HandleOnMouseCaptureEnd();
    UMG_API void HandleOnControllerCaptureBegin();
    UMG_API void HandleOnControllerCaptureEnd();
 
#if WITH_ACCESSIBILITY
    UMG_API virtual TSharedPtr<SWidget> GetAccessibleWidget() const override;
#endif
 
    PROPERTY_BINDING_IMPLEMENTATION(float, Value);
};