Navigation
API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVisual
- UWidget
- UListViewBase
- UListView
- UCommonListView
- UEditorUtilityListView
- UTileView
- UCommonTileView
- UTreeView
- UCommonTreeView
- UEditorUtilityTreeView
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 | |
---|---|---|---|
![]() |
bool | bClearSelectionOnClick | |
![]() |
bool | bIsFocusable | |
![]() |
bool | bReturnFocusToSelection | |
![]() |
EConsumeMouseWheel | ConsumeMouseWheel | |
![]() |
float | EntrySpacing | This deprecated property was originally BlueprintReadOnly. |
![]() |
TArray< TObjectPtr< UObject > > | ListItems | |
![]() |
TSharedPtr< SListView< UObject * > > | MyListView | |
![]() |
TEnumAsByte< EOrientation > | Orientation | The scroll & layout orientation of the list. |
![]() |
FScrollBarStyle | ScrollBarStyle | |
![]() |
TEnumAsByte< ESelectionMode::Type > | SelectionMode | |
![]() |
FTableViewStyle | WidgetStyle |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
UListView
(
const FObjectInitializer& Initializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | Adds an the item to the list | |
![]() |
void | Removes all items from the list | |
![]() |
TSharedRef< ListViewT< UObject * > > | SListView construction helper - useful if using a custom STreeView subclass | |
![]() ![]() |
RowWidgetT * | GetEntryWidgetFromItem
(
const UObject* Item |
|
![]() ![]() |
float | Get the horizontal spacing between entries. | |
![]() ![]() |
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< UObject * > & | GetListItems () |
Gets the list of all items in the list. |
![]() ![]() |
int32 | GetNumItems () |
Returns the total number of items |
![]() ![]() |
EOrientation | ||
![]() ![]() |
ObjectT * | Gets the first selected item, if any; recommended that you only use this for single selection lists. | |
![]() ![]() |
ESelectionMode::Type | ||
![]() ![]() |
float | Get the vertical spacing between entries. | |
![]() |
void | HandleOnEntryInitializedInternal
(
UObject* Item, |
|
![]() |
void | InitHorizontalEntrySpacing
(
float InHorizontalEntrySpacing |
|
![]() |
void | InitVerticalEntrySpacing
(
float InVerticalEntrySpacing |
|
![]() ![]() |
bool | 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* >& AddedItems, |
|
![]() |
void | OnListItemEndPlayed
(
AActor* Item, |
|
![]() |
void | OnListItemOuterEndPlayed
(
AActor* ItemOuter, |
|
![]() ![]() |
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, AllocatorType >& InListItems |
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 > SelectionMode |
Sets the new selection mode, preserving the current selection where possible. |
Overridden from UListViewBase
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | HandleListEntryHovered
(
UUserWidget& EntryWidget |
|
![]() ![]() |
void | HandleListEntryUnhovered
(
UUserWidget& EntryWidget |
|
![]() ![]() |
void | Called during design time to allow lists to generate preview entries via dummy data. | |
![]() ![]() |
TSharedRef< STableViewBase > | Implement in child classes to construct the actual ListView Slate widget |
Overridden from UVisual
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | ReleaseSlateResources
(
bool bReleaseChildren |
Overridden from UObject
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |