UWidgetStudioModernProgressBar Class Reference

A modern styled progress bar. More...

#include <WSModernProgressBar.h>

Inheritance diagram for UWidgetStudioModernProgressBar:

Public Member Functions
float	GetProgress () const
	Returns the current progress percent.
bool	IsIndicatorVisible () const
	Is the indicator visible?
EPalette	GetTrackColor () const
	Returns the track color.
EPalette	GetFillColor () const
	Returns the progress fill color.
void	SetProgress (float NewValue)
	Set the value of the slider. More...
void	SetIndicatorVisibility (bool bNewState)
	Enable or disable the indicators visibility. More...
void	SetTrackColor (EPalette NewColor)
	Set the color of the track. More...
void	SetFillColor (EPalette NewColor)
	Set the color of the fill track. More...
Public Member Functions inherited from UWidgetStudioBase
FVector2D	GetDimensions () const
	Returns the current X and Y dimensions of the Widget. More...
int32	GetBorderRadius () const
	Returns the current border radius of the Widget. More...
void	ForceStyleUpdate ()
	Refresh the dynamic styling of the Widget Studio widget.
void	SetSizeModifier (ESizeModifier InSizeModifier)
	Set the size modifier of the Widget Studio widget.

Protected Member Functions
virtual TSharedRef< SWidget >	RebuildWidget () override
virtual int32	NativePaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
virtual void	SynchronizeProperties () override
virtual void	InitializeStyling () override
virtual void	UpdateStyling () override
Protected Member Functions inherited from UWidgetStudioBase
virtual void	NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override
virtual void	NativeOnMouseLeave (const FPointerEvent &InMouseEvent) override
virtual void	NativeOnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override

Protected Attributes
bool	bForwardProgress = true
UInvalidationBox *	Retainer = nullptr
USizeBox *	SizeBox = nullptr
UOverlay *	Overlay = nullptr
UScaleBox *	TrackScaleBox = nullptr
UOverlay *	TrackOverlay = nullptr
UImage *	Track = nullptr
UImage *	TrackDropShadow = nullptr
USizeBox *	FillTrackSizeBox = nullptr
UImage *	FillTrack = nullptr
USizeBox *	IndicatorSizeBox = nullptr
UImage *	Indicator = nullptr

Additional Inherited Members
Public Attributes inherited from UWidgetStudioBase
FWSBaseHoverStateDelegate	OnHoverStateChanged
	Called when the hover state has been changed.
bool	bCanOverrideDimensions = true
	Used to enable or disable dimension override's.
bool	bCanOverrideBorderRadius = true
	Used to enable or disable dimension override's.
FVector2D	MinimumDimensions = FVector2D(50, 7)
	The minimum dimensions of the widget. More...
bool	bDisablePainting = false
	Used for debugging. More...
float	AnimationTime = 7
	The animation interpolation speed. More...
ESizeModifier	SizeModifier = ESizeModifier::Regular
	Quickly modify the overall size of the widget. More...
FVector2D	OverrideDimensions = FVector2D(0, 0)
	Manually adjust the X and Y dimensions of the widget. More...
int32	OverrideBorderRadius = -1
	Manually adjust the border radius of the widget. More...

Detailed Description

A modern styled progress bar.

Useful for display the progress of an event or the percentage of a value.

Member Function Documentation

InitializeStyling()

void UWidgetStudioModernProgressBar::InitializeStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

SetFillColor()

void UWidgetStudioModernProgressBar::SetFillColor

(

EPalette

NewColor

)

Set the color of the fill track.

Parameters

NewColor

The color to apply to the fill track.

SetIndicatorVisibility()

void UWidgetStudioModernProgressBar::SetIndicatorVisibility

(

bool

bNewState

)

Enable or disable the indicators visibility.

Parameters

bNewState

The state of the indicator visibility.

SetProgress()

void UWidgetStudioModernProgressBar::SetProgress

(

float

NewValue

)

Set the value of the slider.

Parameters

NewValue

The value to set the progress to. Clamped between 0 to 100.

SetTrackColor()

void UWidgetStudioModernProgressBar::SetTrackColor

(

EPalette

NewColor

)

Set the color of the track.

Parameters

NewColor

The color to apply to the track.

UpdateStyling()

void UWidgetStudioModernProgressBar::UpdateStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

---

The documentation for this class was generated from the following files:

• src/WidgetStudio/Source/WidgetStudioRuntime/Public/Widgets/Modern/WSModernProgressBar.h
• src/WidgetStudio/Source/WidgetStudioRuntime/Private/Widgets/Modern/WSModernProgressBar.cpp