UScrollBox Class Reference

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

Public Member Functions
Functions
const bool &	GetAlwaysShowScrollbar () const
const EOrientation &	GetOrientation () const
	The orientation of the scrolling and stacking in the box.
const ESlateVisibility &	GetScrollBarVisibility () const
	Visibility.
const EConsumeMouseWheel &	GetConsumeMouseWheel () const
	When mouse wheel events should be consumed.
const FVector2D &	GetScrollbarThickness () const
	The thickness of the scrollbar thumb.
const FMargin &	GetScrollbarPadding () const
	The margin around the scrollbar.
void	SetbAnimateWheelScrolling (bool bShouldAnimateWheelScrolling)
	True to lerp smoothly when wheel scrolling along the scroll box.
const bool &	GetAllowOverscroll () const
	Disable to stop scrollbars from activating inertial overscrolling.
const bool &	GetbAnimateWheelScrolling () const
	True to lerp smoothly when wheel scrolling along the scroll box.
const EDescendantScrollDestination &	GetNavigationDestination () const
	Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled.
const EScrollWhenFocusChanges &	GetScrollWhenFocusChanges () const
	Scroll behavior when user focus is given to a child widget.
const float32 &	GetWheelScrollMultiplier () const
	The multiplier to apply when wheel scrolling.
int	GetChildrenCount () const
	Gets number of child widgets in the container.
void	ClearChildren ()
	Remove all child widgets from the panel widget.
TArray< UWidget >	GetAllChildren () const
	Gets all widgets in the container.
UWidget	GetChildAt (int Index) const
	Gets the widget at an index.
int	GetChildIndex (const UWidget Content) const
	Gets the index of a specific child widget.
UPanelSlot	AddChild (UWidget Content)
	Adds a new child widget to the container. Returns the base slot type, requires casting to turn it into the type specific to the container.
bool	HasAnyChildren () const
	Returns true if there are any child widgets in the panel.
bool	HasChild (UWidget Content) const
	Returns true if panel contains this widget.
bool	RemoveChild (UWidget Content)
	Removes a specific widget from the container.
bool	RemoveChildAt (int Index)
	Removes a child by it's index.
Public Member Functions inherited from UWidget
bool	IsInViewport () const
void	RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	BroadcastFieldValueChanged (FFieldNotificationId FieldId)
void	AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	SetbOverride_Cursor (bool Value)
void	SetToolTipWidget (UWidget Widget)
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	GetbIsEnabled () const
	Sets whether this widget can be modified interactively by the user.
void	SetbIsEnabled (bool bInIsEnabled)
	Sets whether this widget can be modified interactively by the user.
const FWidgetTransform &	GetRenderTransform ()
const FText &	GetToolTipText () const
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	GetToolTipWidget () const
	Tooltip widget to show when the user hovers over the widget with the mouse.
const FVector2D &	GetRenderTransformPivot () const
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
void	GetChildWidgets (TArray< UWidget > &OutChildWidgets) const
void	SetbOverrideAccessibleDefaults (bool Value)
	Override all of the default accessibility behavior and text for this widget.
void	SetbCanChildrenBeAccessible (bool Value)
	Whether or not children of this widget can appear as distinct accessible widgets.
void	SetAccessibleText (FText Value)
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
void	SetAccessibleSummaryText (FText Value)
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
bool	GetbIsVolatile () const
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
void	SetbIsVolatile (bool Value)
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
const EMouseCursor &	GetCursor () const
	The cursor to show when the mouse is over the widget.
const FGeometry &	GetCachedGeometry () const
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
EWidgetClipping	GetClipping () const
	Gets the clipping state of this widget.
FVector2D	GetDesiredSize () const
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
FText	GetAccessibleText () const
	Gets the accessible text from the underlying Slate accessible widget.
FText	GetAccessibleSummaryText () const
	Gets the accessible summary text from the underlying Slate accessible widget.
UGameInstance	GetGameInstance () const
	Gets the game instance associated with this UI.
ULocalPlayer	GetOwningLocalPlayer () const
	Gets the local player associated with this UI.
APlayerController	GetOwningPlayer () const
	Gets the player controller associated with this UI.
