1. Epic GamesDeveloper
  3. SSlider

SSlider

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

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Input

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Input/SSlider.h
Include #include "Widgets/Input/SSlider.h"

Syntax

class SSlider : public SLeafWidget

Remarks

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

Variables

  Type Name Description
Protected variable bool bControllerInputCaptured Holds a flag indicating whether a controller/keyboard is manipulating the slider's value.
Protected variable bool bIsFocusable When true, this slider will be keyboard focusable. Defaults to false.
Protected variable bool bMouseUsesStep Sets new value if mouse position is greater/less than half the step size.
Protected variable bool bRequiresControllerLock Sets whether we have to lock input to change the slider value.
Protected variable EMouseCursor::Type CachedCursor Holds the initial cursor in case a custom cursor has been specified, so we can restore it after dragging the slider.
Protected variable float MaxValue  
Protected variable float MinValue  
Protected variable EOrientation Orientation Holds the slider's orientation.
Protected variable UE::Slate::FDeprecateVector2DResult PressedScreenSpaceTouchDownPosition The location in screenspace the slider was pressed by a touch
Protected variable TAttribute< float > StepSize Holds the amount to adjust the value by when using a controller or keyboard
Protected variable const FSliderStyle * Style Holds the style passed to the widget upon construction.

Constructors

  Type Name Description
Public function  

SSlider ()

  

Functions

  Type Name Description
Protected function Virtual void

CommitValue ( float NewValue
)

 Commits the specified slider value.
Public function void

Construct ( const SSlider::FArguments& InDeclaration
)

 Construct the widget.
Protected function Const const FSlateBrush *  
Protected function Const TSlateAttributeRef< bool >  
Protected function Const TSlateAttributeRef< bool >  
Public function Const float Get the MaxValue attribute
Public function Const float Get the MinValue attribute
Public function Const float Get the Value attribute scaled from 0 to 1
Protected function Const TSlateAttributeRef< FSlateColor >  
Protected function Const TSlateAttributeRef< FSlateColor >  
Public function Const float Get the StepSize attribute
Protected function Const const FSlateBrush *  
Public function Const float Get the Value attribute
Protected function Const TSlateAttributeRef< float >  
Public function Const bool  
Protected function float

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

 Calculates the new value based on the given absolute coordinates.
Public function void

SetIndentHandle ( TAttribute< bool > InIndentHandle
)

 Set the IndentHandle attribute
Public function void

SetLocked ( TAttribute< bool > InLocked
)

 Set the Locked attribute
Public function void

SetMinAndMaxValues ( float InMinValue,
float InMaxValue
)

 Set the MinValue and MaxValue attributes.
Public function void

SetMouseUsesStep ( bool MouseUsesStep
)

 Set the MouseUsesStep attribute
Public function void

SetOrientation ( EOrientation InOrientation
)

 Set the Orientation attribute
Public function void

SetRequiresControllerLock ( bool RequiresControllerLock
)

 Set the RequiresControllerLock attribute
Public function void

SetSliderBarColor ( TAttribute< FSlateColor > InSliderBarColor
)

 Set the SliderBarColor attribute
Public function void

SetSliderHandleColor ( TAttribute< FSlateColor > InSliderHandleColor
)

 Set the SliderHandleColor attribute
Public function void

SetStepSize ( TAttribute< float > InStepSize
)

 Set the StepSize attribute
Public function void

SetStyle ( const FSliderStyle* InStyle
)

 Set the widget style.
Public function void

SetValue ( TAttribute< float > InValueAttribute
)

 Set the Value attribute
Public function Static const FSlateWidgetClassData &  

Overridden from SWidget

  Type Name Description
Public function Virtual Const FVector2D

ComputeDesiredSize ( float
)

 Overwritten from SWidget.
Public function Virtual TSharedRef< FSlateAccessibleWidget >  
Public function Virtual Const bool  
Public function Virtual void

OnFocusLost ( const FFocusEvent& InFocusEvent
)

 Called when this widget loses focus. This event does not bubble.
Public function Virtual FReply

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

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Public function Virtual FReply

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

 Called after a key is released when this widget has focus
Public function Virtual FReply

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

 MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
Public function Virtual FReply

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

 The system calls this method to notify the widget that a mouse button was release within it.
Public function Virtual void

OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

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

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

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual FNavigationReply

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

 Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.
Public function Virtual Const int32

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

 Overwritten from SWidget.
Public function Virtual FReply

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

 Called when a touchpad touch is ended (finger lifted)
Public function Virtual FReply

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

 Called when a touchpad touch is moved (finger moved)
Public function Virtual FReply

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

 Called when a touchpad touch is started (finger down)
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Overridden from FSlateControlledConstruction

  Type Name Description
Public function Virtual Const const FSlateWidgetClassData &  

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
PrivateParentType  
PrivateThisType  
Super  
ThisClass  

Deprecated Variables

  Type Name Description
Protected variable TSlateDeprecatedTAttribute< bool > IndentHandle Direct access to IndentHandle is now deprecated. Use the setter or getter.
Protected variable TSlateDeprecatedTAttribute< bool > LockedAttribute Direct access to LockedAttribute is now deprecated. Use the setter or getter.
Protected variable TSlateDeprecatedTAttribute< FSlateColor > SliderBarColor Direct access to SliderBarColor is now deprecated. Use the setter or getter.
Protected variable TSlateDeprecatedTAttribute< FSlateColor > SliderHandleColor Direct access to SliderHandleColor is now deprecated. Use the setter or getter.
Protected variable TSlateDeprecatedTAttribute< float > ValueAttribute Direct access to Value is now deprecated. Use the setter or getter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page