FButtonStyle

Represents the appearance of an [SButton](API\Runtime\Slate\Widgets\Input\SButton)

Windows
MacOS
Linux

Inheritance Hierarchy

FSlateWidgetStyle

FButtonStyle

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h

Include

#include "Styling/SlateTypes.h"

Syntax

struct FButtonStyle : public FSlateWidgetStyle

Remarks

Represents the appearance of an SButton

Variables

Name Description

Public variable

FSlateBrush

 

Disabled

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

Public variable

FSlateBrush

 

Hovered

Button appearance when hovered

Public variable

FSlateSound

 

HoveredSlateSound

The sound the button should play when initially hovered over

Public variable

FSlateBrush

 

Normal

Button appearance when the button is not hovered or pressed

Public variable

FMargin

 

NormalPadding

Padding that accounts for the border in the button's background image.

Public variable

FSlateBrush

 

Pressed

Button appearance when pressed

Public variable

FMargin

 

PressedPadding

Same as NormalPadding but used when the button is pressed.

Public variable

FSlateSound

 

PressedSlateSound

The sound the button should play when pressed

Constructors

Name Description

Public function

FButtonStyle()

Destructors

Name Description

Public function Virtual

~FButtonStyle()

Functions

Name Description

Public function Static

const FButto...

 

GetDefault()

Public function

void

 

PostSerialize

(
    const FArchive& Ar
)

Used to upgrade the deprecated FName sound properties into the new-style FSlateSound properties

Public function

FButtonStyle...

 

SetDisabled

(
    const FSlateBrush& InDisabled
)

Public function

FButtonStyle...

 

SetHovered

(
    const FSlateBrush& InHovered
)

Public function

FButtonStyle...

 

SetHoveredSound

(
    const FSlateSound& InHoveredSound
)

Public function

FButtonStyle...

 

SetNormal

(
    const FSlateBrush& InNormal
)

Public function

FButtonStyle...

 

SetNormalPadding

(
    const FMargin& InNormalPadding
)

Public function

FButtonStyle...

 

SetPressed

(
    const FSlateBrush& InPressed
)

Public function

FButtonStyle...

 

SetPressedPadding

(
    const FMargin& InPressedPadding
)

Public function

FButtonStyle...

 

SetPressedSound

(
    const FSlateSound& InPressedSound
)

Public function

void

 

UnlinkColors()

Unlinks all colors in this style.

Overridden from FSlateWidgetStyle

Name Description

Public function Virtual Const

void

 

GetResources

(
    TArray< const FSlateBrush* >&...
)

Gets the brush resources associated with this style.

Public function Virtual Const

const FName

 

GetTypeName()

Gets the name of this style.

This method must be implemented by inherited structures.

Constants

Name

Description

TypeName

Deprecated Variables

Name Description

Public variable

FName

 

HoveredSound_DEPRECATED

Public variable

FName

 

PressedSound_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss