1. Epic GamesDeveloper
  3. FCheckBoxStyle

FCheckBoxStyle

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

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 FCheckBoxStyle : public FSlateWidgetStyle

Remarks

Represents the appearance of an SCheckBox

Variables

  Type Name Description
Public variable FSlateBrush BackgroundHoveredImage Background appearance when hovered
Public variable FSlateBrush BackgroundImage Background appearance
Public variable FSlateBrush BackgroundPressedImage Background appearance when pressed
Public variable FSlateColor BorderBackgroundColor BorderBackgroundColor refers to the actual color and opacity of the supplied border image on toggle buttons
Public variable TEnumAsByte< ESlateCheckBoxType::Type > CheckBoxType The visual type of the checkbox
Public variable FSlateColor CheckedForeground Foreground Color when checked
Public variable FSlateColor CheckedHoveredForeground Foreground Color when checked and pressed
Public variable FSlateBrush CheckedHoveredImage CheckBox appearance when checked and hovered
Public variable FSlateBrush CheckedImage CheckBox appearance when the CheckBox is checked
Public variable FSlateColor CheckedPressedForeground Foreground Color when checked and pressed
Public variable FSlateBrush CheckedPressedImage CheckBox appearance when checked and pressed
Public variable FSlateSound CheckedSlateSound The sound the check box should play when checked
Public variable FSlateColor ForegroundColor The normal unchecked foreground color
Public variable FSlateColor HoveredForeground Foreground Color when hovered
Public variable FSlateSound HoveredSlateSound The sound the check box should play when initially hovered over
Public variable FMargin Padding Padding
Public variable FSlateColor PressedForeground Foreground Color when pressed
Public variable FSlateBrush UncheckedHoveredImage CheckBox appearance when the CheckBox is unchecked and hovered
Public variable FSlateBrush UncheckedImage CheckBox appearance when the CheckBox is unchecked (normal)
Public variable FSlateBrush UncheckedPressedImage CheckBox appearance when the CheckBox is unchecked and hovered
Public variable FSlateSound UncheckedSlateSound The sound the check box should play when unchecked
Public variable FSlateColor UndeterminedForeground Foreground Color when the check state is indeterminate
Public variable FSlateBrush UndeterminedHoveredImage CheckBox appearance when CheckBox is undetermined and hovered
Public variable FSlateBrush UndeterminedImage CheckBox appearance when the CheckBox is undetermined
Public variable FSlateBrush UndeterminedPressedImage CheckBox appearance when CheckBox is undetermined and pressed

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static const FCheckBoxStyle &  
Public function void

PostSerialize ( const FArchive& Ar
)

 Used to upgrade the deprecated FName sound properties into the new-style FSlateSound properties
Public function FCheckBoxStyle &

SetBackgroundHoveredImage ( const FSlateBrush& InBackgroundHoveredImage
)

  
Public function FCheckBoxStyle &

SetBackgroundImage ( const FSlateBrush& InBackgroundImage
)

  
Public function FCheckBoxStyle &

SetBackgroundPressedImage ( const FSlateBrush& InBackgroundPressedImage
)

  
Public function FCheckBoxStyle &

SetBorderBackgroundColor ( const FSlateColor& InBorderBackgroundColor
)

  
Public function FCheckBoxStyle &  
Public function FCheckBoxStyle &

SetCheckedForegroundColor ( const FSlateColor& InCheckedForeground
)

  
Public function FCheckBoxStyle &

SetCheckedHoveredForegroundColor ( const FSlateColor& InCheckedHoveredForeground
)

  
Public function FCheckBoxStyle &

SetCheckedHoveredImage ( const FSlateBrush& InCheckedHoveredImage
)

  
Public function FCheckBoxStyle &

SetCheckedImage ( const FSlateBrush& InCheckedImage
)

  
Public function FCheckBoxStyle &

SetCheckedPressedForegroundColor ( const FSlateColor& InCheckedPressedForeground
)

  
Public function FCheckBoxStyle &

SetCheckedPressedImage ( const FSlateBrush& InCheckedPressedImage
)

  
Public function FCheckBoxStyle &

SetCheckedSound ( const FSlateSound& InCheckedSound
)

  
Public function FCheckBoxStyle &

SetForegroundColor ( const FSlateColor& InForegroundColor
)

  
Public function FCheckBoxStyle &

SetHoveredForegroundColor ( const FSlateColor& InHoveredForeground
)

  
Public function FCheckBoxStyle &

SetHoveredSound ( const FSlateSound& InHoveredSound
)

  
Public function FCheckBoxStyle &

SetPadding ( const FMargin& InPadding
)

  
Public function FCheckBoxStyle &

SetPressedForegroundColor ( const FSlateColor& InPressedForeground
)

  
Public function FCheckBoxStyle &

SetUncheckedHoveredImage ( const FSlateBrush& InUncheckedHoveredImage
)

  
Public function FCheckBoxStyle &

SetUncheckedImage ( const FSlateBrush& InUncheckedImage
)

  
Public function FCheckBoxStyle &

SetUncheckedPressedImage ( const FSlateBrush& InUncheckedPressedImage
)

  
Public function FCheckBoxStyle &

SetUncheckedSound ( const FSlateSound& InUncheckedSound
)

  
Public function FCheckBoxStyle &

SetUndeterminedForegroundColor ( const FSlateColor& InUndeterminedForeground
)

  
Public function FCheckBoxStyle &

SetUndeterminedHoveredImage ( const FSlateBrush& InUndeterminedHoveredImage
)

  
Public function FCheckBoxStyle &

SetUndeterminedImage ( const FSlateBrush& InUndeterminedImage
)

  
Public function FCheckBoxStyle &

SetUndeterminedPressedImage ( const FSlateBrush& InUndeterminedPressedImage
)

  
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 CheckedSound_DEPRECATED  
Public variable FName HoveredSound_DEPRECATED  
Public variable FName UncheckedSound_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page