UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SScrollBar Class Reference

#include <SScrollBar.h>

+ Inheritance diagram for SScrollBar:

Public Member Functions

 SLATE_BEGIN_ARGS (SScrollBar)
 
SLATE_API void Construct (const FArguments &InArgs)
 
SLATE_API void SetOnUserScrolled (const FOnUserScrolled &InHandler)
 
SLATE_API void SetOnScrollBarVisibilityChanged (const FOnScrollBarVisibilityChanged &InHandler)
 
virtual SLATE_API void SetState (float InOffsetFraction, float InThumbSizeFraction, bool bCallOnUserScrolled=false)
 
virtual SLATE_API void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime) 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 FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATE_API void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATE_API void OnMouseLeave (const FPointerEvent &MouseEvent) override
 
SLATE_API bool IsNeeded () const
 
SLATE_API float DistanceFromTop () const
 
SLATE_API float DistanceFromBottom () const
 
SLATE_API float ThumbSizeFraction () const
 
SLATE_API EVisibility ShouldBeVisible () const
 
SLATE_API bool IsScrolling () const
 
SLATE_API EOrientation GetOrientation () const
 
SLATE_API void SetStyle (const FScrollBarStyle *InStyle)
 
SLATE_API void InvalidateStyle ()
 
void SetUserVisibility (TAttribute< EVisibility > InUserVisibility)
 
SLATE_API void SetDragFocusCause (EFocusCause InDragFocusCause)
 
SLATE_API void SetThickness (TAttribute< FVector2D > InThickness)
 
SLATE_API void SetScrollBarAlwaysVisible (bool InAlwaysVisible)
 
SLATE_API void SetScrollBarTrackAlwaysVisible (bool InAlwaysVisible)
 
SLATE_API void SetScrollbarDisabledVisibility (EVisibility InVisibility)
 
SLATE_API bool AlwaysShowScrollbar () const
 
virtual SLATE_API void BeginScrolling ()
 
virtual SLATE_API void EndScrolling ()
 
SLATE_API SScrollBar ()
 
SLATE_API ~SScrollBar ()
 
- Public Member Functions inherited from SBorder
 SLATE_BEGIN_ARGS (SBorder)
 
FArguments & Padding (float Uniform)
 
FArguments & Padding (float Horizontal, float Vertical)
 
FArguments & Padding (float Left, float Top, float Right, float Bottom)
 
SLATE_API SBorder ()
 
virtual SLATE_API ~SBorder ()
 
SLATE_API void Construct (const FArguments &InArgs)
 
virtual SLATE_API void SetContent (TSharedRef< SWidget > InContent)
 
SLATE_API const TSharedRef< SWidget > & GetContent () const
 
SLATE_API void ClearContent ()
 
SLATE_API void SetBorderBackgroundColor (TAttribute< FSlateColor > InColorAndOpacity)
 
FSlateColor GetBorderBackgroundColor () const
 
SLATE_API void SetDesiredSizeScale (TAttribute< FVector2D > InDesiredSizeScale)
 
SLATE_API void SetHAlign (EHorizontalAlignment HAlign)
 
SLATE_API void SetVAlign (EVerticalAlignment VAlign)
 
SLATE_API void SetPadding (TAttribute< FMargin > InPadding)
 
SLATE_API void SetShowEffectWhenDisabled (TAttribute< bool > InShowEffectWhenDisabled)
 
SLATE_API void SetBorderImage (TAttribute< const FSlateBrush * > InBorderImage)
 
const FSlateBrushGetBorderImage () const
 
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
 
- Public Member Functions inherited from SCompoundWidget
const FVector2D GetContentScale () const
 
void SetContentScale (TAttribute< FVector2D > InContentScale)
 
FLinearColor GetColorAndOpacity () const
 
void SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)
 
void SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)
 
virtual SLATECORE_API FChildrenGetChildren () override
 
virtual SLATECORE_API void OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override
 
