FCheckBoxStyle Struct Reference

#include <SlateTypes.h>

Inheritance diagram for FCheckBoxStyle:

Public Member Functions
SLATECORE_API	FCheckBoxStyle ()
SLATECORE_API	FCheckBoxStyle (const FCheckBoxStyle &)
virtual SLATECORE_API	~FCheckBoxStyle ()
virtual SLATECORE_API void	GetResources (TArray< const FSlateBrush * > &OutBrushes) const override
virtual const FName	GetTypeName () const override
FCheckBoxStyle &	SetCheckBoxType (ESlateCheckBoxType::Type InCheckBoxType)
FCheckBoxStyle &	SetUncheckedImage (const FSlateBrush &InUncheckedImage)
FCheckBoxStyle &	SetUncheckedHoveredImage (const FSlateBrush &InUncheckedHoveredImage)
FCheckBoxStyle &	SetUncheckedPressedImage (const FSlateBrush &InUncheckedPressedImage)
FCheckBoxStyle &	SetCheckedImage (const FSlateBrush &InCheckedImage)
FCheckBoxStyle &	SetCheckedHoveredImage (const FSlateBrush &InCheckedHoveredImage)
FCheckBoxStyle &	SetCheckedPressedImage (const FSlateBrush &InCheckedPressedImage)
FCheckBoxStyle &	SetUndeterminedImage (const FSlateBrush &InUndeterminedImage)
FCheckBoxStyle &	SetUndeterminedHoveredImage (const FSlateBrush &InUndeterminedHoveredImage)
FCheckBoxStyle &	SetUndeterminedPressedImage (const FSlateBrush &InUndeterminedPressedImage)
FCheckBoxStyle &	SetPadding (const FMargin &InPadding)
FCheckBoxStyle &	SetBackgroundImage (const FSlateBrush &InBackgroundImage)
FCheckBoxStyle &	SetBackgroundHoveredImage (const FSlateBrush &InBackgroundHoveredImage)
FCheckBoxStyle &	SetBackgroundPressedImage (const FSlateBrush &InBackgroundPressedImage)
FCheckBoxStyle &	SetForegroundColor (const FSlateColor &InForegroundColor)
FCheckBoxStyle &	SetHoveredForegroundColor (const FSlateColor &InHoveredForeground)
FCheckBoxStyle &	SetPressedForegroundColor (const FSlateColor &InPressedForeground)
FCheckBoxStyle &	SetCheckedForegroundColor (const FSlateColor &InCheckedForeground)
FCheckBoxStyle &	SetCheckedHoveredForegroundColor (const FSlateColor &InCheckedHoveredForeground)
FCheckBoxStyle &	SetCheckedPressedForegroundColor (const FSlateColor &InCheckedPressedForeground)
FCheckBoxStyle &	SetUndeterminedForegroundColor (const FSlateColor &InUndeterminedForeground)
FCheckBoxStyle &	SetBorderBackgroundColor (const FSlateColor &InBorderBackgroundColor)
FCheckBoxStyle &	SetCheckedSound (const FSlateSound &InCheckedSound)
FCheckBoxStyle &	SetUncheckedSound (const FSlateSound &InUncheckedSound)
FCheckBoxStyle &	SetHoveredSound (const FSlateSound &InHoveredSound)
void	UnlinkColors ()
Public Member Functions inherited from FSlateWidgetStyle
SLATECORE_API	FSlateWidgetStyle ()
virtual SLATECORE_API	~FSlateWidgetStyle ()

Static Public Member Functions
static SLATECORE_API const FCheckBoxStyle &	GetDefault ()

Public Attributes
TEnumAsByte< ESlateCheckBoxType::Type >	CheckBoxType
FSlateBrush	UncheckedImage
FSlateBrush	UncheckedHoveredImage
FSlateBrush	UncheckedPressedImage
FSlateBrush	CheckedImage
FSlateBrush	CheckedHoveredImage
FSlateBrush	CheckedPressedImage
FSlateBrush	UndeterminedImage
FSlateBrush	UndeterminedHoveredImage
FSlateBrush	UndeterminedPressedImage
FMargin	Padding
FSlateBrush	BackgroundImage
FSlateBrush	BackgroundHoveredImage
FSlateBrush	BackgroundPressedImage
FSlateColor	ForegroundColor
FSlateColor	HoveredForeground
FSlateColor	PressedForeground
FSlateColor	CheckedForeground
FSlateColor	CheckedHoveredForeground
FSlateColor	CheckedPressedForeground
FSlateColor	UndeterminedForeground
FSlateColor	BorderBackgroundColor
FSlateSound	CheckedSlateSound
FSlateSound	UncheckedSlateSound
FSlateSound	HoveredSlateSound

