Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Styling > FCheckBoxStyle

Light Theme

Dark Theme

FCheckBoxStyle

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

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateWidgetStyle

FCheckBoxStyle

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

	Name	Description
FSlateColor	BorderBackgroundColor	BorderBackgroundColor refers to the actual color and opacity of the supplied border image on toggle buttons
TEnumAsByte< ES...	CheckBoxType	The visual type of the checkbox
FSlateBrush	CheckedHoveredImage	CheckBox appearance when checked and hovered
FSlateBrush	CheckedImage	CheckBox appearance when the CheckBox is checked
FSlateBrush	CheckedPressedImage	CheckBox appearance when checked and pressed
FSlateSound	CheckedSlateSound	The sound the check box should play when checked
FSlateColor	ForegroundColor	The foreground color
FSlateSound	HoveredSlateSound	The sound the check box should play when initially hovered over
FMargin	Padding	Padding
FSlateBrush	UncheckedHoveredImage	CheckBox appearance when the CheckBox is unchecked and hovered
FSlateBrush	UncheckedImage	CheckBox appearance when the CheckBox is unchecked (normal)
FSlateBrush	UncheckedPressedImage	CheckBox appearance when the CheckBox is unchecked and hovered
FSlateSound	UncheckedSlateSound	The sound the check box should play when unchecked
FSlateBrush	UndeterminedHoveredImage	CheckBox appearance when CheckBox is undetermined and hovered
FSlateBrush	UndeterminedImage	CheckBox appearance when the CheckBox is undetermined
FSlateBrush	UndeterminedPressedImage	CheckBox appearance when CheckBox is undetermined and pressed

Constructors

	Name	Description
	FCheckBoxStyle()

Destructors

	Name	Description
	~FCheckBoxStyle()

Functions

	Name	Description
const FCheck...	GetDefault()
void	PostSerialize ( const FArchive& Ar )	Used to upgrade the deprecated FName sound properties into the new-style FSlateSound properties
FCheckBoxSty...	SetBorderBackgroundColor ( const FSlateColor& InBorderBackgro... )
FCheckBoxSty...	SetCheckBoxType ( ESlateCheckBoxType::Type InCheckBox... )
FCheckBoxSty...	SetCheckedHoveredImage ( const FSlateBrush& InCheckedHovere... )
FCheckBoxSty...	SetCheckedImage ( const FSlateBrush& InCheckedImage )
FCheckBoxSty...	SetCheckedPressedImage ( const FSlateBrush& InCheckedPresse... )
FCheckBoxSty...	SetCheckedSound ( const FSlateSound& InCheckedSound )
FCheckBoxSty...	SetForegroundColor ( const FSlateColor& InForegroundCol... )
FCheckBoxSty...	SetHoveredSound ( const FSlateSound& InHoveredSound )
FCheckBoxSty...	SetPadding ( const FMargin& InPadding )
FCheckBoxSty...	SetUncheckedHoveredImage ( const FSlateBrush& InUncheckedHove... )
FCheckBoxSty...	SetUncheckedImage ( const FSlateBrush& InUncheckedImag... )
FCheckBoxSty...	SetUncheckedPressedImage ( const FSlateBrush& InUncheckedPres... )
FCheckBoxSty...	SetUncheckedSound ( const FSlateSound& InUncheckedSoun... )
FCheckBoxSty...	SetUndeterminedHoveredImage ( const FSlateBrush& InUndeterminedH... )
FCheckBoxSty...	SetUndeterminedImage ( const FSlateBrush& InUndeterminedI... )
FCheckBoxSty...	SetUndeterminedPressedImage ( const FSlateBrush& InUndeterminedP... )
void	UnlinkColors()	Unlinks all colors in this style.

Overridden from FSlateWidgetStyle

		Name	Description
	void	GetResources ( TArray< const FSlateBrush* >&... )	Gets the brush resources associated with this style.
	const FName	GetTypeName()	Gets the name of this style. This method must be implemented by inherited structures.

Name

Description

void

GetResources

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

Gets the brush resources associated with this style.

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
	FName	CheckedSound_DEPRECATED
	FName	HoveredSound_DEPRECATED
	FName	UncheckedSound_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