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 > UMG > Components > UCheckBox

Light Theme

Dark Theme

UCheckBox

The checkbox widget allows you to display a toggled state of 'unchecked', 'checked' and 'indeterminable.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

UCheckBox

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/CheckBox.h
Include	#include "Components/CheckBox.h"

Syntax

class UCheckBox : public UContentWidget

Remarks

The checkbox widget allows you to display a toggled state of 'unchecked', 'checked' and 'indeterminable. You can use the checkbox for a classic checkbox, or as a toggle button, or as radio buttons.

Single Child Toggle

Variables

	Name	Description
ECheckBoxState	CheckedState	Whether the check box is currently in a checked state
FGetCheckBoxSta...	CheckedStateDelegate	A bindable delegate for the IsChecked.
TEnumAsByte< EB...	ClickMethod	The type of mouse action required by the user to trigger the buttons 'Click'
TEnumAsByte< EH...	HorizontalAlignment	How the content of the toggle button should align within the given space
bool	IsFocusable	Sometimes a button should only be mouse-clickable and never keyboard focusable.
ECheckBoxState	K2_Cache_CheckedState
TSharedPtr< SCh...	MyCheckbox
FOnCheckBoxComp...	OnCheckStateChanged	Called when the checked state has changed
TEnumAsByte< EB...	PressMethod	The type of keyboard/gamepad button press action required by the user to trigger the buttons 'Click'
TEnumAsByte< EB...	TouchMethod	The type of touch action required by the user to trigger the buttons 'Click'
FCheckBoxStyle	WidgetStyle	The checkbox bar style

Constructors

	Name	Description
	UCheckBox ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
ECheckBoxSta...	GetCheckedState()	Returns the full current checked state.
bool	IsChecked()	Returns true if the checkbox is currently checked
bool	IsPressed()	Returns true if this button is currently pressed
ECheckBoxSta...	K2_Gate_CheckedState()
void	SetCheckedState ( ECheckBoxState InCheckedState )	Sets the checked state.
void	SetClickMethod ( EButtonClickMethod::Type InClickMet... )
void	SetIsChecked ( bool InIsChecked )	Sets the checked state.
void	SetPressMethod ( EButtonPressMethod::Type InPressMet... )
void	SetTouchMethod ( EButtonTouchMethod::Type InTouchMet... )
void	SlateOnCheckStateChangedCallback ( ECheckBoxState NewState )

Overridden from UPanelWidget

		Name	Description
	void	OnSlotAdded ( UPanelSlot* Slot )	UPanelWidget.
	void	OnSlotRemoved ( UPanelSlot* Slot )

Overridden from UWidget

	Name	Description
TSharedPtr< ...	GetAccessibleWidget()	Gets the widget that accessibility properties should synchronize to.
const FText	GetPaletteCategory()	Gets the palette category of the widget
TSharedRef< ...	RebuildDesignWidget ( TSharedRef< SWidget > Content )
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostLoad()	Begin UObject.

Deprecated Variables

	Name	Description
FSlateColor	BorderBackgroundColor_DEPRECATED	The color of the background border
TObjectPtr< USl...	CheckedHoveredImage_DEPRECATED	Image to use when the checkbox is checked and hovered
TObjectPtr< USl...	CheckedImage_DEPRECATED	Image to use when the checkbox is checked
TObjectPtr< USl...	CheckedPressedImage_DEPRECATED	Image to use when the checkbox is checked and pressed
FMargin	Padding_DEPRECATED	Spacing between the check box image and its content
TObjectPtr< USl...	Style_DEPRECATED	Style of the check box
TObjectPtr< USl...	UncheckedHoveredImage_DEPRECATED	Image to use when the checkbox is unchecked and hovered
TObjectPtr< USl...	UncheckedImage_DEPRECATED	Image to use when the checkbox is unchecked
TObjectPtr< USl...	UncheckedPressedImage_DEPRECATED	Image to use when the checkbox is unchecked and pressed
TObjectPtr< USl...	UndeterminedHoveredImage_DEPRECATED	Image to use when the checkbox is checked and hovered
TObjectPtr< USl...	UndeterminedImage_DEPRECATED	Image to use when the checkbox is in an ambiguous state and hovered
TObjectPtr< USl...	UndeterminedPressedImage_DEPRECATED	Image to use when the checkbox is in an ambiguous state and pressed