#include <SCheckBox.h>

Inheritance diagram for SCheckBox:

Public Member Functions
	SLATE_BEGIN_ARGS (SCheckBox)

SLATE_API	SCheckBox ()

virtual SLATE_API	~SCheckBox ()

SLATE_API void	Construct (const FArguments &InArgs)

virtual SLATE_API bool	SupportsKeyboardFocus () const override

virtual SLATE_API FReply	OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override

virtual SLATE_API FReply	OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override

virtual SLATE_API FReply	OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent) override

virtual SLATE_API FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API void	OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API void	OnMouseLeave (const FPointerEvent &MouseEvent) override

virtual SLATE_API bool	IsInteractable () const override

virtual SLATE_API FSlateColor	GetForegroundColor () const

bool	IsChecked () const

SLATE_API ECheckBoxState	GetCheckedState () const

bool	IsPressed () const

SLATE_API void	ToggleCheckedState ()

SLATE_API void	SetIsChecked (TAttribute< ECheckBoxState > InIsChecked)

SLATE_API void	SetContent (const TSharedRef< SWidget > &InContent)

SLATE_API void	SetStyle (const FCheckBoxStyle *InStyle)

SLATE_API void	SetUncheckedImage (const FSlateBrush *Brush)

SLATE_API void	SetUncheckedHoveredImage (const FSlateBrush *Brush)

SLATE_API void	SetUncheckedPressedImage (const FSlateBrush *Brush)

SLATE_API void	SetCheckedImage (const FSlateBrush *Brush)

SLATE_API void	SetCheckedHoveredImage (const FSlateBrush *Brush)

SLATE_API void	SetCheckedPressedImage (const FSlateBrush *Brush)

SLATE_API void	SetUndeterminedImage (const FSlateBrush *Brush)

SLATE_API void	SetUndeterminedHoveredImage (const FSlateBrush *Brush)

SLATE_API void	SetUndeterminedPressedImage (const FSlateBrush *Brush)

SLATE_API void	SetClickMethod (EButtonClickMethod::Type InClickMethod)

SLATE_API void	SetTouchMethod (EButtonTouchMethod::Type InTouchMethod)

SLATE_API void	SetPressMethod (EButtonPressMethod::Type InPressMethod)

Public Member Functions inherited from SCompoundWidget
const FVector2D	GetContentScale () const

void	SetContentScale (TAttribute< FVector2D > InContentScale)

FLinearColor	GetColorAndOpacity () const

void	SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)

void	SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)

virtual SLATECORE_API int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override

virtual SLATECORE_API FChildren *	GetChildren () override

virtual SLATECORE_API void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override

virtual SLATECORE_API void	SetVisibility (TAttribute< EVisibility > InVisibility) override final

Public Member Functions inherited from SWidget
SLATECORE_API int32	Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATECORE_API void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)

virtual SLATECORE_API FReply	OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent)

virtual SLATECORE_API void	OnFocusLost (const FFocusEvent &InFocusEvent)

virtual SLATECORE_API void	OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)

virtual SLATECORE_API FReply	OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)

virtual SLATECORE_API FReply	OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)

virtual SLATECORE_API FReply	OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const

virtual SLATECORE_API TOptional< TSharedRef< SWidget > >	OnMapCursor (const FCursorReply &CursorReply) const

virtual SLATECORE_API bool	OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)

virtual SLATECORE_API TSharedPtr< FPopupLayer >	OnVisualizePopup (const TSharedRef< SWidget > &PopupContent)

virtual SLATECORE_API FReply	OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API void	OnDragLeave (const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)

virtual SLATECORE_API FReply	OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)

virtual SLATECORE_API TOptional< bool >	OnQueryShowFocus (const EFocusCause InFocusCause) const

virtual SLATECORE_API FPopupMethodReply	OnQueryPopupMethod () const

virtual SLATECORE_API TOptional< FVirtualPointerPosition >	TranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const

virtual SLATECORE_API void	OnFinishedPointerInput ()

virtual SLATECORE_API void	OnFinishedKeyInput ()

virtual SLATECORE_API FNavigationReply	OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)

virtual SLATECORE_API EWindowZone::Type	GetWindowZoneOverride () const

bool	NeedsPrepass () const

SLATECORE_API void	SlatePrepass ()

SLATECORE_API void	SlatePrepass (float InLayoutScaleMultiplier)

void	SetCanTick (bool bInCanTick)

bool	GetCanTick () const

bool	HasRegisteredSlateAttribute () const

bool	IsAttributesUpdatesEnabled () const

const FSlateWidgetPersistentState &	GetPersistentState () const

const FWidgetProxyHandle	GetProxyHandle () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetDesiredSize () const

SLATECORE_API void	AssignParentWidget (TSharedPtr< SWidget > InParent)

SLATECORE_API bool	ConditionallyDetatchParentWidget (SWidget *InExpectedParent)

virtual bool	ValidatePathToChild (SWidget *InChild)

bool	IsParentValid () const

TSharedPtr< SWidget >	GetParentWidget () const

TSharedPtr< SWidget >	Advanced_GetPaintParentWidget () const

SLATECORE_API FSlateRect	CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const

bool	HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const

TStatId	GetStatID (bool bForDeferredUse=false) const

virtual SLATECORE_API float	GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const

SLATECORE_API void	ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const

virtual FChildren *	GetAllChildren ()

virtual SLATECORE_API bool	HasKeyboardFocus () const

SLATECORE_API TOptional< EFocusCause >	HasUserFocus (int32 UserIndex) const

SLATECORE_API TOptional< EFocusCause >	HasAnyUserFocus () const

SLATECORE_API bool	HasUserFocusedDescendants (int32 UserIndex) const

SLATECORE_API bool	HasFocusedDescendants () const

SLATECORE_API bool	HasAnyUserFocusOrFocusedDescendants () const

SLATECORE_API bool	HasMouseCapture () const

SLATECORE_API bool	HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const

virtual SLATECORE_API void	OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)

void	SetEnabled (TAttribute< bool > InEnabledState)

bool	IsEnabled () const

virtual SLATECORE_API TSharedPtr< IToolTip >	GetToolTip ()

virtual SLATECORE_API void	OnToolTipClosing ()

SLATECORE_API void	EnableToolTipForceField (const bool bEnableForceField)

bool	HasToolTipForceField () const

bool	IsHovered () const

SLATECORE_API bool	IsDirectlyHovered () const

EVisibility	GetVisibility () const

bool	IsVolatile () const

bool	IsVolatileIndirectly () const

void	ForceVolatile (bool bForce)

bool	ShouldInvalidatePrepassDueToVolatility ()

SLATECORE_API void	Invalidate (EInvalidateWidgetReason InvalidateReason)

void	CacheVolatility ()

void	MarkPrepassAsDirty ()

float	GetRenderOpacity () const

void	SetRenderOpacity (float InRenderOpacity)

void	SetTag (FName InTag)

const TOptional< FSlateRenderTransform > &	GetRenderTransform () const

TOptional< FSlateRenderTransform >	GetRenderTransformWithRespectToFlowDirection () const

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivotWithRespectToFlowDirection () const

void	SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivot () const

void	SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)

SLATECORE_API void	SetClipping (EWidgetClipping InClipping)

EWidgetClipping	GetClipping () const

SLATECORE_API void	SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)

EWidgetPixelSnapping	GetPixelSnapping () const

void	SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)

FMargin	GetCullingBoundsExtension () const

void	SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)

EFlowDirectionPreference	GetFlowDirectionPreference () const

SLATECORE_API void	SetToolTipText (const TAttribute< FText > &ToolTipText)

SLATECORE_API void	SetToolTipText (const FText &InToolTipText)

SLATECORE_API void	SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)

SLATECORE_API void	SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)

template<typename MetaDataType >
TSharedPtr< MetaDataType >	GetMetaData () const

template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > >	GetAllMetaData () const

template<typename MetaDataType >
void	AddMetadata (const TSharedRef< MetaDataType > &AddMe)

template<typename MetaDataType >
int32	RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)

