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 > FArguments

Light Theme

Dark Theme

FArguments

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateBaseNamedArgs

TSlateBaseNamedArgs

SCheckBox::FArguments

References

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

Syntax

struct FArguments : public TSlateBaseNamedArgs< SCheckBox >

Constructors

	Name	Description
	FArguments()

Functions

	Name	Description
WidgetArgsTy...	BackgroundHoveredImage ( const FSlateBrush* InArg )	The background hovered image for the checkbox - overrides the style's
WidgetArgsTy...	BackgroundImage ( const FSlateBrush* InArg )	The background image for the checkbox - overrides the style's
WidgetArgsTy...	BackgroundPressedImage ( const FSlateBrush* InArg )	The background pressed image for the checkbox - overrides the style's
WidgetArgsTy...	BorderBackgroundColor ( const TAttribute< FSlateColor >& I... )	The color of the background border (set by the Style arg but the Style can be overridden with this)
WidgetArgsTy...	CheckBoxContentUsesAutoWidth ( bool InArg )	Whether or not the content portion of the checkbox should layout using auto-width.
WidgetArgsTy...	CheckedHoveredImage ( const FSlateBrush* InArg )	The checked hovered image for the checkbox - overrides the style's
WidgetArgsTy...	CheckedImage ( const FSlateBrush* InArg )	The checked image for the checkbox - overrides the style's
WidgetArgsTy...	CheckedPressedImage ( const FSlateBrush* InArg )	The checked pressed image for the checkbox - overrides the style's
WidgetArgsTy...	CheckedSoundOverride ( TOptional< FSlateSound > InArg )	The sound to play when the check box is checked
WidgetArgsTy...	ClickMethod ( EButtonClickMethod::Type InArg )	Sets the rules to use for determining whether the button was clicked.
NamedSlotPro...	Content()	Content to be placed next to the check box, or for a toggle button, the content to be placed inside the button
WidgetArgsTy...	ForegroundColor ( const TAttribute< FSlateColor >& I... )	Foreground color for the checkbox's content and parts (set by the Style arg but the Style can be overridden with this)
WidgetArgsTy...	HAlign ( EHorizontalAlignment InArg )	How the content of the toggle button should align within the given space
WidgetArgsTy...	HoveredSoundOverride ( TOptional< FSlateSound > InArg )	The sound to play when the check box is hovered
WidgetArgsTy...	IsChecked ( const TAttribute< ECheckBoxState > ... )	Whether the check box is currently in a checked state
WidgetArgsTy...	IsFocusable ( bool InArg )
WidgetArgsTy...	OnCheckStateChanged ( const FOnCheckStateChanged& InDele... )	Called when the checked state has changed
WidgetArgsTy...	OnGetMenuContent ( const FOnGetContent& InDelegate )
WidgetArgsTy...	Padding ( const TAttribute< FMargin >& InAtt... )	Spacing between the check box image and its content (set by the Style arg but the Style can be overridden with this)
WidgetArgsTy...	PressMethod ( EButtonPressMethod::Type InArg )	How should the button be clicked with keyboard/controller button events?
WidgetArgsTy...	Style ( const FCheckBoxStyle* InArg )	The style structure for this checkbox' visual style
WidgetArgsTy...	TouchMethod ( EButtonTouchMethod::Type InArg )	How should the button be clicked with touch events?
WidgetArgsTy...	Type ( TOptional< ESlateCheckBoxType::Type... )	Type of check box (set by the Style arg but the Style can be overridden with this)
WidgetArgsTy...	UncheckedHoveredImage ( const FSlateBrush* InArg )	The unchecked hovered image for the checkbox - overrides the style's
WidgetArgsTy...	UncheckedImage ( const FSlateBrush* InArg )	The unchecked image for the checkbox - overrides the style's
WidgetArgsTy...	UncheckedPressedImage ( const FSlateBrush* InArg )	The unchecked pressed image for the checkbox - overrides the style's
WidgetArgsTy...	UncheckedSoundOverride ( TOptional< FSlateSound > InArg )	The sound to play when the check box is unchecked
WidgetArgsTy...	UndeterminedHoveredImage ( const FSlateBrush* InArg )	The undetermined hovered image for the checkbox - overrides the style's
WidgetArgsTy...	UndeterminedImage ( const FSlateBrush* InArg )	The undetermined image for the checkbox - overrides the style's
WidgetArgsTy...	UndeterminedPressedImage ( const FSlateBrush* InArg )	The undetermined pressed image for the checkbox - overrides the style's

Operators

		Name	Description
	FArguments &	operator[] ( const TSharedRef< SWidget >& InChi... )

Typedefs

Name	Description
WidgetArgsType