1. Epic GamesDeveloper
  3. SSlider

SSlider

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

API > API/Runtime > API/Runtime/Slate

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

   
Name SSlider
Type class
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Input/SSlider.h
Include Path #include "Widgets/Input/SSlider.h"

Syntax

class SSlider : public SLeafWidget

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

SSlider()

   Widgets/Input/SSlider.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~SSlider()

   Widgets/Input/SSlider.h  

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
PrivateParentType SLeafWidget   Widgets/Input/SSlider.h
PrivateThisType SSlider   Widgets/Input/SSlider.h
Super SLeafWidget   Widgets/Input/SSlider.h
ThisClass SSlider   Widgets/Input/SSlider.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
IndentHandleSlateAttribute TSlateAttribute< bool > Holds a flag indicating whether the slideable area should be indented to fit the handle. Widgets/Input/SSlider.h  
LockedSlateAttribute TSlateAttribute< bool > Holds a flag indicating whether the slider is locked. Widgets/Input/SSlider.h  
OnControllerCaptureBegin FSimpleDelegate Holds a delegate that is executed when capture begins for controller or keyboard. Widgets/Input/SSlider.h  
OnControllerCaptureEnd FSimpleDelegate Holds a delegate that is executed when capture ends for controller or keyboard. Widgets/Input/SSlider.h  
OnMouseCaptureBegin FSimpleDelegate Holds a delegate that is executed when the mouse is pressed and a capture begins. Widgets/Input/SSlider.h  
OnMouseCaptureEnd FSimpleDelegate Holds a delegate that is executed when the mouse is let up and a capture ends. Widgets/Input/SSlider.h  
OnValueChanged FOnFloatValueChanged Holds a delegate that is executed when the slider's value changed. Widgets/Input/SSlider.h  
SliderBarColorSlateAttribute TSlateAttribute< FSlateColor > Holds the color of the slider bar. Widgets/Input/SSlider.h  
SliderHandleColorSlateAttribute TSlateAttribute< FSlateColor > Holds the color of the slider handle. Widgets/Input/SSlider.h  
ValueSlateAttribute TSlateAttribute< float > Holds the slider's current value. Widgets/Input/SSlider.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const SSlider::FArguments& InDeclaration
)

 Construct the widget. Widgets/Input/SSlider.h  

float GetMaxValue()

 Get the MaxValue attribute Widgets/Input/SSlider.h  

float GetMinValue()

 Get the MinValue attribute Widgets/Input/SSlider.h  

float GetNormalizedValue()

 Get the Value attribute scaled from 0 to 1 Widgets/Input/SSlider.h  

float GetStepSize()

 Get the StepSize attribute Widgets/Input/SSlider.h  

float GetValue()

 Get the Value attribute Widgets/Input/SSlider.h  

bool IsLocked()

   Widgets/Input/SSlider.h  

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

   Widgets/Input/SSlider.h  

void SetIndentHandle ( TAttribute< bool > InIndentHandle
)

 Set the IndentHandle attribute Widgets/Input/SSlider.h  

void SetLocked ( TAttribute< bool > InLocked
)

 Set the Locked attribute Widgets/Input/SSlider.h  

void SetMinAndMaxValues ( float InMinValue,
float InMaxValue
)

 Set the MinValue and MaxValue attributes. Widgets/Input/SSlider.h  

void SetMouseUsesStep ( bool MouseUsesStep
)

 Set the MouseUsesStep attribute Widgets/Input/SSlider.h  

void SetOrientation ( EOrientation InOrientation
)

 Set the Orientation attribute Widgets/Input/SSlider.h  

void SetRequiresControllerLock ( bool RequiresControllerLock
)

 Set the RequiresControllerLock attribute Widgets/Input/SSlider.h  

void SetSliderBarColor ( TAttribute< FSlateColor > InSliderBarColor
)

 Set the SliderBarColor attribute Widgets/Input/SSlider.h  

void SetSliderHandleColor ( TAttribute< FSlateColor > InSliderHandleColor
)

 Set the SliderHandleColor attribute Widgets/Input/SSlider.h  

void SetStepSize ( TAttribute< float > InStepSize
)

 Set the StepSize attribute Widgets/Input/SSlider.h  

void SetStyle ( const FSliderStyle* InStyle
)

 Set the widget style. Widgets/Input/SSlider.h  

void SetValue ( TAttribute< float > InValueAttribute
)

 Set the Value attribute Widgets/Input/SSlider.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FVector2D ComputeDesiredSize ( float
) const

   Widgets/Input/SSlider.h  

virtual TSharedRef< FSlateAccessibleWidget > CreateAccessibleWidget()

   Widgets/Input/SSlider.h  

virtual bool IsInteractable()

   Widgets/Input/SSlider.h  

virtual void OnFocusLost ( const FFocusEvent& InFocusEvent
)

   Widgets/Input/SSlider.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Widgets/Input/SSlider.h  

virtual FReply OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Widgets/Input/SSlider.h  

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

   Widgets/Input/SSlider.h  

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

   Widgets/Input/SSlider.h  

virtual void OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

   Widgets/Input/SSlider.h  

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

   Widgets/Input/SSlider.h  

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

   Widgets/Input/SSlider.h  

virtual FReply OnTouchEnded ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

   Widgets/Input/SSlider.h  

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

   Widgets/Input/SSlider.h  

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

   Widgets/Input/SSlider.h  

virtual bool SupportsKeyboardFocus()

   Widgets/Input/SSlider.h  

Overridden from FSlateControlledConstruction

Name Remarks Include Path Unreal Specifiers

virtual const FSlateWidgetClassData & GetWidgetClass()

   Widgets/Input/SSlider.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CommitValue ( float NewValue
)

 Commits the specified slider value. Widgets/Input/SSlider.h  

const FSlateBrush * GetBarImage()

   Widgets/Input/SSlider.h  

TSlateAttributeRef< bool > GetIndentHandleAttribute()

   Widgets/Input/SSlider.h  

TSlateAttributeRef< bool > GetLockedAttribute()

   Widgets/Input/SSlider.h  

TSlateAttributeRef< FSlateColor > GetSliderBarColorAttribute()

   Widgets/Input/SSlider.h  

TSlateAttributeRef< FSlateColor > GetSliderHandleColorAttribute()

   Widgets/Input/SSlider.h  

const FSlateBrush * GetThumbImage()

   Widgets/Input/SSlider.h  

TSlateAttributeRef< float > GetValueAttribute()

   Widgets/Input/SSlider.h  

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

 Calculates the new value based on the given absolute coordinates. Widgets/Input/SSlider.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FSlateWidgetClassData & GetPrivateWidgetClass()

   Widgets/Input/SSlider.h  

static SLATE_API void PrivateRegisterAttributes ( FSlateAttributeInitializer&
)

   Widgets/Input/SSlider.h  

static const FSlateWidgetClassData & StaticWidgetClass()

   Widgets/Input/SSlider.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page