FProgressBarStyle Struct Reference

#include <SlateTypes.h>

Inheritance diagram for FProgressBarStyle:

Public Member Functions
SLATECORE_API	FProgressBarStyle ()
virtual SLATECORE_API	~FProgressBarStyle ()
virtual SLATECORE_API void	GetResources (TArray< const FSlateBrush * > &OutBrushes) const override
virtual const FName	GetTypeName () const override
FProgressBarStyle &	SetBackgroundImage (const FSlateBrush &InBackgroundImage)
FProgressBarStyle &	SetFillImage (const FSlateBrush &InFillImage)
FProgressBarStyle &	SetMarqueeImage (const FSlateBrush &InMarqueeImage)
FProgressBarStyle &	SetEnableFillAnimation (bool InEnableFillAnimation)
void	UnlinkColors ()
Public Member Functions inherited from FSlateWidgetStyle
SLATECORE_API	FSlateWidgetStyle ()
virtual SLATECORE_API	~FSlateWidgetStyle ()

Static Public Member Functions
static SLATECORE_API const FProgressBarStyle &	GetDefault ()

Public Attributes
FSlateBrush	BackgroundImage
FSlateBrush	FillImage
FSlateBrush	MarqueeImage
bool	EnableFillAnimation

Static Public Attributes
static SLATECORE_API const FName	TypeName

Detailed Description

Represents the appearance of an SProgressBar

Constructor & Destructor Documentation

FProgressBarStyle()

FProgressBarStyle::FProgressBarStyle

(

)

~FProgressBarStyle()

FProgressBarStyle::~FProgressBarStyle ( )

virtualdefault

Member Function Documentation

GetDefault()

const FProgressBarStyle & FProgressBarStyle::GetDefault ( )

static

GetResources()

void FProgressBarStyle::GetResources ( TArray< const FSlateBrush * > &  OutBrushes ) const

overridevirtual

Gets the brush resources associated with this style.

This method must be implemented by inherited structures.

Parameters

OutBrushes

The brush resources.

Reimplemented from FSlateWidgetStyle.

GetTypeName()

virtual const FName FProgressBarStyle::GetTypeName ( ) const

inlineoverridevirtual

Gets the name of this style.

This method must be implemented by inherited structures.

Returns

Widget style name.

Reimplemented from FSlateWidgetStyle.

SetBackgroundImage()

FProgressBarStyle & FProgressBarStyle::SetBackgroundImage ( const FSlateBrush &  InBackgroundImage )

inline

SetEnableFillAnimation()

FProgressBarStyle & FProgressBarStyle::SetEnableFillAnimation ( bool  InEnableFillAnimation )

inline

SetFillImage()

FProgressBarStyle & FProgressBarStyle::SetFillImage ( const FSlateBrush &  InFillImage )

inline

SetMarqueeImage()

FProgressBarStyle & FProgressBarStyle::SetMarqueeImage ( const FSlateBrush &  InMarqueeImage )

inline

UnlinkColors()

void FProgressBarStyle::UnlinkColors ( )

inline

Unlinks all colors in this style.

See also

FSlateColor::Unlink

Member Data Documentation

BackgroundImage

FSlateBrush FProgressBarStyle::BackgroundImage

Background image to use for the progress bar

EnableFillAnimation

bool FProgressBarStyle::EnableFillAnimation

Enables a simple animation on the fill image to give the appearance that progress has not stalled. Disable this if you have a custom material which animates itself. This requires a pattern in your material or texture to give the appearance of movement. A solid color will show no movement.

FillImage

FSlateBrush FProgressBarStyle::FillImage

Foreground image to use for the progress bar

MarqueeImage

FSlateBrush FProgressBarStyle::MarqueeImage

Image to use for marquee mode

TypeName

const FName FProgressBarStyle::TypeName

static

---

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

• Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h
• Engine/Source/Runtime/SlateCore/Private/Styling/SlateTypes.cpp