UWidgetStudioModernSlider Class Reference

A modern styled slider. More...

#include <WSModernSlider.h>

Inheritance diagram for UWidgetStudioModernSlider:

Public Member Functions
FText	GetLabelText () const
	Deprecated. More...
bool	IsValueVisible () const
	Is the value visible?
bool	IsHandleVisible () const
	Is the handle visible?
bool	IsColorBasedOnValue () const
	Returns true if the color is based on value.
bool	IsColorBasedOnValueReversed () const
	Returns true if the color based on value order is reversed.
bool	IsInputEnabled () const
	Can the user interact with the slider?
void	SetLabelText (FText NewText)
	Deprecated. More...
void	SetValueVisibility (bool bNewState)
	Set the values visibility. More...
void	SetHandleVisibility (bool bNewState)
	Set the handles visibility. More...
void	SetColorBasedOnValue (bool bNewState)
	Set the color to be based on value (true) or to use the handle color (false). More...
void	SetReverseColorOrder (bool bNewState)
	Reverses the color based on value's order. More...
void	SetInputState (bool NewState)
	Allow or disallow the user to interact with the slider. More...
Public Member Functions inherited from UWidgetStudioSliderBase
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 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
void	OnTextCommitted (const FText &InText, ETextCommit::Type InCommitMethod)
Protected Member Functions inherited from UWidgetStudioSliderBase
float	FilterValue (float InValue) const
	Filter Value based on set properties. More...
Protected Member Functions inherited from UWidgetStudioBase
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
UVerticalBox *	VBox = nullptr
USizeBox *	SizeBox = nullptr
UHorizontalBox *	HBox = nullptr
UOverlay *	Overlay = nullptr
UScaleBox *	TrackScaleBox = nullptr
UOverlay *	TrackOverlay = nullptr
UImage *	Track = nullptr
UImage *	TrackDropShadow = nullptr
USizeBox *	FillTrackSizeBox = nullptr
UImage *	FillTrack = nullptr
UScaleBox *	HandleScaleBox = nullptr
USizeBox *	HandleSizeBox = nullptr
UOverlay *	HandleOverlay = nullptr
UImage *	HandleDropShadow = nullptr
UImage *	Handle = nullptr
USlider *	SliderItem = nullptr
USizeBox *	TextInputSizeBox = nullptr
UEditableTextBox *	TextInput = nullptr
UWidgetStudioText *	LabelItem = nullptr
Protected Attributes inherited from UWidgetStudioSliderBase
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

A modern styled slider.

Useful for setting a value between a minimum and a maximum.

Member Function Documentation

GetLabelText()

FText UWidgetStudioModernSlider::GetLabelText

(

)

const

Deprecated.

Use the Label Widget instead.

InitializeStyling()

void UWidgetStudioModernSlider::InitializeStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

SetColorBasedOnValue()

void UWidgetStudioModernSlider::SetColorBasedOnValue

(

bool

bNewState

)

Set the color to be based on value (true) or to use the handle color (false).

Parameters

bNewState

The new color based on value state. Enable to have the color change based on the current value compared to the min/max. Disable to have the color controlled by the set palette.

SetHandleVisibility()

void UWidgetStudioModernSlider::SetHandleVisibility

(

bool

bNewState

)

Set the handles visibility.

Parameters

bNewState

The new visibility state of the handle. Enable to display the handle. Disable to hide the handle. Functionality remains the same.

SetInputState()

void UWidgetStudioModernSlider::SetInputState

(

bool

NewState

)

Allow or disallow the user to interact with the slider.

Parameters

NewState

The new input state. Enable to allow user input. Disable to block user input.

SetLabelText()

void UWidgetStudioModernSlider::SetLabelText

(

FText

NewText

)

Deprecated.

Use the Label Widget instead.

SetReverseColorOrder()

void UWidgetStudioModernSlider::SetReverseColorOrder

(

bool

bNewState

)

Reverses the color based on value's order.

Changes to [0] Hostile -> Friendly [1].

Parameters

bNewState

The new color order state. Enable to reverse the order of the color based on value range.

SetValueVisibility()

void UWidgetStudioModernSlider::SetValueVisibility

(

bool

bNewState

)

Set the values visibility.

Parameters

bNewState

The new visibility state of the value. Enable to display the value. Disable to hide the value and have the slider fill in the remaining space.

SynchronizeProperties()

void UWidgetStudioModernSlider::SynchronizeProperties ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioSliderBase.

UpdateStyling()

void UWidgetStudioModernSlider::UpdateStyling ( )

overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

---

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

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