const FGeometry &	GetPaintSpaceGeometry () const
UPanelWidget	GetParent () const
	Gets the parent widget.
float32	GetRenderOpacity () const
	Gets the current visibility of the widget.
bool	GetIsEnabled () const
	Gets the current enabled status of the widget.
void	ForceVolatile (bool bForce)
	Sets the forced volatility of the widget.
ESlateVisibility	GetVisibility () const
	Gets the current visibility of the widget.
bool	HasAnyUserFocus () const
	Returns true if this widget is focused by any user.
bool	HasFocusedDescendants () const
	Returns true if any descendant widget is focused by any user.
bool	HasKeyboardFocus () const
	Checks to see if this widget currently has the keyboard focus.
bool	HasMouseCapture () const
	Checks to see if this widget is the current mouse captor.
bool	HasMouseCaptureByUser (int UserIndex, int PointerIndex=- 1) const
	Checks to see if this widget is the current mouse captor.
bool	HasUserFocus (APlayerController PlayerController) const
	Returns true if this widget is focused by a specific user.
bool	HasUserFocusedDescendants (APlayerController PlayerController) const
	Returns true if any descendant widget is focused by a specific user.
void	InvalidateLayoutAndVolatility ()
	Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass.
bool	IsHovered () const
	Returns true if the widget is currently being hovered by a pointer device.
void	ForceLayoutPrepass ()
	Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget. One pre-pass already happens for every widget before Tick occurs. You only need to perform another pre-pass if you are adding child widgets this frame and want them to immediately be visible this frame.
bool	IsRendered () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
bool	IsVisible () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
const FGeometry &	GetTickSpaceGeometry () const
void	SetClipping (EWidgetClipping InClipping)
	Sets the clipping state of this widget.
void	SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Custom Rule.
void	RemoveFromParent ()
	Removes the widget from its parent widget. If this widget was added to the player's screen or the viewport it will also be removed from those containers.
void	ResetCursor ()
	Resets the cursor to use on the widget, removing any customization for it.
void	SetAllNavigationRules (EUINavigationRule Rule, FName WidgetToFocus)
	Sets the widget navigation rules for all directions. This can only be called on widgets that are in a widget tree.
void	SetVisibility (ESlateVisibility InVisibility)
	Sets the visibility of the widget.
void	SetCursor (EMouseCursor InCursor)
	Sets the cursor to show over the widget.
void	SetFocus ()
	Sets the focus to this widget for the owning user.
void	SetIsEnabled (bool bInIsEnabled)
	Sets the current enabled status of the widget.
void	SetKeyboardFocus ()
	Sets the focus to this widget.
void	SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
void	SetNavigationRuleBase (EUINavigation Direction, EUINavigationRule Rule)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for non Explicit, non Custom and non CustomBoundary Rules.
void	SetUserFocus (APlayerController PlayerController)
	Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus()).
void	SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for CustomBoundary Rule.
void	SetNavigationRuleExplicit (EUINavigation Direction, UWidget InWidget)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Explicit Rule.
void	SetRenderOpacity (float32 InOpacity)
	Sets the visibility of the widget.
void	SetToolTip (UWidget Widget)
	Sets a custom widget as the tooltip of the widget.
void	SetToolTipText (FText InToolTipText)
	Sets the tooltip text for the widget.
void	SetRenderTransformAngle (float32 Angle)
void	SetRenderTransformPivot (FVector2D Pivot)
float32	GetRenderTransformAngle () const
void	SetRenderTransform (FWidgetTransform InTransform)
void	SetRenderShear (FVector2D Shear)
void	SetRenderScale (FVector2D Scale)
void	SetRenderTranslation (FVector2D Translation)
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UPanelWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UVisual
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Button|Event
FOnScrollBarVisibilityChangedEvent	OnScrollBarVisibilityChanged
	Called when the scrollbar visibility has changed.
FOnUserScrolledEvent	OnUserScrolled
	Called when the scroll has changed.
Style
FScrollBoxStyle	WidgetStyle
	The style.
FScrollBarStyle	WidgetBarStyle
	The bar style.
