1. Epic GamesDeveloper
  3. FButtonStyle

FButtonStyle

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

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Styling

Inheritance Hierarchy

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

  Type 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 FSlateColor DisabledForeground Foreground Color when disabled
Public variable FSlateBrush Hovered Button appearance when hovered
Public variable FSlateColor HoveredForeground Foreground Color 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 FSlateColor NormalForeground Foreground Color 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 FSlateColor PressedForeground Foreground Color 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

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static const FButtonStyle &  
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 &

SetDisabledForeground ( const FSlateColor& InDisabledForeground
)

  
Public function FButtonStyle &

SetHovered ( const FSlateBrush& InHovered
)

  
Public function FButtonStyle &

SetHoveredForeground ( const FSlateColor& InHoveredForeground
)

  
Public function FButtonStyle &

SetHoveredSound ( const FSlateSound& InHoveredSound
)

  
Public function FButtonStyle &

SetNormal ( const FSlateBrush& InNormal
)

  
Public function FButtonStyle &

SetNormalForeground ( const FSlateColor& InNormalForeground
)

  
Public function FButtonStyle &

SetNormalPadding ( const FMargin& InNormalPadding
)

  
Public function FButtonStyle &

SetPressed ( const FSlateBrush& InPressed
)

  
Public function FButtonStyle &

SetPressedForeground ( const FSlateColor& InPressedForeground
)

  
Public function FButtonStyle &

SetPressedPadding ( const FMargin& InPressedPadding
)

  
Public function FButtonStyle &

SetPressedSound ( const FSlateSound& InPressedSound
)

  
Public function void Unlinks all colors in this style.

Overridden from FSlateWidgetStyle

  Type Name Description
Public function Virtual Const void

GetResources ( TArray< const FSlateBrush* >& OutBrushes
)

 Gets the brush resources associated with this style.
Public function Virtual Const const FName Gets the name of this style.This method must be implemented by inherited structures.

Constants

Name Description
TypeName  

Deprecated Variables

  Type Name Description
Public variable FName HoveredSound_DEPRECATED  
Public variable FName PressedSound_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page