UListViewBase

[UListViewBase](API\Runtime\UMG\Components\UListViewBase).

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

class UListViewBase : public UWidget

Remarks

Bare-bones base class to make creating custom UListView widgets easier. Child classes should also inherit from ITypedUMGListView<T> to get a basic public ListView API for free.

Child classes will own the actual SListView<T> widgets, but this provides some boilerplate functionality for generating entries. To generate a row for the child list, use GenerateTypedRow with the appropriate SObjectTableRow<T> type for your list

Additionally, the entry widget class can be filtered for a particular class and interface with the EntryClass and EntryInterface metadata arguments This can be specified either on the class directly (see below) or on any BindWidget FProperty

Variables

Name Description

Protected variable

bool

 

AllowOverscroll

Disable to stop scrollbars from activating inertial overscrolling

Protected variable

bool

 

bAllowDragging

True to allow dragging of row widgets in the list

Protected variable

bool

 

bEnableFixedLineOffset

Protected variable

bool

 

bEnableRightClickScrolling

True to allow right click drag scrolling.

Protected variable

bool

 

bEnableScrollAnimation

True to enable lerped animation when scrolling through the list

Protected variable

TSubclassOf< UU...

 

EntryWidgetClass

The type of widget to create for each entry displayed in the list.

Protected variable

float

 

FixedLineScrollOffset

Optional fixed offset (in lines) to always apply to the top/left (depending on orientation) of the list.

Protected variable

float

 

WheelScrollMultiplier

The multiplier to apply when wheel scrolling

Constructors

Name Description

Public function

UListViewBase

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

WidgetEntryT...

 

GenerateTypedEntry

(
    TSubclassOf< WidgetEntryT > WidgetC...,
    const TSharedRef< STableViewBase > ...
)

Public function Const

const TArray...

 

GetDisplayedEntryWidgets()

Gets all of the list entry widgets currently being displayed by the list

Public function Const

TSubclassOf<...

 

GetEntryWidgetClass()

Public function Const

float

 

GetScrollOffset()

Get the scroll offset of this view (in items)

Protected function Virtual

void

 

HandleListEntryHovered

(
    UUserWidget& EntryWidget
)

Protected function Virtual

void

 

HandleListEntryUnhovered

(
    UUserWidget& EntryWidget
)

Protected function

void

 

HandleRowReleased

(
    const TSharedRef< ITableRow >& Row
)

Expected to be bound to the actual ListView widget created by a child class (automatically taken care of via the construction helpers within ITypedUMGListView)

Public function

FOnListEntry...

 

OnEntryWidgetGenerated()

Public function

FOnEntryWidg...

 

OnEntryWidgetReleased()

Protected function Virtual

void

 

OnRefreshDesignerItems()

Called during design time to allow lists to generate preview entries via dummy data.

Protected function Virtual

TSharedRef< ...

 

RebuildListWidget()

Implement in child classes to construct the actual ListView Slate widget

Protected function

void

 

RefreshDesignerItems

(
    TArray< PlaceholderItemT >& ListIt...,
    TFunctionRef< PlaceholderItemT()> C...
)

Helper intended to be called by overrides of OnRefreshDesignerItems.

Public function

void

 

RegenerateAllEntries()

Full regeneration of all entries in the list.

Public function

void

 

RequestRefresh()

Sets the list to refresh on the next tick.

Public function

void

 

ScrollToBottom()

Scroll the entire list down to the bottom-most item

Public function

void

 

ScrollToTop()

Scroll the entire list up to the first item

Public function

void

 

SetScrollbarVisibility

(
    ESlateVisibility InVisibility
)

Public function

void

 

SetScrollOffset

(
    const float InScrollOffset
)

Set the scroll offset of this view (in items)

Public function

void

 

SetWheelScrollMultiplier

(
    float NewWheelScrollMultiplier
)

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Protected function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Public function Virtual Const

void

 

ValidateCompiledDefaults

(
    IWidgetCompilerLog& CompileLog
)

Called at the end of Widget Blueprint compilation.

Overridden from UVisual

Name Description

Protected function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Classes