1. Epic GamesDeveloper
  3. UListView

UListView

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

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

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

  Type Name Description
Protected variable bool bClearSelectionOnClick  
Protected variable bool bIsFocusable  
Protected variable bool bReturnFocusToSelection  
Protected variable EConsumeMouseWheel ConsumeMouseWheel  
Protected variable float EntrySpacing This deprecated property was originally BlueprintReadOnly.
Protected variable TArray< TObjectPtr< UObject > > ListItems  
Protected variable TSharedPtr< SListView< UObject * > > MyListView  
Protected variable TEnumAsByte< EOrientation > Orientation The scroll & layout orientation of the list.
Protected variable FScrollBarStyle ScrollBarStyle  
Protected variable TEnumAsByte< ESelectionMode::Type > SelectionMode  
Protected variable FTableViewStyle WidgetStyle  

Constructors

  Type Name Description
Public function  

UListView ( const FObjectInitializer& Initializer
)

  

Functions

  Type Name Description
Public function void

AddItem ( UObject* Item
)

 Adds an the item to the list
Public function void Removes all items from the list
Protected function TSharedRef< ListViewT< UObject * > > SListView construction helper - useful if using a custom STreeView subclass
Public function Const RowWidgetT *  
Public function Const float Get the horizontal spacing between entries.
Public function Const int32

GetIndexForItem ( const UObject* Item
)

 Returns the index that the specified item is at. Will return the first found, or -1 for not found
Public function Const UObject *

GetItemAt ( int32 Index
)

 Returns the item at the given index
Public function Const const TArray< UObject * > & Gets the list of all items in the list.
Public function Const int32 Returns the total number of items
Public function Const EOrientation  
Public function Const ObjectT * Gets the first selected item, if any; recommended that you only use this for single selection lists.
Public function Const ESelectionMode::Type  
Public function Const float Get the vertical spacing between entries.
Protected function void  
Protected function void

InitHorizontalEntrySpacing ( float InHorizontalEntrySpacing
)

  
Protected function void

InitVerticalEntrySpacing ( float InVerticalEntrySpacing
)

  
Public function Const bool Returns true if a refresh is pending and the list will be rebuilt on the next tick
Public function void

NavigateToIndex ( int32 Index
)

 Requests that the item at the given index navigated to, scrolling it into view if needed.
Protected function Virtual void

OnItemsChanged ( const TArray< UObject* >& AddedItems,
const TArray< UObject* >& RemovedItems
)

  
Protected function void  
Protected function void

OnListItemOuterEndPlayed ( AActor* ItemOuter,
EEndPlayReason::Type EndPlayReason
)

  
Protected function Virtual void

OnSelectionChangedInternal ( UObject* FirstSelectedItem
)

  
Public function void

RemoveItem ( UObject* Item
)

 Removes an the item from the list
Public function void

ScrollIndexIntoView ( int32 Index
)

 Requests that the item at the given index is scrolled into view
Public function void

SetListItems ( const TArray< ItemObjectT, AllocatorType >& InListItems
)

 Set the list of items to display within this listview
Public function void

SetSelectedIndex ( int32 Index
)

 Sets the item at the given index as the sole selected item.
Public function void

SetSelectedItem ( const UObject* Item
)

  
Public function void Sets the new selection mode, preserving the current selection where possible.

Overridden from UListViewBase

  Type Name Description
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void Called during design time to allow lists to generate preview entries via dummy data.
Protected function Virtual TSharedRef< STableViewBase > Implement in child classes to construct the actual ListView Slate widget

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from ITypedUMGListView

  Type Name Description
Public function Virtual Const TSubclassOf< UUserWidget >  
Protected function Virtual Const FMargin Gets the desired padding for the entry representing the given item
Protected function Virtual Const SListView< UObject * > *  
Protected function Virtual Const uint32  
Protected function Virtual Const bool  
Public function Virtual Const FOnFinishedScrolling &  
Protected function Virtual UUserWidget &

OnGenerateEntryWidgetInternal ( UObject* Item,
TSubclassOf< UUserWidget > DesiredEntryClass,
const TSharedRef< STableViewBase >& OwnerTable
)

 Generates the actual entry widget that represents the given item.
Public function Virtual Const FOnGetEntryClassForItem &  
Public function Virtual Const FOnIsItemSelectableOrNavigable &  
Public function Virtual Const FSimpleListItemEvent &  
Protected function Virtual void ListView events - implement these instead of binding handlers directly to a list
Public function Virtual Const FSimpleListItemEvent &  
Protected function Virtual void  
Public function Virtual Const FOnItemExpansionChanged &  
Public function Virtual Const FOnItemIsHoveredChanged &  
Public function Virtual Const FOnItemScrolledIntoView &  
Protected function Virtual void  
Public function Virtual Const FOnItemSelectionChanged &  
Public function Virtual Const FOnListViewScrolled &  
Protected function Virtual void

OnListViewScrolledInternal ( float ItemOffset,
float DistanceRemaining
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page