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. More...

Public Member Functions
ListView
void	SetScrollOffset (float32 InScrollOffset)
	Set the scroll offset of this view (in items).
Functions
const float32 &	GetWheelScrollMultiplier () const
	The multiplier to apply when wheel scrolling.
Public Member Functions inherited from UWidget
bool	IsInViewport () const
void	RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	BroadcastFieldValueChanged (FFieldNotificationId FieldId)
void	AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void	SetbOverride_Cursor (bool Value)
void	SetToolTipWidget (UWidget Widget)
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	GetbIsEnabled () const
	Sets whether this widget can be modified interactively by the user.
void	SetbIsEnabled (bool bInIsEnabled)
	Sets whether this widget can be modified interactively by the user.
const FWidgetTransform &	GetRenderTransform ()
const FText &	GetToolTipText () const
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	GetToolTipWidget () const
	Tooltip widget to show when the user hovers over the widget with the mouse.
const FVector2D &	GetRenderTransformPivot () const
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
void	GetChildWidgets (TArray< UWidget > &OutChildWidgets) const
void	SetbOverrideAccessibleDefaults (bool Value)
	Override all of the default accessibility behavior and text for this widget.
void	SetbCanChildrenBeAccessible (bool Value)
	Whether or not children of this widget can appear as distinct accessible widgets.
void	SetAccessibleText (FText Value)
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
void	SetAccessibleSummaryText (FText Value)
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
bool	GetbIsVolatile () const
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
void	SetbIsVolatile (bool Value)
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
const EMouseCursor &	GetCursor () const
	The cursor to show when the mouse is over the widget.
const FGeometry &	GetCachedGeometry () const
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
EWidgetClipping	GetClipping () const
	Gets the clipping state of this widget.
FVector2D	GetDesiredSize () const
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
FText	GetAccessibleText () const
	Gets the accessible text from the underlying Slate accessible widget.
FText	GetAccessibleSummaryText () const
	Gets the accessible summary text from the underlying Slate accessible widget.
UGameInstance	GetGameInstance () const
	Gets the game instance associated with this UI.
ULocalPlayer	GetOwningLocalPlayer () const
	Gets the local player associated with this UI.
APlayerController	GetOwningPlayer () const
	Gets the player controller associated with this UI.
const FGeometry &	GetPaintSpaceGeometry () const
UPanelWidget	GetParent () const
	Gets the parent widget.
float32	GetRenderOpacity () const
	Gets the current visibility of the widget.
bool	GetIsEnabled () const
	Gets the current enabled status of the widget.
void	ForceVolatile (bool bForce)
	Sets the forced volatility of the widget.
ESlateVisibility	GetVisibility () const
	Gets the current visibility of the widget.
bool	HasAnyUserFocus () const
	Returns true if this widget is focused by any user.
bool	HasFocusedDescendants () const
	Returns true if any descendant widget is focused by any user.
bool	HasKeyboardFocus () const
	Checks to see if this widget currently has the keyboard focus.
bool	HasMouseCapture () const
	Checks to see if this widget is the current mouse captor.
bool	HasMouseCaptureByUser (int UserIndex, int PointerIndex=- 1) const
	Checks to see if this widget is the current mouse captor.
bool	HasUserFocus (APlayerController PlayerController) const
	Returns true if this widget is focused by a specific user.
bool	HasUserFocusedDescendants (APlayerController PlayerController) const
	Returns true if any descendant widget is focused by a specific user.
void	InvalidateLayoutAndVolatility ()
	Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass.
bool	IsHovered () const
	Returns true if the widget is currently being hovered by a pointer device.
void	ForceLayoutPrepass ()
	Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget. One pre-pass already happens for every widget before Tick occurs. You only need to perform another pre-pass if you are adding child widgets this frame and want them to immediately be visible this frame.
bool	IsRendered () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
bool	IsVisible () const
	Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
const FGeometry &	GetTickSpaceGeometry () const
void	SetClipping (EWidgetClipping InClipping)
	Sets the clipping state of this widget.
void	SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Custom Rule.
void	RemoveFromParent ()
	Removes the widget from its parent widget. If this widget was added to the player's screen or the viewport it will also be removed from those containers.
void	ResetCursor ()
	Resets the cursor to use on the widget, removing any customization for it.
void	SetAllNavigationRules (EUINavigationRule Rule, FName WidgetToFocus)
	Sets the widget navigation rules for all directions. This can only be called on widgets that are in a widget tree.
void	SetVisibility (ESlateVisibility InVisibility)
	Sets the visibility of the widget.
void	SetCursor (EMouseCursor InCursor)
	Sets the cursor to show over the widget.
void	SetFocus ()
	Sets the focus to this widget for the owning user.
void	SetIsEnabled (bool bInIsEnabled)
	Sets the current enabled status of the widget.
void	SetKeyboardFocus ()
	Sets the focus to this widget.
void	SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
void	SetNavigationRuleBase (EUINavigation Direction, EUINavigationRule Rule)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for non Explicit, non Custom and non CustomBoundary Rules.
void	SetUserFocus (APlayerController PlayerController)
	Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus()).
