ITypedUMGListView

ITypedUMGListView

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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

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

Public function

void

 

CancelScrollIntoView()

Public function

void

 

ClearSelection()

Protected function Static

TSharedRef< ...

 

ConstructListView

(
    UListViewBaseT* Implementer,
    const TArray< ItemType >& ListItem...,
    const FListViewConstructArgs& Args
)

Protected function Static

TSharedRef< ...

 

ConstructTileView

(
    UListViewBaseT* Implementer,
    const TArray< ItemType >& ListItem...,
    const FTileViewConstructArgs& Args
)

Protected function Static

TSharedRef< ...

 

ConstructTreeView

(
    UListViewBaseT* Implementer,
    const TArray< ItemType >& ListItem...,
    const FTreeViewConstructArgs& Args
)

Public function Const

TSubclassOf<...

 

GetDefaultEntryClass()

Public function Virtual Const

TSubclassOf<...

 

GetDesiredEntryClassForItem

(
    ItemType Item
)

Default behavior is to check the delegate, then fall back to the default if that fails.

Protected function Virtual Const

FMargin

 

GetDesiredEntryPadding

(
    ItemType Item
)

Gets the desired padding for the entry representing the given item

Public function Const

RowWidgetT &...

 

GetEntryWidgetFromItem

(
    const ItemType& Item
)

Public function Const

int32

 

GetIndexInList

(
    const ItemType& Item
)

Protected function Const

SListView< I...

 

GetMyListView()

Public function Const

int32

 

GetNumItemsSelected()

Protected function Const

TSharedPtr< ...

 

GetObjectRowFromItem

(
    const ItemType& Item
)

Gets the SObjectTableRow underlying the UMG EntryWidget that represents the given item (if one exists)

Protected function Const

uint32

 

GetOwningUserIndex()

Public function Const

NullableItem...

 

GetSelectedItem()

Public API to match that of SListView.

Public function Const

int32

 

GetSelectedItems

(
    TArray< ItemType >& OutSelectedIte...
)

Protected function Const

bool

 

IsDesignerPreview()

Public function Const

bool

 

IsItemSelected

(
    const ItemType& Item
)

Public function Const

bool

 

IsItemVisible

(
    const ItemType& Item
)

Public function Const

const ItemTy...

 

ItemFromEntryWidget

(
    const UUserWidget& EntryWidget
)

Protected function

UUserWidget ...

 

OnGenerateEntryWidgetInternal

(
    ItemType Item,
    TSubclassOf< UUserWidget > DesiredE...,
    const TSharedRef< STableViewBase > ...
)

Generates the actual entry widget that represents the given item.

Protected function Virtual Const

void

 

OnGetChildrenInternal

(
    ItemType Item,
    TArray< ItemType >& OutChildren
)

TreeViews only.

Public function Const

FOnGetEntryC...

 

OnGetEntryClassForItem()

Protected function Virtual

bool

 

OnIsSelectableOrNavigableInternal

(
    ItemType FirstSelectedItem
)

Public function Const

FSimpleListI...

 

OnItemClicked()

Protected function Virtual

void

 

OnItemClickedInternal

(
    ItemType Item
)

ListView events - implement these instead of binding handlers directly to a list

Public function Const

FSimpleListI...

 

OnItemDoubleClicked()

Protected function Virtual

void

 

OnItemDoubleClickedInternal

(
    ItemType Item
)

Public function Const

FOnItemExpan...

 

OnItemExpansionChanged()

Protected function Virtual

void

 

OnItemExpansionChangedInternal

(
    ItemType Item,
    bool bIsExpanded
)

Public function Const

FOnItemIsHov...

 

OnItemIsHoveredChanged()

Public function Const

FOnItemScrol...

 

OnItemScrolledIntoView()

Protected function Virtual

void

 

OnItemScrolledIntoViewInternal

(
    ItemType Item,
    UUserWidget& EntryWidget
)

Public function Const

FOnItemSelec...

 

OnItemSelectionChanged()

Public function Const

FOnListViewS...

 

OnListViewScrolled()

Protected function Virtual

void

 

OnListViewScrolledInternal

(
    float ItemOffset,
    float DistanceRemaining
)

Protected function Virtual

void

 

OnSelectionChangedInternal

(
    NullableItemType FirstSelectedItem
)

Public function

void

 

RequestNavigateToItem

(
    const ItemType& Item
)

Public function

void

 

RequestScrollItemIntoView

(
    const ItemType& Item
)

Public function

void

 

SetItemSelection

(
    const ItemType& Item,
    bool bIsSelected,
    ESelectInfo::Type SelectInfo
)

Public function

void

 

SetSelectedItem

(
    const ItemType& SoleSelectedItem,
    ESelectInfo::Type SelectInfo
)

Classes

Name

Description

Protected struct

FListViewConstructArgs

ListView construction helpers Use these instead of SNew-ing your owned ListView directly to get exposed events for free

Protected struct

FTileViewConstructArgs

Protected struct

FTreeViewConstructArgs

Typedefs

Deprecated Functions

Name Description

Protected function Static

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.

Protected function Static

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.

Protected function Static

TSharedRef< ...

 

ConstructTreeView

(
    UListViewBaseT* Implementer,
    const TArray< ItemType >& ListItem...,
    ESelectionMode::Type SelectionMode,
    bool bClearSelectionOnClick,
    EConsumeMouseWheel ConsumeMouseWhee...
)

Use ConstructTreeView with FTreeViewConstructArgs instead of individual arguments.

See Also

UListViewfor an implementation example.