1. Epic GamesDeveloper
  3. UScrollBox

UScrollBox

An arbitrary scrollable collection of widgets.

API > API/Runtime > API/Runtime/UMG

An arbitrary scrollable collection of widgets. Great for presenting 10-100 widgets in a list. Doesn't support virtualization.

   
Name UScrollBox
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/ScrollBox.h
Include Path #include "Components/ScrollBox.h"

Syntax

UCLASS (MinimalAPI)  
class UScrollBox : public UPanelWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UScrollBox ( const FObjectInitializer& ObjectInitializer
)

   Components/ScrollBox.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllowOverscroll bool Disable to stop scrollbars from activating inertial overscrolling Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsAllowOverscroll"
  • Setter
  • BlueprintSetter="SetAllowOverscroll"
  • Category="Scroll"
AlwaysShowScrollbar bool   Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsAlwaysShowScrollbar"
  • Setter
  • BlueprintSetter="SetAlwaysShowScrollbar"
  • Category="Scroll"
AlwaysShowScrollbarTrack bool   Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsAlwaysShowScrollbarTrack"
  • Setter
  • Category="Scroll"
BackPadScrolling bool Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadOnly
  • Getter="IsBackPadScrolling"
  • Category="Scroll"
bAllowRightClickDragScrolling bool Option to disable right-click-drag scrolling Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsAllowRightClickDragScrolling"
  • Setter="SetAllowRightClickDragScrolling"
  • Category="Scroll"
bAnimateWheelScrolling bool True to lerp smoothly when wheel scrolling along the scroll box Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsAnimateWheelScrolling"
  • Setter="SetAnimateWheelScrolling"
  • BlueprintSetter="SetAnimateWheelScrolling"
  • Category="Scroll"
ConsumeMouseWheel EConsumeMouseWheel When mouse wheel events should be consumed. Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetConsumeMouseWheel"
  • Category="Scroll"
FrontPadScrolling bool Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadOnly
  • Getter="IsFrontPadScrolling"
  • Category="Scroll"
NavigationDestination EDescendantScrollDestination Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetNavigationDestination"
  • Getter
  • Setter
  • Category="Scroll"
NavigationScrollPadding float The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox. Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadOnly
  • Getter
  • Category="Scroll"
OnFocusLost FOnScrollBoxFocusLostEvent Called when the scroll has changed Components/ScrollBox.h
  • BlueprintAssignable
  • Category="Scroll|Event"
OnFocusReceived FOnScrollBoxFocusReceivedEvent Called when the scroll has changed Components/ScrollBox.h
  • BlueprintAssignable
  • Category="Scroll|Event"
OnScrollBarVisibilityChanged FOnScrollBarVisibilityChangedEvent Called when the scrollbar visibility has changed Components/ScrollBox.h
  • BlueprintAssignable
  • Category="Button|Event"
OnUserScrolled FOnUserScrolledEvent Called when the scroll has changed Components/ScrollBox.h
  • BlueprintAssignable
  • Category="Button|Event"
Orientation TEnumAsByte< EOrientation > The orientation of the scrolling and stacking in the box. Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetOrientation"
  • Category="Scroll"
ScrollbarPadding FMargin The margin around the scrollbar Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetScrollbarPadding"
  • Category="Scroll"
ScrollbarThickness FVector2D The thickness of the scrollbar thumb Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetScrollbarThickness"
  • Category="Scroll"
ScrollBarVisibility ESlateVisibility Visibility Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetScrollBarVisibility"
  • Category="Scroll"
ScrollWhenFocusChanges EScrollWhenFocusChanges Scroll behavior when user focus is given to a child widget Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetScrollWhenFocusChanges"
  • Category="Scroll"
  • Meta=(DisplayName="Scroll When Focus Changes")
WheelScrollMultiplier float The multiplier to apply when wheel scrolling Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetWheelScrollMultiplier"
  • Category="Scroll"
WidgetBarStyle FScrollBarStyle The bar style Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Style"
  • Meta=(DisplayName="Bar Style")
WidgetStyle FScrollBoxStyle The style Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Style"
  • Meta=(DisplayName="Style")

Protected

