Navigation
API > API/Runtime > API/Runtime/Slate
Check box Slate control
| Name | SCheckBox |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Input/SCheckBox.h |
| Include Path | #include "Widgets/Input/SCheckBox.h" |
Syntax
class SCheckBox : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SCheckBox
- FSlateControlledConstruction → SWidget → SCompoundWidget → SCheckBox
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SCheckBox() |
Widgets/Input/SCheckBox.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SCheckBox() |
Widgets/Input/SCheckBox.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct this widget | Widgets/Input/SCheckBox.h | |
ECheckBoxState GetCheckedState() |
Widgets/Input/SCheckBox.h | ||
bool IsChecked() |
Returns true if the checkbox is currently checked | Widgets/Input/SCheckBox.h | |
bool IsPressed() |
Returns true if this button is currently pressed | Widgets/Input/SCheckBox.h | |
void SetCheckedHoveredImage
(
const FSlateBrush* Brush |
See the CheckedHoveredImage attribute | Widgets/Input/SCheckBox.h | |
void SetCheckedImage
(
const FSlateBrush* Brush |
See the CheckedImage attribute | Widgets/Input/SCheckBox.h | |
void SetCheckedPressedImage
(
const FSlateBrush* Brush |
See the CheckedPressedImage attribute | Widgets/Input/SCheckBox.h | |
void SetClickMethod
(
EButtonClickMethod::Type InClickMethod |
Widgets/Input/SCheckBox.h | ||
void SetContent
(
const TSharedRef< SWidget >& InContent |
See the Content slot | Widgets/Input/SCheckBox.h | |
void SetIsChecked
(
TAttribute< ECheckBoxState > InIsChecked |
See the IsChecked attribute | Widgets/Input/SCheckBox.h | |
void SetPressMethod
(
EButtonPressMethod::Type InPressMethod |
Widgets/Input/SCheckBox.h | ||
void SetStyle
(
const FCheckBoxStyle* InStyle |
See the Style attribute | Widgets/Input/SCheckBox.h | |
void SetTouchMethod
(
EButtonTouchMethod::Type InTouchMethod |
Widgets/Input/SCheckBox.h | ||
void SetUncheckedHoveredImage
(
const FSlateBrush* Brush |
See the UncheckedHoveredImage attribute | Widgets/Input/SCheckBox.h | |
void SetUncheckedImage
(
const FSlateBrush* Brush |
See the UncheckedImage attribute | Widgets/Input/SCheckBox.h | |
void SetUncheckedPressedImage
(
const FSlateBrush* Brush |
See the UncheckedPressedImage attribute | Widgets/Input/SCheckBox.h | |
void SetUndeterminedHoveredImage
(
const FSlateBrush* Brush |
See the UndeterminedHoveredImage attribute | Widgets/Input/SCheckBox.h | |
void SetUndeterminedImage
(
const FSlateBrush* Brush |
See the UndeterminedImage attribute | Widgets/Input/SCheckBox.h | |
void SetUndeterminedPressedImage
(
const FSlateBrush* Brush |
See the UndeterminedPressedImage attribute | Widgets/Input/SCheckBox.h | |
void ToggleCheckedState() |
Toggles the checked state for this check box, fire events as needed | Widgets/Input/SCheckBox.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< FSlateAccessibleWidget > CreateAccessibleWidget() |
Widgets/Input/SCheckBox.h | ||
virtual FSlateColor GetForegroundColor() |
Widgets/Input/SCheckBox.h | ||
virtual bool IsInteractable() |
Widgets/Input/SCheckBox.h | ||
| Widgets/Input/SCheckBox.h | |||
| Widgets/Input/SCheckBox.h | |||
virtual FReply OnMouseButtonDoubleClick
(
const FGeometry& InMyGeometry, |
See SWidget::OnMouseButtonDoubleClick. | Widgets/Input/SCheckBox.h | |
virtual FReply OnMouseButtonDown
(
const FGeometry& MyGeometry, |
See SWidget::OnMouseButtonDown. | Widgets/Input/SCheckBox.h | |
virtual FReply OnMouseButtonUp
(
const FGeometry& MyGeometry, |
See SWidget::OnMouseButtonUp. | Widgets/Input/SCheckBox.h | |
virtual void OnMouseEnter
(
const FGeometry& MyGeometry, |
Widgets/Input/SCheckBox.h | ||
virtual void OnMouseLeave
(
const FPointerEvent& MouseEvent |
Widgets/Input/SCheckBox.h | ||
virtual bool SupportsKeyboardFocus() |
See SWidget::SupportsKeyboardFocus(). | Widgets/Input/SCheckBox.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BuildCheckBox
(
TSharedRef< SWidget > InContent |
Rebuilds the checkbox based on the current ESlateCheckBoxType | Widgets/Input/SCheckBox.h | |
const FSlateBrush * GetBackgroundHoveredImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetBackgroundImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetBackgroundPressedImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetCheckedHoveredImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetCheckedImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetCheckedPressedImage() |
Widgets/Input/SCheckBox.h | ||
TEnumAsByte< EButtonClickMethod::Type > GetClickMethodFromInputType
(
const FPointerEvent& MouseEvent |
Utility function to translate other input click methods to regular ones. | Widgets/Input/SCheckBox.h | |
const FSlateBrush * GetUncheckedHoveredImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetUncheckedImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetUncheckedPressedImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetUndeterminedHoveredImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetUndeterminedImage() |
Widgets/Input/SCheckBox.h | ||
const FSlateBrush * GetUndeterminedPressedImage() |
Widgets/Input/SCheckBox.h | ||
bool IsPreciseTapOrClick
(
const FPointerEvent& MouseEvent |
Utility function to determine if the incoming mouse event is for a precise tap or click | Widgets/Input/SCheckBox.h | |
const FSlateBrush * OnGetBackgroundImage() |
Attribute getter for the background image | Widgets/Input/SCheckBox.h | |
FSlateColor OnGetBorderBackgroundColor() |
Attribute getter for the border background color | Widgets/Input/SCheckBox.h | |
ESlateCheckBoxType::Type OnGetCheckBoxType() |
Attribute getter for the checkbox type | Widgets/Input/SCheckBox.h | |
const FSlateBrush * OnGetCheckImage() |
Gets the check image to display for the current state of the check box | Widgets/Input/SCheckBox.h | |
FMargin OnGetPadding() |
Attribute getter for the padding | Widgets/Input/SCheckBox.h | |
void PlayCheckedSound() |
Play the checked sound | Widgets/Input/SCheckBox.h | |
void PlayHoverSound() |
Play the hovered sound | Widgets/Input/SCheckBox.h | |
void PlayUncheckedSound() |
Play the unchecked sound | Widgets/Input/SCheckBox.h |