ScrollBar.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 "Widgets/Layout/SScrollBar.h"
#include "Components/Widget.h"
#include "ScrollBar.generated.h"
 
UCLASS(Experimental, MinimalAPI)
class UScrollBar : public UWidget
{
    GENERATED_UCLASS_BODY()
 
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" ))
    FScrollBarStyle WidgetStyle;
 
    UE_DEPRECATED(5.2, "Direct access to bAlwaysShowScrollbar is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "IsAlwaysShowScrollbar", Setter = "SetAlwaysShowScrollbar", Category = "Behavior")
    bool bAlwaysShowScrollbar;
 
    UE_DEPRECATED(5.2, "Direct access to bAlwaysShowScrollbarTrack is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "IsAlwaysShowScrollbarTrack", Setter = "SetAlwaysShowScrollbarTrack", Category = "Behavior")
    bool bAlwaysShowScrollbarTrack;
 
    UE_DEPRECATED(5.2, "Direct access to Orientation is deprecated. Please use the getter. Note that the orientation of a scrollbar is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter, Category="Behavior")
    TEnumAsByte<EOrientation> Orientation;
 
    UE_DEPRECATED(5.2, "Direct access to Thickness is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Behavior")
    FVector2D Thickness;
 
    UE_DEPRECATED(5.2, "Direct access to Padding is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = "Behavior")
    FMargin Padding;
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Scrolling")
    UMG_API void SetState(float InOffsetFraction, float InThumbSizeFraction);
 
    //~ 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
 
    //~ Begin UObject Interface
#if WITH_EDITORONLY_DATA
    UMG_API virtual void Serialize(FArchive& Ar) override;
#endif // if WITH_EDITORONLY_DATA
    //~ End UObject Interface
 
#if WITH_EDITOR
    //~ Begin UWidget Interface
    UMG_API virtual const FText GetPaletteCategory() override;
    //~ End UWidget Interface
#endif
 
    UMG_API const FScrollBarStyle& GetWidgetStyle() const;
    UMG_API void SetWidgetStyle(const FScrollBarStyle& InWidgetStyle);
 
    UMG_API bool IsAlwaysShowScrollbar() const;
    UMG_API void SetAlwaysShowScrollbar(bool bNewValue);
 
    UMG_API bool IsAlwaysShowScrollbarTrack() const;
    UMG_API void SetAlwaysShowScrollbarTrack(bool bNewValue);
 
    UMG_API EOrientation GetOrientation() const;
 
    UMG_API FVector2D GetThickness() const;
    UMG_API void SetThickness(const FVector2D& InThickness);
 
    UMG_API FMargin GetPadding() const;
    UMG_API void SetPadding(const FMargin& InPadding);
 
protected:
 
    TSharedPtr<class SScrollBar> MyScrollBar;
 
protected:
    //~ Begin UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    //~ End UWidget Interface
 
    UMG_API void InitOrientation(EOrientation InOrientation);
};