void	SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for CustomBoundary Rule.
void	SetNavigationRuleExplicit (EUINavigation Direction, UWidget InWidget)
	Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Explicit Rule.
void	SetRenderOpacity (float32 InOpacity)
	Sets the visibility of the widget.
void	SetToolTip (UWidget Widget)
	Sets a custom widget as the tooltip of the widget.
void	SetToolTipText (FText InToolTipText)
	Sets the tooltip text for the widget.
void	SetRenderTransformAngle (float32 Angle)
void	SetRenderTransformPivot (FVector2D Pivot)
float32	GetRenderTransformAngle () const
void	SetRenderTransform (FWidgetTransform InTransform)
void	SetRenderShear (FVector2D Shear)
void	SetRenderScale (FVector2D Scale)
void	SetRenderTranslation (FVector2D Translation)
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UWidget
static UClass	StaticClass ()
Static Public Member Functions inherited from UVisual
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
Events
FOnListEntryReleasedDynamic	BP_OnEntryReleased
	Called when a row widget is released by the list (i.e. when it no longer represents a list item).
FOnListEntryGeneratedDynamic	BP_OnEntryGenerated
	Called when a row widget is generated for a list item.
Input
bool	bAllowDragging
	True to allow dragging of row widgets in the list.
ListEntries
TSubclassOf< UUserWidget >	EntryWidgetClass
	The type of widget to create for each entry displayed in the list.
int	NumDesignerPreviewEntries
	The number of dummy item entry widgets to preview in the widget designer.
Scrolling
bool	AllowOverscroll
	Disable to stop scrollbars from activating inertial overscrolling.
float32	FixedLineScrollOffset
	Optional fixed offset (in lines) to always apply to the top/left (depending on orientation) of the list. If provided, all non-inertial means of scrolling will settle with exactly this offset of the topmost entry. Ex: A value of 0.25 would cause the topmost full entry to be offset down by a quarter length of the preceeding entry.
bool	bInEnableTouchAnimatedScrolling
	True to enable lerped animation when scrolling through the list with touch.
bool	bEnableScrollAnimation
	True to enable lerped animation when scrolling through the list.
bool	bEnableRightClickScrolling
	True to allow right click drag scrolling.
bool	bEnableTouchScrolling
	True to allow scrolling using touch input.
bool	bIsPointerScrollingEnabled
	Enable/Disable scrolling using Touch or Mouse.
bool	bEnableFixedLineOffset
float32	WheelScrollMultiplier
	The multiplier to apply when wheel scrolling.
Public Attributes inherited from UWidget
FText	AccessibleSummaryText
	When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
FText	AccessibleText
	When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
ESlateAccessibleBehavior	AccessibleBehavior
	Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
ESlateAccessibleBehavior	AccessibleSummaryBehavior
	How to describe this widget when it's being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
EMouseCursor	Cursor
	The cursor to show when the mouse is over the widget.
FText	ToolTipText
	Tooltip text to show when the user hovers over the widget with the mouse.
UWidget	ToolTipWidget
	Tooltip widget to show when the user hovers over the widget with the mouse.
bool	bIsEnabled
	Sets whether this widget can be modified interactively by the user.
ESlateVisibility	Visibility
	The visibility of the widget.
UPanelSlot	Slot
	The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
EFlowDirectionPreference	FlowDirectionPreference
	Allows you to set a new flow direction.
UWidgetNavigation	Navigation
	The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.
bool	bIsVolatile
	If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
FVector2D	RenderTransformPivot
	The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
FWidgetTransform	RenderTransform
	The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
EWidgetPixelSnapping	PixelSnapping
	If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation.
EWidgetClipping	Clipping
	Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.
float32	RenderOpacity
	The opacity of the widget.
const FGeometry	CachedGeometry
	Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
const FGeometry	PaintSpaceGeometry
const UGameInstance	GameInstance
	Gets the game instance associated with this UI.
const UPanelWidget	Parent
	Gets the parent widget.
const FVector2D	DesiredSize
	Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
const FGeometry	TickSpaceGeometry
bool	IsEnabled
	Gets the current enabled status of the widget.
const ULocalPlayer	OwningLocalPlayer
	Gets the local player associated with this UI.
const APlayerController	OwningPlayer
	Gets the player controller associated with this UI.
float32	RenderTransformAngle
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

ListViewBase
const TArray< UUserWidget >	DisplayedEntryWidgets
	Gets all of the list entry widgets currently being displayed by the list.
float32	ScrollOffset
	Get the scroll offset of this view (in items).
void	RegenerateAllEntries ()
	Full regeneration of all entries in the list. Note that the entry UWidget instances will not be destroyed, but they will be released and re-generated. In other words, entry widgets will not receive Destruct/Construct events. They will receive OnEntryReleased and IUserObjectListEntry implementations will receive OnListItemObjectSet.
void	RequestRefresh ()
	Sets the list to refresh on the next tick.