SLATECORE_API void	SetOnMouseButtonDown (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseButtonUp (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseMove (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseDoubleClick (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)

virtual SLATECORE_API FString	ToString () const

SLATECORE_API FString	GetTypeAsString () const

SLATECORE_API FName	GetType () const

virtual SLATECORE_API FString	GetReadableLocation () const

SLATECORE_API FName	GetCreatedInLocation () const

virtual SLATECORE_API FName	GetTag () const

virtual SLATECORE_API FSlateColor	GetDisabledForegroundColor () const

SLATECORE_API const FGeometry &	GetCachedGeometry () const

SLATECORE_API const FGeometry &	GetTickSpaceGeometry () const

SLATECORE_API const FGeometry &	GetPaintSpaceGeometry () const

const TOptional< FSlateClippingState > &	GetCurrentClippingState () const

virtual bool	Advanced_IsWindow () const

virtual bool	Advanced_IsInvalidationRoot () const

virtual const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const

SLATECORE_API TSharedRef< FActiveTimerHandle >	RegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)

SLATECORE_API void	UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)

bool	HasActiveTimers () const

Public Member Functions inherited from FSlateControlledConstruction
	FSlateControlledConstruction ()=default

virtual	~FSlateControlledConstruction ()=default

virtual const FSlateWidgetClassData &	GetWidgetClass () const =0

void	operator delete (void *mem)

Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode >	AsShared ()

TSharedRef< SWidget const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< SWidget, Mode >	AsWeak ()

TWeakPtr< SWidget const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Protected Member Functions
SLATE_API void	BuildCheckBox (TSharedRef< SWidget > InContent)

SLATE_API FMargin	OnGetPadding () const

SLATE_API FSlateColor	OnGetBorderBackgroundColor () const

SLATE_API ESlateCheckBoxType::Type	OnGetCheckBoxType () const

SLATE_API const FSlateBrush *	OnGetCheckImage () const

SLATE_API const FSlateBrush *	GetUncheckedImage () const

SLATE_API const FSlateBrush *	GetUncheckedHoveredImage () const

SLATE_API const FSlateBrush *	GetUncheckedPressedImage () const

SLATE_API const FSlateBrush *	GetCheckedImage () const

SLATE_API const FSlateBrush *	GetCheckedHoveredImage () const

SLATE_API const FSlateBrush *	GetCheckedPressedImage () const

SLATE_API const FSlateBrush *	GetUndeterminedImage () const

SLATE_API const FSlateBrush *	GetUndeterminedHoveredImage () const

SLATE_API const FSlateBrush *	GetUndeterminedPressedImage () const

SLATE_API const FSlateBrush *	OnGetBackgroundImage () const

SLATE_API const FSlateBrush *	GetBackgroundImage () const

SLATE_API const FSlateBrush *	GetBackgroundHoveredImage () const

SLATE_API const FSlateBrush *	GetBackgroundPressedImage () const

SLATE_API void	PlayCheckedSound () const

SLATE_API void	PlayUncheckedSound () const

SLATE_API void	PlayHoverSound () const

SLATE_API TEnumAsByte< EButtonClickMethod::Type >	GetClickMethodFromInputType (const FPointerEvent &MouseEvent) const

SLATE_API bool	IsPreciseTapOrClick (const FPointerEvent &MouseEvent) const

Protected Member Functions inherited from SCompoundWidget
virtual SLATECORE_API FVector2D	ComputeDesiredSize (float) const override

TSlateAttributeRef< FVector2D >	GetContentScaleAttribute () const

TSlateAttributeRef< FLinearColor >	GetColorAndOpacityAttribute () const

TSlateAttributeRef< FSlateColor >	GetForegroundColorAttribute () const

SLATECORE_API	SCompoundWidget ()

virtual SLATECORE_API	~SCompoundWidget ()

Protected Member Functions inherited from SWidget
void	SetVolatilePrepass (bool bVolatile)

virtual bool	CustomPrepass (float LayoutScaleMultiplier)

virtual SLATECORE_API void	CacheDesiredSize (float InLayoutScaleMultiplier)

void	SetHover (TAttribute< bool > InHovered)

bool	IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const

SLATECORE_API void	InvalidateChildRemovedFromTree (SWidget &Child)

bool	Advanced_InvalidateVolatility ()

EFlowDirection	ComputeFlowDirection () const

SLATECORE_API void	SetDebugInfo (const ANSICHAR InType, const ANSICHAR InFile, int32 OnLine, size_t InAllocSize)

virtual SLATECORE_API TOptional< EMouseCursor::Type >	GetCursor () const

SLATECORE_API	SWidget ()

SLATECORE_API void	SWidgetConstruct (const FSlateBaseNamedArgs &Args)

bool	IsConstructed () const

SLATECORE_API bool	FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API void	FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API FGeometry	FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const

bool	ShouldBeEnabled (bool InParentEnabled) const

virtual SLATECORE_API const FSlateBrush *	GetFocusBrush () const

virtual bool	ComputeVolatility () const

virtual SLATECORE_API void	OnClippingChanged ()

float	GetPrepassLayoutScaleMultiplier () const

SLATECORE_API void	Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)

