A modern styled checkbox. More...

#include <WSModernCheckBox.h>

Inheritance diagram for UWidgetStudioModernCheckBox:

Public Member Functions
FText	GetLabel () const
	Returns the text.

EIconItem	GetIcon () const
	Returns the icon.

EPalette	GetBackgroundColor () const
	Returns the background color.

EPalette	GetContentColor () const
	Returns the content (Text/Icon).

EPalette	GetCheckedColor () const
	Returns the checked color.

EClusivity	GetSelectionMethod () const
	Returns the selection method.

void	SetText (FText NewText)
	Sets the label displayed on the checkbox. More...

void	SetIcon (EIconItem NewIcon)
	Sets the icon displayed on the checkbox when checked (on/true). More...

void	SetBackgroundColor (EPalette NewColor)
	Set the color of the background. More...

void	SetContentColor (EPalette NewColor)
	Set the color of the content (Text/Icon) when the button IS in a checked state. More...

void	SetCheckedColor (EPalette NewColor)
	Set the color of the checkbox when checked. More...

void	SetSelectionMethod (EClusivity NewState)

Public Member Functions inherited from UWidgetStudioButtonBase
void	ExecuteOnPressedLambda (UWidgetStudioButtonBase *CallingButton)
	Executes the OnPressedLambda delegate. More...

bool	IsCheckable () const
	Returns the checkable state of the button. More...

bool	IsChecked () const
	Returns the checked state of the button. More...

bool	IsCheckedStateLocked () const
	Returns the checked lock state of the button.

bool	IsPressed () const
	Returns the pressed state of the button.

virtual void	SetCheckable (bool bNewCheckableState)
	Set the checkable state of the button. More...

virtual void	SetChecked (bool bNewCheckedState, bool bBroadcast=true)
	Set the checked state of the button. More...

virtual void	SetCheckedLockedState (bool bNewCheckedState)
	Lock or unlock the ability to change the checked state of the button. More...

Public Member Functions inherited from UWidgetStudioBase
FVector2D	GetDimensions () const
	Returns the current X and Y dimensions of the Widget. More...

int32	GetBorderRadius () const
	Returns the current border radius of the Widget. More...

void	ForceStyleUpdate ()
	Refresh the dynamic styling of the Widget Studio widget.

void	SetSizeModifier (ESizeModifier InSizeModifier)
	Set the size modifier of the Widget Studio widget.

Protected Member Functions
virtual TSharedRef< SWidget >	RebuildWidget () override

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

virtual void	SynchronizeProperties () override

virtual void	InitializeStyling () override

virtual void	UpdateStyling () override

Protected Member Functions inherited from UWidgetStudioButtonBase
virtual void	NativeOnInitialized () override

virtual FReply	NativeOnMouseButtonDown (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override

virtual FReply	NativeOnMouseButtonUp (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override

virtual void	NativeOnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override

virtual void	NativeOnMouseLeave (const FPointerEvent &InMouseEvent) override

Protected Member Functions inherited from UWidgetStudioBase
virtual void	NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override

Protected Attributes
UInvalidationBox *	Retainer = nullptr

USizeBox *	SizeBox = nullptr

UScaleBox *	BackgroundScaleBox = nullptr

UOverlay *	Overlay = nullptr

UOverlay *	BackgroundOverlay = nullptr

UImage *	DropShadow = nullptr

UImage *	Background = nullptr

UScaleBox *	CheckScaleBox = nullptr

UImage *	BackgroundOutline = nullptr

UHorizontalBox *	HBox = nullptr

UOverlay *	CheckOverlay = nullptr

UImage *	CheckBackground = nullptr

UImage *	CheckOutline = nullptr

UImage *	IconItem = nullptr

UWidgetStudioText *	TextItem = nullptr

USpacer *	SpacerItem = nullptr

Protected Attributes inherited from UWidgetStudioButtonBase
FTimerHandle	DoublePressTimer

bool	bIsCheckable = false
	Depicts if the button can be checked or not.

bool	bIsChecked = false
	Depicts if the button is checked (on/true) or not (off/false). More...

bool	bIsCheckedStateLocked = false
	Locks the current checked state. More...

Additional Inherited Members
Public Attributes inherited from UWidgetStudioButtonBase
FWSButtonLambda	OnPressedLambda
	An open lambda binding for to be used for complex functionality when the button is pressed. More...

FWSButtonDelegate	OnPressed
	Called when the button is pressed with the left mouse button.

FWSButtonDelegate	OnReleased
	Called when the button is released.

FWSButtonDelegate	OnDoublePressed
	Called when the button is quickly pressed twice with the left mouse button.

FWSButtonToggledDelegate	OnToggled
	Called when the buttons checked status is toggled. More...

bool	bForceCheckable = false

bool	bIsInteractable = true
	Internal Use Only. More...

Public Attributes inherited from UWidgetStudioBase
FWSBaseHoverStateDelegate	OnHoverStateChanged
	Called when the hover state has been changed.

bool	bCanOverrideDimensions = true
	Used to enable or disable dimension override's.

bool	bCanOverrideBorderRadius = true
	Used to enable or disable dimension override's.

FVector2D	MinimumDimensions = FVector2D(50, 7)
	The minimum dimensions of the widget. More...

bool	bDisablePainting = false
	Used for debugging. More...

float	AnimationTime = 7
	The animation interpolation speed. More...

ESizeModifier	SizeModifier = ESizeModifier::Regular
	Quickly modify the overall size of the widget. More...

FVector2D	OverrideDimensions = FVector2D(0, 0)
	Manually adjust the X and Y dimensions of the widget. More...

int32	OverrideBorderRadius = -1
	Manually adjust the border radius of the widget. More...

Detailed Description

A modern styled checkbox.

Member Function Documentation

◆ InitializeStyling()

void UWidgetStudioModernCheckBox::InitializeStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

◆ SetBackgroundColor()

void UWidgetStudioModernCheckBox::SetBackgroundColor ( EPalette NewColor )

Set the color of the background.

Only available when the CheckBox style is set to modern.

Parameters

NewColor The color to apply to the background.

◆ SetCheckedColor()

void UWidgetStudioModernCheckBox::SetCheckedColor ( EPalette NewColor )

Set the color of the checkbox when checked.

Parameters

NewColor The color to apply to the checkbox.

◆ SetContentColor()

void UWidgetStudioModernCheckBox::SetContentColor ( EPalette NewColor )

Set the color of the content (Text/Icon) when the button IS in a checked state.

Parameters

NewColor The color to apply to the content.

◆ SetIcon()

void UWidgetStudioModernCheckBox::SetIcon ( EIconItem NewIcon )

Sets the icon displayed on the checkbox when checked (on/true).

Parameters

NewIcon The icon to update the checkbox icon to.

◆ SetText()

void UWidgetStudioModernCheckBox::SetText ( FText NewText )

Sets the label displayed on the checkbox.

Parameters

NewText The text to update the label to.

◆ UpdateStyling()

void UWidgetStudioModernCheckBox::UpdateStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

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

src/WidgetStudio/Source/WidgetStudioRuntime/Public/Widgets/Modern/WSModernCheckBox.h
src/WidgetStudio/Source/WidgetStudioRuntime/Private/Widgets/Modern/WSModernCheckBox.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ InitializeStyling()

◆ SetBackgroundColor()

◆ SetCheckedColor()

◆ SetContentColor()

◆ SetIcon()

◆ SetText()

◆ UpdateStyling()