Navigation
API > API/Runtime > API/Runtime/UMG
Mirrored SListView
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.
| Name | ITypedUMGListView |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Components/ListViewBase.h |
| Include Path | #include "Components/ListViewBase.h" |
Syntax
template<typename ItemType>
class ITypedUMGListView
Derived Classes
Structs
| Name | Remarks |
|---|---|
| FListViewConstructArgs | ListView construction helpers Use these instead of SNew-ing your owned ListView directly to get exposed events for free |
| FTileViewConstructArgs | |
| FTreeViewConstructArgs |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnFinishedScrolling | TMulticastDelegate_NoParams< void > | Components/ListViewBase.h | |
| FOnGetEntryClassForItem | TBaseDelegate_OneParam< TSubclassOf< UUserWidget >, ItemType > | Components/ListViewBase.h | |
| FOnIsItemSelectableOrNavigable | TBaseDelegate_OneParam< bool, ItemType > | Components/ListViewBase.h | |
| FOnItemCanAcceptDrop | TMulticastDelegate_TwoParams< void, ItemType, bool > | Components/ListViewBase.h | |
| FOnItemDragCancelled | TMulticastDelegate_OneParam< void, const FDragDropEvent & > | Components/ListViewBase.h | |
| FOnItemExpansionChanged | TMulticastDelegate_TwoParams< void, ItemType, bool > | Components/ListViewBase.h | |
| FOnItemIsHoveredChanged | TMulticastDelegate_TwoParams< void, ItemType, bool > | Components/ListViewBase.h | |
| FOnItemScrolledIntoView | TMulticastDelegate_TwoParams< void, ItemType, UUserWidget & > | Components/ListViewBase.h | |
| FOnItemSelectionChanged | TMulticastDelegate_OneParam< void, NullableItemType > | Components/ListViewBase.h | |
| FOnListViewScrolled | TMulticastDelegate_TwoParams< void, float, float > | Components/ListViewBase.h | |
| FSimpleListItemEvent | TMulticastDelegate_OneParam< void, ItemType > | Automatically implemented via IMPLEMENT_TYPED_UMG_LIST() | Components/ListViewBase.h |
| NullableItemType | typename SListView< ItemType >::NullableItemType | Components/ListViewBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CancelScrollIntoView() |
Components/ListViewBase.h | ||
void ClearSelection() |
Components/ListViewBase.h | ||
TSubclassOf< UUserWidget > GetDefaultEntryClass() |
Components/ListViewBase.h | ||
virtual TSubclassOf< UUserWidget > GetDesiredEntryClassForItem
(
ItemType Item |
Default behavior is to check the delegate, then fall back to the default if that fails. | Components/ListViewBase.h | |
RowWidgetT * GetEntryWidgetFromItem
(
const ItemType& Item |
Components/ListViewBase.h | ||
int32 GetIndexInList
(
const ItemType& Item |
Components/ListViewBase.h | ||
int32 GetNumItemsSelected() |
Components/ListViewBase.h | ||
NullableItemType GetSelectedItem() |
Public API to match that of SListView. | Components/ListViewBase.h | |
int32 GetSelectedItems
(
TArray< ItemType >& OutSelectedItems |
Components/ListViewBase.h | ||
bool IsItemSelected
(
const ItemType& Item |
Components/ListViewBase.h | ||
bool IsItemVisible
(
const ItemType& Item |
Components/ListViewBase.h | ||
const TObjectPtrWrapTypeOf< ItemType > * ItemFromEntryWidget
(
const UUserWidget& EntryWidget |
Components/ListViewBase.h | ||
FOnFinishedScrolling & OnFinishedScrolling() |
Components/ListViewBase.h | ||
FOnGetEntryClassForItem & OnGetEntryClassForItem() |
Components/ListViewBase.h | ||
FOnIsItemSelectableOrNavigable & OnIsItemSelectableOrNavigable() |
Components/ListViewBase.h | ||
FSimpleListItemEvent & OnItemAcceptDrop() |
Components/ListViewBase.h | ||
FOnItemCanAcceptDrop & OnItemCanAcceptDrop() |
Components/ListViewBase.h | ||
FSimpleListItemEvent & OnItemClicked() |
Components/ListViewBase.h | ||
FSimpleListItemEvent & OnItemDoubleClicked() |
Components/ListViewBase.h | ||
FOnItemDragCancelled & OnItemDragCancelled() |
Components/ListViewBase.h | ||
FSimpleListItemEvent & OnItemDragDetected() |
Drag and Drop. | Components/ListViewBase.h | |
FSimpleListItemEvent & OnItemDragEnter() |
Components/ListViewBase.h | ||
FSimpleListItemEvent & OnItemDragLeave() |
Components/ListViewBase.h | ||
FOnItemExpansionChanged & OnItemExpansionChanged() |
Components/ListViewBase.h | ||
FOnItemIsHoveredChanged & OnItemIsHoveredChanged() |
Components/ListViewBase.h | ||
FOnItemScrolledIntoView & OnItemScrolledIntoView() |
Components/ListViewBase.h | ||
FOnItemSelectionChanged & OnItemSelectionChanged() |
Components/ListViewBase.h | ||
FOnListViewScrolled & OnListViewScrolled() |
Components/ListViewBase.h | ||
void RequestNavigateToItem
(
const ItemType& Item |
Components/ListViewBase.h | ||
void RequestScrollItemIntoView
(
const ItemType& Item |
Components/ListViewBase.h | ||
void SetItemSelection
(
const ItemType& Item, |
Components/ListViewBase.h | ||
void SetSelectedItem
(
const ItemType& SoleSelectedItem, |
Components/ListViewBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FMargin GetDesiredEntryPadding
(
ItemType Item |
Gets the desired padding for the entry representing the given item | Components/ListViewBase.h | |
SListView< ItemType > * GetMyListView() |
Components/ListViewBase.h | ||
TSharedPtr< ObjectRowT< ItemType > > GetObjectRowFromItem
(
const ItemType& Item |
Gets the SObjectTableRow underlying the UMG EntryWidget that represents the given item (if one exists) | Components/ListViewBase.h | |
uint32 GetOwningUserIndex() |
Components/ListViewBase.h | ||
bool IsDesignerPreview() |
Components/ListViewBase.h | ||
UUserWidget & OnGenerateEntryWidgetInternal
(
ItemType Item, |
Generates the actual entry widget that represents the given item. | Components/ListViewBase.h | |
virtual void OnGetChildrenInternal
(
ItemType Item, |
TreeViews only. | Components/ListViewBase.h | |
virtual bool OnIsSelectableOrNavigableInternal
(
ItemType FirstSelectedItem |
Components/ListViewBase.h | ||
virtual void OnItemClickedInternal
(
ItemType Item |
ListView events - implement these instead of binding handlers directly to a list | Components/ListViewBase.h | |
virtual void OnItemDoubleClickedInternal
(
ItemType Item |
Components/ListViewBase.h | ||
virtual void OnItemExpansionChangedInternal
(
ItemType Item, |
Components/ListViewBase.h | ||
virtual void OnItemScrolledIntoViewInternal
(
ItemType Item, |
Components/ListViewBase.h | ||
virtual void OnListViewFinishedScrollingInternal() |
Components/ListViewBase.h | ||
virtual void OnListViewScrolledInternal
(
float ItemOffset, |
Components/ListViewBase.h | ||
virtual void OnSelectionChangedInternal
(
NullableItemType FirstSelectedItem |
Components/ListViewBase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< ListViewT< ItemType > > ConstructListView
(
UListViewBaseT* Implementer, |
Components/ListViewBase.h | ||
static TSharedRef< TileViewT< ItemType > > ConstructTileView
(
UListViewBaseT* Implementer, |
Components/ListViewBase.h | ||
static TSharedRef< TreeViewT< ItemType > > ConstructTreeView
(
UListViewBaseT* Implementer, |
Components/ListViewBase.h |
See Also
- UListView for an implementation example.