Navigation
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
- FSlateWidgetStyle → FCheckBoxStyle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Styling/SlateTypes.h | |||
FCheckBoxStyle
(
const FCheckBoxStyle& |
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 |
|
| BackgroundImage | FSlateBrush | Background appearance | Styling/SlateTypes.h |
|
| BackgroundPressedImage | FSlateBrush | Background appearance when pressed | Styling/SlateTypes.h |
|
| BorderBackgroundColor | FSlateColor | BorderBackgroundColor refers to the actual color and opacity of the supplied border image on toggle buttons | Styling/SlateTypes.h |
|
| CheckBoxType | TEnumAsByte< ESlateCheckBoxType::Type > | The visual type of the checkbox | Styling/SlateTypes.h |
|
| CheckedForeground | FSlateColor | Foreground Color when checked | Styling/SlateTypes.h |
|
| CheckedHoveredForeground | FSlateColor | Foreground Color when checked and pressed | Styling/SlateTypes.h |
|
| CheckedHoveredImage | FSlateBrush | CheckBox appearance when checked and hovered | Styling/SlateTypes.h |
|
| CheckedImage | FSlateBrush | CheckBox appearance when the CheckBox is checked | Styling/SlateTypes.h |
|
| CheckedPressedForeground | FSlateColor | Foreground Color when checked and pressed | Styling/SlateTypes.h |
|
| CheckedPressedImage | FSlateBrush | CheckBox appearance when checked and pressed | Styling/SlateTypes.h |
|
| CheckedSlateSound | FSlateSound | The sound the check box should play when checked | Styling/SlateTypes.h |
|
| ForegroundColor | FSlateColor | The normal unchecked foreground color | Styling/SlateTypes.h |
|
| HoveredForeground | FSlateColor | Foreground Color when hovered | Styling/SlateTypes.h |
|
| HoveredSlateSound | FSlateSound | The sound the check box should play when initially hovered over | Styling/SlateTypes.h |
|
| Padding | FMargin | Padding | Styling/SlateTypes.h |
|
| PressedForeground | FSlateColor | Foreground Color when pressed | Styling/SlateTypes.h |
|
| UncheckedHoveredImage | FSlateBrush | CheckBox appearance when the CheckBox is unchecked and hovered | Styling/SlateTypes.h |
|
| UncheckedImage | FSlateBrush | CheckBox appearance when the CheckBox is unchecked (normal) | Styling/SlateTypes.h |
|
| UncheckedPressedImage | FSlateBrush | CheckBox appearance when the CheckBox is unchecked and hovered | Styling/SlateTypes.h |
|
| UncheckedSlateSound | FSlateSound | The sound the check box should play when unchecked | Styling/SlateTypes.h |
|
| UndeterminedForeground | FSlateColor | Foreground Color when the check state is indeterminate | Styling/SlateTypes.h |
|
| UndeterminedHoveredImage | FSlateBrush | CheckBox appearance when CheckBox is undetermined and hovered | Styling/SlateTypes.h |
|
| UndeterminedImage | FSlateBrush | CheckBox appearance when the CheckBox is undetermined | Styling/SlateTypes.h |
|
| UndeterminedPressedImage | FSlateBrush | CheckBox appearance when CheckBox is undetermined and 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 | |
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 |
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 |