Navigation
API > API/Runtime > API/Runtime/Slate
Contains ListView functionality that does not depend on the type of data being observed by the ListView.
| Name | STableViewBase |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Views/STableViewBase.h |
| Include Path | #include "Widgets/Views/STableViewBase.h" |
Syntax
class STableViewBase :
public SCompoundWidget ,
public IScrollableWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → STableViewBase
- FSlateControlledConstruction → SWidget → SCompoundWidget → STableViewBase
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
STableViewBase
(
ETableViewMode::Type InTableViewMode |
Widgets/Views/STableViewBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~STableViewBase() |
Widgets/Views/STableViewBase.h |
Structs
| Name | Remarks |
|---|---|
| FReGenerateResults | Information about the outcome of the WidgetRegeneratePass |
Enums
Protected
| Name | Remarks |
|---|---|
| EScrollIntoViewResult |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HorizontalScrollBarSlot | SVerticalBox::FSlot * | Widgets/Views/STableViewBase.h | ||
| TableViewMode | const ETableViewMode::Type | Is this list backing a tree or just a standalone list | Widgets/Views/STableViewBase.h | |
| VerticalScrollBarSlot | SHorizontalBox::FSlot * | Vertical scroll bar is stored in horizontal box and vice versa | Widgets/Views/STableViewBase.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInertialScroll | bool | Whether or not the current scroll is inertial | Widgets/Views/STableViewBase.h | |
| bItemsNeedRefresh | bool | When true, a refresh should occur the next tick | Widgets/Views/STableViewBase.h | |
| STableViewBase | union STableViewBase | Widgets/Views/STableViewBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddScrollOffset
(
const float InScrollOffsetDelta, |
Add the scroll offset of this view (in items) | Widgets/Views/STableViewBase.h | |
void ConstructChildren
(
const TAttribute< float >& InItemWidth, |
Create the child widgets that comprise the list | Widgets/Views/STableViewBase.h | |
void EndInertialScrolling
(
const bool bInShouldStopScrollNow |
Reset the inertial scroll velocity accumulated in the InertialScrollManager | Widgets/Views/STableViewBase.h | |
TSharedPtr< SWidget > GetGeneratedChildAt
(
int32 Index |
Widgets/Views/STableViewBase.h | ||
TSharedPtr< SHeaderRow > GetHeaderRow() |
Widgets/Views/STableViewBase.h | ||
int32 GetNumGeneratedChildren() |
Widgets/Views/STableViewBase.h | ||
EVisibility GetScrollbarVisibility() |
Widgets/Views/STableViewBase.h | ||
float GetScrollOffset() |
Gets the scroll offset of this view (in items) | Widgets/Views/STableViewBase.h | |
bool IsPendingRefresh() |
Return true if there is currently a refresh pending, false otherwise | Widgets/Views/STableViewBase.h | |
bool IsRightClickScrolling() |
Widgets/Views/STableViewBase.h | ||
bool IsScrollbarNeeded() |
Returns true if scrolling is possible; false if the view is big enough to fit all the content. | Widgets/Views/STableViewBase.h | |
bool IsScrolling() |
Returns whether the attached scrollbar is scrolling | Widgets/Views/STableViewBase.h | |
bool IsUserScrolling() |
Widgets/Views/STableViewBase.h | ||
void RebuildList() |
Completely wipe existing widgets and fully regenerate them on next tick. | Widgets/Views/STableViewBase.h | |
virtual void RequestListRefresh () |
Mark the list as dirty so that it will refresh its widgets on next tick. | Widgets/Views/STableViewBase.h | |
void ScrollBar_OnUserScrolled
(
float InScrollOffsetFraction |
Invoked by the scrollbar when the user scrolls. | Widgets/Views/STableViewBase.h | |
void ScrollToBottom() |
Scrolls the view to the bottom | Widgets/Views/STableViewBase.h | |
void ScrollToTop() |
Scrolls the view to the top | Widgets/Views/STableViewBase.h | |
void SetAllowOverscroll
(
EAllowOverscroll InAllowOverscroll |
Sets whether to permit overscroll on this list view | Widgets/Views/STableViewBase.h | |
void SetBackgroundBrush
(
const TAttribute< const FSlateBrush* >& InBackgroundBrush |
Sets the Background Brush | Widgets/Views/STableViewBase.h | |
void SetEnableTouchAnimatedScrolling
(
bool bInEnableTouchAnimatedScrolling |
Sets whether the list should lerp between scroll offsets or jump instantly between them with touch. | Widgets/Views/STableViewBase.h | |
void SetFixedLineScrollOffset
(
TOptional< double > InFixedLineScrollOffset |
Sets the fixed offset in items to always apply to the top/left (depending on orientation) of the list. | Widgets/Views/STableViewBase.h | |
void SetIsGamepadScrollingEnabled
(
bool bInIsGamepadScrollingEnabled |
Enables/disables being able to scroll via gamepad. | Widgets/Views/STableViewBase.h | |
void SetIsPointerScrollingEnabled
(
bool bInIsPointerScrollingEnabled |
Enables/disables being able to scroll via pointer. | Widgets/Views/STableViewBase.h | |
void SetIsRightClickScrollingEnabled
(
const bool bInEnableRightClickScrolling |
Enables/disables being able to scroll with the right mouse button. | Widgets/Views/STableViewBase.h | |
void SetIsScrollAnimationEnabled
(
bool bInEnableScrollAnimation |
Sets whether the list should lerp between scroll offsets or jump instantly between them. | Widgets/Views/STableViewBase.h | |
void SetIsTouchScrollingEnabled
(
const bool bInEnableTouchScrolling |
Enables/disables being able to scroll using touch input. | Widgets/Views/STableViewBase.h | |
void SetItemHeight
(
TAttribute< float > Height |
Sets the item height | Widgets/Views/STableViewBase.h | |
void SetItemWidth
(
TAttribute< float > Width |
Sets the item width | Widgets/Views/STableViewBase.h | |
void SetScrollbarPadding
(
const FMargin& InScrollbarPadding |
Widgets/Views/STableViewBase.h | ||
void SetScrollbarVisibility
(
const EVisibility InVisibility |
Widgets/Views/STableViewBase.h | ||
void SetScrollingAnimationInterpolationSpeed
(
float InScrollingAnimationInterpolationSpeed |
Sets the speed of lerp between scroll offsets. | Widgets/Views/STableViewBase.h | |
void SetScrollOffset
(
const float InScrollOffset |
Set the scroll offset of this view (in items) | Widgets/Views/STableViewBase.h | |
void SetSelectItemOnNavigation
(
const bool bInSelectItemOnNavigation |
Sets whether items will be selected and focused or only focused when navigating to them. | Widgets/Views/STableViewBase.h | |
void SetWheelScrollMultiplier
(
float NewWheelScrollMultiplier |
Sets the multiplier applied when wheel scrolling. | Widgets/Views/STableViewBase.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ComputeVolatility() |
Widgets/Views/STableViewBase.h | ||
virtual FCursorReply OnCursorQuery
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual void OnFocusLost
(
const FFocusEvent& InFocusEvent |
Widgets/Views/STableViewBase.h | ||
| Widgets/Views/STableViewBase.h | |||
virtual FReply OnMouseButtonDoubleClick
(
const FGeometry& InMyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual FReply OnMouseButtonDown
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual FReply OnMouseButtonUp
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual void OnMouseCaptureLost
(
const FCaptureLostEvent& CaptureLostEvent |
Widgets/Views/STableViewBase.h | ||
virtual void OnMouseEnter
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual void OnMouseLeave
(
const FPointerEvent& MouseEvent |
Widgets/Views/STableViewBase.h | ||
virtual FReply OnMouseMove
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual FReply OnMouseWheel
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Views/STableViewBase.h | ||
virtual FReply OnPreviewMouseButtonDown
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual FReply OnTouchEnded
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual FReply OnTouchMoved
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual FReply OnTouchStarted
(
const FGeometry& MyGeometry, |
Widgets/Views/STableViewBase.h | ||
virtual bool SupportsKeyboardFocus() |
Widgets/Views/STableViewBase.h | ||
virtual void Tick
(
const FGeometry& AllottedGeometry, |
Widgets/Views/STableViewBase.h |
Overridden from IScrollableWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D GetScrollDistance() |
Gets the distance that user has scrolled into the control in normalized coordinates (0 - 1) | Widgets/Views/STableViewBase.h | |
virtual FVector2D GetScrollDistanceRemaining() |
Gets the distance that user has left to scroll in the control before reaching the end in normalized coordinates (0 - 1) | Widgets/Views/STableViewBase.h | |
virtual TSharedRef< class SWidget > GetScrollWidget() |
Returns the typed SWidget that implements this interface | Widgets/Views/STableViewBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AppendPinnedWidget
(
const TSharedRef< SWidget >& WidgetToAppend |
Add a WidgetToAppend to the bottom of the pinned view. | Widgets/Views/STableViewBase.h | |
void AppendWidget
(
const TSharedRef< ITableRow >& WidgetToAppend |
Add a WidgetToAppend to the bottom of the view. | Widgets/Views/STableViewBase.h | |
bool CanUseInertialScroll
(
float ScrollAmount |
Check whether the current state of the table warrants inertial scroll by the specified amount | Widgets/Views/STableViewBase.h | |
void ClearPinnedWidgets() |
Remove all the pinned widgets from the view. | Widgets/Views/STableViewBase.h | |
void ClearWidgets() |
Remove all the widgets from the view. | Widgets/Views/STableViewBase.h | |
EActiveTimerReturnType EnsureTickToRefresh
(
double InCurrentTime, |
One-off active timer to refresh the contents of the table as needed | Widgets/Views/STableViewBase.h | |
int32 FindChildUnderPosition
(
FArrangedChildren& ArrangedChildren, |
Util function to find the child index under the given position. | Widgets/Views/STableViewBase.h | |
const FChildren * GetConstructedTableItems() |
Widgets/Views/STableViewBase.h | ||
virtual float GetFirstLineScrollOffset() |
Get the offset of the first list item. | Widgets/Views/STableViewBase.h | |
float GetItemHeight() |
Get the uniform item height that is enforced by ListViews. | Widgets/Views/STableViewBase.h | |
UE::Slate::FDeprecateVector2DResult GetItemSize() |
Get the uniform item | Widgets/Views/STableViewBase.h | |
float GetItemWidth() |
Get the uniform item width. | Widgets/Views/STableViewBase.h | |
int32 GetNumItemsBeingObserved() |
Widgets/Views/STableViewBase.h | ||
virtual int32 GetNumItemsPerLine () |
Get the number of items that can fit in the view along the line axis (orthogonal to the scroll axis) before creating a new line. | Widgets/Views/STableViewBase.h | |
virtual float GetNumLiveWidgets() |
Widgets/Views/STableViewBase.h | ||
int32 GetNumPinnedItems() |
Widgets/Views/STableViewBase.h | ||
EVisibility GetPinnedItemsVisiblity() |
Widgets/Views/STableViewBase.h | ||
float GetScrollRateInItems() |
Get the scroll rate in items that best approximates a constant physical scroll rate. | Widgets/Views/STableViewBase.h | |
double GetTargetScrollOffset() |
Returns the "true" scroll offset where the list will ultimately settle (and may already be). | Widgets/Views/STableViewBase.h | |
void InsertPinnedWidget
(
const TSharedRef< SWidget >& WidgetToInset |
Insert WidgetToInsert at the top of the pinned view. | Widgets/Views/STableViewBase.h | |
void InsertWidget
(
const TSharedRef< ITableRow >& WidgetToInset |
Insert WidgetToInsert at the top of the view. | Widgets/Views/STableViewBase.h | |
void NavigateToWidget
(
const uint32 UserIndex, |
Util Function so templates classes don't need to include SlateApplication | Widgets/Views/STableViewBase.h | |
void NotifyFinishedScrolling () |
Called at the end of a Tick when | Widgets/Views/STableViewBase.h | |
void NotifyItemScrolledIntoView() |
Called when an item has entered the visible geometry to check to see if the ItemScrolledIntoView delegate should be fired. | Widgets/Views/STableViewBase.h | |
virtual void OnRightMouseButtonDown
(
const FPointerEvent& MouseEvent |
Right click down | Widgets/Views/STableViewBase.h | |
virtual void OnRightMouseButtonUp
(
const FPointerEvent& MouseEvent |
Opens a context menu as the result of a right click if OnContextMenuOpening is bound and we are not right click scrolling. | Widgets/Views/STableViewBase.h | |
FReGenerateResults ReGenerateItems
(
const FGeometry& MyGeometry |
Update generate Widgets for Items as needed and clean up any Widgets that are no longer needed. | Widgets/Views/STableViewBase.h | |
void RequestLayoutRefresh() |
Internal request for a layout update on the next tick (i.e. a refresh without implication that the source items have changed) | Widgets/Views/STableViewBase.h | |
virtual float ScrollBy
(
const FGeometry& MyGeometry, |
Scroll the list view by some number of screen units. | Widgets/Views/STableViewBase.h | |
EScrollIntoViewResult ScrollIntoView
(
const FGeometry& ListViewGeometry |
If there is a pending request to scroll an item into view, do so. | Widgets/Views/STableViewBase.h | |
virtual float ScrollTo
(
float InScrollOffset |
Scroll the view to an offset and resets the inertial scroll velocity | Widgets/Views/STableViewBase.h | |
EActiveTimerReturnType UpdateInertialScroll
(
double InCurrentTime, |
Active timer to update the inertial scroll | Widgets/Views/STableViewBase.h | |
void UpdateSelectionSet() |
Remove any items that are no longer in the list from the selection set. | Widgets/Views/STableViewBase.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnClippingChanged() |
Passing over the clipping to SListPanel | Widgets/Views/STableViewBase.h |