Navigation
API > API/Runtime > API/Runtime/Slate
A progress bar widget.
| Name | SProgressBar |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Notifications/SProgressBar.h |
| Include Path | #include "Widgets/Notifications/SProgressBar.h" |
Syntax
class SProgressBar : public SLeafWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SLeafWidget → SProgressBar
- FSlateControlledConstruction → SWidget → SLeafWidget → SProgressBar
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveTimerHandle | TWeakPtr< FActiveTimerHandle > | Reference to the widgets current active timer | Widgets/Notifications/SProgressBar.h | |
| BackgroundImage | const FSlateBrush * | Background image to use for the progress bar | Widgets/Notifications/SProgressBar.h | |
| BarFillStyle | EProgressBarFillStyle::Type | Widgets/Notifications/SProgressBar.h | ||
| BarFillType | EProgressBarFillType::Type | Widgets/Notifications/SProgressBar.h | ||
| BorderPadding | TAttribute< FVector2D > | Border Padding | Widgets/Notifications/SProgressBar.h | |
| CurrentTickRate | float | Rate at which the widget is currently ticked when slate sleep mode is active | Widgets/Notifications/SProgressBar.h | |
| FillColorAndOpacity | TAttribute< FSlateColor > | Fill Color and Opacity | Widgets/Notifications/SProgressBar.h | |
| FillImage | const FSlateBrush * | Foreground image to use for the progress bar | Widgets/Notifications/SProgressBar.h | |
| MarqueeImage | const FSlateBrush * | Image to use for marquee mode | Widgets/Notifications/SProgressBar.h | |
| MarqueeOffset | float | Value to drive progress bar animation | Widgets/Notifications/SProgressBar.h | |
| MinimumTickRate | float | The slowest that this widget can tick when in slate sleep mode | Widgets/Notifications/SProgressBar.h | |
| Percent | TAttribute< TOptional< float > > | The text displayed over the progress bar | Widgets/Notifications/SProgressBar.h | |
| Style | const FProgressBarStyle * | The style of the progress bar | Widgets/Notifications/SProgressBar.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct the widget | Widgets/Notifications/SProgressBar.h | |
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Notifications/SProgressBar.h | ||
void SetBackgroundImage
(
const FSlateBrush* InBackgroundImage |
See attribute BackgroundImage | Widgets/Notifications/SProgressBar.h | |
void SetBarFillStyle
(
EProgressBarFillStyle::Type InBarFillStyle |
See attribute BarFillStyle | Widgets/Notifications/SProgressBar.h | |
void SetBarFillType
(
EProgressBarFillType::Type InBarFillType |
See attribute BarFillType | Widgets/Notifications/SProgressBar.h | |
void SetBorderPadding
(
TAttribute< FVector2D > InBorderPadding |
See attribute BorderPadding | Widgets/Notifications/SProgressBar.h | |
void SetFillColorAndOpacity
(
TAttribute< FSlateColor > InFillColorAndOpacity |
See attribute SetFillColorAndOpacity | Widgets/Notifications/SProgressBar.h | |
void SetFillImage
(
const FSlateBrush* InFillImage |
See attribute FillImage | Widgets/Notifications/SProgressBar.h | |
void SetMarqueeImage
(
const FSlateBrush* InMarqueeImage |
See attribute MarqueeImage | Widgets/Notifications/SProgressBar.h | |
void SetPercent
(
TAttribute< TOptional< float > > InPercent |
See attribute Percent | Widgets/Notifications/SProgressBar.h | |
void SetStyle
(
const FProgressBarStyle* InStyle |
See attribute Style | Widgets/Notifications/SProgressBar.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Widgets/Notifications/SProgressBar.h | ||
virtual bool ComputeVolatility() |
Widgets/Notifications/SProgressBar.h |