STableViewBase

Contains ListView functionality that does not depend on the type of data being observed by the ListView.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

SCompoundWidget

IScrollableWidget

STableViewBase

SListView

SAssetColumnView

SAssetListView

SCommonListView

STileView

SAssetTileView

STreeView

	SCommonTreeView
	SCurveEditorTree
	SIKRigSkeletonTreeView
	SSceneOutlinerTreeView
	SSCSEditorDragDropTree
	SSubobjectEditorDragDropTree

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Views/STableViewBase.h
Include	#include "Widgets/Views/STableViewBase.h"

Syntax

class STableViewBase :
public SCompoundWidget,
public IScrollableWidget

Remarks

Contains ListView functionality that does not depend on the type of data being observed by the ListView.

Variables

	Name	Description
EAllowOverscrol...	AllowOverscroll	Whether to permit overscroll on this list view
float	AmountScrolledWhileRightMouseDown	How much we scrolled while the rmb has been held
FInvalidatableB...	BackgroundBrush	Brush resource representing the background area of the view
bool	bEnableAnimatedScrolling	True to lerp smoothly between offsets when the desired scroll offset changes.
bool	bEnableRightClickScrolling	True to allow right click drag scrolling.
bool	bIsScrollingActiveTimerRegistered	Whether the active timer to update the inertial scrolling is currently registered
bool	bShowSoftwareCursor	Whether the software cursor should be drawn in the viewport
bool	bStartedTouchInteraction	Did the user start an interaction in this list?
bool	bWasAtEndOfList	Last time we scrolled, did we end up at the end of the list.
EConsumeMouseWh...	ConsumeMouseWheel	How we should handle scrolling with the mouse wheel
double	CurrentScrollOffset	The currently displayed scroll offset from the beginning of the list in items.
double	DesiredScrollOffset	The raw desired scroll offset from the beginning of the list in items.
TOptional< doub...	FixedLineScrollOffset	The fixed offset in lines to always apply to the top/left (depending on orientation) of the list.
TSharedPtr< SHe...	HeaderRow	Column headers that describe which columns this list shows
FInertialScroll...	InertialScrollManager	Helper object to manage inertial scrolling
TSharedPtr< SLi...	ItemsPanel	The panel which holds the visible widgets in this list
FReGenerateResu...	LastGenerateResults	Information about the widgets we generated during the last regenerate pass
FOnContextMenuO...	OnContextMenuOpening	Delegate to invoke when the context menu should be opening.
FOnTableViewScr...	OnTableViewScrolled	Delegate to call when the table view is scrolled
EOrientation	Orientation	The layout and scroll orientation of the list
FOverscroll	Overscroll
FGeometry	PanelGeometryLastTick	What the list's geometry was the last time a refresh occurred.
FVector2D	PressedScreenSpacePosition	The location in screenspace the view was pressed
TSharedPtr< SSc...	ScrollBar	The scroll bar widget
TAttribute< ESe...	SelectionMode	The selection mode that this tree/list is in.
FVector2D	SoftwareCursorPosition	The current position of the software cursor
const ETableVie...	TableViewMode	Is this list backing a tree or just a standalone list
float	TickScrollDelta	The amount we have scrolled this tick cycle
float	WheelScrollMultiplier	How much to scroll when using mouse wheel

Constructors

	Name	Description
	STableViewBase ( ETableViewMode::Type InTableViewMod... )

Functions

	Name	Description
