Navigation
API > API/Runtime > API/Runtime/Slate
| Name | SScrollBar |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScrollBar.h |
| Include Path | #include "Widgets/Layout/SScrollBar.h" |
Syntax
class SScrollBar : public SBorder
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBorder → SScrollBar
- FSlateControlledConstruction → SWidget → SCompoundWidget → SBorder → SScrollBar
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SScrollBar() |
Widgets/Layout/SScrollBar.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~SScrollBar() |
Widgets/Layout/SScrollBar.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DefaultUniformPadding | const float | Widgets/Layout/SScrollBar.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AlwaysShowScrollbar() |
Returns True when the scrollbar should always be shown, else False | Widgets/Layout/SScrollBar.h | |
virtual void BeginScrolling() |
Allows external scrolling panels to notify the scrollbar when scrolling begins. | Widgets/Layout/SScrollBar.h | |
void Construct
(
const FArguments& InArgs |
Construct this widget | Widgets/Layout/SScrollBar.h | |
float DistanceFromBottom() |
Widgets/Layout/SScrollBar.h | ||
float DistanceFromTop() |
Widgets/Layout/SScrollBar.h | ||
virtual void EndScrolling() |
Allows external scrolling panels to notify the scrollbar when scrolling ends. | Widgets/Layout/SScrollBar.h | |
EOrientation GetOrientation() |
Widgets/Layout/SScrollBar.h | ||
void InvalidateStyle() |
Invalidate the style | Widgets/Layout/SScrollBar.h | |
bool IsNeeded() |
Widgets/Layout/SScrollBar.h | ||
bool IsScrolling() |
Widgets/Layout/SScrollBar.h | ||
void SetDragFocusCause
(
EFocusCause InDragFocusCause |
Set DragFocusCause attribute | Widgets/Layout/SScrollBar.h | |
void SetOnScrollBarVisibilityChanged
(
const FOnScrollBarVisibilityChanged& InHandler |
Set the handler to be invoked when scroll bar visibility changes. | Widgets/Layout/SScrollBar.h | |
void SetOnUserScrolled
(
const FOnUserScrolled& InHandler |
Set the handler to be invoked when the user scrolls. | Widgets/Layout/SScrollBar.h | |
void SetScrollBarAlwaysVisible
(
bool InAlwaysVisible |
Set ScrollBarAlwaysVisible attribute | Widgets/Layout/SScrollBar.h | |
void SetScrollbarDisabledVisibility
(
EVisibility InVisibility |
Set the visibility of the ScrollBar when it is not needed. | Widgets/Layout/SScrollBar.h | |
void SetScrollBarTrackAlwaysVisible
(
bool InAlwaysVisible |
Set ScrollBarTrackAlwaysVisible attribute | Widgets/Layout/SScrollBar.h | |
virtual void SetState
(
float InOffsetFraction, |
Set the offset and size of the track's thumb. | Widgets/Layout/SScrollBar.h | |
void SetStyle
(
const FScrollBarStyle* InStyle |
Set argument Style | Widgets/Layout/SScrollBar.h | |
void SetThickness
(
TAttribute< FVector2D > InThickness |
Set Thickness attribute | Widgets/Layout/SScrollBar.h | |
void SetUserVisibility
(
TAttribute< EVisibility > InUserVisibility |
Set UserVisibility attribute | Widgets/Layout/SScrollBar.h | |
EVisibility ShouldBeVisible() |
Widgets/Layout/SScrollBar.h | ||
float ThumbSizeFraction() |
Widgets/Layout/SScrollBar.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FReply OnMouseButtonDown
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBar.h | ||
virtual FReply OnMouseButtonUp
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBar.h | ||
virtual void OnMouseEnter
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBar.h | ||
virtual void OnMouseLeave
(
const FPointerEvent& MouseEvent |
Widgets/Layout/SScrollBar.h | ||
virtual FReply OnMouseMove
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBar.h | ||
virtual void Tick
(
const FGeometry& AllottedGeometry, |
SWidget. | Widgets/Layout/SScrollBar.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExecuteOnUserScrolled
(
const FGeometry& MyGeometry, |
Execute the on user scrolled delegate | Widgets/Layout/SScrollBar.h | |
const FSlateBrush * GetDragThumbImage() |
Widgets/Layout/SScrollBar.h | ||
FLinearColor GetThumbOpacity() |
We always show a subtle scroll thumb, but highlight it extra when dragging | Widgets/Layout/SScrollBar.h | |
FSlateColor GetTrackOpacity() |
We fade the scroll track unless it is being hovered | Widgets/Layout/SScrollBar.h |