FButtonStyle Struct Reference

#include <SlateTypes.h>

Inheritance diagram for FButtonStyle:

Public Member Functions
SLATECORE_API	FButtonStyle ()
SLATECORE_API	FButtonStyle (const FButtonStyle &)
virtual SLATECORE_API	~FButtonStyle ()
virtual SLATECORE_API void	GetResources (TArray< const FSlateBrush * > &OutBrushes) const override
virtual const FName	GetTypeName () const override
FButtonStyle &	SetNormal (const FSlateBrush &InNormal)
FButtonStyle &	SetHovered (const FSlateBrush &InHovered)
FButtonStyle &	SetPressed (const FSlateBrush &InPressed)
FButtonStyle &	SetDisabled (const FSlateBrush &InDisabled)
FButtonStyle &	SetNormalForeground (const FSlateColor &InNormalForeground)
FButtonStyle &	SetHoveredForeground (const FSlateColor &InHoveredForeground)
FButtonStyle &	SetPressedForeground (const FSlateColor &InPressedForeground)
FButtonStyle &	SetDisabledForeground (const FSlateColor &InDisabledForeground)
FButtonStyle &	SetNormalPadding (const FMargin &InNormalPadding)
FButtonStyle &	SetPressedPadding (const FMargin &InPressedPadding)
FButtonStyle &	SetPressedSound (const FSlateSound &InPressedSound)
FButtonStyle &	SetClickedSound (const FSlateSound &InClickedSound)
FButtonStyle &	SetHoveredSound (const FSlateSound &InHoveredSound)
void	UnlinkColors ()
Public Member Functions inherited from FSlateWidgetStyle
SLATECORE_API	FSlateWidgetStyle ()
virtual SLATECORE_API	~FSlateWidgetStyle ()

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

Public Attributes
FSlateBrush	Normal
FSlateBrush	Hovered
FSlateBrush	Pressed
FSlateBrush	Disabled
FSlateColor	NormalForeground
FSlateColor	HoveredForeground
FSlateColor	PressedForeground
FSlateColor	DisabledForeground
FMargin	NormalPadding
FMargin	PressedPadding
FSlateSound	PressedSlateSound
FSlateSound	ClickedSlateSound
FSlateSound	HoveredSlateSound

Static Public Attributes
static SLATECORE_API const FName	TypeName

Detailed Description

Represents the appearance of an SButton

Constructor & Destructor Documentation

FButtonStyle() [1/2]

PRAGMA_ENABLE_DEPRECATION_WARNINGS FButtonStyle::FButtonStyle

(

)

FButtonStyle() [2/2]

FButtonStyle::FButtonStyle ( const FButtonStyle &  )

default

~FButtonStyle()

FButtonStyle::~FButtonStyle ( )

virtualdefault

Member Function Documentation

GetDefault()

const FButtonStyle & FButtonStyle::GetDefault ( )

static

GetResources()

void FButtonStyle::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 FButtonStyle::GetTypeName ( ) const

inlineoverridevirtual

Gets the name of this style.

This method must be implemented by inherited structures.

Returns

Widget style name.

Reimplemented from FSlateWidgetStyle.

SetClickedSound()

FButtonStyle & FButtonStyle::SetClickedSound ( const FSlateSound &  InClickedSound )

inline

SetDisabled()

FButtonStyle & FButtonStyle::SetDisabled ( const FSlateBrush &  InDisabled )

inline

SetDisabledForeground()

FButtonStyle & FButtonStyle::SetDisabledForeground ( const FSlateColor &  InDisabledForeground )

inline

SetHovered()

FButtonStyle & FButtonStyle::SetHovered ( const FSlateBrush &  InHovered )

inline

SetHoveredForeground()

FButtonStyle & FButtonStyle::SetHoveredForeground ( const FSlateColor &  InHoveredForeground )

inline

SetHoveredSound()

FButtonStyle & FButtonStyle::SetHoveredSound ( const FSlateSound &  InHoveredSound )

inline

SetNormal()

FButtonStyle & FButtonStyle::SetNormal ( const FSlateBrush &  InNormal )

inline

SetNormalForeground()

FButtonStyle & FButtonStyle::SetNormalForeground ( const FSlateColor &  InNormalForeground )

inline

SetNormalPadding()

FButtonStyle & FButtonStyle::SetNormalPadding ( const FMargin &  InNormalPadding )

inline

SetPressed()

FButtonStyle & FButtonStyle::SetPressed ( const FSlateBrush &  InPressed )

inline

SetPressedForeground()

FButtonStyle & FButtonStyle::SetPressedForeground ( const FSlateColor &  InPressedForeground )

inline

SetPressedPadding()

FButtonStyle & FButtonStyle::SetPressedPadding ( const FMargin &  InPressedPadding )

inline

SetPressedSound()

FButtonStyle & FButtonStyle::SetPressedSound ( const FSlateSound &  InPressedSound )

inline

UnlinkColors()

void FButtonStyle::UnlinkColors ( )

inline

Unlinks all colors in this style.

See also

FSlateColor::Unlink

Member Data Documentation

ClickedSlateSound

FSlateSound FButtonStyle::ClickedSlateSound

The sound the button should play when clicked

Disabled

FSlateBrush FButtonStyle::Disabled

Button appearance when disabled, by default this is set to an invalid resource when that is the case default disabled drawing is used.

DisabledForeground

FSlateColor FButtonStyle::DisabledForeground

Foreground Color when disabled

Hovered

FSlateBrush FButtonStyle::Hovered

Button appearance when hovered

HoveredForeground

FSlateColor FButtonStyle::HoveredForeground

Foreground Color when hovered

HoveredSlateSound

FSlateSound FButtonStyle::HoveredSlateSound

The sound the button should play when initially hovered over

Normal

FSlateBrush FButtonStyle::Normal

Button appearance when the button is not hovered or pressed

NormalForeground

FSlateColor FButtonStyle::NormalForeground

Foreground Color when the button is not hovered or pressed

NormalPadding

FMargin FButtonStyle::NormalPadding

Padding that accounts for the border in the button's background image. When this is applied, the content of the button should appear flush with the button's border. Use this padding when the button is not pressed.

Pressed

FSlateBrush FButtonStyle::Pressed

Button appearance when pressed

PressedForeground

FSlateColor FButtonStyle::PressedForeground

Foreground Color when pressed

PressedPadding

FMargin FButtonStyle::PressedPadding

Same as NormalPadding but used when the button is pressed. Allows for moving the content to match any "movement" in the button's border image.

PressedSlateSound

FSlateSound FButtonStyle::PressedSlateSound

The sound the button should play when pressed

TypeName

const FName FButtonStyle::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