UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ProgressBar.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
8#include "Widgets/SWidget.h"
10#include "Components/Widget.h"
11#include "ProgressBar.generated.h"
12
14
20UCLASS(MinimalAPI)
22{
24
25public:
26 UE_DEPRECATED(5.1, "Direct access to WidgetStyle is deprecated. Please use the getter or setter.")
28 UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Style", meta=( DisplayName="Style" ))
29 FProgressBarStyle WidgetStyle;
30
31 UE_DEPRECATED(5.1, "Direct access to Percent is deprecated. Please use the getter or setter.")
33 UPROPERTY(EditAnywhere, BlueprintReadWrite, FieldNotify, Getter, Setter, BlueprintSetter="SetPercent", Category="Progress", meta = (UIMin = "0", UIMax = "1"))
34 float Percent;
35
36 UE_DEPRECATED(5.1, "Direct access to BarFillType is deprecated. Please use the getter or setter.")
38 UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Progress")
40
41 UE_DEPRECATED(5.1, "Direct access to BarFillStyle is deprecated. Please use the getter or setter.")
43 UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Progress")
45
46 UE_DEPRECATED(5.1, "Direct access to bIsMarquee is deprecated. Please use the getter or setter.")
48 UPROPERTY(EditAnywhere, BlueprintReadWrite, FieldNotify, Getter="UseMarquee", Setter="SetIsMarquee", BlueprintSetter="SetIsMarquee", Category="Progress")
49 bool bIsMarquee;
50
51 UE_DEPRECATED(5.1, "Direct access to BorderPadding is deprecated. Please use the getter or setter.")
53 UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Progress")
54 FVector2D BorderPadding;
55
57 UPROPERTY()
58 FGetFloat PercentDelegate;
59
60 UE_DEPRECATED(5.1, "Direct access to FillColorAndOpacity is deprecated. Please use the getter or setter.")
62 UPROPERTY(EditAnywhere, BlueprintReadWrite, FieldNotify, Getter, Setter, BlueprintSetter="SetFillColorAndOpacity", Category="Appearance")
63 FLinearColor FillColorAndOpacity;
64
66 UPROPERTY()
67 FGetLinearColor FillColorAndOpacityDelegate;
68
69public:
70
72 UMG_API const FProgressBarStyle& GetWidgetStyle() const;
73
74
75 UMG_API void SetWidgetStyle(const FProgressBarStyle& InStyle);
76
78 UMG_API float GetPercent() const;
79
81 UFUNCTION(BlueprintCallable, Category="Progress")
82 UMG_API void SetPercent(float InPercent);
83
85 UMG_API EProgressBarFillType::Type GetBarFillType() const;
86
88 UMG_API void SetBarFillType(EProgressBarFillType::Type InBarFillType);
89
91 UMG_API EProgressBarFillStyle::Type GetBarFillStyle() const;
92
94 UMG_API void SetBarFillStyle(EProgressBarFillStyle::Type InBarFillStyle);
95
97 UMG_API bool UseMarquee() const;
98
100 UFUNCTION(BlueprintCallable, Category="Progress")
101 UMG_API void SetIsMarquee(bool InbIsMarquee);
102
104 UMG_API FVector2D GetBorderPadding() const;
105
107 UMG_API void SetBorderPadding(FVector2D InBorderPadding);
108
110 UMG_API FLinearColor GetFillColorAndOpacity() const;
111
113 UFUNCTION(BlueprintCallable, Category="Progress")
114 UMG_API void SetFillColorAndOpacity(FLinearColor InColor);
115
116public:
117
118 //~ Begin UWidget Interface
119 UMG_API virtual void SynchronizeProperties() override;
120 //~ End UWidget Interface
121
122 //~ Begin UVisual Interface
123 UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
124 //~ End UVisual Interface
125
126#if WITH_EDITOR
127 //~ Begin UWidget Interface
128 UMG_API virtual const FText GetPaletteCategory() override;
129 UMG_API virtual void OnCreationFromPalette() override;
130 //~ End UWidget Interface
131#endif
132
133protected:
136
137 //~ Begin UWidget Interface
138 UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
139 //~ End UWidget Interface
140
142};
#define UE_DEPRECATED(Version, Message)
Definition CoreMiscDefines.h:302
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
#define UPROPERTY(...)
UObject definition macros.
Definition ObjectMacros.h:744
#define UFUNCTION(...)
Definition ObjectMacros.h:745
#define GENERATED_UCLASS_BODY(...)
Definition ObjectMacros.h:768
#define UCLASS(...)
Definition ObjectMacros.h:776
Definition Text.h:385
Definition EnumAsByte.h:22
Definition SharedPointer.h:692
Definition SharedPointer.h:153
Definition ProgressBar.h:22
TSharedPtr< SProgressBar > MyProgressBar
Definition ProgressBar.h:135
PROPERTY_BINDING_IMPLEMENTATION(FSlateColor, FillColorAndOpacity)
Definition SlateBrushAsset.h:17
Definition Widget.h:217
Definition SProgressBar.h:50
Definition SProgressBar.h:25
Definition Color.h:48
Definition SlateTypes.h:1165
Definition SlateColor.h:42