Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Components > UListView

Light Theme

Dark Theme

UListView

A virtualized list that allows up to thousands of items to be displayed.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UListViewBase

UListView

UCommonListView

UTileView

UCommonTileView

UTreeView

UCommonTreeView

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/ListView.h
Include	#include "Components/ListView.h"

Syntax

class UListView :
public UListViewBase,
public ITypedUMGListView< UObject * >

Remarks

A virtualized list that allows up to thousands of items to be displayed.

An important distinction to keep in mind here is "Item" vs. "Entry" The list itself is based on a list of n items, but only creates as many entry widgets as can fit on screen. For example, a scrolling ListView of 200 items with 5 currently visible will only have created 5 entry widgets.

To make a widget usable as an entry in a ListView, it must inherit from the IUserObjectListEntry interface.

Variables

	Name	Description
bool	bClearSelectionOnClick
bool	bIsFocusable
bool	bReturnFocusToSelection
EConsumeMouseWh...	ConsumeMouseWheel
float	EntrySpacing
TArray< TObject...	ListItems
TSharedPtr< SLi...	MyListView
TEnumAsByte< EO...	Orientation	The scroll & layout orientation of the list.
FScrollBarStyle	ScrollBarStyle
TEnumAsByte< ES...	SelectionMode
FTableViewStyle	WidgetStyle

Constructors

	Name	Description
	UListView ( const FObjectInitializer& Initiali... )

Functions

	Name	Description
void	AddItem ( UObject* Item )	Adds an the item to the list
void	ClearListItems()	Removes all items from the list
TSharedRef< ...	ConstructListView()	SListView construction helper - useful if using a custom STreeView subclass
RowWidgetT &...	GetEntryWidgetFromItem ( const UObject* Item )
int32	GetIndexForItem ( const UObject* Item )	Returns the index that the specified item is at. Will return the first found, or -1 for not found
UObject *...	GetItemAt ( int32 Index )	Returns the item at the given index
const TArray...	GetListItems()	Gets the list of all items in the list.
int32	GetNumItems()	Returns the total number of items
EOrientation	GetOrientation()
ObjectT *...	GetSelectedItem()	Gets the first selected item, if any; recommended that you only use this for single selection lists.
ESelectionMo...	GetSelectionMode()
void	HandleOnEntryInitializedInternal ( UObject* Item, const TSharedRef< ITableRow >& Tab... )
bool	IsRefreshPending()	Returns true if a refresh is pending and the list will be rebuilt on the next tick
void	NavigateToIndex ( int32 Index )	Requests that the item at the given index navigated to, scrolling it into view if needed.
void	OnItemsChanged ( const TArray< UObject* >& Add..., const TArray< UObject* >& Rem... )
void	OnListItemEndPlayed ( AActor* Item, EEndPlayReason::Type EndPlayReason )
void	OnListItemOuterEndPlayed ( AActor* ItemOuter, EEndPlayReason::Type EndPlayReason )
void	OnSelectionChangedInternal ( UObject* FirstSelectedItem )
void	RemoveItem ( UObject* Item )	Removes an the item from the list
void	ScrollIndexIntoView ( int32 Index )	Requests that the item at the given index is scrolled into view
void	SetListItems ( const TArray< ItemObjectT, Allocato... )	Set the list of items to display within this listview
void	SetSelectedIndex ( int32 Index )	Sets the item at the given index as the sole selected item.
void	SetSelectedItem ( const UObject* Item )
void	SetSelectionMode ( TEnumAsByte< ESelectionMode::Type >... )	Sets the new selection mode, preserving the current selection where possible.

Overridden from UListViewBase

	Name	Description
void	HandleListEntryHovered ( UUserWidget& EntryWidget )
void	HandleListEntryUnhovered ( UUserWidget& EntryWidget )
void	OnRefreshDesignerItems()	Called during design time to allow lists to generate preview entries via dummy data.
TSharedRef< ...	RebuildListWidget()	Implement in child classes to construct the actual ListView Slate widget

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from ITypedUMGListView

	Name	Description
TSubclassOf<...	GetDefaultEntryClass()
FMargin	GetDesiredEntryPadding ( UObject* Item )	Gets the desired padding for the entry representing the given item
SListView< U...	GetMyListView()
uint32	GetOwningUserIndex()
bool	IsDesignerPreview()
UUserWidget ...	OnGenerateEntryWidgetInternal ( UObject* Item, TSubclassOf< UUserWidget > DesiredE..., const TSharedRef< STableViewBase > ... )	Generates the actual entry widget that represents the given item.
FOnGetEntryC...	OnGetEntryClassForItem()
FSimpleListI...	OnItemClicked()
void	OnItemClickedInternal ( UObject* Item )	ListView events - implement these instead of binding handlers directly to a list
FSimpleListI...	OnItemDoubleClicked()
void	OnItemDoubleClickedInternal ( UObject* Item )
FOnItemExpan...	OnItemExpansionChanged()
FOnItemIsHov...	OnItemIsHoveredChanged()
FOnItemScrol...	OnItemScrolledIntoView()
void	OnItemScrolledIntoViewInternal ( UObject* Item, UUserWidget& EntryWidget )
FOnItemSelec...	OnItemSelectionChanged()
FOnListViewS...	OnListViewScrolled()