1. Epic GamesDeveloper
  3. FCheckBoxStyle

FCheckBoxStyle

Represents the appearance of an SCheckBox

API > API/Runtime > API/Runtime/SlateCore

Represents the appearance of an SCheckBox

   
Name FCheckBoxStyle
Type struct
Header File /Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h
Include Path #include "Styling/SlateTypes.h"

Syntax

USTRUCT (BlueprintType )  
struct FCheckBoxStyle : public FSlateWidgetStyle

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Styling/SlateTypes.h  
  Styling/SlateTypes.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FCheckBoxStyle()

   Styling/SlateTypes.h  

Constants

Name Type Remarks Include Path
TypeName const FName   Styling/SlateTypes.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BackgroundHoveredImage FSlateBrush Background appearance when hovered Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
BackgroundImage FSlateBrush Background appearance Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
BackgroundPressedImage FSlateBrush Background appearance when pressed Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
BorderBackgroundColor FSlateColor BorderBackgroundColor refers to the actual color and opacity of the supplied border image on toggle buttons Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
CheckBoxType TEnumAsByte< ESlateCheckBoxType::Type > The visual type of the checkbox Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
CheckedForeground FSlateColor Foreground Color when checked Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=Appearance
CheckedHoveredForeground FSlateColor Foreground Color when checked and pressed Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=Appearance
CheckedHoveredImage FSlateBrush CheckBox appearance when checked and hovered Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
CheckedImage FSlateBrush CheckBox appearance when the CheckBox is checked Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
CheckedPressedForeground FSlateColor Foreground Color when checked and pressed Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=Appearance
CheckedPressedImage FSlateBrush CheckBox appearance when checked and pressed Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
CheckedSlateSound FSlateSound The sound the check box should play when checked Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sound
  • Meta=(DisplayName="Checked Sound")
ForegroundColor FSlateColor The normal unchecked foreground color Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
HoveredForeground FSlateColor Foreground Color when hovered Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=Appearance
HoveredSlateSound FSlateSound The sound the check box should play when initially hovered over Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sound
  • Meta=(DisplayName="Hovered Sound")
Padding FMargin Padding Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
PressedForeground FSlateColor Foreground Color when pressed Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=Appearance
UncheckedHoveredImage FSlateBrush CheckBox appearance when the CheckBox is unchecked and hovered Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
UncheckedImage FSlateBrush CheckBox appearance when the CheckBox is unchecked (normal) Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
UncheckedPressedImage FSlateBrush CheckBox appearance when the CheckBox is unchecked and hovered Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
UncheckedSlateSound FSlateSound The sound the check box should play when unchecked Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sound
  • Meta=(DisplayName="Unchecked Sound")
UndeterminedForeground FSlateColor Foreground Color when the check state is indeterminate Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category=Appearance
UndeterminedHoveredImage FSlateBrush CheckBox appearance when CheckBox is undetermined and hovered Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
UndeterminedImage FSlateBrush CheckBox appearance when the CheckBox is undetermined Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance
UndeterminedPressedImage FSlateBrush CheckBox appearance when CheckBox is undetermined and pressed Styling/SlateTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Appearance

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  

FCheckBoxStyle & SetBackgroundHoveredImage ( const FSlateBrush& InBackgroundHoveredImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetBackgroundImage ( const FSlateBrush& InBackgroundImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetBackgroundPressedImage ( const FSlateBrush& InBackgroundPressedImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetBorderBackgroundColor ( const FSlateColor& InBorderBackgroundColor
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetCheckBoxType ( ESlateCheckBoxType::Type InCheckBoxType
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetCheckedForegroundColor ( const FSlateColor& InCheckedForeground
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetCheckedHoveredForegroundColor ( const FSlateColor& InCheckedHoveredForeground
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetCheckedHoveredImage ( const FSlateBrush& InCheckedHoveredImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetCheckedImage ( const FSlateBrush& InCheckedImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetCheckedPressedForegroundColor ( const FSlateColor& InCheckedPressedForeground
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetCheckedPressedImage ( const FSlateBrush& InCheckedPressedImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetCheckedSound ( const FSlateSound& InCheckedSound
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetForegroundColor ( const FSlateColor& InForegroundColor
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetHoveredForegroundColor ( const FSlateColor& InHoveredForeground
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetHoveredSound ( const FSlateSound& InHoveredSound
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetPadding ( const FMargin& InPadding
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetPressedForegroundColor ( const FSlateColor& InPressedForeground
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetUncheckedHoveredImage ( const FSlateBrush& InUncheckedHoveredImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetUncheckedImage ( const FSlateBrush& InUncheckedImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetUncheckedPressedImage ( const FSlateBrush& InUncheckedPressedImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetUncheckedSound ( const FSlateSound& InUncheckedSound
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetUndeterminedForegroundColor ( const FSlateColor& InUndeterminedForeground
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetUndeterminedHoveredImage ( const FSlateBrush& InUndeterminedHoveredImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetUndeterminedImage ( const FSlateBrush& InUndeterminedImage
)

   Styling/SlateTypes.h  

FCheckBoxStyle & SetUndeterminedPressedImage ( const FSlateBrush& InUndeterminedPressedImage
)

   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
) const

 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 FCheckBoxStyle & GetDefault()

   Styling/SlateTypes.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
CheckedSound_DEPRECATED FName   Styling/SlateTypes.h  
HoveredSound_DEPRECATED FName   Styling/SlateTypes.h  
UncheckedSound_DEPRECATED FName   Styling/SlateTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page