Base class for building sliders. More...

#include <WSSliderBase.h>

Inheritance diagram for UWidgetStudioSliderBase:

Public Member Functions
EValueClamp	GetClampMethod () const
	Returns the clamp method.

float	GetValue () const
	Returns the current value.

FString	GetValueAsString () const
	Returns the current value as FString.

FText	GetValueAsText () const
	Returns the current value as FText.

float	GetMinValue () const
	Returns the minimum slider value.

float	GetMaxValue () const
	Returns the maximum slider value.

float	GetStepSize () const
	Returns the step size of the slider.

EEnumeration	GetEnumerationType () const
	Returns the enumeration type.

bool	IsIncrementLocked () const
	Can the user increase the value?

bool	IsDecrementLocked () const
	Can the user decrease the value?

void	SetClampMethod (const EValueClamp NewMethod)
	Set the clamping method. More...

virtual void	SetValue (float NewValue, bool bBroadcast=true)
	Set the value of the slider. More...

virtual void	SetMinValue (float NewValue)
	Set the minimum value of the slider. More...

virtual void	SetMaxValue (float NewValue)
	Set the maximum value of the slider. More...

virtual void	SetStepSize (float NewValue)
	Set the step size of the slider. More...

virtual void	SetEnumerationType (EEnumeration NewType)
	Set the enumeration type. More...

virtual void	Increment (float Multiplier=1.f, bool bBroadcast=true)
	Increases the value by the step value. More...

virtual void	Decrement (float Multiplier=1.f, bool bBroadcast=true)
	Decreases the value by the step value. More...

virtual void	SetLockIncrement (bool NewState)
	Allow or disallow the user to increase the value. More...

virtual void	SetLockDecrement (bool NewState)
	Allow or disallow the user to decrease the value. 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 void	SynchronizeProperties () override

float	FilterValue (float InValue) const
	Filter Value based on set properties. More...

Protected Member Functions inherited from UWidgetStudioBase
virtual void	InitializeStyling ()

virtual void	UpdateStyling ()

virtual void	NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override

virtual void	NativeOnMouseLeave (const FPointerEvent &InMouseEvent) override

virtual void	NativeOnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override

Protected Attributes
FWSSliderDelegate	OnValueChanged

bool	bLockIncrement = false

bool	bLockDecrement = false

EValueClamp	ClampMethod = EValueClamp::Clamped
	The clamping method for the widget.

EEnumeration	Enumeration = EEnumeration::Int
	The value type of the slider. More...

float	Value = 50.f
	The current value of the slider.

float	Min = 0.f
	The minimum value of the slider.

float	Max = 100.f
	The maximum value of the slider.

float	StepSize = 1.f
	The step size value of the slider.

Additional Inherited Members
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

Base class for building sliders.

Member Function Documentation

◆ Decrement()

void UWidgetStudioSliderBase::Decrement	(	float	Multiplier = `1.f`,
		bool	bBroadcast = `true`
	)

virtual

Decreases the value by the step value.

Parameters

Multiplier	Multiply the step value increase per increment call.
bBroadcast	Enable to broadcast the OnValueChanged event.

◆ FilterValue()

float UWidgetStudioSliderBase::FilterValue ( float InValue ) const

protected

Filter Value based on set properties.

Important: Internal Use Only.

Parameters

InValue The value to filter.

◆ Increment()

void UWidgetStudioSliderBase::Increment	(	float	Multiplier = `1.f`,
		bool	bBroadcast = `true`
	)

virtual

Increases the value by the step value.

Parameters

Multiplier	Multiply the step value increase per increment call.
bBroadcast	Enable to broadcast the OnValueChanged event.

◆ SetClampMethod()

void UWidgetStudioSliderBase::SetClampMethod ( const EValueClamp NewMethod )

Set the clamping method.

Parameters

NewMethod The new clamping method. If setting the method to clamped, make sure to update the min/max values.

◆ SetEnumerationType()

void UWidgetStudioSliderBase::SetEnumerationType ( EEnumeration NewType )

virtual

Set the enumeration type.

Parameters

NewType The new enumeration type.

◆ SetLockDecrement()

void UWidgetStudioSliderBase::SetLockDecrement ( bool NewState )

virtual

Allow or disallow the user to decrease the value.

Parameters

NewState The new lock increment state. Enable to disable the option to decrease the slider value.

◆ SetLockIncrement()

void UWidgetStudioSliderBase::SetLockIncrement ( bool NewState )

virtual

Allow or disallow the user to increase the value.

Parameters

NewState The new lock increment state. Enable to disable the option to increase the slider value.

◆ SetMaxValue()

void UWidgetStudioSliderBase::SetMaxValue ( float NewValue )

virtual

Set the maximum value of the slider.

Parameters

NewValue The new maximum value that the slider will allow.

◆ SetMinValue()

void UWidgetStudioSliderBase::SetMinValue ( float NewValue )

virtual

Set the minimum value of the slider.

Parameters

NewValue The new minimum value that the slider will allow.

◆ SetStepSize()

void UWidgetStudioSliderBase::SetStepSize ( float NewValue )

virtual

Set the step size of the slider.

Parameters

NewValue The new step size that the slider will snap to when the current value changes.

◆ SetValue()

void UWidgetStudioSliderBase::SetValue	(	float	NewValue,
		bool	bBroadcast = `true`
	)

virtual

Set the value of the slider.

Parameters

NewValue	The value to set the slider to.
bBroadcast	Enable to broadcast the OnValueChanged event.

Reimplemented in UWidgetStudioModernSpinBox.

Member Data Documentation

◆ Enumeration

EEnumeration UWidgetStudioSliderBase::Enumeration = EEnumeration::Int

protected

The value type of the slider.

Note, change the Step Size to a decimal value for this to properly take effect.

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

src/WidgetStudio/Source/WidgetStudioRuntime/Public/Widgets/WSSliderBase.h
src/WidgetStudio/Source/WidgetStudioRuntime/Private/Widgets/WSSliderBase.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Decrement()

◆ FilterValue()

◆ Increment()

◆ SetClampMethod()

◆ SetEnumerationType()

◆ SetLockDecrement()

◆ SetLockIncrement()

◆ SetMaxValue()

◆ SetMinValue()

◆ SetStepSize()

◆ SetValue()

Member Data Documentation

◆ Enumeration