template<typename TargetValueType , typename SourceValueType >
bool	SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)

TSlateAttributeRef< bool >	GetEnabledStateAttribute () const

TSlateAttributeRef< bool >	GetHoveredAttribute () const

TSlateAttributeRef< EVisibility >	GetVisibilityAttribute () const

TSlateAttributeRef< TOptional< FSlateRenderTransform > >	GetRenderTransformAttribute () const

TSlateAttributeRef< FVector2D >	GetRenderTransformPivotAttribute () const

virtual SLATECORE_API	~SWidget ()

Protected Member Functions inherited from TSharedFromThis< SWidget >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Protected Attributes
const FCheckBoxStyle *	Style

bool	bIsPressed

TAttribute< ECheckBoxState >	IsCheckboxChecked

FOnCheckStateChanged	OnCheckStateChanged

const FSlateBrush *	UncheckedImage

const FSlateBrush *	UncheckedHoveredImage

const FSlateBrush *	UncheckedPressedImage

const FSlateBrush *	CheckedImage

const FSlateBrush *	CheckedHoveredImage

const FSlateBrush *	CheckedPressedImage

const FSlateBrush *	UndeterminedImage

const FSlateBrush *	UndeterminedHoveredImage

const FSlateBrush *	UndeterminedPressedImage

const FSlateBrush *	BackgroundImage

const FSlateBrush *	BackgroundHoveredImage

const FSlateBrush *	BackgroundPressedImage

TAttribute< FMargin >	PaddingOverride

TAttribute< FSlateColor >	ForegroundColorOverride

TAttribute< FSlateColor >	BorderBackgroundColorOverride

TOptional< ESlateCheckBoxType::Type >	CheckBoxTypeOverride

EHorizontalAlignment	HorizontalAlignment

EVerticalAlignment	CheckBoxImageVAlign

bool	bCheckBoxContentUsesAutoWidth

EButtonClickMethod::Type	ClickMethod

TEnumAsByte< EButtonTouchMethod::Type >	TouchMethod

TEnumAsByte< EButtonPressMethod::Type >	PressMethod

bool	bIsFocusable

FOnGetContent	OnGetMenuContent

FSlateSound	HoveredSound

FSlateSound	CheckedSound

FSlateSound	UncheckedSound

TSharedPtr< SBorder >	ContentContainer

Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot	ChildSlot

Protected Attributes inherited from SWidget
uint8	bCanSupportFocus: 1

uint8	bCanHaveChildren: 1

uint8	bClippingProxy: 1

uint8	bHasCustomPrepass: 1

uint8	bHasRelativeLayoutScale: 1

uint8	bVolatilityAlwaysInvalidatesPrepass: 1

EWidgetClipping	Clipping

EWidgetPixelSnapping	PixelSnappingMethod

FMargin	CullingBoundsExtension

float	RenderOpacity

Additional Inherited Members
Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData &	StaticWidgetClass ()

Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32	FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)

static SLATECORE_API int32	FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)

static TAttribute< EVisibility >	AccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)

Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Check box Slate control

Constructor & Destructor Documentation

◆ SCheckBox()

SCheckBox::SCheckBox ( )

Content to be placed next to the check box, or for a toggle button, the content to be placed inside the button The style structure for this checkbox' visual style Type of check box (set by the Style arg but the Style can be overridden with this) Called when the checked state has changed Whether the check box is currently in a checked state How the content of the toggle button should align within the given space How the image of the checkbox should align vertically within the given space Whether or not the content portion of the checkbox should layout using auto-width. When true the content will always be arranged at its desired size as opposed to resizing to the available space. Spacing between the check box image and its content (set by the Style arg but the Style can be overridden with this) Sets the rules to use for determining whether the button was clicked. This is an advanced setting and generally should be left as the default. How should the button be clicked with touch events? How should the button be clicked with keyboard/controller button events? Foreground color for the checkbox's content and parts (set by the Style arg but the Style can be overridden with this) The color of the background border (set by the Style arg but the Style can be overridden with this) The sound to play when the check box is checked The sound to play when the check box is unchecked The sound to play when the check box is hovered The unchecked image for the checkbox - overrides the style's The unchecked hovered image for the checkbox - overrides the style's The unchecked pressed image for the checkbox - overrides the style's The checked image for the checkbox - overrides the style's The checked hovered image for the checkbox - overrides the style's The checked pressed image for the checkbox - overrides the style's The undetermined image for the checkbox - overrides the style's The undetermined hovered image for the checkbox - overrides the style's The undetermined pressed image for the checkbox - overrides the style's The background image for the checkbox - overrides the style's The background hovered image for the checkbox - overrides the style's The background pressed image for the checkbox - overrides the style's

