1. Epic GamesDeveloper
  3. UScrollBox

UScrollBox

An arbitrary scrollable collection of widgets.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/ScrollBox.h
Include #include "Components/ScrollBox.h"

Syntax

class UScrollBox : public UPanelWidget

Remarks

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

Variables

  Type Name Description
Protected variable float DesiredScrollOffset The desired scroll offset for the underlying scrollbox.
Protected variable TSharedPtr< class SScrollBox > MyScrollBox  
Public variable FOnUserScrolledEvent OnUserScrolled Called when the scroll has changed
Protected variable FTSTicker::FDelegateHandle TickHandle  

Constructors

  Type Name Description
Public function  

UScrollBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Instantly stops any inertial scrolling that is currently in progress
Public function Const EConsumeMouseWheel  
Public function Const EDescendantScrollDestination  
Public function Const float  
Public function Const EOrientation  
Public function Const FMargin  
Public function Const FVector2D  
Public function Const ESlateVisibility  
Public function Const float Gets the scroll offset of the scrollbox in Slate Units.
Public function Const float Gets the scroll offset of the bottom of the ScrollBox in Slate Units.
Public function Const EScrollWhenFocusChanges  
Public function Const float Gets the fraction currently visible in the scrollbox
Public function Const float  
Public function Const float  
Public function Const const FScrollBarStyle &  
Public function Const const FScrollBoxStyle &  
Protected function void

InitBackPadScrolling ( bool InBackPadScrolling
)

 Initialize IsFocusable in the constructor before the SWidget is constructed.
Protected function void

InitFrontPadScrolling ( bool InFrontPadScrolling
)

 Initialize IsFocusable in the constructor before the SWidget is constructed.
Protected function void

InitNavigationScrollPadding ( float InNavigationScrollPadding
)

 Initialize IsFocusable in the constructor before the SWidget is constructed.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void Scrolls the ScrollBox to the bottom instantly during the next layout pass.
Public function void Scrolls the ScrollBox to the top instantly
Public function void

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

 Scrolls the ScrollBox to the widget during the next layout pass.
Public function void

SetAllowOverscroll ( bool NewAllowOverscroll
)

  
Public function void

SetAllowRightClickDragScrolling ( bool bShouldAllowRightClickDragScrolling
)

  
Public function void

SetAlwaysShowScrollbar ( bool NewAlwaysShowScrollbar
)

  
Public function void

SetAlwaysShowScrollbarTrack ( bool NewAlwaysShowScrollbarTrack
)

  
Public function void

SetAnimateWheelScrolling ( bool bShouldAnimateWheelScrolling
)

  
Public function void

SetConsumeMouseWheel ( EConsumeMouseWheel NewConsumeMouseWheel
)

  
Public function void

SetNavigationDestination ( const EDescendantScrollDestination NewNavigationDestination
)

  
Public function void

SetOrientation ( EOrientation NewOrientation
)

  
Public function void

SetScrollbarPadding ( const FMargin& NewScrollbarPadding
)

  
Public function void

SetScrollbarThickness ( const FVector2D& NewScrollbarThickness
)

  
Public function void

SetScrollBarVisibility ( ESlateVisibility NewScrollBarVisibility
)

  
Public function void

SetScrollOffset ( float NewScrollOffset
)

 Updates the scroll offset of the scrollbox.
Public function void

SetScrollWhenFocusChanges ( EScrollWhenFocusChanges NewScrollWhenFocusChanges
)

  
Public function void

SetWheelScrollMultiplier ( float NewWheelScrollMultiplier
)

  
Public function void

SetWidgetBarStyle ( const FScrollBarStyle& NewWidgetBarStyle
)

  
Public function void

SetWidgetStyle ( const FScrollBoxStyle& NewWidgetStyle
)

  
Protected function void

SlateHandleUserScrolled ( float CurrentOffset
)

  

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual Const UClass * UPanelWidget.
Protected function Virtual void  
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual void  
Public function Virtual void

OnDescendantSelectedByDesigner ( UWidget* DescendantWidget
)

  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable bool AllowOverscroll Direct access to AllowOverscroll is deprecated. Please use the getter or setter.
Public variable bool AlwaysShowScrollbar Direct access to AlwaysShowScrollbar is deprecated. Please use the getter or setter.
Public variable bool AlwaysShowScrollbarTrack Direct access to AlwaysShowScrollbarTrack is deprecated. Please use the getter or setter.
Public variable bool BackPadScrolling Direct access to BackPadScrolling is deprecated. Please use the getter. Note that BackPadScrolling is only set at construction and is not modifiable at runtime.
Public variable bool bAllowRightClickDragScrolling Direct access to bAllowRightClickDragScrolling is deprecated. Please use the getter or setter.
Public variable bool bAnimateWheelScrolling Direct access to bAnimateWheelScrolling is deprecated. Please use the getter or setter.
Public variable EConsumeMouseWheel ConsumeMouseWheel Direct access to ConsumeMouseWheel is deprecated. Please use the getter or setter.
Public variable bool FrontPadScrolling Direct access to FrontPadScrolling is deprecated. Please use the getter. Note that FrontPadScrolling is only set at construction and is not modifiable at runtime.
Public variable EDescendantScrollDestination NavigationDestination Direct access to NavigationDestination is deprecated. Please use the getter or setter.
Public variable float NavigationScrollPadding Direct access to NavigationScrollPadding is deprecated. Please use the getter. Note that NavigationScrollPadding is only set at construction and is not modifiable at runtime.
Public variable TEnumAsByte< EOrientation > Orientation Direct access to Orientation is deprecated. Please use the getter or setter.
Public variable FMargin ScrollbarPadding Direct access to ScrollbarPadding is deprecated. Please use the getter or setter.
Public variable FVector2D ScrollbarThickness Direct access to ScrollbarThickness is deprecated. Please use the getter or setter.
Public variable ESlateVisibility ScrollBarVisibility Direct access to ScrollBarVisibility is deprecated. Please use the getter or setter.
Public variable EScrollWhenFocusChanges ScrollWhenFocusChanges Direct access to ScrollWhenFocusChanges is deprecated. Please use the getter or setter.
Public variable float WheelScrollMultiplier Direct access to WheelScrollMultiplier is deprecated. Please use the getter or setter.
Public variable FScrollBarStyle WidgetBarStyle Direct access to WidgetBarStyle is deprecated. Please use the getter or setter.
Public variable FScrollBoxStyle WidgetStyle Direct access to WidgetStyle is deprecated. Please use the getter or setter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page