void	ScrollToBottom ()
	Scroll the entire list down to the bottom-most item.
void	ScrollToTop ()
	Scroll the entire list up to the first item.
const TArray< UUserWidget > &	GetDisplayedEntryWidgets () const
	Gets all of the list entry widgets currently being displayed by the list.
void	SetScrollbarVisibility (ESlateVisibility InVisibility)
float32	GetScrollOffset () const
	Get the scroll offset of this view (in items).
void	SetIsPointerScrollingEnabled (bool bInIsPointerScrollingEnabled)
	Enable/Disable the ability of the list to scroll. This should be use as a temporary disable.
void	SetWheelScrollMultiplier (float32 NewWheelScrollMultiplier)

Detailed Description

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

Example: class UMyUserWidget : public UUserWidget { UPROPERTY(BindWidget, meta = (EntryClass = MyListEntryWidget)) UListView* ListView_InventoryItems; }

Member Function Documentation

◆ GetDisplayedEntryWidgets()

const TArray< UUserWidget > & GetDisplayedEntryWidgets ( ) const

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

◆ GetScrollOffset()

float32 GetScrollOffset ( ) const

Get the scroll offset of this view (in items).

◆ GetWheelScrollMultiplier()

const float32 & GetWheelScrollMultiplier ( ) const

The multiplier to apply when wheel scrolling.

◆ RegenerateAllEntries()

void RegenerateAllEntries ( )

Full regeneration of all entries in the list. Note that the entry UWidget instances will not be destroyed, but they will be released and re-generated. In other words, entry widgets will not receive Destruct/Construct events. They will receive OnEntryReleased and IUserObjectListEntry implementations will receive OnListItemObjectSet.

◆ RequestRefresh()

void RequestRefresh ( )

Sets the list to refresh on the next tick.

Note that refreshing, from a list perspective, is limited to accounting for discrepancies between items and entries. In other words, it will only release entries that no longer have items and generate entries for new items (or newly visible items).

It does NOT account for changes within existing items - that is up to the item to announce and an entry to listen to as needed. This can be onerous to set up for simple cases, so it's also reasonable (though not ideal) to call RegenerateAllEntries when changes within N list items need to be reflected.

◆ ScrollToBottom()

void ScrollToBottom ( )

Scroll the entire list down to the bottom-most item.

◆ ScrollToTop()

void ScrollToTop ( )

Scroll the entire list up to the first item.

◆ SetIsPointerScrollingEnabled()

void SetIsPointerScrollingEnabled ( bool bInIsPointerScrollingEnabled )

Enable/Disable the ability of the list to scroll. This should be use as a temporary disable.

◆ SetScrollbarVisibility()

void SetScrollbarVisibility ( ESlateVisibility InVisibility )

◆ SetScrollOffset()

void SetScrollOffset ( float32 InScrollOffset )

Set the scroll offset of this view (in items).

◆ SetWheelScrollMultiplier()

void SetWheelScrollMultiplier ( float32 NewWheelScrollMultiplier )

◆ StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

◆ AllowOverscroll

bool AllowOverscroll

Disable to stop scrollbars from activating inertial overscrolling.

◆ bAllowDragging

bool bAllowDragging

True to allow dragging of row widgets in the list.

◆ bEnableFixedLineOffset

bool bEnableFixedLineOffset

◆ bEnableRightClickScrolling

bool bEnableRightClickScrolling

True to allow right click drag scrolling.

◆ bEnableScrollAnimation

bool bEnableScrollAnimation

True to enable lerped animation when scrolling through the list.

◆ bEnableTouchScrolling

bool bEnableTouchScrolling

True to allow scrolling using touch input.

◆ bInEnableTouchAnimatedScrolling

bool bInEnableTouchAnimatedScrolling

True to enable lerped animation when scrolling through the list with touch.

◆ bIsPointerScrollingEnabled

bool bIsPointerScrollingEnabled

Enable/Disable scrolling using Touch or Mouse.

◆ BP_OnEntryGenerated

FOnListEntryGeneratedDynamic BP_OnEntryGenerated

Called when a row widget is generated for a list item.

◆ BP_OnEntryReleased

FOnListEntryReleasedDynamic BP_OnEntryReleased

Called when a row widget is released by the list (i.e. when it no longer represents a list item).

◆ DisplayedEntryWidgets

const TArray<UUserWidget> DisplayedEntryWidgets

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

◆ EntryWidgetClass

TSubclassOf<UUserWidget> EntryWidgetClass

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

◆ FixedLineScrollOffset

float32 FixedLineScrollOffset

Optional fixed offset (in lines) to always apply to the top/left (depending on orientation) of the list. If provided, all non-inertial means of scrolling will settle with exactly this offset of the topmost entry. Ex: A value of 0.25 would cause the topmost full entry to be offset down by a quarter length of the preceeding entry.

◆ NumDesignerPreviewEntries

int NumDesignerPreviewEntries

The number of dummy item entry widgets to preview in the widget designer.

◆ ScrollOffset

float32 ScrollOffset