◆ ~SCheckBox()

SCheckBox::~SCheckBox ( )

virtualdefault

Member Function Documentation

◆ BuildCheckBox()

void SCheckBox::BuildCheckBox ( TSharedRef< SWidget > InContent )

protected

Rebuilds the checkbox based on the current ESlateCheckBoxType

◆ Construct()

void SCheckBox::Construct ( const FArguments & InArgs )

Construct this widget

Parameters

InArgs The declaration data for this widget

◆ GetBackgroundHoveredImage()

const FSlateBrush * SCheckBox::GetBackgroundHoveredImage ( ) const

protected

◆ GetBackgroundImage()

const FSlateBrush * SCheckBox::GetBackgroundImage ( ) const

protected

◆ GetBackgroundPressedImage()

const FSlateBrush * SCheckBox::GetBackgroundPressedImage ( ) const

protected

◆ GetCheckedHoveredImage()

const FSlateBrush * SCheckBox::GetCheckedHoveredImage ( ) const

protected

◆ GetCheckedImage()

const FSlateBrush * SCheckBox::GetCheckedImage ( ) const

protected

◆ GetCheckedPressedImage()

const FSlateBrush * SCheckBox::GetCheckedPressedImage ( ) const

protected

◆ GetCheckedState()

ECheckBoxState SCheckBox::GetCheckedState ( ) const

Returns: The current checked state of the checkbox.

◆ GetClickMethodFromInputType()

TEnumAsByte< EButtonClickMethod::Type > SCheckBox::GetClickMethodFromInputType ( const FPointerEvent & MouseEvent ) const

protected

Utility function to translate other input click methods to regular ones.

◆ GetForegroundColor()

FSlateColor SCheckBox::GetForegroundColor ( ) const

virtual

Returns: the Foreground color that this widget sets; unset options if the widget does not set a foreground color

Reimplemented from SCompoundWidget.

◆ GetUncheckedHoveredImage()

const FSlateBrush * SCheckBox::GetUncheckedHoveredImage ( ) const

protected

◆ GetUncheckedImage()

const FSlateBrush * SCheckBox::GetUncheckedImage ( ) const

protected

◆ GetUncheckedPressedImage()

const FSlateBrush * SCheckBox::GetUncheckedPressedImage ( ) const

protected

◆ GetUndeterminedHoveredImage()

const FSlateBrush * SCheckBox::GetUndeterminedHoveredImage ( ) const

protected

◆ GetUndeterminedImage()

const FSlateBrush * SCheckBox::GetUndeterminedImage ( ) const

protected

◆ GetUndeterminedPressedImage()

const FSlateBrush * SCheckBox::GetUndeterminedPressedImage ( ) const

protected

◆ IsChecked()

bool SCheckBox::IsChecked ( ) const

inline

Returns true if the checkbox is currently checked

Returns: True if checked, otherwise false

◆ IsInteractable()

bool SCheckBox::IsInteractable ( ) const

overridevirtual

Returns: Is this widget interactive or not? Defaults to false

Reimplemented from SWidget.

◆ IsPreciseTapOrClick()

bool SCheckBox::IsPreciseTapOrClick ( const FPointerEvent & MouseEvent ) const

protected

Utility function to determine if the incoming mouse event is for a precise tap or click

◆ IsPressed()

bool SCheckBox::IsPressed ( ) const

inline

Returns true if this button is currently pressed

Returns: True if pressed, otherwise false

◆ OnGetBackgroundImage()

const FSlateBrush * SCheckBox::OnGetBackgroundImage ( ) const

protected

Attribute getter for the background image

◆ OnGetBorderBackgroundColor()

FSlateColor SCheckBox::OnGetBorderBackgroundColor ( ) const

