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 > Slate > Widgets > Input > SCheckBox

Light Theme

Dark Theme

SCheckBox

Check box Slate control

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SCheckBox

SNiagaraSourceFilterCheckBox

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Input/SCheckBox.h
Include	#include "Widgets/Input/SCheckBox.h"

Syntax

class SCheckBox : public SCompoundWidget

Remarks

Check box Slate control

Variables

	Name	Description
const FSlateBru...	BackgroundHoveredImage	Image to use for the checkbox background when hovered
const FSlateBru...	BackgroundImage	Image to use for the checkbox background
const FSlateBru...	BackgroundPressedImage	Image to use for the checkbox background when pressed
bool	bCheckBoxContentUsesAutoWidth	Whether or not the checkbox content is arranged using auto-width when in checkbox mode.
bool	bIsFocusable	When true, this checkbox will be keyboard focusable. Defaults to true.
bool	bIsPressed	True if this check box is currently in a pressed state
TAttribute< FSl...	BorderBackgroundColorOverride	Overrides border background color in the widget style, if set
TOptional< ESla...	CheckBoxTypeOverride	Overrides checkbox type in the widget style, if set
const FSlateBru...	CheckedHoveredImage	Image to use when the checkbox is checked and hovered
const FSlateBru...	CheckedImage	Image to use when the checkbox is checked
const FSlateBru...	CheckedPressedImage	Image to use when the checkbox is checked and pressed
FSlateSound	CheckedSound	The Sound to play when the check box is checked
EButtonClickMet...	ClickMethod	Sets whether a click should be triggered on mouse down, mouse up, or that both a mouse down and up are required.
TSharedPtr< SBo...	ContentContainer	When in toggle button mode, this will hold the pointer to the toggle button's border
TAttribute< FSl...	ForegroundColorOverride	Overrides foreground color in the widget style, if set
EHorizontalAlig...	HorizontalAlignment	Horiz align setting if in togglebox mode
FSlateSound	HoveredSound	The Sound to play when the check box is hovered
TAttribute< ECh...	IsCheckboxChecked	Are we checked
FOnCheckStateCh...	OnCheckStateChanged	Delegate called when the check box changes state
FOnGetContent	OnGetMenuContent	Delegate to execute to get the menu content of this button
TAttribute< FMa...	PaddingOverride	Overrides padding in the widget style, if set
TEnumAsByte< EB...	PressMethod	How should the button be clicked with keyboard/controller button events?
const FCheckBox...	Style
TEnumAsByte< EB...	TouchMethod	How should the button be clicked with touch events?
const FSlateBru...	UncheckedHoveredImage	Image to use when the checkbox is unchecked and hovered
const FSlateBru...	UncheckedImage	Image to use when the checkbox is unchecked
const FSlateBru...	UncheckedPressedImage	Image to use when the checkbox is unchecked and pressed
FSlateSound	UncheckedSound	The Sound to play when the check box is unchecked
const FSlateBru...	UndeterminedHoveredImage	Image to use when the checkbox is in an ambiguous state and hovered
const FSlateBru...	UndeterminedImage	Image to use when the checkbox is in an ambiguous state
const FSlateBru...	UndeterminedPressedImage	Image to use when the checkbox is in an ambiguous state and pressed

Constructors

	Name	Description
	SCheckBox()

Functions

	Name	Description
void	BuildCheckBox ( TSharedRef< SWidget > InContent )	Rebuilds the checkbox based on the current ESlateCheckBoxType
void	Construct ( const FArguments& InArgs )	Construct this widget
const FSlate...	GetBackgroundHoveredImage()
const FSlate...	GetBackgroundImage()
const FSlate...	GetBackgroundPressedImage()
const FSlate...	GetCheckedHoveredImage()
const FSlate...	GetCheckedImage()
const FSlate...	GetCheckedPressedImage()
ECheckBoxSta...	GetCheckedState()
TEnumAsByte<...	GetClickMethodFromInputType ( const FPointerEvent& MouseEvent )	Utility function to translate other input click methods to regular ones.
const FSlate...	GetUncheckedHoveredImage()
const FSlate...	GetUncheckedImage()
const FSlate...	GetUncheckedPressedImage()
const FSlate...	GetUndeterminedHoveredImage()
const FSlate...	GetUndeterminedImage()
const FSlate...	GetUndeterminedPressedImage()
bool	IsChecked()	Returns true if the checkbox is currently checked
bool	IsPreciseTapOrClick ( const FPointerEvent& MouseEvent )	Utility function to determine if the incoming mouse event is for a precise tap or click
bool	IsPressed()	Returns true if this button is currently pressed
const FSlate...	OnGetBackgroundImage()	Attribute getter for the background image
FSlateColor	OnGetBorderBackgroundColor()	Attribute getter for the border background color
ESlateCheckB...	OnGetCheckBoxType()	Attribute getter for the checkbox type
const FSlate...	OnGetCheckImage()	Gets the check image to display for the current state of the check box
FMargin	OnGetPadding()	Attribute getter for the padding
void	PlayCheckedSound()	Play the checked sound
void	PlayHoverSound()	Play the hovered sound
void	PlayUncheckedSound()	Play the unchecked sound
void	SetCheckedHoveredImage ( const FSlateBrush* Brush )	See the CheckedHoveredImage attribute
void	SetCheckedImage ( const FSlateBrush* Brush )	See the CheckedImage attribute
void	SetCheckedPressedImage ( const FSlateBrush* Brush )	See the CheckedPressedImage attribute
void	SetClickMethod ( EButtonClickMethod::Type InClickMet... )
void	SetContent ( const TSharedRef< SWidget >& InCon... )	See the Content slot
void	SetIsChecked ( TAttribute< ECheckBoxState > InIsCh... )	See the IsChecked attribute
void	SetPressMethod ( EButtonPressMethod::Type InPressMet... )
void	SetStyle ( const FCheckBoxStyle* InStyle )	See the Style attribute
void	SetTouchMethod ( EButtonTouchMethod::Type InTouchMet... )
void	SetUncheckedHoveredImage ( const FSlateBrush* Brush )	See the UncheckedHoveredImage attribute
void	SetUncheckedImage ( const FSlateBrush* Brush )	See the UncheckedImage attribute
void	SetUncheckedPressedImage ( const FSlateBrush* Brush )	See the UncheckedPressedImage attribute
void	SetUndeterminedHoveredImage ( const FSlateBrush* Brush )	See the UndeterminedHoveredImage attribute
void	SetUndeterminedImage ( const FSlateBrush* Brush )	See the UndeterminedImage attribute
void	SetUndeterminedPressedImage ( const FSlateBrush* Brush )	See the UndeterminedPressedImage attribute
void	ToggleCheckedState()	Toggles the checked state for this check box, fire events as needed

Overridden from SWidget

	Name	Description
TSharedRef< ...	CreateAccessibleWidget()
FSlateColor	GetForegroundColor()
bool	IsInteractable()
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
FReply	OnKeyUp ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is released when this widget has focus
FReply	OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent )	See SWidget::OnMouseButtonDoubleClick.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	See SWidget::OnMouseButtonDown.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	See SWidget::OnMouseButtonUp.
void	OnMouseEnter ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has entered it.
void	OnMouseLeave ( const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has left it.
bool	SupportsKeyboardFocus()	See SWidget::SupportsKeyboardFocus().

Classes

	Name	Description
	FArguments