Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Views > SListView > FWidgetGenerator

Light Theme

Dark Theme

FWidgetGenerator

A WidgetGenerator is a component responsible for creating widgets from data items.

Windows

MacOS

Linux

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Views/SListView.h
Include	#include "Widgets/Views/SListView.h"

Syntax

class FWidgetGenerator

Remarks

A WidgetGenerator is a component responsible for creating widgets from data items. It also provides mapping from currently generated widgets to the data items which they represent.

Variables

	Name	Description
TArray< ItemTyp...	ItemsToBeCleanedUp	Items that need their widgets destroyed because they are no longer on screen.
TArray< ItemTyp...	ItemsWithGeneratedWidgets	A set of Items that currently have a generated widget
TMap< ItemType,...	ItemToWidgetMap	Map of DataItems to corresponding SWidgets
SListView< Item...	OwnerList	We store a pointer to the owner list for error purposes, so when asserts occur we can report which list it happened for.
int32	TotalItemsLastGeneration	Total number of DataItems the last time we performed a generation pass.
TMap< const ITa...	WidgetMapToItem	Map of SWidgets to DataItems from which they were generated

Constructors

	Name	Description
	FWidgetGenerator ( SListView< ItemType >* InOwner... )

Functions

	Name	Description
void	Clear()	Clear everything so widgets will be regenerated
TSharedPtr< ...	GetWidgetForItem ( const ItemType& Item )	Find a widget for this item if it has already been constructed.
void	OnBeginGenerationPass()	Called at the beginning of the generation pass.
void	OnEndGenerationPass()	Called at the end of the generation pass.
void	OnItemSeen ( ItemType InItem, TSharedRef< ITableRow > InGenerated... )	Keep track of every item and corresponding widget during a generation pass.
void	ProcessItemCleanUp()
void	ValidateWidgetGeneration()

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss