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