const int	ChildrenCount
	Gets number of child widgets in the container.
const TArray< UWidget >	AllChildren
	Gets all widgets in the container.
Public Attributes inherited from UWidget
FText	AccessibleSummaryText
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
FText	AccessibleText
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
ESlateAccessibleBehavior	AccessibleBehavior
	Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
ESlateAccessibleBehavior	AccessibleSummaryBehavior
	How to describe this widget when it's being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
EMouseCursor	Cursor
	The cursor to show when the mouse is over the widget.
FText	ToolTipText
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	ToolTipWidget
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	bIsEnabled
	Sets whether this widget can be modified interactively by the user.
ESlateVisibility	Visibility
	The visibility of the widget.
UPanelSlot	Slot
	The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
EFlowDirectionPreference	FlowDirectionPreference
	Allows you to set a new flow direction.
UWidgetNavigation	Navigation
	The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.
bool	bIsVolatile
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
FVector2D	RenderTransformPivot
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
FWidgetTransform	RenderTransform
	The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
EWidgetPixelSnapping	PixelSnapping
	If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation.
EWidgetClipping	Clipping
	Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.
float32	RenderOpacity
	The opacity of the widget.
const FGeometry	CachedGeometry
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
const FGeometry	PaintSpaceGeometry
const UGameInstance	GameInstance
	Gets the game instance associated with this UI.
const UPanelWidget	Parent
	Gets the parent widget.
const FVector2D	DesiredSize
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
const FGeometry	TickSpaceGeometry
bool	IsEnabled
	Gets the current enabled status of the widget.
const ULocalPlayer	OwningLocalPlayer
	Gets the local player associated with this UI.
const APlayerController	OwningPlayer
	Gets the player controller associated with this UI.
float32	RenderTransformAngle
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Scroll
bool	BackPadScrolling
	Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible.
bool	FrontPadScrolling
	Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible.
float32	NavigationScrollPadding
	The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox. Use this if you want to ensure there's a preview of the next item the user could scroll to.
bool	bAllowRightClickDragScrolling
	Option to disable right-click-drag scrolling.
bool	AlwaysShowScrollbarTrack
float32	WheelScrollMultiplier
	The multiplier to apply when wheel scrolling.
EConsumeMouseWheel	ConsumeMouseWheel
	When mouse wheel events should be consumed.
ESlateVisibility	ScrollBarVisibility
	Visibility.
EDescendantScrollDestination	NavigationDestination
	Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled.
EScrollWhenFocusChanges	ScrollWhenFocusChanges
	Scroll behavior when user focus is given to a child widget.
EOrientation	Orientation
	The orientation of the scrolling and stacking in the box.
bool	AllowOverscroll
	Disable to stop scrollbars from activating inertial overscrolling.
bool	bAnimateWheelScrolling
	True to lerp smoothly when wheel scrolling along the scroll box.
FVector2D	ScrollbarThickness
	The thickness of the scrollbar thumb.
FMargin	ScrollbarPadding
	The margin around the scrollbar.
bool	AlwaysShowScrollbar
void	SetScrollBarVisibility (ESlateVisibility NewScrollBarVisibility)
void	SetAnimateWheelScrolling (bool bShouldAnimateWheelScrolling)
void	SetWheelScrollMultiplier (float32 NewWheelScrollMultiplier)
void	SetConsumeMouseWheel (EConsumeMouseWheel NewConsumeMouseWheel)
void	SetOrientation (EOrientation NewOrientation)
void	EndInertialScrolling ()
	Instantly stops any inertial scrolling that is currently in progress.
void	SetScrollbarPadding (FMargin NewScrollbarPadding)
void	SetAllowOverscroll (bool NewAllowOverscroll)
void	SetAlwaysShowScrollbar (bool NewAlwaysShowScrollbar)
void	SetScrollWhenFocusChanges (EScrollWhenFocusChanges NewScrollWhenFocusChanges)
void	SetScrollbarThickness (FVector2D NewScrollbarThickness)
void	SetNavigationDestination (EDescendantScrollDestination NewNavigationDestination)

Widget
const float32	ScrollOffsetOfEnd
	Gets the scroll offset of the bottom of the ScrollBox in Slate Units.
