UWidgetStudioButtonBase Class Reference

Contain the fundamental logic for a Widget Studio button. More...

#include <WSButtonBase.h>

Inheritance diagram for UWidgetStudioButtonBase:

Public Member Functions
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.

Public Attributes
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...

Protected Member Functions
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	InitializeStyling ()
virtual void	UpdateStyling ()
virtual void	NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override

Protected Attributes
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...

Detailed Description

Contain the fundamental logic for a Widget Studio button.

Subclass to create custom buttons that are compatible with Widget Studio.

Member Function Documentation

ExecuteOnPressedLambda()

void UWidgetStudioButtonBase::ExecuteOnPressedLambda ( UWidgetStudioButtonBase *  CallingButton )

inline

Executes the OnPressedLambda delegate.

Note: Will only execute if the lambda has been bound.

IsCheckable()

bool UWidgetStudioButtonBase::IsCheckable

(

)

const

Returns the checkable state of the button.

• Will return false if not checkable.
• Will return false if checked state changing is locked.

IsChecked()

bool UWidgetStudioButtonBase::IsChecked

(

)

const

Returns the checked state of the button.

• Will return false if not checkable.

NativeOnMouseCaptureLost()

void UWidgetStudioButtonBase::NativeOnMouseCaptureLost ( const FCaptureLostEvent &  CaptureLostEvent )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

NativeOnMouseLeave()

void UWidgetStudioButtonBase::NativeOnMouseLeave ( const FPointerEvent &  InMouseEvent )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

SetCheckable()

void UWidgetStudioButtonBase::SetCheckable ( bool  bNewCheckableState )

virtual

Set the checkable state of the button.

When enabled, the button can be checked on or off.

Parameters

bNewCheckableState

The checkable state to update the button to.

SetChecked()

void UWidgetStudioButtonBase::SetChecked ( bool  bNewCheckedState, bool  bBroadcast = true  )

virtual

Set the checked state of the button.

Important: This function does nothing if the buttons checkable state is set to false.

Parameters

bNewCheckedState	The checked state to update the button to.
bBroadcastEvent	Whether or not to broadcast the event.

SetCheckedLockedState()

void UWidgetStudioButtonBase::SetCheckedLockedState ( bool  bNewCheckedState )

virtual

Lock or unlock the ability to change the checked state of the button.

Parameters

bNewCheckedState

The checked locked state to update to button to.

Member Data Documentation

bIsChecked

bool UWidgetStudioButtonBase::bIsChecked = false

protected

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

Requires the bIsCheckable state to be enabled to utilize.

bIsCheckedStateLocked

bool UWidgetStudioButtonBase::bIsCheckedStateLocked = false

protected

Locks the current checked state.

The user will not be able to change the state until this bool is set to false. Requires the bIsCheckable state to be enabled to utilize.

bIsInteractable

bool UWidgetStudioButtonBase::bIsInteractable = true

Internal Use Only.

Used to make the button non-interactable when checked.

OnPressedLambda

FWSButtonLambda UWidgetStudioButtonBase::OnPressedLambda

An open lambda binding for to be used for complex functionality when the button is pressed.

Called when OnPressed is called.

OnToggled

FWSButtonToggledDelegate UWidgetStudioButtonBase::OnToggled

Called when the buttons checked status is toggled.

Only called when the button is set to checkable.

---

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

• src/WidgetStudio/Source/WidgetStudioRuntime/Public/Widgets/WSButtonBase.h
• src/WidgetStudio/Source/WidgetStudioRuntime/Private/Widgets/WSButtonBase.cpp