protected

Attribute getter for the border background color

◆ OnGetCheckBoxType()

ESlateCheckBoxType::Type SCheckBox::OnGetCheckBoxType ( ) const

protected

Attribute getter for the checkbox type

◆ OnGetCheckImage()

const FSlateBrush * SCheckBox::OnGetCheckImage ( ) const

protected

Gets the check image to display for the current state of the check box

Returns: The name of the image to display

◆ OnGetPadding()

FMargin SCheckBox::OnGetPadding ( ) const

protected

Attribute getter for the padding

◆ OnKeyDown()

FReply SCheckBox::OnKeyDown	(	const FGeometry &	MyGeometry,
		const FKeyEvent &	InKeyEvent
	)

overridevirtual

Called after a key is pressed when this widget has focus (this event bubbles if not handled)

Parameters

MyGeometry	The Geometry of the widget receiving the event
InKeyEvent	Key event

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnKeyUp()

FReply SCheckBox::OnKeyUp	(	const FGeometry &	MyGeometry,
		const FKeyEvent &	InKeyEvent
	)

overridevirtual

Called after a key is released when this widget has focus

Parameters

MyGeometry	The Geometry of the widget receiving the event
InKeyEvent	Key event

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnMouseButtonDoubleClick()

FReply SCheckBox::OnMouseButtonDoubleClick	(	const FGeometry &	InMyGeometry,
		const FPointerEvent &	InMouseEvent
	)

overridevirtual

See SWidget::OnMouseButtonDoubleClick.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnMouseButtonDown()

FReply SCheckBox::OnMouseButtonDown	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

See SWidget::OnMouseButtonDown.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

Reimplemented in SCheckBoxStack.

◆ OnMouseButtonUp()

FReply SCheckBox::OnMouseButtonUp	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

See SWidget::OnMouseButtonUp.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

Reimplemented in SCheckBoxStack.

◆ OnMouseEnter()

void SCheckBox::OnMouseEnter	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Reimplemented from SWidget.

◆ OnMouseLeave()

void SCheckBox::OnMouseLeave ( const FPointerEvent & MouseEvent )

overridevirtual

The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.

Parameters

MouseEvent Information about the input event

Reimplemented from SWidget.

◆ PlayCheckedSound()

void SCheckBox::PlayCheckedSound ( ) const

protected

Play the checked sound

◆ PlayHoverSound()

void SCheckBox::PlayHoverSound ( ) const

protected

Play the hovered sound

◆ PlayUncheckedSound()

void SCheckBox::PlayUncheckedSound ( ) const

protected

Play the unchecked sound

◆ SetCheckedHoveredImage()

void SCheckBox::SetCheckedHoveredImage ( const FSlateBrush * Brush )

See the CheckedHoveredImage attribute

◆ SetCheckedImage()

void SCheckBox::SetCheckedImage ( const FSlateBrush * Brush )

See the CheckedImage attribute

◆ SetCheckedPressedImage()

void SCheckBox::SetCheckedPressedImage ( const FSlateBrush * Brush )

See the CheckedPressedImage attribute

◆ SetClickMethod()

void SCheckBox::SetClickMethod ( EButtonClickMethod::Type InClickMethod )

◆ SetContent()

void SCheckBox::SetContent ( const TSharedRef< SWidget > & InContent )

See the Content slot

◆ SetIsChecked()

void SCheckBox::SetIsChecked ( TAttribute< ECheckBoxState > InIsChecked )

See the IsChecked attribute

◆ SetPressMethod()

void SCheckBox::SetPressMethod ( EButtonPressMethod::Type InPressMethod )

◆ SetStyle()

void SCheckBox::SetStyle ( const FCheckBoxStyle * InStyle )

See the Style attribute

◆ SetTouchMethod()

void SCheckBox::SetTouchMethod ( EButtonTouchMethod::Type InTouchMethod )

◆ SetUncheckedHoveredImage()

void SCheckBox::SetUncheckedHoveredImage ( const FSlateBrush * Brush )

See the UncheckedHoveredImage attribute

◆ SetUncheckedImage()

void SCheckBox::SetUncheckedImage ( const FSlateBrush * Brush )

See the UncheckedImage attribute

◆ SetUncheckedPressedImage()

void SCheckBox::SetUncheckedPressedImage ( const FSlateBrush * Brush )