float32	ScrollOffset
	Gets the scroll offset of the scrollbox in Slate Units.
const float32	ViewFraction
	Gets the fraction currently visible in the scrollbox.
const float32	ViewOffsetFraction
float32	GetViewOffsetFraction () const
void	ScrollWidgetIntoView (UWidget WidgetToFind, bool AnimateScroll=true, EDescendantScrollDestination ScrollDestination=EDescendantScrollDestination ::IntoView, float32 Padding=0.000000)
	Scrolls the ScrollBox to the widget during the next layout pass.
void	ScrollToEnd ()
	Scrolls the ScrollBox to the bottom instantly during the next layout pass.
float32	GetScrollOffset () const
	Gets the scroll offset of the scrollbox in Slate Units.
float32	GetScrollOffsetOfEnd () const
	Gets the scroll offset of the bottom of the ScrollBox in Slate Units.
void	ScrollToStart ()
	Scrolls the ScrollBox to the top instantly.
float32	GetViewFraction () const
	Gets the fraction currently visible in the scrollbox.
void	SetScrollOffset (float32 NewScrollOffset)
	Updates the scroll offset of the scrollbox.

Detailed Description

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

Member Function Documentation

EndInertialScrolling()

void EndInertialScrolling

(

)

Instantly stops any inertial scrolling that is currently in progress.

GetAllowOverscroll()

const bool & GetAllowOverscroll

(

)

const

Disable to stop scrollbars from activating inertial overscrolling.

GetAlwaysShowScrollbar()

const bool & GetAlwaysShowScrollbar

(

)

const

GetbAnimateWheelScrolling()

const bool & GetbAnimateWheelScrolling

(

)

const

True to lerp smoothly when wheel scrolling along the scroll box.

GetConsumeMouseWheel()

const EConsumeMouseWheel & GetConsumeMouseWheel

(

)

const

When mouse wheel events should be consumed.

GetNavigationDestination()

const EDescendantScrollDestination & GetNavigationDestination

(

)

const

Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled.

GetOrientation()

const EOrientation & GetOrientation

(

)

const

The orientation of the scrolling and stacking in the box.

GetScrollbarPadding()

const FMargin & GetScrollbarPadding

(

)

const

The margin around the scrollbar.

GetScrollbarThickness()

const FVector2D & GetScrollbarThickness

(

)

const

The thickness of the scrollbar thumb.

GetScrollBarVisibility()

const ESlateVisibility & GetScrollBarVisibility

(

)

const

Visibility.

GetScrollOffset()

float32 GetScrollOffset

(

)

const

Gets the scroll offset of the scrollbox in Slate Units.

GetScrollOffsetOfEnd()

float32 GetScrollOffsetOfEnd

(

)

const

Gets the scroll offset of the bottom of the ScrollBox in Slate Units.

GetScrollWhenFocusChanges()

const EScrollWhenFocusChanges & GetScrollWhenFocusChanges

(

)

const

Scroll behavior when user focus is given to a child widget.

GetViewFraction()

float32 GetViewFraction

(

)

const

Gets the fraction currently visible in the scrollbox.

GetViewOffsetFraction()

float32 GetViewOffsetFraction

(

)

const

GetWheelScrollMultiplier()

const float32 & GetWheelScrollMultiplier

(

)

const

The multiplier to apply when wheel scrolling.

ScrollToEnd()

void ScrollToEnd

(

)

Scrolls the ScrollBox to the bottom instantly during the next layout pass.

ScrollToStart()

void ScrollToStart

(

)

Scrolls the ScrollBox to the top instantly.

ScrollWidgetIntoView()

void ScrollWidgetIntoView	(	UWidget	WidgetToFind,
		bool	AnimateScroll = true,
		EDescendantScrollDestination	ScrollDestination = EDescendantScrollDestination :: IntoView,
		float32	Padding = 0.000000 )

Scrolls the ScrollBox to the widget during the next layout pass.

SetAllowOverscroll()

void SetAllowOverscroll

(

bool

NewAllowOverscroll

)

SetAlwaysShowScrollbar()