Name Type Remarks Include Path Unreal Specifiers
AnalogMouseWheelKey FKey The virtual mouse wheel key for gamepad input Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetAnalogMouseWheelKey"
  • Setter="SetAnalogMouseWheelKey"
  • Category="Scroll"
  • Meta=(AllowPrivateAccess="true", DisplayAfter="bConsumePointerInput")
bConsumePointerInput bool Option to pass touch input events to widgets behind the ScrollBox. Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetConsumePointerInput"
  • Setter="SetConsumePointerInput"
  • Category="Scroll"
  • Meta=(AllowPrivateAccess="true", DisplayAfter="bEnableTouchScrolling")
bEnableTouchScrolling bool True to allow scrolling using touch input. Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetIsTouchScrollingEnabled"
  • Setter="SetIsTouchScrollingEnabled"
  • Category="Scroll"
  • Meta=(AllowPrivateAccess="true", DisplayAfter="WheelScrollMultiplier")
bIsFocusable bool If true, scrollbox can receive focus. Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetIsFocusable"
  • Setter="SetIsFocusable"
  • Category="Scroll"
  • Meta=(AllowPrivateAccess="true", DisplayAfter="AnalogMouseWheelKey")
ScrollAnimationInterpolationSpeed float   Components/ScrollBox.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Scroll"
  • Meta=(AllowPrivateAccess="true", DisplayAfter="bAnimateWheelScrolling")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void EndInertialScrolling()

 Instantly stops any inertial scrolling that is currently in progress Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

FKey GetAnalogMouseWheelKey()

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

EConsumeMouseWheel GetConsumeMouseWheel()

   Components/ScrollBox.h  

bool GetConsumePointerInput()

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

bool GetIsFocusable()

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

bool GetIsScrolling()

 Returns true when the widget is currently inertial scrolling Components/ScrollBox.h
  • BlueprintPure
  • Category="Widget"

bool GetIsTouchScrollingEnabled()

   Components/ScrollBox.h  

EDescendantScrollDestination GetNavigationDestination()

   Components/ScrollBox.h  

float GetNavigationScrollPadding()

   Components/ScrollBox.h  

EOrientation GetOrientation()

   Components/ScrollBox.h  

float GetOverscrollOffset()

 Gets the overscroll offset of the scrollbox in Slate Units. Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

float GetOverscrollPercentage()

 Gets the overscroll offset of the scrollbox in percentage from its view size. Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

float GetScrollAnimationInterpolationSpeed()

   Components/ScrollBox.h  

FMargin GetScrollbarPadding()

   Components/ScrollBox.h  

FVector2D GetScrollbarThickness()

   Components/ScrollBox.h  

ESlateVisibility GetScrollBarVisibility()

   Components/ScrollBox.h  

float GetScrollOffset()

 Gets the scroll offset of the scrollbox in Slate Units. Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

float GetScrollOffsetOfEnd()

 Gets the scroll offset of the bottom of the ScrollBox in Slate Units. Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

EScrollWhenFocusChanges GetScrollWhenFocusChanges()

   Components/ScrollBox.h  

float GetViewFraction()

 Gets the fraction currently visible in the scrollbox Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

float GetViewOffsetFraction()

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

float GetWheelScrollMultiplier()

   Components/ScrollBox.h  

const FScrollBarStyle & GetWidgetBarStyle()

   Components/ScrollBox.h  

const FScrollBoxStyle & GetWidgetStyle()

   Components/ScrollBox.h  

bool IsAllowOverscroll()

   Components/ScrollBox.h  

bool IsAllowRightClickDragScrolling()

   Components/ScrollBox.h  

bool IsAlwaysShowScrollbar()

   Components/ScrollBox.h  

bool IsAlwaysShowScrollbarTrack()

   Components/ScrollBox.h  

bool IsAnimateWheelScrolling()

   Components/ScrollBox.h  

bool IsBackPadScrolling()

   Components/ScrollBox.h  

bool IsFrontPadScrolling()

   Components/ScrollBox.h  

void ScrollToEnd()

 Scrolls the ScrollBox to the bottom instantly during the next layout pass. Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