See the UncheckedPressedImage attribute

◆ SetUndeterminedHoveredImage()

void SCheckBox::SetUndeterminedHoveredImage ( const FSlateBrush * Brush )

See the UndeterminedHoveredImage attribute

◆ SetUndeterminedImage()

void SCheckBox::SetUndeterminedImage ( const FSlateBrush * Brush )

See the UndeterminedImage attribute

◆ SetUndeterminedPressedImage()

void SCheckBox::SetUndeterminedPressedImage ( const FSlateBrush * Brush )

See the UndeterminedPressedImage attribute

◆ SLATE_BEGIN_ARGS()

SCheckBox::SLATE_BEGIN_ARGS ( SCheckBox )

inline

◆ SupportsKeyboardFocus()

bool SCheckBox::SupportsKeyboardFocus ( ) const

overridevirtual

See SWidget::SupportsKeyboardFocus().

Returns: True if this widget can take keyboard focus

Reimplemented from SWidget.

◆ ToggleCheckedState()

void SCheckBox::ToggleCheckedState ( )

Toggles the checked state for this check box, fire events as needed

Member Data Documentation

◆ BackgroundHoveredImage

const FSlateBrush* SCheckBox::BackgroundHoveredImage

protected

Image to use for the checkbox background when hovered

◆ BackgroundImage

const FSlateBrush* SCheckBox::BackgroundImage

protected

Image to use for the checkbox background

◆ BackgroundPressedImage

const FSlateBrush* SCheckBox::BackgroundPressedImage

protected

Image to use for the checkbox background when pressed

◆ bCheckBoxContentUsesAutoWidth

bool SCheckBox::bCheckBoxContentUsesAutoWidth

protected

Whether or not the checkbox content is arranged using auto-width when in checkbox mode.

◆ bIsFocusable

bool SCheckBox::bIsFocusable

protected

When true, this checkbox will be keyboard focusable. Defaults to true.

◆ bIsPressed

bool SCheckBox::bIsPressed

protected

True if this check box is currently in a pressed state

◆ BorderBackgroundColorOverride

TAttribute<FSlateColor> SCheckBox::BorderBackgroundColorOverride

protected

Overrides border background color in the widget style, if set

◆ CheckBoxImageVAlign

EVerticalAlignment SCheckBox::CheckBoxImageVAlign

protected

How the image of the checkbox should align vertically within the given space

◆ CheckBoxTypeOverride

TOptional<ESlateCheckBoxType::Type> SCheckBox::CheckBoxTypeOverride

protected

Overrides checkbox type in the widget style, if set

◆ CheckedHoveredImage

const FSlateBrush* SCheckBox::CheckedHoveredImage

protected

Image to use when the checkbox is checked and hovered

◆ CheckedImage

const FSlateBrush* SCheckBox::CheckedImage

protected

Image to use when the checkbox is checked

◆ CheckedPressedImage

const FSlateBrush* SCheckBox::CheckedPressedImage

protected

Image to use when the checkbox is checked and pressed

◆ CheckedSound

FSlateSound SCheckBox::CheckedSound

protected

The Sound to play when the check box is checked

◆ ClickMethod

EButtonClickMethod::Type SCheckBox::ClickMethod

protected

Sets whether a click should be triggered on mouse down, mouse up, or that both a mouse down and up are required.

◆ ContentContainer

TSharedPtr<SBorder> SCheckBox::ContentContainer

protected

When in toggle button mode, this will hold the pointer to the toggle button's border

◆ ForegroundColorOverride

TAttribute<FSlateColor> SCheckBox::ForegroundColorOverride

protected

Overrides foreground color in the widget style, if set

◆ HorizontalAlignment

EHorizontalAlignment SCheckBox::HorizontalAlignment

protected

How the content of the toggle button should align within the given space

◆ HoveredSound

FSlateSound SCheckBox::HoveredSound

protected

The Sound to play when the check box is hovered

◆ IsCheckboxChecked

TAttribute<ECheckBoxState> SCheckBox::IsCheckboxChecked

protected

Are we checked

◆ OnCheckStateChanged

FOnCheckStateChanged SCheckBox::OnCheckStateChanged

protected

Delegate called when the check box changes state

◆ OnGetMenuContent

FOnGetContent SCheckBox::OnGetMenuContent

protected

Delegate to execute to get the menu content of this button