void SetAlwaysShowScrollbar

(

bool

NewAlwaysShowScrollbar

)

SetAnimateWheelScrolling()

void SetAnimateWheelScrolling

(

bool

bShouldAnimateWheelScrolling

)

SetbAnimateWheelScrolling()

void SetbAnimateWheelScrolling

(

bool

bShouldAnimateWheelScrolling

)

True to lerp smoothly when wheel scrolling along the scroll box.

SetConsumeMouseWheel()

void SetConsumeMouseWheel

(

EConsumeMouseWheel

NewConsumeMouseWheel

)

SetNavigationDestination()

void SetNavigationDestination

(

EDescendantScrollDestination

NewNavigationDestination

)

SetOrientation()

void SetOrientation

(

EOrientation

NewOrientation

)

SetScrollbarPadding()

void SetScrollbarPadding

(

FMargin

NewScrollbarPadding

)

SetScrollbarThickness()

void SetScrollbarThickness

(

FVector2D

NewScrollbarThickness

)

SetScrollBarVisibility()

void SetScrollBarVisibility

(

ESlateVisibility

NewScrollBarVisibility

)

SetScrollOffset()

void SetScrollOffset

(

float32

NewScrollOffset

)

Updates the scroll offset of the scrollbox.

Parameters

NewScrollOffset

is in Slate Units.

SetScrollWhenFocusChanges()

void SetScrollWhenFocusChanges

(

EScrollWhenFocusChanges

NewScrollWhenFocusChanges

)

SetWheelScrollMultiplier()

void SetWheelScrollMultiplier

(

float32

NewWheelScrollMultiplier

)

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

AllowOverscroll

bool AllowOverscroll

Disable to stop scrollbars from activating inertial overscrolling.

AlwaysShowScrollbar

bool AlwaysShowScrollbar

AlwaysShowScrollbarTrack

bool AlwaysShowScrollbarTrack

BackPadScrolling

bool BackPadScrolling

Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible.

bAllowRightClickDragScrolling

bool bAllowRightClickDragScrolling

Option to disable right-click-drag scrolling.

bAnimateWheelScrolling

bool bAnimateWheelScrolling

True to lerp smoothly when wheel scrolling along the scroll box.

ConsumeMouseWheel

EConsumeMouseWheel ConsumeMouseWheel

When mouse wheel events should be consumed.

FrontPadScrolling

bool FrontPadScrolling

Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible.

NavigationDestination

EDescendantScrollDestination NavigationDestination

Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled.

NavigationScrollPadding

float32 NavigationScrollPadding

The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox. Use this if you want to ensure there's a preview of the next item the user could scroll to.

OnScrollBarVisibilityChanged

FOnScrollBarVisibilityChangedEvent OnScrollBarVisibilityChanged

Called when the scrollbar visibility has changed.

OnUserScrolled

FOnUserScrolledEvent OnUserScrolled

Called when the scroll has changed.

Orientation

EOrientation Orientation

The orientation of the scrolling and stacking in the box.

ScrollbarPadding

FMargin ScrollbarPadding

The margin around the scrollbar.

ScrollbarThickness

FVector2D ScrollbarThickness

The thickness of the scrollbar thumb.

ScrollBarVisibility

ESlateVisibility ScrollBarVisibility

Visibility.

ScrollOffset

float32 ScrollOffset

Gets the scroll offset of the scrollbox in Slate Units.

ScrollOffsetOfEnd

const float32 ScrollOffsetOfEnd

Gets the scroll offset of the bottom of the ScrollBox in Slate Units.

ScrollWhenFocusChanges

EScrollWhenFocusChanges ScrollWhenFocusChanges

Scroll behavior when user focus is given to a child widget.

ViewFraction

const float32 ViewFraction

Gets the fraction currently visible in the scrollbox.

ViewOffsetFraction

const float32 ViewOffsetFraction

WheelScrollMultiplier

float32 WheelScrollMultiplier

The multiplier to apply when wheel scrolling.

WidgetBarStyle

FScrollBarStyle WidgetBarStyle

The bar style.

WidgetStyle

FScrollBoxStyle WidgetStyle

The style.