void	AddScrollOffset ( const float InScrollOffsetDelta, bool RefreshList )	Add the scroll offset of this view (in items)
void	AppendWidget ( const TSharedRef< ITableRow >& Wid... )	Add a WidgetToAppend to the bottom of the view.
bool	CanUseInertialScroll ( float ScrollAmount )	Check whether the current state of the table warrants inertial scroll by the specified amount
void	ClearWidgets()	Remove all the widgets from the view.
void	ConstructChildren ( const TAttribute< float >& InItemW..., const TAttribute< float >& InItemH..., const TAttribute< EListItemAlignmen..., const TSharedPtr< SHeaderRow >& In..., const TSharedPtr< SScrollBar >& In..., EOrientation InScrollOrientation, const FOnTableViewScrolled& InOnTa..., const FScrollBarStyle* InScrol... )	Create the child widgets that comprise the list
void	EndInertialScrolling()	Reset the inertial scroll velocity accumulated in the InertialScrollManager
EActiveTimer...	EnsureTickToRefresh ( double InCurrentTime, float InDeltaTime )	One-off active timer to refresh the contents of the table as needed
float	GetFirstLineScrollOffset()	Get the offset of the first list item.
TSharedPtr< ...	GetHeaderRow()
float	GetItemHeight()	Get the uniform item height that is enforced by ListViews.
FVector2D	GetItemSize()	Get the uniform item
float	GetItemWidth()	Get the uniform item width.
int32	GetNumGeneratedChildren()
int32	GetNumItemsBeingObserved()
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.
float	GetNumLiveWidgets()
EVisibility	GetScrollbarVisibility()
float	GetScrollOffset()	Gets the scroll offset of this view (in items)
float	GetScrollRateInItems()	Get the scroll rate in items that best approximates a constant physical scroll rate.
double	GetTargetScrollOffset()	Returns the "true" scroll offset where the list will ultimately settle (and may already be).
void	InsertWidget ( const TSharedRef< ITableRow >& Wid... )	Insert WidgetToInsert at the top of the view.
bool	IsPendingRefresh()	Return true if there is currently a refresh pending, false otherwise
bool	IsRightClickScrolling()
bool	IsScrollbarNeeded()	Returns true if scrolling is possible; false if the view is big enough to fit all the content.
bool	IsScrolling()	Returns whether the attached scrollbar is scrolling
bool	IsUserScrolling()
void	NavigateToWidget ( const uint32 UserIndex, const TSharedPtr< SWidget >& Navig..., ENavigationSource NavigationSource )	Util Function so templates classes don't need to include SlateApplication
void	NotifyItemScrolledIntoView()	Called when an item has entered the visible geometry to check to see if the ItemScrolledIntoView delegate should be fired.
void	OnRightMouseButtonDown ( const FPointerEvent& MouseEvent )	Right click down
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.
void	RebuildList()	Completely wipe existing widgets and fully regenerate them on next tick.
FReGenerateR...	ReGenerateItems ( const FGeometry& MyGeometry )	Update generate Widgets for Items as needed and clean up any Widgets that are no longer needed.
void	RequestLayoutRefresh()	Internal request for a layout update on the next tick (i.e. a refresh without implication that the source items have changed)
void	RequestListRefresh()	Mark the list as dirty so that it will refresh its widgets on next tick.
void	ScrollBar_OnUserScrolled ( float InScrollOffsetFraction )	Invoked by the scrollbar when the user scrolls.
float	ScrollBy ( const FGeometry& MyGeometry, float ScrollByAmount, EAllowOverscroll InAllowOverscroll )	Scroll the list view by some number of screen units.
EScrollIntoV...	ScrollIntoView ( const FGeometry& ListViewGeometry )	If there is a pending request to scroll an item into view, do so.
float	ScrollTo ( float InScrollOffset )	Scroll the view to an offset and resets the inertial scroll velocity
void	ScrollToBottom()	Scrolls the view to the bottom
void	ScrollToTop()	Scrolls the view to the top
void	SetAllowOverscroll ( EAllowOverscroll InAllowOverscroll )	Sets whether to permit overscroll on this list view
void	SetBackgroundBrush ( const TAttribute< const FSlateBrush... )	Sets the Background Brush
void	SetFixedLineScrollOffset ( TOptional< double > InFixedLineScro... )	Sets the fixed offset in items to always apply to the top/left (depending on orientation) of the list.
void	SetIsRightClickScrollingEnabled ( const bool bInEnableRightClickScrol... )	Enables/disables being able to scroll with the right mouse button.
void	SetIsScrollAnimationEnabled ( bool bInEnableScrollAnimation )	Sets whether the list should lerp between scroll offsets or jump instantly between them.
void	SetItemHeight ( TAttribute< float > Height )	Sets the item height
void	SetItemWidth ( TAttribute< float > Width )	Sets the item width
void	SetScrollbarVisibility ( const EVisibility InVisibility )
void	SetScrollOffset ( const float InScrollOffset )	Set the scroll offset of this view (in items)
void	SetWheelScrollMultiplier ( float NewWheelScrollMultiplier )	Sets the multiplier applied when wheel scrolling.
EActiveTimer...	UpdateInertialScroll ( double InCurrentTime, float InDeltaTime )	Active timer to update the inertial scroll
void	UpdateSelectionSet()	Remove any items that are no longer in the list from the selection set.

Overridden from SWidget

	Name	Description
bool	ComputeVolatility()	Recomputes the volatility of the widget.
void	OnClippingChanged()	Passing over the clipping to SListPanel
FCursorReply	OnCursorQuery ( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent )	The system asks each widget under the mouse to provide a cursor. This event is bubbled.
void	OnFocusLost ( const FFocusEvent& InFocusEvent )	Called when this widget loses focus. This event does not bubble.
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
FReply	OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent )	Called when a mouse button is double clicked. Override this in derived classes.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
void	OnMouseCaptureLost ( const FCaptureLostEvent& CaptureLo... )	Called when this widget had captured the mouse, but that capture has been revoked for some reason.
void	OnMouseEnter ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has entered it.
void	OnMouseLeave ( const FPointerEvent& MouseEvent )	The system will use this event to notify a widget that the cursor has left it.
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
FReply	OnMouseWheel ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Called when the mouse wheel is spun. This event is bubbled.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
FReply	OnPreviewMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Just like OnMouseButtonDown, but tunnels instead of bubbling.
FReply	OnTouchEnded ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is ended (finger lifted)
FReply	OnTouchMoved ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is moved (finger moved)
FReply	OnTouchStarted ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is started (finger down)
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	Ticks this widget with Geometry.

Overridden from IScrollableWidget

	Name	Description
FVector2D	GetScrollDistance()	Gets the distance that user has scrolled into the control in normalized coordinates (0 - 1)
FVector2D	GetScrollDistanceRemaining()	Gets the distance that user has left to scroll in the control before reaching the end in normalized coordinates (0 - 1)
TSharedRef< ...	GetScrollWidget()	Returns the typed SWidget that implements this interface

Classes

	Name	Description
	FReGenerateResults	Information about the outcome of the WidgetRegeneratePass

Enums

	Name	Description
	EScrollIntoViewResult