◆ PaddingOverride

TAttribute<FMargin> SCheckBox::PaddingOverride

protected

Overrides padding in the widget style, if set

◆ PressMethod

TEnumAsByte<EButtonPressMethod::Type> SCheckBox::PressMethod

protected

How should the button be clicked with keyboard/controller button events?

◆ Style

const FCheckBoxStyle* SCheckBox::Style

protected

◆ TouchMethod

TEnumAsByte<EButtonTouchMethod::Type> SCheckBox::TouchMethod

protected

How should the button be clicked with touch events?

◆ UncheckedHoveredImage

const FSlateBrush* SCheckBox::UncheckedHoveredImage

protected

Image to use when the checkbox is unchecked and hovered

◆ UncheckedImage

const FSlateBrush* SCheckBox::UncheckedImage

protected

Image to use when the checkbox is unchecked

◆ UncheckedPressedImage

const FSlateBrush* SCheckBox::UncheckedPressedImage

protected

Image to use when the checkbox is unchecked and pressed

◆ UncheckedSound

FSlateSound SCheckBox::UncheckedSound

protected

The Sound to play when the check box is unchecked

◆ UndeterminedHoveredImage

const FSlateBrush* SCheckBox::UndeterminedHoveredImage

protected

Image to use when the checkbox is in an ambiguous state and hovered

◆ UndeterminedImage

const FSlateBrush* SCheckBox::UndeterminedImage

protected

Image to use when the checkbox is in an ambiguous state

◆ UndeterminedPressedImage

const FSlateBrush* SCheckBox::UndeterminedPressedImage

protected

Image to use when the checkbox is in an ambiguous state and pressed

The documentation for this class was generated from the following files:

Engine/Source/Runtime/Slate/Public/Widgets/Input/SCheckBox.h
Engine/Source/Runtime/Slate/Private/Widgets/Input/SCheckBox.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SCheckBox()

◆ ~SCheckBox()

Member Function Documentation

◆ BuildCheckBox()

◆ Construct()

◆ GetBackgroundHoveredImage()

◆ GetBackgroundImage()

◆ GetBackgroundPressedImage()

◆ GetCheckedHoveredImage()

◆ GetCheckedImage()

◆ GetCheckedPressedImage()

◆ GetCheckedState()

◆ GetClickMethodFromInputType()

◆ GetForegroundColor()

◆ GetUncheckedHoveredImage()

◆ GetUncheckedImage()

◆ GetUncheckedPressedImage()

◆ GetUndeterminedHoveredImage()

◆ GetUndeterminedImage()

◆ GetUndeterminedPressedImage()

◆ IsChecked()

◆ IsInteractable()

◆ IsPreciseTapOrClick()

◆ IsPressed()

◆ OnGetBackgroundImage()

◆ OnGetBorderBackgroundColor()

◆ OnGetCheckBoxType()

◆ OnGetCheckImage()

◆ OnGetPadding()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnMouseButtonDoubleClick()

◆ OnMouseButtonDown()

◆ OnMouseButtonUp()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ PlayCheckedSound()

◆ PlayHoverSound()

◆ PlayUncheckedSound()

◆ SetCheckedHoveredImage()

◆ SetCheckedImage()

◆ SetCheckedPressedImage()

◆ SetClickMethod()

◆ SetContent()

◆ SetIsChecked()

◆ SetPressMethod()

◆ SetStyle()

◆ SetTouchMethod()

◆ SetUncheckedHoveredImage()

◆ SetUncheckedImage()

◆ SetUncheckedPressedImage()

◆ SetUndeterminedHoveredImage()

◆ SetUndeterminedImage()

◆ SetUndeterminedPressedImage()

◆ SLATE_BEGIN_ARGS()

◆ SupportsKeyboardFocus()

◆ ToggleCheckedState()

Member Data Documentation

◆ BackgroundHoveredImage

◆ BackgroundImage

◆ BackgroundPressedImage

◆ bCheckBoxContentUsesAutoWidth

◆ bIsFocusable

◆ bIsPressed

◆ BorderBackgroundColorOverride

◆ CheckBoxImageVAlign

◆ CheckBoxTypeOverride

◆ CheckedHoveredImage

◆ CheckedImage

◆ CheckedPressedImage

◆ CheckedSound

◆ ClickMethod

◆ ContentContainer

◆ ForegroundColorOverride