SScrollBar

Windows
MacOS
Linux

Inheritance Hierarchy

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

Protected variable

const FSlateBru ...

 

BackgroundBrush

Background brush

Protected variable

bool

 

bAlwaysShowScrollbar

Protected variable

bool

 

bAlwaysShowScrollbarTrack

Protected variable

bool

 

bDraggingThumb

Protected variable

bool

 

bHideWhenNotInUse

Protected variable

bool

 

bIsScrolling

Protected variable

const FSlateBru ...

 

BottomBrush

Bottom brush

Protected variable

EFocusCause

 

DragFocusCause

Protected variable

const FSlateBru ...

 

DraggedThumbImage

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

Protected variable

float

 

DragGrabOffset

Protected variable

TSharedPtr < SBo ...

 

DragThumb

Protected variable

const FSlateBru ...

 

HoveredThumbImage

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

Protected variable

double

 

LastInteractionTime

Protected variable

const FSlateBru ...

 

NormalThumbImage

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

Protected variable

FOnUserScrolled

 

OnUserScrolled

Protected variable

EOrientation

 

Orientation

Protected variable

TSharedPtr < SSp ...

 

ThicknessSpacer

Protected variable

const FSlateBru ...

 

TopBrush

Top brush

Protected variable

TSharedPtr < SSc ...

 

Track

Protected variable

TAttribute < EVi ...

 

UserVisibility

The scrollbar's visibility as specified by the user.

Constructors

Name Description

Public function

SScrollBar()

Functions

Name Description

Public function Const

bool

 

AlwaysShowScrollbar()

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

Public function Virtual

void

 

BeginScrolling()

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

Public function

void

 

Construct

(
    const FArguments & InArgs
)

Construct this widget

Public function Const

float

 

DistanceFromBottom()

Public function Const

float

 

DistanceFromTop()

Public function Virtual

void

 

EndScrolling()

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

Protected function

void

 

ExecuteOnUserScrolled

(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
)

Execute the on user scrolled delegate

Protected function Const

const FSlate ...

 

GetDragThumbImage()

Public function Const

EOrientation

 

GetOrientation()

Protected function Const

FLinearColor

 

GetThumbOpacity()

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

Protected function Const

FSlateColor

 

GetTrackOpacity()

We fade the scroll track unless it is being hovered

Public function Const

bool

 

IsNeeded()

Public function Const

bool

 

IsScrolling()

Public function

void

 

SetDragFocusCause

(
    EFocusCause InDragFocusCause
)

Set DragFocusCause attribute

Public function

void

 

SetOnUserScrolled

(
    const FOnUserScrolled & InHandler
)

Set the handler to be invoked when the user scrolls.

Public function

void

 

SetScrollBarAlwaysVisible

(
    bool InAlwaysVisible
)

Set ScrollBarAlwaysVisible attribute

Public function

void

 

SetScrollBarTrackAlwaysVisible

(
    bool InAlwaysVisible
)

Set ScrollBarTrackAlwaysVisible attribute

Public function

void

 

SetState

(
    float InOffsetFraction,
    float InThumbSizeFraction
)

Set the offset and size of the track's thumb.

Public function

void

 

SetStyle

(
    const FScrollBarStyle * InStyle
)

Set argument Style

Public function

void

 

SetThickness

(
    TAttribute < FVector2D > InThickness
)

Set Thickness attribute

Public function

void

 

SetUserVisibility

(
    TAttribute < EVisibility > InUserVis...
)

Set UserVisibility attribute

Public function Const

EVisibility

 

ShouldBeVisible()

Overridden from SWidget

Name Description

Public function Virtual

FReply

 

OnMouseButtonDown

(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
)

SWidget .

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

 

OnMouseEnter

(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
)

The system will use this event to notify a widget that the cursor has entered it.

Public function Virtual

void

 

OnMouseLeave

(
    const FPointerEvent & MouseEvent
)

The system will use this event to notify a widget that the cursor has left it.

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.

Classes

Name

Description

Public struct

FArguments

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback