1. Epic GamesDeveloper
  3. UListViewBase

UListViewBase

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

Unreal Engine C++ API Reference > Runtime > UMG > Components

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 to get a basic public ListView API for free.

Child classes will own the actual SListView widgets, but this provides some boilerplate functionality for generating entries. To generate a row for the child list, use GenerateTypedRow with the appropriate SObjectTableRow 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

Example: class UMyUserWidget : public UUserWidget { UListView* ListView_InventoryItems; }

Variables

  Type 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 FOnListEntryGeneratedDynamic BP_OnEntryGenerated Called when a row widget is generated for a list item
Protected variable FOnListEntryReleasedDynamic BP_OnEntryReleased Called when a row widget is released by the list (i.e. when it no longer represents a list item)
Protected variable TSubclassOf< UUserWidget > EntryWidgetClass Note: Options for this property can be configured via class and property metadata. See class declaration comment above.
Protected variable float FixedLineScrollOffset Optional fixed offset (in lines) to always apply to the top/left (depending on orientation) of the list.
Protected variable TArray< TWeakObjectPtr< UUserWidget > > GeneratedEntriesToAnnounce Normally these are processed by UListViewBase::FinishGeneratingEntry which uses World->GetTimerManager() to generate entries next frame However when for example using a listview in editor utility widgets a world there is not reliable and an alternative is to use FTSTicker::GetCoreTicker()
Protected variable float WheelScrollMultiplier The multiplier to apply when wheel scrolling

Constructors

  Type Name Description
Public function  

UListViewBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual void

FinishGeneratingEntry ( UUserWidget& GeneratedEntry
)

  
Protected function WidgetEntryT &

GenerateTypedEntry ( TSubclassOf< WidgetEntryT > WidgetClass,
const TSharedRef< STableViewBase >& OwnerTable
)

  
Public function Const const TArray< UUserWidget * > & Gets all of the list entry widgets currently being displayed by the list
Public function Const TSubclassOf< UUserWidget >  
Public function Const float Get the scroll offset of this view (in items)
Protected function Virtual void  
Protected function Virtual void  
Protected function void Expected to be bound to the actual ListView widget created by a child class (automatically taken care of via the construction helpers within ITypedUMGListView)
Protected function Virtual void  
Protected function Virtual void  
Public function FOnListEntryGenerated &  
Public function FOnEntryWidgetReleased &  
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
Protected function void

RefreshDesignerItems ( TArray< PlaceholderItemT >& ListItems,
TFunctionRef< PlaceholderItemT()> CreateItemFunc
)

 Helper intended to be called by overrides of OnRefreshDesignerItems.
Public function void Full regeneration of all entries in the list.
Public function void Sets the list to refresh on the next tick.
Public function void Scroll the entire list down to the bottom-most item
Public function void 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

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Protected function Virtual void Applies all properties to the native widget if possible.
Public function Virtual Const void Called at the end of Widget Blueprint compilation.

Overridden from UVisual

  Type Name Description
Protected function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FOnEntryWidgetReleased    
Public class FOnListEntryGenerated    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page