#include <SSlider.h>

Inheritance diagram for SSlider:

Public Member Functions
	SLATE_BEGIN_ARGS (SSlider)

SLATE_API	SSlider ()

virtual SLATE_API	~SSlider ()

SLATE_API void	Construct (const SSlider::FArguments &InDeclaration)

SLATE_API void	SetStyle (const FSliderStyle *InStyle)

float	GetMinValue () const

float	GetMaxValue () const

SLATE_API float	GetValue () const

SLATE_API float	GetNormalizedValue () const

SLATE_API void	SetValue (TAttribute< float > InValueAttribute)

SLATE_API void	SetMinAndMaxValues (float InMinValue, float InMaxValue)

SLATE_API void	SetIndentHandle (TAttribute< bool > InIndentHandle)

SLATE_API void	SetLocked (TAttribute< bool > InLocked)

SLATE_API void	SetOrientation (EOrientation InOrientation)

SLATE_API void	SetSliderBarColor (TAttribute< FSlateColor > InSliderBarColor)

SLATE_API void	SetSliderHandleColor (TAttribute< FSlateColor > InSliderHandleColor)

SLATE_API float	GetStepSize () const

SLATE_API void	SetStepSize (TAttribute< float > InStepSize)

SLATE_API void	SetMouseUsesStep (bool MouseUsesStep)

SLATE_API void	SetRequiresControllerLock (bool RequiresControllerLock)

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

virtual SLATE_API FVector2D	ComputeDesiredSize (float) const override

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

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

virtual SLATE_API void	OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override

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

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

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

virtual SLATE_API FReply	OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) 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 void	OnFocusLost (const FFocusEvent &InFocusEvent) override

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

virtual SLATE_API bool	SupportsKeyboardFocus () const override

virtual SLATE_API bool	IsInteractable () const override

SLATE_API bool	IsLocked () const

Public Member Functions inherited from SLeafWidget
SLATECORE_API	SLeafWidget ()

virtual SLATECORE_API	~SLeafWidget ()

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	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 void	OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseLeave (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 FReply	OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)

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	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 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

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	GetForegroundColor () 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
virtual SLATE_API void	CommitValue (float NewValue)

SLATE_API float	PositionToValue (const FGeometry &MyGeometry, const UE::Slate::FDeprecateVector2DParameter &AbsolutePosition)

SLATE_API const FSlateBrush *	GetBarImage () const

SLATE_API const FSlateBrush *	GetThumbImage () const

TSlateAttributeRef< float >	GetValueAttribute () const

TSlateAttributeRef< bool >	GetIndentHandleAttribute () const

TSlateAttributeRef< bool >	GetLockedAttribute () const

TSlateAttributeRef< FSlateColor >	GetSliderBarColorAttribute () const

TSlateAttributeRef< FSlateColor >	GetSliderHandleColorAttribute () const

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 FSliderStyle *	Style

EOrientation	Orientation

EMouseCursor::Type	CachedCursor

UE::Slate::FDeprecateVector2DResult	PressedScreenSpaceTouchDownPosition

TAttribute< float >	StepSize

float	MinValue

float	MaxValue

bool	bControllerInputCaptured

bool	bMouseUsesStep

bool	bRequiresControllerLock

bool	bIsFocusable

bool	bPreventThrottling = false

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

A Slate slider control is a linear scale and draggable handle.

Constructor & Destructor Documentation

◆ SSlider()

SSlider::SSlider ( )

Whether the slidable area should be indented to fit the handle. Sets new value if mouse position is greater/less than half the step size. Sets whether we have to lock input to change the slider value. Whether the handle is interactive or fixed. The slider's orientation. The color to draw the slider bar in. The color to draw the slider handle in. The style used to draw the slider. The input mode while using the controller. A value that drives where the slider handle appears. Value is normalized between 0 and 1. The minimum value that can be specified by using the slider. The maximum value that can be specified by using the slider. Sometimes a slider should only be mouse-clickable and never keyboard focusable. Invoked when the mouse is pressed and a capture begins. Invoked when the mouse is released and a capture ends. Invoked when the Controller is pressed and capture begins. Invoked when the controller capture is released.
Called when the value is changed by the slider. If refresh requests for the viewport should happen for all value changes

◆ ~SSlider()

SSlider::~SSlider ( )

virtualdefault

Member Function Documentation

◆ CommitValue()

void SSlider::CommitValue ( float NewValue )

protectedvirtual

Commits the specified slider value.

Parameters

NewValue The value to commit.

◆ ComputeDesiredSize()

FVector2D SSlider::ComputeDesiredSize ( float ) const

overridevirtual

Overwritten from SWidget.

LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.

Implements SLeafWidget.

◆ Construct()

void SSlider::Construct ( const SSlider::FArguments & InDeclaration )

Construct the widget.

Parameters

InDeclaration A declaration from which to construct the widget.

◆ GetBarImage()

const FSlateBrush * SSlider::GetBarImage ( ) const

protected

◆ GetIndentHandleAttribute()

TSlateAttributeRef< bool > SSlider::GetIndentHandleAttribute ( ) const

inlineprotected

Returns: an attribute reference of IndentHandle

◆ GetLockedAttribute()

TSlateAttributeRef< bool > SSlider::GetLockedAttribute ( ) const

inlineprotected

Returns: an attribute reference of Locked

◆ GetMaxValue()

float SSlider::GetMaxValue ( ) const

inline

Get the MaxValue attribute

◆ GetMinValue()

float SSlider::GetMinValue ( ) const

inline

Get the MinValue attribute

◆ GetNormalizedValue()

float SSlider::GetNormalizedValue ( ) const

Get the Value attribute scaled from 0 to 1

◆ GetSliderBarColorAttribute()

TSlateAttributeRef< FSlateColor > SSlider::GetSliderBarColorAttribute ( ) const

inlineprotected

Returns: an attribute reference of SliderBarColor

◆ GetSliderHandleColorAttribute()

TSlateAttributeRef< FSlateColor > SSlider::GetSliderHandleColorAttribute ( ) const

inlineprotected

Returns: an attribute reference of SliderHandleColor

◆ GetStepSize()

float SSlider::GetStepSize ( ) const

Get the StepSize attribute

◆ GetThumbImage()

const FSlateBrush * SSlider::GetThumbImage ( ) const

protected

◆ GetValue()

float SSlider::GetValue ( ) const

Get the Value attribute

◆ GetValueAttribute()

TSlateAttributeRef< float > SSlider::GetValueAttribute ( ) const

inlineprotected

Returns: an attribute reference of IndentHandle

◆ IsInteractable()

bool SSlider::IsInteractable ( ) const

overridevirtual

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

Reimplemented from SWidget.

◆ IsLocked()

bool SSlider::IsLocked ( ) const

Returns: Is the handle locked or not? Defaults to false

◆ OnFocusLost()

void SSlider::OnFocusLost ( const FFocusEvent & InFocusEvent )

overridevirtual

Called when this widget loses focus. This event does not bubble.

Parameters

InFocusEvent The FocusEvent

Reimplemented from SWidget.

◆ OnKeyDown()

FReply SSlider::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 SSlider::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.

◆ OnMouseButtonDown()

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

overridevirtual

The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.

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.

◆ OnMouseButtonUp()

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

overridevirtual

The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled.

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.

◆ OnMouseCaptureLost()

void SSlider::OnMouseCaptureLost ( const FCaptureLostEvent & CaptureLostEvent )

overridevirtual

Called when this widget had captured the mouse, but that capture has been revoked for some reason.

Reimplemented from SWidget.

◆ OnMouseMove()

FReply SSlider::OnMouseMove	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

The system calls this method to notify the widget that a mouse moved within it. This event is bubbled.

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.

◆ OnNavigation()

FNavigationReply SSlider::OnNavigation	(	const FGeometry &	MyGeometry,
		const FNavigationEvent &	InNavigationEvent
	)

overridevirtual

Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.

Parameters

InNavigationEvent The navigation event generated

Reimplemented from SWidget.

◆ OnPaint()

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

overridevirtual

Overwritten from SWidget.

LeafWidgets provide a visual representation of themselves. They do so by adding DrawElement(s) to the OutDrawElements. DrawElements should have their positions set to absolute coordinates in Window space; for this purpose the Slate system provides the AllottedGeometry parameter. AllottedGeometry describes the space allocated for the visualization of this widget.

Whenever possible, LeafWidgets should avoid dealing with layout properties. See TextBlock for an example.

Implements SLeafWidget.

◆ OnTouchEnded()

FReply SSlider::OnTouchEnded	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

overridevirtual

Called when a touchpad touch is ended (finger lifted)

Parameters

InTouchEvent The touch event generated

Reimplemented from SWidget.

◆ OnTouchMoved()

FReply SSlider::OnTouchMoved	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

overridevirtual

Called when a touchpad touch is moved (finger moved)

Parameters

InTouchEvent The touch event generated

Reimplemented from SWidget.

◆ OnTouchStarted()

FReply SSlider::OnTouchStarted	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	InTouchEvent
	)

overridevirtual

Called when a touchpad touch is started (finger down)

Parameters

InTouchEvent The touch event generated

Reimplemented from SWidget.

◆ PositionToValue()

float SSlider::PositionToValue	(	const FGeometry &	MyGeometry,
		const UE::Slate::FDeprecateVector2DParameter &	AbsolutePosition
	)

protected

Calculates the new value based on the given absolute coordinates.

Parameters

MyGeometry	The slider's geometry.
AbsolutePosition	The absolute position of the slider.

Returns: The new value.

◆ SetIndentHandle()

void SSlider::SetIndentHandle ( TAttribute< bool > InIndentHandle )

Set the IndentHandle attribute

