Navigation
API > API/Runtime > API/Runtime/UMG
The progress bar widget is a simple bar that fills up that can be restyled to fit any number of uses.
- No Children
| Name | UProgressBar |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Components/ProgressBar.h |
| Include Path | #include "Components/ProgressBar.h" |
Syntax
UCLASS (MinimalAPI)
class UProgressBar : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UProgressBar
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UProgressBar
(
const FObjectInitializer& ObjectInitializer |
Components/ProgressBar.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BarFillStyle | TEnumAsByte< EProgressBarFillStyle::Type > | Defines the visual style of the progress bar fill - scale or mask | Components/ProgressBar.h |
|
| BarFillType | TEnumAsByte< EProgressBarFillType::Type > | Defines the direction in which the progress bar fills | Components/ProgressBar.h |
|
| bIsMarquee | bool | Components/ProgressBar.h |
|
|
| BorderPadding | FVector2D | Components/ProgressBar.h |
|
|
| FillColorAndOpacity | FLinearColor | Fill Color and Opacity | Components/ProgressBar.h |
|
| FillColorAndOpacityDelegate | FGetLinearColor | Components/ProgressBar.h | ||
| Percent | float | Used to determine the fill position of the progress bar ranging 0..1 | Components/ProgressBar.h |
|
| PercentDelegate | FGetFloat | A bindable delegate to allow logic to drive the text of the widget | Components/ProgressBar.h | |
| WidgetStyle | FProgressBarStyle | The progress bar style | Components/ProgressBar.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EProgressBarFillStyle::Type GetBarFillStyle() |
Components/ProgressBar.h | ||
EProgressBarFillType::Type GetBarFillType() |
Components/ProgressBar.h | ||
FVector2D GetBorderPadding() |
Components/ProgressBar.h | ||
FLinearColor GetFillColorAndOpacity() |
Components/ProgressBar.h | ||
float GetPercent() |
Components/ProgressBar.h | ||
const FProgressBarStyle & GetWidgetStyle() |
Components/ProgressBar.h | ||
void SetBarFillStyle
(
EProgressBarFillStyle::Type InBarFillStyle |
Components/ProgressBar.h | ||
void SetBarFillType
(
EProgressBarFillType::Type InBarFillType |
Components/ProgressBar.h | ||
void SetBorderPadding
(
FVector2D InBorderPadding |
Components/ProgressBar.h | ||
void SetFillColorAndOpacity
(
FLinearColor InColor |
Sets the fill color of the progress bar. | Components/ProgressBar.h |
|
void SetIsMarquee
(
bool InbIsMarquee |
Sets the progress bar to show as a marquee. | Components/ProgressBar.h |
|
void SetPercent
(
float InPercent |
Sets the current value of the ProgressBar. | Components/ProgressBar.h |
|
void SetWidgetStyle
(
const FProgressBarStyle& InStyle |
Components/ProgressBar.h | ||
bool UseMarquee() |
Components/ProgressBar.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
Gets the palette category of the widget | Components/ProgressBar.h | |
virtual void OnCreationFromPalette () |
Called after constructing a new widget from the palette. | Components/ProgressBar.h | |
virtual void SynchronizeProperties () |
Applies all properties to the native widget if possible. | Components/ProgressBar.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
Components/ProgressBar.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateColor K2_Gate_FillColorAndOpacity() |
Components/ProgressBar.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > RebuildWidget() |
Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | Components/ProgressBar.h |