Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Layout > SScrollBar

Light Theme

Dark Theme

SScrollBar

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SBorder

SScrollBar

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScrollBar.h
Include	#include "Widgets/Layout/SScrollBar.h"

Syntax

class SScrollBar : public SBorder

Variables

	Name	Description
const FSlateBru...	BackgroundBrush	Background brush
bool	bAlwaysShowScrollbar
bool	bAlwaysShowScrollbarTrack
bool	bDraggingThumb
bool	bHideWhenNotInUse
bool	bIsScrolling
const FSlateBru...	BottomBrush	Bottom brush
TSharedPtr< SIm...	BottomImage
EFocusCause	DragFocusCause
const FSlateBru...	DraggedThumbImage	Image to use when the scrollbar thumb is in its dragged state
float	DragGrabOffset
TSharedPtr< SBo...	DragThumb
const FSlateBru...	HoveredThumbImage	Image to use when the scrollbar thumb is in its hovered state
double	LastInteractionTime
const FSlateBru...	NormalThumbImage	Image to use when the scrollbar thumb is in its normal state
FOnUserScrolled	OnUserScrolled
EOrientation	Orientation
TSharedPtr< SSp...	ThicknessSpacer
const FSlateBru...	TopBrush	Top brush
TSharedPtr< SIm...	TopImage
TSharedPtr< SSc...	Track
TAttribute< EVi...	UserVisibility	The scrollbar's visibility as specified by the user.

Constructors

	Name	Description
	SScrollBar()

Functions

	Name	Description
bool	AlwaysShowScrollbar()	Returns True when the scrollbar should always be shown, else False
void	BeginScrolling()	Allows external scrolling panels to notify the scrollbar when scrolling begins.
void	Construct ( const FArguments& InArgs )	Construct this widget
float	DistanceFromBottom()
float	DistanceFromTop()
void	EndScrolling()	Allows external scrolling panels to notify the scrollbar when scrolling ends.
void	ExecuteOnUserScrolled ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Execute the on user scrolled delegate
const FSlate...	GetDragThumbImage()
EOrientation	GetOrientation()
FLinearColor	GetThumbOpacity()	We always show a subtle scroll thumb, but highlight it extra when dragging
FSlateColor	GetTrackOpacity()	We fade the scroll track unless it is being hovered
bool	IsNeeded()
bool	IsScrolling()
void	SetDragFocusCause ( EFocusCause InDragFocusCause )	Set DragFocusCause attribute
void	SetOnUserScrolled ( const FOnUserScrolled& InHandler )	Set the handler to be invoked when the user scrolls.
void	SetScrollBarAlwaysVisible ( bool InAlwaysVisible )	Set ScrollBarAlwaysVisible attribute
void	SetScrollBarTrackAlwaysVisible ( bool InAlwaysVisible )	Set ScrollBarTrackAlwaysVisible attribute
void	SetState ( float InOffsetFraction, float InThumbSizeFraction )	Set the offset and size of the track's thumb.
void	SetStyle ( const FScrollBarStyle* InStyle )	Set argument Style
void	SetThickness ( TAttribute< FVector2D > InThickness )	Set Thickness attribute
void	SetUserVisibility ( TAttribute< EVisibility > InUserVis... )	Set UserVisibility attribute
EVisibility	ShouldBeVisible()

Overridden from SWidget

	Name	Description
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.
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.
void	OnMouseEnter ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has entered it.
void	OnMouseLeave ( const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has left it.
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	SWidget.

Classes

	Name	Description
	FArguments