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

UCLASS (MinimalAPI)  
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
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool AllowOverscroll Disable to stop scrollbars from activating inertial overscrolling
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool AlwaysShowScrollbar  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool AlwaysShowScrollbarTrack  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly getter bool BackPadScrolling Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter bool bAllowRightClickDragScrolling Option to disable right-click-drag scrolling
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool bAnimateWheelScrolling True to lerp smoothly when wheel scrolling along the scroll box
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter EConsumeMouseWheel ConsumeMouseWheel When mouse wheel events should be consumed.
Protected variable float DesiredScrollOffset The desired scroll offset for the underlying scrollbox.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly getter bool FrontPadScrolling Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible
Protected variable TSharedPtr< class SScrollBox > MyScrollBox  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter EDescendantScrollDestination NavigationDestination Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled
Public variable UProperty Category, EditAnywhere BlueprintReadOnly getter float NavigationScrollPadding The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox.
Public variable UProperty Category BlueprintAssignable FOnScrollBarVisibilityChangedEvent OnScrollBarVisibilityChanged Called when the scrollbar visibility has changed
Public variable UProperty Category BlueprintAssignable FOnUserScrolledEvent OnUserScrolled Called when the scroll has changed
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EOrientation > Orientation The orientation of the scrolling and stacking in the box.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FMargin ScrollbarPadding The margin around the scrollbar
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FVector2D ScrollbarThickness The thickness of the scrollbar thumb
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter ESlateVisibility ScrollBarVisibility Visibility
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter EScrollWhenFocusChanges ScrollWhenFocusChanges Scroll behavior when user focus is given to a child widget
Protected variable FTSTicker::FDelegateHandle TickHandle  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter float WheelScrollMultiplier The multiplier to apply when wheel scrolling
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FScrollBarStyle WidgetBarStyle The bar style
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FScrollBoxStyle WidgetStyle The style

Constructors

  Type Name Description
Public function  

UScrollBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Instantly stops any inertial scrolling that is currently in progress
Public function Const EConsumeMouseWheel  
Public function Const bool  
Public function Const EDescendantScrollDestination  
Public function Const float  
Public function Const EOrientation  
Public function Const float  
Public function Const FMargin  
Public function Const FVector2D  
Public function Const ESlateVisibility  
Public function Const UFunction BlueprintCallable, Category float Gets the scroll offset of the scrollbox in Slate Units.
Public function Const UFunction BlueprintCallable, Category float Gets the scroll offset of the bottom of the ScrollBox in Slate Units.
Public function Const EScrollWhenFocusChanges  
Public function Const UFunction BlueprintCallable, Category float Gets the fraction currently visible in the scrollbox
Public function Const UFunction BlueprintCallable, Category 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 UFunction BlueprintCallable, Category void Scrolls the ScrollBox to the bottom instantly during the next layout pass.
Public function UFunction BlueprintCallable, Category void Scrolls the ScrollBox to the top instantly
Public function UFunction BlueprintCallable, Category void

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

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

Serialize ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category void

SetAllowOverscroll ( bool NewAllowOverscroll
)

  
Public function void

SetAllowRightClickDragScrolling ( bool bShouldAllowRightClickDragScrolling
)

  
Public function UFunction BlueprintCallable, Category void

SetAlwaysShowScrollbar ( bool NewAlwaysShowScrollbar
)

  
Public function void

SetAlwaysShowScrollbarTrack ( bool NewAlwaysShowScrollbarTrack
)

  
Public function UFunction BlueprintCallable, Category void

SetAnimateWheelScrolling ( bool bShouldAnimateWheelScrolling
)

  
Public function UFunction BlueprintCallable, Category void

SetConsumeMouseWheel ( EConsumeMouseWheel NewConsumeMouseWheel
)

  
Public function UFunction Category void

SetIsTouchScrollingEnabled ( bool bInEnableTouchScrolling
)

  
Public function UFunction BlueprintCallable, Category void

SetNavigationDestination ( const EDescendantScrollDestination NewNavigationDestination
)

  
Public function UFunction BlueprintCallable, Category void

SetOrientation ( EOrientation NewOrientation
)

  
Public function UFunction BlueprintCallable, Category void

SetScrollAnimationInterpolationSpeed ( float NewScrollAnimationInterpolationSpeed
)

  
Public function UFunction BlueprintCallable, Category void

SetScrollbarPadding ( const FMargin& NewScrollbarPadding
)

  
Public function UFunction BlueprintCallable, Category void

SetScrollbarThickness ( const FVector2D& NewScrollbarThickness
)

  
Public function UFunction BlueprintCallable, Category void

SetScrollBarVisibility ( ESlateVisibility NewScrollBarVisibility
)

  
Public function UFunction BlueprintCallable, Category void

SetScrollOffset ( float NewScrollOffset
)

 Updates the scroll offset of the scrollbox.
Public function UFunction BlueprintCallable, Category void

SetScrollWhenFocusChanges ( EScrollWhenFocusChanges NewScrollWhenFocusChanges
)

  
Public function UFunction BlueprintCallable, Category void

SetWheelScrollMultiplier ( float NewWheelScrollMultiplier
)

  
Public function void

SetWidgetBarStyle ( const FScrollBarStyle& NewWidgetBarStyle
)

  
Public function void

SetWidgetStyle ( const FScrollBoxStyle& NewWidgetStyle
)

  
Protected function void

SlateHandleScrollBarVisibilityChanged ( EVisibility NewVisibility
)

  
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
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page