Navigation
API > API/Runtime > API/Runtime/SlateCore
Represents the appearance of an SButton
| Name | FButtonStyle |
| Type | struct |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h |
| Include Path | #include "Styling/SlateTypes.h" |
Syntax
USTRUCT (BlueprintType )
struct FButtonStyle : public FSlateWidgetStyle
Inheritance Hierarchy
- FSlateWidgetStyle → FButtonStyle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FButtonStyle () |
Styling/SlateTypes.h | ||
FButtonStyle
(
const FButtonStyle& |
Styling/SlateTypes.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FButtonStyle() |
Styling/SlateTypes.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TypeName | const FName | Styling/SlateTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClickedSlateSound | FSlateSound | The sound the button should play when clicked | Styling/SlateTypes.h |
|
| Disabled | FSlateBrush | Button appearance when disabled, by default this is set to an invalid resource when that is the case default disabled drawing is used. | Styling/SlateTypes.h |
|
| DisabledForeground | FSlateColor | Foreground Color when disabled | Styling/SlateTypes.h |
|
| Hovered | FSlateBrush | Button appearance when hovered | Styling/SlateTypes.h |
|
| HoveredForeground | FSlateColor | Foreground Color when hovered | Styling/SlateTypes.h |
|
| HoveredSlateSound | FSlateSound | The sound the button should play when initially hovered over | Styling/SlateTypes.h |
|
| Normal | FSlateBrush | Button appearance when the button is not hovered or pressed | Styling/SlateTypes.h |
|
| NormalForeground | FSlateColor | Foreground Color when the button is not hovered or pressed | Styling/SlateTypes.h |
|
| NormalPadding | FMargin | Padding that accounts for the border in the button's background image. | Styling/SlateTypes.h |
|
| Pressed | FSlateBrush | Button appearance when pressed | Styling/SlateTypes.h |
|
| PressedForeground | FSlateColor | Foreground Color when pressed | Styling/SlateTypes.h |
|
| PressedPadding | FMargin | Same as NormalPadding but used when the button is pressed. | Styling/SlateTypes.h |
|
| PressedSlateSound | FSlateSound | The sound the button should play when pressed | Styling/SlateTypes.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void PostSerialize
(
const FArchive& Ar |
Used to upgrade the deprecated FName sound properties into the new-style FSlateSound properties | Styling/SlateTypes.h | |
FButtonStyle & SetClickedSound
(
const FSlateSound& InClickedSound |
Styling/SlateTypes.h | ||
FButtonStyle & SetDisabled
(
const FSlateBrush& InDisabled |
Styling/SlateTypes.h | ||
FButtonStyle & SetDisabledForeground
(
const FSlateColor& InDisabledForeground |
Styling/SlateTypes.h | ||
FButtonStyle & SetHovered
(
const FSlateBrush& InHovered |
Styling/SlateTypes.h | ||
FButtonStyle & SetHoveredForeground
(
const FSlateColor& InHoveredForeground |
Styling/SlateTypes.h | ||
FButtonStyle & SetHoveredSound
(
const FSlateSound& InHoveredSound |
Styling/SlateTypes.h | ||
FButtonStyle & SetNormal
(
const FSlateBrush& InNormal |
Styling/SlateTypes.h | ||
FButtonStyle & SetNormalForeground
(
const FSlateColor& InNormalForeground |
Styling/SlateTypes.h | ||
FButtonStyle & SetNormalPadding
(
const FMargin& InNormalPadding |
Styling/SlateTypes.h | ||
FButtonStyle & SetPressed
(
const FSlateBrush& InPressed |
Styling/SlateTypes.h | ||
FButtonStyle & SetPressedForeground
(
const FSlateColor& InPressedForeground |
Styling/SlateTypes.h | ||
FButtonStyle & SetPressedPadding
(
const FMargin& InPressedPadding |
Styling/SlateTypes.h | ||
FButtonStyle & SetPressedSound
(
const FSlateSound& InPressedSound |
Styling/SlateTypes.h | ||
void UnlinkColors () |
Unlinks all colors in this style. | Styling/SlateTypes.h |
Overridden from FSlateWidgetStyle
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetResources
(
TArray< const FSlateBrush* >& OutBrushes |
Gets the brush resources associated with this style. | Styling/SlateTypes.h | |
virtual const FName GetTypeName() |
Gets the name of this style.This method must be implemented by inherited structures. | Styling/SlateTypes.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FButtonStyle & GetDefault() |
Styling/SlateTypes.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HoveredSound_DEPRECATED | FName | Styling/SlateTypes.h | ||
| PressedSound_DEPRECATED | FName | Styling/SlateTypes.h |