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 > ITypedUMGListView

Light Theme

Dark Theme

ITypedUMGListView

Windows

MacOS

Linux

Inheritance Hierarchy

ITypedUMGListView

UListView

	UTileView
	UTreeView

References

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

Syntax

template<typename ItemType>
class ITypedUMGListView

Remarks

Mirrored SListView<T> API for easier interaction with a bound UListViewBase widget See declarations on SListView for more info on each function and event

Note that, being a template class, this is not a UClass and therefore cannot be exposed to Blueprint. If you are using UObject* items, just use (or inherit from) UListView directly Otherwise, it is up to the child class to propagate events and/or expose functions to BP as needed

Use the IMPLEMENT_TYPED_UMG_LIST() macro for the implementation boilerplate in your implementing class.

Functions

	Name	Description
void	CancelScrollIntoView()
void	ClearSelection()
TSharedRef< ...	ConstructListView ( UListViewBaseT* Implementer, const TArray< ItemType >& ListItem..., const FListViewConstructArgs& Args )
TSharedRef< ...	ConstructTileView ( UListViewBaseT* Implementer, const TArray< ItemType >& ListItem..., const FTileViewConstructArgs& Args )
TSharedRef< ...	ConstructTreeView ( UListViewBaseT* Implementer, const TArray< ItemType >& ListItem..., const FTreeViewConstructArgs& Args )
TSubclassOf<...	GetDefaultEntryClass()
TSubclassOf<...	GetDesiredEntryClassForItem ( ItemType Item )	Default behavior is to check the delegate, then fall back to the default if that fails.
FMargin	GetDesiredEntryPadding ( ItemType Item )	Gets the desired padding for the entry representing the given item
RowWidgetT &...	GetEntryWidgetFromItem ( const ItemType& Item )
SListView< I...	GetMyListView()
int32	GetNumItemsSelected()
TSharedPtr< ...	GetObjectRowFromItem ( const ItemType& Item )	Gets the SObjectTableRow underlying the UMG EntryWidget that represents the given item (if one exists)
uint32	GetOwningUserIndex()
NullableItem...	GetSelectedItem()	Public API to match that of SListView.
int32	GetSelectedItems ( TArray< ItemType >& OutSelectedIte... )
bool	IsDesignerPreview()
bool	IsItemSelected ( const ItemType& Item )
bool	IsItemVisible ( const ItemType& Item )
const ItemTy...	ItemFromEntryWidget ( const UUserWidget& EntryWidget )
UUserWidget ...	OnGenerateEntryWidgetInternal ( ItemType Item, TSubclassOf< UUserWidget > DesiredE..., const TSharedRef< STableViewBase > ... )	Generates the actual entry widget that represents the given item.
void	OnGetChildrenInternal ( ItemType Item, TArray< ItemType >& OutChildren )	TreeViews only.
FOnGetEntryC...	OnGetEntryClassForItem()
bool	OnIsSelectableOrNavigableInternal ( ItemType FirstSelectedItem )
FSimpleListI...	OnItemClicked()
void	OnItemClickedInternal ( ItemType Item )	ListView events - implement these instead of binding handlers directly to a list
FSimpleListI...	OnItemDoubleClicked()
void	OnItemDoubleClickedInternal ( ItemType Item )
FOnItemExpan...	OnItemExpansionChanged()
void	OnItemExpansionChangedInternal ( ItemType Item, bool bIsExpanded )
FOnItemIsHov...	OnItemIsHoveredChanged()
FOnItemScrol...	OnItemScrolledIntoView()
void	OnItemScrolledIntoViewInternal ( ItemType Item, UUserWidget& EntryWidget )
FOnItemSelec...	OnItemSelectionChanged()
FOnListViewS...	OnListViewScrolled()
void	OnListViewScrolledInternal ( float ItemOffset, float DistanceRemaining )
void	OnSelectionChangedInternal ( NullableItemType FirstSelectedItem )
void	RequestNavigateToItem ( const ItemType& Item )
void	RequestScrollItemIntoView ( const ItemType& Item )
void	SetItemSelection ( const ItemType& Item, bool bIsSelected, ESelectInfo::Type SelectInfo )
void	SetSelectedItem ( const ItemType& SoleSelectedItem, ESelectInfo::Type SelectInfo )

Classes

	Name	Description
	FListViewConstructArgs	ListView construction helpers Use these instead of SNew-ing your owned ListView directly to get exposed events for free
	FTileViewConstructArgs
	FTreeViewConstructArgs

Typedefs

Name	Description
FOnGetEntryClassForItem
FOnItemExpansionChanged
FOnItemIsHoveredChanged
FOnItemScrolledIntoView
FOnItemSelectionChanged
FOnListViewScrolled
FSimpleListItemEvent	Automatically implemented via IMPLEMENT_TYPED_UMG_LIST()
NullableItemType

Deprecated Functions

	Name	Description
TSharedRef< ...	ConstructListView ( UListViewBaseT* Implementer, const TArray< ItemType >& ListItem..., bool bAllowFocus, ESelectionMode::Type SelectionMode, bool bClearSelectionOnClick, EConsumeMouseWheel ConsumeMouseWhee..., bool bReturnFocusToSelection, EOrientation Orientation )	Use ConstructListView with FListViewConstructArgs instead of individual arguments.
TSharedRef< ...	ConstructTileView ( UListViewBaseT* Implementer, const TArray< ItemType >& ListItem..., EListItemAlignment TileAlignment, TAttribute< float > TileHeight, TAttribute< float > TileWidth, ESelectionMode::Type SelectionMode, bool bClearSelectionOnClick, bool bWrapDirectionalNavigation, EConsumeMouseWheel ConsumeMouseWhee..., EOrientation Orientation )	Use ConstructTileView with FTileViewConstructArgs instead of individual arguments.
TSharedRef< ...	ConstructTreeView ( UListViewBaseT* Implementer, const TArray< ItemType >& ListItem..., ESelectionMode::Type SelectionMode, bool bClearSelectionOnClick, EConsumeMouseWheel ConsumeMouseWhee... )	Use ConstructTreeView with FTreeViewConstructArgs instead of individual arguments.