Navigation
API > API/Runtime > API/Runtime/Slate
SScrollBox can scroll through an arbitrary number of widgets.
| Name | SScrollBox |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScrollBox.h |
| Include Path | #include "Widgets/Layout/SScrollBox.h" |
Syntax
class SScrollBox : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SScrollBox
- FSlateControlledConstruction → SWidget → SCompoundWidget → SScrollBox
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SScrollBox() |
Widgets/Layout/SScrollBox.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SScrollBox() |
Widgets/Layout/SScrollBox.h |
Classes
| Name | Remarks |
|---|---|
| FSlot | A Slot that provides layout options for the contents of a scrollable box. |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FScopedWidgetSlotArguments | TPanelChildren< FSlot >::FScopedWidgetSlotArguments | Widgets/Layout/SScrollBox.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HorizontalScrollBarSlot | SVerticalBox::FSlot * | Widgets/Layout/SScrollBox.h | ||
| VerticalScrollBarSlot | SHorizontalBox::FSlot * | Vertical scroll bar is stored in horizontal box and vice versa | Widgets/Layout/SScrollBox.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DesiredScrollOffset | float | Scroll offset that the user asked for. We will clamp it before actually scrolling there. | Widgets/Layout/SScrollBox.h | |
| ScrollBarSlotPadding | FMargin | Padding to the scrollbox | Widgets/Layout/SScrollBox.h | |
| SScrollBox | union SScrollBox | Widgets/Layout/SScrollBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FScopedWidgetSlotArguments AddSlot() |
Adds a slot to SScrollBox | Widgets/Layout/SScrollBox.h | |
void ClearChildren() |
Removes all children from the box | Widgets/Layout/SScrollBox.h | |
void Construct
(
const FArguments& InArgs |
Widgets/Layout/SScrollBox.h | ||
void EndInertialScrolling() |
Widgets/Layout/SScrollBox.h | ||
EAllowOverscroll GetAllowOverscroll() |
Widgets/Layout/SScrollBox.h | ||
bool GetIsScrolling() |
Widgets/Layout/SScrollBox.h | ||
EOrientation GetOrientation() |
Get the current orientation of the scrollbox. | Widgets/Layout/SScrollBox.h | |
float GetOverscrollOffset() |
Widgets/Layout/SScrollBox.h | ||
float GetOverscrollPercentage() |
Widgets/Layout/SScrollBox.h | ||
float GetScrollOffset() |
Widgets/Layout/SScrollBox.h | ||
float GetScrollOffsetOfEnd() |
Gets the scroll offset of the bottom of the ScrollBox in Slate Units. | Widgets/Layout/SScrollBox.h | |
UE::Slate::FDeprecateVector2DResult GetScrollPanelContentSize() |
Widgets/Layout/SScrollBox.h | ||
| Returns the slot at the given index. | Widgets/Layout/SScrollBox.h | ||
| Widgets/Layout/SScrollBox.h | |||
float GetViewFraction() |
Widgets/Layout/SScrollBox.h | ||
float GetViewOffsetFraction() |
Widgets/Layout/SScrollBox.h | ||
FScopedWidgetSlotArguments InsertSlot
(
int32 Index |
Insert a slot at a given position. | Widgets/Layout/SScrollBox.h | |
void InvalidateScrollBarStyle() |
Widgets/Layout/SScrollBox.h | ||
void InvalidateStyle() |
Widgets/Layout/SScrollBox.h | ||
bool IsRightClickScrolling() |
Widgets/Layout/SScrollBox.h | ||
int32 NumSlots() |
Widgets/Layout/SScrollBox.h | ||
void RemoveSlot
(
const TSharedRef< SWidget >& WidgetToRemove |
Removes the corresponding widget from the set of slots if it exists. | Widgets/Layout/SScrollBox.h | |
void ScrollDescendantIntoView
(
const TSharedPtr< SWidget >& WidgetToFind, |
Attempt to scroll a widget into view, will safely handle non-descendant widgets | Widgets/Layout/SScrollBox.h | |
void ScrollToEnd() |
Widgets/Layout/SScrollBox.h | ||
void ScrollToStart() |
Widgets/Layout/SScrollBox.h | ||
void SetAllowOverscroll
(
EAllowOverscroll NewAllowOverscroll |
Widgets/Layout/SScrollBox.h | ||
void SetAnalogMouseWheelKey
(
FKey InAnalogKey |
Widgets/Layout/SScrollBox.h | ||
void SetAnimateWheelScrolling
(
bool bInAnimateWheelScrolling |
Widgets/Layout/SScrollBox.h | ||
void SetConsumeMouseWheel
(
EConsumeMouseWheel NewConsumeMouseWheel |
Widgets/Layout/SScrollBox.h | ||
void SetConsumePointerInput
(
bool bInConsumePointerInput |
Widgets/Layout/SScrollBox.h | ||
void SetIsFocusable
(
bool bInIsFocusable |
Widgets/Layout/SScrollBox.h | ||
void SetIsTouchScrollingEnabled
(
const bool bInEnableTouchScrolling |
Enables/disables being able to scroll using touch input. | Widgets/Layout/SScrollBox.h | |
void SetNavigationDestination
(
const EDescendantScrollDestination NewNavigationDestination |
Widgets/Layout/SScrollBox.h | ||
void SetOrientation
(
EOrientation InOrientation |
Sets the current orientation of the scrollbox and updates the layout | Widgets/Layout/SScrollBox.h | |
void SetScrollBarAlwaysVisible
(
bool InAlwaysVisible |
Widgets/Layout/SScrollBox.h | ||
void SetScrollBarPadding
(
const FMargin& InPadding |
Widgets/Layout/SScrollBox.h | ||
void SetScrollBarRightClickDragAllowed
(
bool bIsAllowed |
Widgets/Layout/SScrollBox.h | ||
void SetScrollBarStyle
(
const FScrollBarStyle* InBarStyle |
Widgets/Layout/SScrollBox.h | ||
void SetScrollBarThickness
(
UE::Slate::FDeprecateVector2DParameter InThickness |
Widgets/Layout/SScrollBox.h | ||
void SetScrollBarTrackAlwaysVisible
(
bool InAlwaysVisible |
Widgets/Layout/SScrollBox.h | ||
void SetScrollBarVisibility
(
EVisibility InVisibility |
Widgets/Layout/SScrollBox.h | ||
void SetScrollingAnimationInterpolationSpeed
(
float NewScrollingAnimationInterpolationSpeed |
Widgets/Layout/SScrollBox.h | ||
void SetScrollOffset
(
float NewScrollOffset |
Widgets/Layout/SScrollBox.h | ||
void SetScrollWhenFocusChanges
(
EScrollWhenFocusChanges NewScrollWhenFocusChanges |
Widgets/Layout/SScrollBox.h | ||
void SetStyle
(
const FScrollBoxStyle* InStyle |
Widgets/Layout/SScrollBox.h | ||
void SetWheelScrollMultiplier
(
float NewWheelScrollMultiplier |
Widgets/Layout/SScrollBox.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ComputeVolatility() |
Widgets/Layout/SScrollBox.h | ||
virtual FReply OnAnalogValueChanged
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual FCursorReply OnCursorQuery
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual void OnFocusChanging
(
const FWeakWidgetPath& PreviousFocusPath, |
Widgets/Layout/SScrollBox.h | ||
virtual void OnFocusLost
(
const FFocusEvent& InFocusEvent |
Widgets/Layout/SScrollBox.h | ||
virtual FReply OnFocusReceived
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual FReply OnMouseButtonDown
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual FReply OnMouseButtonUp
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual void OnMouseCaptureLost
(
const FCaptureLostEvent& CaptureLostEvent |
Widgets/Layout/SScrollBox.h | ||
virtual void OnMouseEnter
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual void OnMouseLeave
(
const FPointerEvent& MouseEvent |
Widgets/Layout/SScrollBox.h | ||
virtual FReply OnMouseMove
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual FReply OnMouseWheel
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual FNavigationReply OnNavigation
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Layout/SScrollBox.h | ||
virtual FReply OnPreviewMouseButtonDown
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual FReply OnTouchEnded
(
const FGeometry& MyGeometry, |
Widgets/Layout/SScrollBox.h | ||
virtual bool SupportsKeyboardFocus() |
Widgets/Layout/SScrollBox.h | ||
virtual void Tick
(
const FGeometry& AllottedGeometry, |
Widgets/Layout/SScrollBox.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< SWidget > GetKeyboardFocusableWidget
(
TSharedPtr< SWidget > InWidget |
Returns widget that can receive keyboard focus or nullptr | Widgets/Layout/SScrollBox.h | |
bool InternalScrollDescendantIntoView
(
const FGeometry& MyGeometry, |
Scrolls or begins scrolling a widget into view, only valid to call when we have layout geometry. | Widgets/Layout/SScrollBox.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnClippingChanged() |
Widgets/Layout/SScrollBox.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSlot::FSlotArguments Slot() |
Widgets/Layout/SScrollBox.h |