1. Epic GamesDeveloper
  3. SCheckBox

SCheckBox

Check box Slate control

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Input

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void

BuildCheckBox ( TSharedRef< SWidget > InContent
)

 Rebuilds the checkbox based on the current ESlateCheckBoxType
Public function void

Construct ( const FArguments& InArgs
)

 Construct this widget
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Public function Const ECheckBoxState  
Protected function Const TEnumAsByte< EButtonClickMethod::Type > Utility function to translate other input click methods to regular ones.
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Protected function Const const FSlateBrush *  
Public function Const bool Returns true if the checkbox is currently checked
Protected function Const bool

IsPreciseTapOrClick ( const FPointerEvent& MouseEvent
)

 Utility function to determine if the incoming mouse event is for a precise tap or click
Public function Const bool Returns true if this button is currently pressed
Protected function Const const FSlateBrush * Attribute getter for the background image
Protected function Const FSlateColor Attribute getter for the border background color
Protected function Const ESlateCheckBoxType::Type Attribute getter for the checkbox type
Protected function Const const FSlateBrush * Gets the check image to display for the current state of the check box
Protected function Const FMargin Attribute getter for the padding
Protected function Const void Play the checked sound
Protected function Const void Play the hovered sound
Protected function Const void Play the unchecked sound
Public function void See the CheckedHoveredImage attribute
Public function void

SetCheckedImage ( const FSlateBrush* Brush
)

 See the CheckedImage attribute
Public function void See the CheckedPressedImage attribute
Public function void  
Public function void

SetContent ( const TSharedRef< SWidget >& InContent
)

 See the Content slot
Public function void

SetIsChecked ( TAttribute< ECheckBoxState > InIsChecked
)

 See the IsChecked attribute
Public function void  
Public function void

SetStyle ( const FCheckBoxStyle* InStyle
)

 See the Style attribute
Public function void  
Public function void See the UncheckedHoveredImage attribute
Public function void

SetUncheckedImage ( const FSlateBrush* Brush
)

 See the UncheckedImage attribute
Public function void See the UncheckedPressedImage attribute
Public function void See the UndeterminedHoveredImage attribute
Public function void See the UndeterminedImage attribute
Public function void See the UndeterminedPressedImage attribute
Public function void Toggles the checked state for this check box, fire events as needed

Overridden from SWidget

  Type Name Description
Public function Virtual TSharedRef< FSlateAccessibleWidget >  
Public function Virtual Const FSlateColor  
Public function Virtual Const bool  
Public function Virtual 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)
Public function Virtual FReply

OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is released when this widget has focus
Public function Virtual FReply

OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 See SWidget::OnMouseButtonDoubleClick.
Public function Virtual FReply

OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 See SWidget::OnMouseButtonDown.
Public function Virtual FReply

OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 See SWidget::OnMouseButtonUp.
Public function Virtual void

OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has entered it.
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has left it.
Public function Virtual Const bool See SWidget::SupportsKeyboardFocus().

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page