virtual SLATECORE_API FSlateColor GetForegroundColor () const override
 
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 FReply OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusLost (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 OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyUp (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 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< FPopupLayerOnVisualizePopup (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 OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
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< boolOnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual SLATECORE_API FPopupMethodReply OnQueryPopupMethod () const
 
virtual SLATECORE_API TOptional< FVirtualPointerPositionTranslateMouseCoordinateForCustomHitTestChild (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 FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)
 
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 FSlateWidgetPersistentStateGetPersistentState () 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< SWidgetGetParentWidget () const
 
TSharedPtr< SWidgetAdvanced_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 FChildrenGetAllChildren ()
 
virtual SLATECORE_API bool SupportsKeyboardFocus () const
 
virtual SLATECORE_API bool HasKeyboardFocus () const
 
SLATECORE_API TOptional< EFocusCauseHasUserFocus (int32 UserIndex) const
 
SLATECORE_API TOptional< EFocusCauseHasAnyUserFocus () 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
 
virtual SLATECORE_API void OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
 
void SetEnabled (TAttribute< bool > InEnabledState)
 
bool IsEnabled () const
 
virtual bool IsInteractable () const
 
virtual SLATECORE_API TSharedPtr< IToolTipGetToolTip ()
 
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< FSlateRenderTransformGetRenderTransformWithRespectToFlowDirection () 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 GetDisabledForegroundColor () const
 
SLATECORE_API const FGeometryGetCachedGeometry () const
 
SLATECORE_API const FGeometryGetTickSpaceGeometry () const
 
SLATECORE_API const FGeometryGetPaintSpaceGeometry () const
 
const TOptional< FSlateClippingState > & GetCurrentClippingState () const
 
virtual bool Advanced_IsWindow () const
 
virtual bool Advanced_IsInvalidationRoot () const
 
virtual const FSlateInvalidationRootAdvanced_AsInvalidationRoot () const
 
SLATECORE_API TSharedRef< FActiveTimerHandleRegisterActiveTimer (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 FSlateWidgetClassDataGetWidgetClass () 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
 

Static Public Attributes

static const float DefaultUniformPadding = 2.0f
 

Protected Member Functions

SLATE_API void ExecuteOnUserScrolled (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
SLATE_API FSlateColor GetTrackOpacity () const
 
SLATE_API FLinearColor GetThumbOpacity () const
 
SLATE_API const FSlateBrushGetDragThumbImage () const
 
- Protected Member Functions inherited from SBorder
virtual SLATE_API FVector2D ComputeDesiredSize (float) const override
 
bool GetShowDisabledEffect () const
 
FVector2D GetDesiredSizeScale () const
 
TSlateAttributeRef< const FSlateBrush * > GetBorderImageAttribute () const
 
TSlateAttributeRef< FSlateColorGetBorderBackgroundColorAttribute () const
 
TSlateAttributeRef< FVector2DGetDesiredSizeScaleAttribute () const
 
TSlateAttributeRef< boolGetShowDisabledEffectAttribute () const
 
- Protected Member Functions inherited from SCompoundWidget
TSlateAttributeRef< FVector2DGetContentScaleAttribute () const
 
TSlateAttributeRef< FLinearColorGetColorAndOpacityAttribute () const
 
TSlateAttributeRef< FSlateColorGetForegroundColorAttribute () const
 
SLATECORE_API SCompoundWidget ()
 
virtual SLATECORE_API ~SCompoundWidget ()
 
- 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::TypeGetCursor () 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 FSlateBrushGetFocusBrush () 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< boolGetEnabledStateAttribute () const
 
TSlateAttributeRef< boolGetHoveredAttribute () const
 
TSlateAttributeRef< EVisibilityGetVisibilityAttribute () const
 
TSlateAttributeRef< TOptional< FSlateRenderTransform > > GetRenderTransformAttribute () const
 
TSlateAttributeRef< FVector2DGetRenderTransformPivotAttribute () const
 
virtual SLATECORE_API ~SWidget ()
 
- Protected Member Functions inherited from TSharedFromThis< SWidget >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

TAttribute< EVisibilityUserVisibility
 
TSharedPtr< SImageTopImage
 
TSharedPtr< SImageBottomImage
 
TSharedPtr< SBorderDragThumb
 
TSharedPtr< SSpacerThicknessSpacer
 
bool bDraggingThumb
 
TSharedPtr< SScrollBarTrackTrack
 
FOnUserScrolled OnUserScrolled
 
FOnScrollBarVisibilityChanged OnScrollBarVisibilityChanged
 
float DragGrabOffset
 
EOrientation Orientation
 
bool bAlwaysShowScrollbar
 
bool bAlwaysShowScrollbarTrack
 
EFocusCause DragFocusCause
 
bool bHideWhenNotInUse
 
EVisibility ScrollbarDisabledVisibility = EVisibility::Collapsed
 
bool bPreventThrottling
 
bool bIsScrolling
 
double LastInteractionTime
 
const FSlateBrushNormalThumbImage
 
const FSlateBrushHoveredThumbImage
 
const FSlateBrushDraggedThumbImage
 
const FSlateBrushBackgroundBrush
 
const FSlateBrushTopBrush
 
const FSlateBrushBottomBrush
 
- Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot ChildSlot
 
- 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 FSlateWidgetClassDataStaticWidgetClass ()
 
- 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< EVisibilityAccessWidgetVisibilityAttribute (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)
 

Constructor & Destructor Documentation

◆ SScrollBar()

SScrollBar::SScrollBar ( )

◆ ~SScrollBar()

SScrollBar::~SScrollBar ( )
default

Member Function Documentation

◆ AlwaysShowScrollbar()

bool SScrollBar::AlwaysShowScrollbar ( ) const

Returns True when the scrollbar should always be shown, else False

◆ BeginScrolling()

void SScrollBar::BeginScrolling ( )
virtual

Allows external scrolling panels to notify the scrollbar when scrolling begins.

◆ Construct()

void SScrollBar::Construct ( const FArguments &  InArgs)

The style to use for this scrollbar The thickness of the scrollbar thumb The margin around the scrollbar Construct this widget

Parameters
InArgsThe declaration data for this widget

◆ DistanceFromBottom()

float SScrollBar::DistanceFromBottom ( ) const
Returns
normalized distance from bottom

◆ DistanceFromTop()

float SScrollBar::DistanceFromTop ( ) const
Returns
normalized distance from top

◆ EndScrolling()

void SScrollBar::EndScrolling ( )
virtual

Allows external scrolling panels to notify the scrollbar when scrolling ends.

◆ ExecuteOnUserScrolled()

void SScrollBar::ExecuteOnUserScrolled ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
protected

Execute the on user scrolled delegate

◆ GetDragThumbImage()

const FSlateBrush * SScrollBar::GetDragThumbImage ( ) const
protected
Returns
the name of an image for the scrollbar thumb based on whether the user is dragging or hovering it.

◆ GetOrientation()

EOrientation SScrollBar::GetOrientation ( ) const
Returns
the orientation in which the scrollbar is scrolling.

◆ GetThumbOpacity()

FLinearColor SScrollBar::GetThumbOpacity ( ) const
protected

We always show a subtle scroll thumb, but highlight it extra when dragging

◆ GetTrackOpacity()

FSlateColor SScrollBar::GetTrackOpacity ( ) const
protected

We fade the scroll track unless it is being hovered

◆ InvalidateStyle()

void SScrollBar::InvalidateStyle ( )

Invalidate the style

◆ IsNeeded()

bool SScrollBar::IsNeeded ( ) const
Returns
true if scrolling is possible; false if the view is big enough to fit all the content

◆ IsScrolling()

bool SScrollBar::IsScrolling ( ) const
Returns
True if the user is scrolling by dragging the scroll bar thumb.

◆ OnMouseButtonDown()

FReply SScrollBar::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
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation 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 SScrollBar::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
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation about the input event
Returns
Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnMouseEnter()

void SScrollBar::OnMouseEnter ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.

Parameters
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation about the input event

Reimplemented from SWidget.

◆ OnMouseLeave()

void SScrollBar::OnMouseLeave ( const FPointerEvent MouseEvent)
overridevirtual

The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.

Parameters
MouseEventInformation about the input event

Reimplemented from SWidget.

◆ OnMouseMove()

FReply SScrollBar::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
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation about the input event
Returns
Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ SetDragFocusCause()

void SScrollBar::SetDragFocusCause ( EFocusCause  InDragFocusCause)

Set DragFocusCause attribute

◆ SetOnScrollBarVisibilityChanged()

void SScrollBar::SetOnScrollBarVisibilityChanged ( const FOnScrollBarVisibilityChanged InHandler)

Set the handler to be invoked when scroll bar visibility changes.

Parameters
InHandlerMethod to execute when scroll bar visibility changed

◆ SetOnUserScrolled()

void SScrollBar::SetOnUserScrolled ( const FOnUserScrolled InHandler)

Set the handler to be invoked when the user scrolls.

Parameters
InHandlerMethod to execute when the user scrolls the scrollbar

◆ SetScrollBarAlwaysVisible()

void SScrollBar::SetScrollBarAlwaysVisible ( bool  InAlwaysVisible)

Set ScrollBarAlwaysVisible attribute

◆ SetScrollbarDisabledVisibility()

SLATE_API void SScrollBar::SetScrollbarDisabledVisibility ( EVisibility  InVisibility)

Set the visibility of the ScrollBar when it is not needed. The default value is EVisibility::Collapsed.

◆ SetScrollBarTrackAlwaysVisible()

void SScrollBar::SetScrollBarTrackAlwaysVisible ( bool  InAlwaysVisible)

Set ScrollBarTrackAlwaysVisible attribute

◆ SetState()

void SScrollBar::SetState ( float  InOffsetFraction,
float  InThumbSizeFraction,
bool  bCallOnUserScrolled = false 
)
virtual

Set the offset and size of the track's thumb. Note that the maximum offset is 1.0-ThumbSizeFraction. If the user can view 1/3 of the items in a single page, the maximum offset will be ~0.667f

Parameters
InOffsetFractionOffset of the thumbnail from the top as a fraction of the total available scroll space.
InThumbSizeFractionSize of thumbnail as a fraction of the total available scroll space.
bCallOnUserScrolledIf true, OnUserScrolled will be called with InOffsetFraction

Reimplemented in SLinkableScrollBar.

◆ SetStyle()

void SScrollBar::SetStyle ( const FScrollBarStyle InStyle)

Set argument Style

◆ SetThickness()

void SScrollBar::SetThickness ( TAttribute< FVector2D InThickness)

Set Thickness attribute

◆ SetUserVisibility()

void SScrollBar::SetUserVisibility ( TAttribute< EVisibility InUserVisibility)
inline

Set UserVisibility attribute

◆ ShouldBeVisible()

EVisibility SScrollBar::ShouldBeVisible ( ) const
Returns
the scrollbar's visibility as a product of internal rules and user-specified visibility

◆ SLATE_BEGIN_ARGS()

SScrollBar::SLATE_BEGIN_ARGS ( SScrollBar  )
inline

◆ ThumbSizeFraction()

float SScrollBar::ThumbSizeFraction ( ) const
Returns
normalized percentage of track covered by thumb bar

◆ Tick()

void SScrollBar::Tick ( const FGeometry AllottedGeometry,
const double  InCurrentTime,
const float  InDeltaTime 
)
overridevirtual

Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.

Parameters
AllottedGeometryThe space allotted for this widget
InCurrentTimeCurrent absolute real time
InDeltaTimeReal time passed since last tick

Reimplemented from SWidget.

Member Data Documentation

◆ BackgroundBrush

const FSlateBrush* SScrollBar::BackgroundBrush
protected

Background brush

◆ bAlwaysShowScrollbar

bool SScrollBar::bAlwaysShowScrollbar
protected

◆ bAlwaysShowScrollbarTrack

bool SScrollBar::bAlwaysShowScrollbarTrack
protected

◆ bDraggingThumb

bool SScrollBar::bDraggingThumb
protected

◆ bHideWhenNotInUse

bool SScrollBar::bHideWhenNotInUse
protected

◆ bIsScrolling

bool SScrollBar::bIsScrolling
protected

◆ BottomBrush

const FSlateBrush* SScrollBar::BottomBrush
protected

Bottom brush

◆ BottomImage

TSharedPtr<SImage> SScrollBar::BottomImage
protected

◆ bPreventThrottling

bool SScrollBar::bPreventThrottling
protected

◆ DefaultUniformPadding

const float SScrollBar::DefaultUniformPadding = 2.0f
inlinestatic

◆ DragFocusCause

EFocusCause SScrollBar::DragFocusCause
protected

◆ DraggedThumbImage

const FSlateBrush* SScrollBar::DraggedThumbImage
protected

Image to use when the scrollbar thumb is in its dragged state

◆ DragGrabOffset

float SScrollBar::DragGrabOffset
protected

◆ DragThumb

TSharedPtr<SBorder> SScrollBar::DragThumb
protected

◆ HoveredThumbImage

const FSlateBrush* SScrollBar::HoveredThumbImage
protected

Image to use when the scrollbar thumb is in its hovered state

◆ LastInteractionTime

double SScrollBar::LastInteractionTime
protected

◆ NormalThumbImage

const FSlateBrush* SScrollBar::NormalThumbImage
protected

Image to use when the scrollbar thumb is in its normal state

◆ OnScrollBarVisibilityChanged

FOnScrollBarVisibilityChanged SScrollBar::OnScrollBarVisibilityChanged
protected

◆ OnUserScrolled

FOnUserScrolled SScrollBar::OnUserScrolled
protected

◆ Orientation

EOrientation SScrollBar::Orientation
protected

◆ ScrollbarDisabledVisibility

EVisibility SScrollBar::ScrollbarDisabledVisibility = EVisibility::Collapsed
protected

◆ ThicknessSpacer

TSharedPtr<SSpacer> SScrollBar::ThicknessSpacer
protected

◆ TopBrush

const FSlateBrush* SScrollBar::TopBrush
protected

Top brush

◆ TopImage

TSharedPtr<SImage> SScrollBar::TopImage
protected

◆ Track

TSharedPtr<SScrollBarTrack> SScrollBar::Track
protected

◆ UserVisibility

TAttribute<EVisibility> SScrollBar::UserVisibility
protected

The scrollbar's visibility as specified by the user. Will be compounded with internal visibility rules.


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