Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScrollBox.h |
Include |
#include "Widgets/Layout/SScrollBox.h" |
class SScrollBox : public SCompoundWidget
SScrollBox can scroll through an arbitrary number of widgets.
Name | Description | ||
---|---|---|---|
|
AllowOverscroll |
Whether to permit overscroll on this scroll box |
|
|
float |
AmountScrolledWhileRightMouseDown |
How much we scrolled while the rmb has been held |
|
BackPadScrolling |
Whether to back pad this scroll box, allowing user to scroll backward until child contents are no longer visible |
|
|
bool: 1 |
bAllowsRightClickDragScrolling |
|
|
bool: 1 |
bAnimateScroll |
Should the current scrolling be animated or immediately jump to the desired scroll offer |
|
bool: 1 |
bAnimateWheelScrolling |
Whether to animate wheel scrolling |
|
bFingerOwningTouchInteraction |
Did the user start an interaction in this list? |
|
|
bool: 1 |
bIsScrolling |
Are we actively scrolling right now |
|
bool: 1 |
bIsScrollingActiveTimerRegistered |
Whether the active timer to update the inertial scroll is registered |
|
bool: 1 |
bScrollBarIsExternal |
Whether or not the user supplied an external scrollbar to control scrolling. |
|
bool: 1 |
bScrollToEnd |
If true, will scroll to the end next Tick |
|
bool: 1 |
bShowSoftwareCursor |
Whether the software cursor should be drawn in the viewport |
|
bool: 1 |
bTouchPanningCapture |
|
|
CachedGeometry |
Cached geometry for use with the active timer |
|
|
ConsumeMouseWheel |
How we should handle scrolling with the mouse wheel |
|
|
FrontPadScrolling |
Whether to front pad this scroll box, allowing user to scroll forward until child contents are no longer visible |
|
|
HorizontalScrollBarSlot |
||
|
InertialScrollManager |
Helper object to manage inertial scrolling |
|
|
double |
LastScrollTime |
|
|
NavigationDestination |
Sets where to scroll a widget to when using explicit navigation or if ScrollWhenFocusChanges is enabled |
|
|
float |
NavigationScrollPadding |
The amount of padding to ensure exists between the item being navigated to, at the edge of the scrollbox. |
|
OnUserScrolled |
Fired when the user scrolls the scrollbox |
|
|
Orientation |
The scrolling and stacking orientation. |
|
|
Overscroll |
The overscroll state management structure. |
|
|
float |
PendingScrollTriggerAmount |
The current deviation we've accumulated on scrol, once it passes the trigger amount, we're going to begin scrolling. |
|
TSharedPtr< SSc... |
ScrollBar |
The scrollbar which controls scrolling for the scrollbox. |
|
const FScrollBa... |
ScrollBarStyle |
Style resource for the scrollbar |
|
ScrollIntoViewRequest |
Scroll into view request. |
|
|
TSharedPtr< cla... |
ScrollPanel |
The panel which stacks the child slots |
|
ScrollWhenFocusChanges |
Scroll behavior when user focus is given to a child widget |
|
|
SoftwareCursorPosition |
The current position of the software cursor |
|
|
const FScrollBo... |
Style |
Style resource for the scrollbox |
|
float |
TickScrollDelta |
The amount we have scrolled this tick cycle |
|
TSharedPtr< FAc... |
UpdateInertialScrollHandle |
|
|
VerticalScrollBarSlot |
Vertical scroll bar is stored in horizontal box and vice versa |
|
|
float |
WheelScrollMultiplier |
Multiplier applied to each click of the scroll wheel (applied alongside the global scroll amount) |
Name | Description | |
---|---|---|
|
SScrollBox() |
Name | Description | ||
---|---|---|---|
|
FScopedWidge... |
AddSlot() |
Adds a slot to SScrollBox |
|
ClearChildren() |
Removes all children from the box |
|
|
Construct ( |
||
|
EndInertialScrolling() |
||
|
EAllowOversc... |
GetAllowOverscroll() |
|
|
TSharedPtr< ... |
GetKeyboardFocusableWidget ( |
Returns widget that can receive keyboard focus or nullprt |
|
GetOrientation() |
Get the current orientation of the scrollbox. |
|
|
float |
GetScrollOffset() |
|
|
float |
GetScrollOffsetOfEnd() |
Gets the scroll offset of the bottom of the ScrollBox in Slate Units. |
|
float |
GetViewFraction() |
|
|
float |
GetViewOffsetFraction() |
|
|
InternalScrollDescendantIntoView ( |
Scrolls or begins scrolling a widget into view, only valid to call when we have layout geometry. |
|
|
IsRightClickScrolling() |
||
|
RemoveSlot ( |
Removes a slot at the specified location |
|
|
ScrollDescendantIntoView ( |
Attempt to scroll a widget into view, will safely handle non-descendant widgets |
|
|
ScrollToEnd() |
||
|
ScrollToStart() |
||
|
SetAllowOverscroll ( |
||
|
SetAnimateWheelScrolling ( |
||
|
SetConsumeMouseWheel ( |
||
|
SetNavigationDestination ( |
||
|
SetOrientation ( |
Sets the current orientation of the scrollbox and updates the layout |
|
|
SetScrollBarAlwaysVisible ( |
||
|
SetScrollBarPadding ( |
||
|
SetScrollBarRightClickDragAllowed ( |
||
|
SetScrollBarThickness ( |
||
|
SetScrollBarTrackAlwaysVisible ( |
||
|
SetScrollBarVisibility ( |
||
|
SetScrollOffset ( |
||
|
SetScrollWhenFocusChanges ( |
||
|
SetWheelScrollMultiplier ( |
||
|
FSlot::FSlot... |
Slot() |
Name | Description | ||
---|---|---|---|
|
ComputeVolatility() |
Recomputes the volatility of the widget. |
|
|
OnClippingChanged() |
Called when clipping is changed. |
|
|
OnCursorQuery ( |
The system asks each widget under the mouse to provide a cursor. This event is bubbled. |
|
|
OnFocusChanging ( |
Called whenever a focus path is changing on all the widgets within the old and new focus paths |
|
|
OnMouseButtonDown ( |
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. |
|
|
OnMouseButtonUp ( |
The system calls this method to notify the widget that a mouse button was release within it. |
|
|
OnMouseCaptureLost ( |
Called when this widget had captured the mouse, but that capture has been revoked for some reason. |
|
|
OnMouseEnter ( |
The system will use this event to notify a widget that the cursor has entered it. |
|
|
OnMouseLeave ( |
The system will use this event to notify a widget that the cursor has left it. |
|
|
OnMouseMove ( |
The system calls this method to notify the widget that a mouse moved within it. |
|
|
OnMouseWheel ( |
Called when the mouse wheel is spun. This event is bubbled. |
|
|
FNavigationR... |
OnNavigation ( |
Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events. |
|
OnPaint ( |
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. |
|
|
OnPreviewMouseButtonDown ( |
Just like OnMouseButtonDown, but tunnels instead of bubbling. |
|
|
OnTouchEnded ( |
Called when a touchpad touch is ended (finger lifted) |
|
|
Tick ( |
Ticks this widget with Geometry. |
Name |
Description |
|
---|---|---|
|
FArguments |
Name |
Description |
---|---|
FScopedWidgetSlotArguments |
|
FSlot |
A Slot that provides layout options for the contents of a scrollable box. |
Name | Description | ||
---|---|---|---|
|
ScrollBarPadding |
ScrollBarPadding is deprecated, Use SetScrollBarPadding |