◆ SetLocked()

void SSlider::SetLocked ( TAttribute< bool > InLocked )

Set the Locked attribute

◆ SetMinAndMaxValues()

void SSlider::SetMinAndMaxValues	(	float	InMinValue,
		float	InMaxValue
	)

Set the MinValue and MaxValue attributes. If the new MinValue is more than the new MaxValue, MaxValue will be changed to equal MinValue.

◆ SetMouseUsesStep()

void SSlider::SetMouseUsesStep ( bool MouseUsesStep )

Set the MouseUsesStep attribute

◆ SetOrientation()

void SSlider::SetOrientation ( EOrientation InOrientation )

Set the Orientation attribute

◆ SetRequiresControllerLock()

void SSlider::SetRequiresControllerLock ( bool RequiresControllerLock )

Set the RequiresControllerLock attribute

◆ SetSliderBarColor()

void SSlider::SetSliderBarColor ( TAttribute< FSlateColor > InSliderBarColor )

Set the SliderBarColor attribute

◆ SetSliderHandleColor()

void SSlider::SetSliderHandleColor ( TAttribute< FSlateColor > InSliderHandleColor )

Set the SliderHandleColor attribute

◆ SetStepSize()

void SSlider::SetStepSize ( TAttribute< float > InStepSize )

Set the StepSize attribute

◆ SetStyle()

void SSlider::SetStyle ( const FSliderStyle * InStyle )

Set the widget style.

◆ SetValue()

void SSlider::SetValue ( TAttribute< float > InValueAttribute )

Set the Value attribute

◆ SLATE_BEGIN_ARGS()

SSlider::SLATE_BEGIN_ARGS ( SSlider )

inline

◆ SupportsKeyboardFocus()

bool SSlider::SupportsKeyboardFocus ( ) const

overridevirtual

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Returns: True if this widget can take keyboard focus

Reimplemented from SWidget.

Member Data Documentation

◆ bControllerInputCaptured

bool SSlider::bControllerInputCaptured

protected

◆ bIsFocusable

bool SSlider::bIsFocusable

protected

When true, this slider will be keyboard focusable. Defaults to false.

◆ bMouseUsesStep

bool SSlider::bMouseUsesStep

protected

Sets new value if mouse position is greater/less than half the step size.

◆ bPreventThrottling

bool SSlider::bPreventThrottling = false

protected

◆ bRequiresControllerLock

bool SSlider::bRequiresControllerLock

protected

Sets whether we have to lock input to change the slider value.

◆ CachedCursor

EMouseCursor::Type SSlider::CachedCursor

protected

◆ MaxValue

float SSlider::MaxValue

protected

◆ MinValue

float SSlider::MinValue

protected

◆ Orientation

EOrientation SSlider::Orientation

protected

◆ PressedScreenSpaceTouchDownPosition

UE::Slate::FDeprecateVector2DResult SSlider::PressedScreenSpaceTouchDownPosition

protected

The location in screenspace the slider was pressed by a touch

◆ StepSize

TAttribute<float> SSlider::StepSize

protected

Holds the amount to adjust the value by when using a controller or keyboard

◆ Style

const FSliderStyle* SSlider::Style

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SSlider()

◆ ~SSlider()

Member Function Documentation

◆ CommitValue()

◆ ComputeDesiredSize()

◆ Construct()

◆ GetBarImage()

◆ GetIndentHandleAttribute()

◆ GetLockedAttribute()

◆ GetMaxValue()

◆ GetMinValue()

◆ GetNormalizedValue()

◆ GetSliderBarColorAttribute()

◆ GetSliderHandleColorAttribute()

◆ GetStepSize()

◆ GetThumbImage()

◆ GetValue()

◆ GetValueAttribute()

◆ IsInteractable()

◆ IsLocked()

◆ OnFocusLost()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnMouseButtonDown()

◆ OnMouseButtonUp()

◆ OnMouseCaptureLost()

◆ OnMouseMove()

◆ OnNavigation()

◆ OnPaint()

◆ OnTouchEnded()

◆ OnTouchMoved()

◆ OnTouchStarted()

◆ PositionToValue()

◆ SetIndentHandle()

◆ SetLocked()

◆ SetMinAndMaxValues()

◆ SetMouseUsesStep()

◆ SetOrientation()

◆ SetRequiresControllerLock()

◆ SetSliderBarColor()

◆ SetSliderHandleColor()

◆ SetStepSize()

◆ SetStyle()

◆ SetValue()

◆ SLATE_BEGIN_ARGS()

◆ SupportsKeyboardFocus()

Member Data Documentation

◆ bControllerInputCaptured

◆ bIsFocusable

◆ bMouseUsesStep

◆ bPreventThrottling

◆ bRequiresControllerLock

◆ CachedCursor

◆ MaxValue

◆ MinValue

◆ Orientation

◆ PressedScreenSpaceTouchDownPosition

◆ StepSize

◆ Style