void ScrollToStart()

 Scrolls the ScrollBox to the top instantly Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

void ScrollWidgetIntoView ( UWidget* WidgetToFind,
bool AnimateScroll,
EDescendantScrollDestination ScrollDestination,
float Padding
)

 Scrolls the ScrollBox to the widget during the next layout pass. Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

void SetAllowOverscroll ( bool NewAllowOverscroll
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetAllowRightClickDragScrolling ( bool bShouldAllowRightClickDragScrolling
)

   Components/ScrollBox.h  

void SetAlwaysShowScrollbar ( bool NewAlwaysShowScrollbar
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetAlwaysShowScrollbarTrack ( bool NewAlwaysShowScrollbarTrack
)

   Components/ScrollBox.h  

void SetAnalogMouseWheelKey ( FKey InMouseWheelKey
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetAnimateWheelScrolling ( bool bShouldAnimateWheelScrolling
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetConsumeMouseWheel ( EConsumeMouseWheel NewConsumeMouseWheel
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetConsumePointerInput ( bool bInConsumePointerInput
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetIsFocusable ( bool bInIsFocusable
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetIsTouchScrollingEnabled ( bool bInEnableTouchScrolling
)

   Components/ScrollBox.h
  • Category="Scroll"

void SetNavigationDestination ( const EDescendantScrollDestination NewNavigationDestination
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetOrientation ( EOrientation NewOrientation
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetScrollAnimationInterpolationSpeed ( float NewScrollAnimationInterpolationSpeed
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetScrollbarPadding ( const FMargin& NewScrollbarPadding
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetScrollbarThickness ( const FVector2D& NewScrollbarThickness
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetScrollBarVisibility ( ESlateVisibility NewScrollBarVisibility
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetScrollOffset ( float NewScrollOffset
)

 Updates the scroll offset of the scrollbox. Components/ScrollBox.h
  • BlueprintCallable
  • Category="Widget"

void SetScrollWhenFocusChanges ( EScrollWhenFocusChanges NewScrollWhenFocusChanges
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetWheelScrollMultiplier ( float NewWheelScrollMultiplier
)

   Components/ScrollBox.h
  • BlueprintCallable
  • Category="Scroll"

void SetWidgetBarStyle ( const FScrollBarStyle& NewWidgetBarStyle
)

   Components/ScrollBox.h  

void SetWidgetStyle ( const FScrollBoxStyle& NewWidgetStyle
)

   Components/ScrollBox.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/ScrollBox.h  

virtual void OnDescendantDeselectedByDesigner ( UWidget* DescendantWidget
)

   Components/ScrollBox.h  

virtual void OnDescendantSelectedByDesigner ( UWidget* DescendantWidget
)

   Components/ScrollBox.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/ScrollBox.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/ScrollBox.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

   Components/ScrollBox.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitBackPadScrolling ( bool InBackPadScrolling
)

 Initialize IsFocusable in the constructor before the SWidget is constructed. Components/ScrollBox.h  

void InitFrontPadScrolling ( bool InFrontPadScrolling
)

 Initialize IsFocusable in the constructor before the SWidget is constructed. Components/ScrollBox.h  

void InitNavigationScrollPadding ( float InNavigationScrollPadding
)

 Initialize IsFocusable in the constructor before the SWidget is constructed. Components/ScrollBox.h  

void SlateHandleFocusLost()

   Components/ScrollBox.h  

void SlateHandleFocusReceived()

   Components/ScrollBox.h  

void SlateHandleScrollBarVisibilityChanged ( EVisibility NewVisibility
)

   Components/ScrollBox.h  

void SlateHandleUserScrolled ( float CurrentOffset
)

   Components/ScrollBox.h  

Overridden from UPanelWidget

Name Remarks Include Path Unreal Specifiers

virtual UClass * GetSlotClass()

 UPanelWidget. Components/ScrollBox.h  

virtual void OnSlotAdded ( UPanelSlot* Slot
)

   Components/ScrollBox.h  

virtual void OnSlotRemoved ( UPanelSlot* Slot
)

   Components/ScrollBox.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

 Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. Components/ScrollBox.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page