Static Public Attributes
static SLATECORE_API const FName	TypeName

Detailed Description

Represents the appearance of an SCheckBox

Constructor & Destructor Documentation

FCheckBoxStyle() [1/2]

FCheckBoxStyle::FCheckBoxStyle

(

)

FCheckBoxStyle() [2/2]

FCheckBoxStyle::FCheckBoxStyle ( const FCheckBoxStyle &  )

default

~FCheckBoxStyle()

FCheckBoxStyle::~FCheckBoxStyle ( )

virtualdefault

Member Function Documentation

GetDefault()

const FCheckBoxStyle & FCheckBoxStyle::GetDefault ( )

static

GetResources()

void FCheckBoxStyle::GetResources ( TArray< const FSlateBrush * > &  OutBrushes ) const

overridevirtual

Gets the brush resources associated with this style.

This method must be implemented by inherited structures.

Parameters

OutBrushes

The brush resources.

Reimplemented from FSlateWidgetStyle.

GetTypeName()

virtual const FName FCheckBoxStyle::GetTypeName ( ) const

inlineoverridevirtual

Gets the name of this style.

This method must be implemented by inherited structures.

Returns

Widget style name.

Reimplemented from FSlateWidgetStyle.

SetBackgroundHoveredImage()

FCheckBoxStyle & FCheckBoxStyle::SetBackgroundHoveredImage ( const FSlateBrush &  InBackgroundHoveredImage )

inline

SetBackgroundImage()

FCheckBoxStyle & FCheckBoxStyle::SetBackgroundImage ( const FSlateBrush &  InBackgroundImage )

inline

SetBackgroundPressedImage()

FCheckBoxStyle & FCheckBoxStyle::SetBackgroundPressedImage ( const FSlateBrush &  InBackgroundPressedImage )

inline

SetBorderBackgroundColor()

FCheckBoxStyle & FCheckBoxStyle::SetBorderBackgroundColor ( const FSlateColor &  InBorderBackgroundColor )

inline

SetCheckBoxType()

FCheckBoxStyle & FCheckBoxStyle::SetCheckBoxType ( ESlateCheckBoxType::Type  InCheckBoxType )

inline

SetCheckedForegroundColor()

FCheckBoxStyle & FCheckBoxStyle::SetCheckedForegroundColor ( const FSlateColor &  InCheckedForeground )

inline

SetCheckedHoveredForegroundColor()

FCheckBoxStyle & FCheckBoxStyle::SetCheckedHoveredForegroundColor ( const FSlateColor &  InCheckedHoveredForeground )

inline

SetCheckedHoveredImage()

FCheckBoxStyle & FCheckBoxStyle::SetCheckedHoveredImage ( const FSlateBrush &  InCheckedHoveredImage )

inline

SetCheckedImage()

FCheckBoxStyle & FCheckBoxStyle::SetCheckedImage ( const FSlateBrush &  InCheckedImage )

inline

SetCheckedPressedForegroundColor()

FCheckBoxStyle & FCheckBoxStyle::SetCheckedPressedForegroundColor ( const FSlateColor &  InCheckedPressedForeground )

inline

SetCheckedPressedImage()

FCheckBoxStyle & FCheckBoxStyle::SetCheckedPressedImage ( const FSlateBrush &  InCheckedPressedImage )

inline

SetCheckedSound()

FCheckBoxStyle & FCheckBoxStyle::SetCheckedSound ( const FSlateSound &  InCheckedSound )

inline

SetForegroundColor()

FCheckBoxStyle & FCheckBoxStyle::SetForegroundColor ( const FSlateColor &  InForegroundColor )

inline

SetHoveredForegroundColor()

FCheckBoxStyle & FCheckBoxStyle::SetHoveredForegroundColor ( const FSlateColor &  InHoveredForeground )

inline

SetHoveredSound()

FCheckBoxStyle & FCheckBoxStyle::SetHoveredSound ( const FSlateSound &  InHoveredSound )

inline

SetPadding()

FCheckBoxStyle & FCheckBoxStyle::SetPadding ( const FMargin &  InPadding )

inline

SetPressedForegroundColor()

FCheckBoxStyle & FCheckBoxStyle::SetPressedForegroundColor ( const FSlateColor &  InPressedForeground )

inline

SetUncheckedHoveredImage()

FCheckBoxStyle & FCheckBoxStyle::SetUncheckedHoveredImage ( const FSlateBrush &  InUncheckedHoveredImage )

inline

SetUncheckedImage()

FCheckBoxStyle & FCheckBoxStyle::SetUncheckedImage ( const FSlateBrush &  InUncheckedImage )

inline

SetUncheckedPressedImage()

FCheckBoxStyle & FCheckBoxStyle::SetUncheckedPressedImage ( const FSlateBrush &  InUncheckedPressedImage )

inline

SetUncheckedSound()

FCheckBoxStyle & FCheckBoxStyle::SetUncheckedSound ( const FSlateSound &  InUncheckedSound )

inline

SetUndeterminedForegroundColor()

FCheckBoxStyle & FCheckBoxStyle::SetUndeterminedForegroundColor ( const FSlateColor &  InUndeterminedForeground )

inline

SetUndeterminedHoveredImage()

FCheckBoxStyle & FCheckBoxStyle::SetUndeterminedHoveredImage ( const FSlateBrush &  InUndeterminedHoveredImage )

inline

SetUndeterminedImage()

FCheckBoxStyle & FCheckBoxStyle::SetUndeterminedImage ( const FSlateBrush &  InUndeterminedImage )

inline

SetUndeterminedPressedImage()

FCheckBoxStyle & FCheckBoxStyle::SetUndeterminedPressedImage ( const FSlateBrush &  InUndeterminedPressedImage )

inline

UnlinkColors()

void FCheckBoxStyle::UnlinkColors ( )

inline

Unlinks all colors in this style.

See also

FSlateColor::Unlink

Member Data Documentation

BackgroundHoveredImage

FSlateBrush FCheckBoxStyle::BackgroundHoveredImage

Background appearance when hovered

BackgroundImage

FSlateBrush FCheckBoxStyle::BackgroundImage

Background appearance

BackgroundPressedImage

FSlateBrush FCheckBoxStyle::BackgroundPressedImage

Background appearance when pressed

BorderBackgroundColor

FSlateColor FCheckBoxStyle::BorderBackgroundColor

BorderBackgroundColor refers to the actual color and opacity of the supplied border image on toggle buttons

CheckBoxType

TEnumAsByte<ESlateCheckBoxType::Type> FCheckBoxStyle::CheckBoxType

The visual type of the checkbox

CheckedForeground

FSlateColor FCheckBoxStyle::CheckedForeground

Foreground Color when checked

CheckedHoveredForeground

FSlateColor FCheckBoxStyle::CheckedHoveredForeground

Foreground Color when checked and pressed

CheckedHoveredImage

FSlateBrush FCheckBoxStyle::CheckedHoveredImage

CheckedImage

FSlateBrush FCheckBoxStyle::CheckedImage

CheckedPressedForeground

FSlateColor FCheckBoxStyle::CheckedPressedForeground

Foreground Color when checked and pressed

CheckedPressedImage

FSlateBrush FCheckBoxStyle::CheckedPressedImage

CheckedSlateSound

FSlateSound FCheckBoxStyle::CheckedSlateSound

The sound the check box should play when checked

ForegroundColor

FSlateColor FCheckBoxStyle::ForegroundColor

The normal unchecked foreground color

HoveredForeground

FSlateColor FCheckBoxStyle::HoveredForeground

Foreground Color when hovered

HoveredSlateSound

FSlateSound FCheckBoxStyle::HoveredSlateSound

The sound the check box should play when initially hovered over

Padding

FMargin FCheckBoxStyle::Padding

Padding

PressedForeground

FSlateColor FCheckBoxStyle::PressedForeground

Foreground Color when pressed

TypeName

const FName FCheckBoxStyle::TypeName

static

UncheckedHoveredImage

FSlateBrush FCheckBoxStyle::UncheckedHoveredImage

UncheckedImage

FSlateBrush FCheckBoxStyle::UncheckedImage

UncheckedPressedImage

FSlateBrush FCheckBoxStyle::UncheckedPressedImage

UncheckedSlateSound

FSlateSound FCheckBoxStyle::UncheckedSlateSound

The sound the check box should play when unchecked

UndeterminedForeground

FSlateColor FCheckBoxStyle::UndeterminedForeground

Foreground Color when the check state is indeterminate

UndeterminedHoveredImage

FSlateBrush FCheckBoxStyle::UndeterminedHoveredImage

UndeterminedImage

FSlateBrush FCheckBoxStyle::UndeterminedImage

UndeterminedPressedImage

FSlateBrush FCheckBoxStyle::UndeterminedPressedImage

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/SlateCore/Public/Styling/SlateTypes.h
• Engine/Source/Runtime/SlateCore/Private/Styling/SlateTypes.cpp