unreal.ListView

class unreal.ListView(outer: Object | None = None, name: Name | str = 'None')

Bases: ListViewBase

A virtualized list that allows up to thousands of items to be displayed.

An important distinction to keep in mind here is “Item” vs. “Entry” The list itself is based on a list of n items, but only creates as many entry widgets as can fit on screen. For example, a scrolling ListView of 200 items with 5 currently visible will only have created 5 entry widgets.

To make a widget usable as an entry in a ListView, it must inherit from the IUserObjectListEntry interface.

C++ Source:

  • Module: UMG

  • File: ListView.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

  • accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] 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.

  • accessible_summary_text (Text): [Read-Write] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • allow_dragging (bool): [Read-Write] True to allow dragging of row widgets in the list

  • allow_overscroll (bool): [Read-Write] Disable to stop scrollbars from activating inertial overscrolling

  • bp_on_entry_generated (OnListEntryGeneratedDynamic): [Read-Write] Called when a row widget is generated for a list item

  • bp_on_entry_initialized (OnListEntryInitializedDynamic): [Read-Write] Called when a row widget is generated for a list item

  • bp_on_entry_released (OnListEntryReleasedDynamic): [Read-Write] Called when a row widget is released by the list (i.e. when it no longer represents a list item)

  • bp_on_item_clicked (SimpleListItemEventDynamic): [Read-Write]

  • bp_on_item_double_clicked (SimpleListItemEventDynamic): [Read-Write]

  • bp_on_item_is_hovered_changed (OnItemIsHoveredChangedDynamic): [Read-Write]

  • bp_on_item_scrolled_into_view (OnListItemScrolledIntoViewDynamic): [Read-Write]

  • bp_on_item_selection_changed (OnListItemSelectionChangedDynamic): [Read-Write]

  • bp_on_list_view_scrolled (OnListViewScrolledDynamic): [Read-Write]

  • can_children_be_accessible (bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.

  • clear_selection_on_click (bool): [Read-Write]

  • clipping (WidgetClipping): [Read-Write] 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.

    NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.

  • consume_mouse_wheel (ConsumeMouseWheel): [Read-Write]

  • cursor (MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget

  • enable_fixed_line_offset (bool): [Read-Write]

  • enable_right_click_scrolling (bool): [Read-Write] True to allow right click drag scrolling.

  • enable_scroll_animation (bool): [Read-Write] True to enable lerped animation when scrolling through the list

  • entry_spacing (float): [Read-Write]

  • entry_widget_class (type(Class)): [Read-Write] The type of widget to create for each entry displayed in the list.

  • fixed_line_scroll_offset (float): [Read-Write] 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.

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction

  • is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user

  • is_focusable (bool): [Read-Write]

  • is_volatile (bool): [Read-Write] 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.

  • navigation (WidgetNavigation): [Read-Write] 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.

  • num_designer_preview_entries (int32): [Read-Write] The number of dummy item entry widgets to preview in the widget designer

  • orientation (Orientation): [Read-Write] The scroll & layout orientation of the list. ListView and TileView only. Vertical will scroll vertically and arrange tiles into rows. Horizontal will scroll horizontally and arrange tiles into columns.

  • override_accessible_defaults (bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write]

  • render_opacity (float): [Read-Write] The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] 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.

  • return_focus_to_selection (bool): [Read-Write]

  • scroll_bar_style (ScrollBarStyle): [Read-Write]

  • selection_mode (SelectionMode): [Read-Write]

  • slot (PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • tool_tip_text (Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mouse

  • visibility (SlateVisibility): [Read-Write] The visibility of the widget

  • wheel_scroll_multiplier (float): [Read-Write] The multiplier to apply when wheel scrolling

  • widget_style (TableViewStyle): [Read-Write]

add_item(item) → None

Adds an the item to the list

Parameters:

item (Object) –

bp_cancel_scroll_into_view() → None

Cancels a previous request to scroll and item into view.

bp_clear_selection() → None

Clear selection

bp_get_num_items_selected() → int32

Gets the number of items currently selected in the list

Return type:

int32

bp_get_selected_item() → Object

Gets the first selected item, if any; recommended that you only use this for single selection lists.

Return type:

Object

bp_get_selected_items() → Array[Object] or None

Gets a list of all the currently selected items

Returns:

items (Array[Object]):

Return type:

Array[Object] or None

bp_is_item_visible(item) → bool

Gets whether the entry for the given object is currently visible in the list

Parameters:

item (Object) –

Return type:

bool

bp_navigate_to_item(item) → None

Requests that the given item is navigated to, scrolling it into view if needed.

Parameters:

item (Object) –

property bp_on_entry_initialized: OnListEntryInitializedDynamic

[Read-Write] Called when a row widget is generated for a list item

Type:

(OnListEntryInitializedDynamic)

property bp_on_item_clicked: SimpleListItemEventDynamic

[Read-Write]

Type:

(SimpleListItemEventDynamic)

property bp_on_item_double_clicked: SimpleListItemEventDynamic

[Read-Write]

Type:

(SimpleListItemEventDynamic)

property bp_on_item_is_hovered_changed: OnItemIsHoveredChangedDynamic

[Read-Write]

Type:

(OnItemIsHoveredChangedDynamic)

property bp_on_item_scrolled_into_view: OnListItemScrolledIntoViewDynamic

[Read-Write]

Type:

(OnListItemScrolledIntoViewDynamic)

property bp_on_item_selection_changed: OnListItemSelectionChangedDynamic

[Read-Write]

Type:

(OnListItemSelectionChangedDynamic)

property bp_on_list_view_scrolled: OnListViewScrolledDynamic

[Read-Write]

Type:

(OnListViewScrolledDynamic)

bp_scroll_item_into_view(item) → None

Requests that the given item is scrolled into view

Parameters:

item (Object) –

bp_set_item_selection(item, selected) → None

Sets whether the given item is selected.

Parameters:
bp_set_list_items(list_items) → None

Sets the array of objects to display rows for in the list

Parameters:

list_items (Array[Object]) –

bp_set_selected_item(item) → None

Sets the given item as the sole selected item.

Parameters:

item (Object) –

clear_list_items() → None

Removes all items from the list

property clear_selection_on_click: bool

[Read-Only]

Type:

(bool)

property consume_mouse_wheel: ConsumeMouseWheel

[Read-Only]

Type:

(ConsumeMouseWheel)

property entry_spacing: float

[Read-Only]

Type:

(float)

get_index_for_item(item) → int32

Returns the index that the specified item is at. Will return the first found, or -1 for not found

Parameters:

item (Object) –

Return type:

int32

get_item_at(index) → Object

Returns the item at the given index

Parameters:

index (int32) –

Return type:

Object

get_list_items() → Array[Object]

Gets the list of all items in the list. Note that each of these items only has a corresponding entry widget when visible. Use GetDisplayedEntryWidgets to get the currently displayed widgets.

Return type:

Array[Object]

get_num_items() → int32

Returns the total number of items

Return type:

int32

property is_focusable: bool

[Read-Only]

Type:

(bool)

is_refresh_pending() → bool

Returns true if a refresh is pending and the list will be rebuilt on the next tick

Return type:

bool

navigate_to_index(index) → None

Requests that the item at the given index navigated to, scrolling it into view if needed.

Parameters:

index (int32) –

property orientation: Orientation

[Read-Only] The scroll & layout orientation of the list. ListView and TileView only. Vertical will scroll vertically and arrange tiles into rows. Horizontal will scroll horizontally and arrange tiles into columns.

Type:

(Orientation)

remove_item(item) → None

Removes an the item from the list

Parameters:

item (Object) –

property return_focus_to_selection: bool

[Read-Only]

Type:

(bool)

property scroll_bar_style: ScrollBarStyle

[Read-Only]

Type:

(ScrollBarStyle)

scroll_index_into_view(index) → None

Requests that the item at the given index is scrolled into view

Parameters:

index (int32) –

property selection_mode: SelectionMode

[Read-Only]

Type:

(SelectionMode)

set_selected_index(index) → None

Sets the item at the given index as the sole selected item.

Parameters:

index (int32) –

set_selection_mode(selection_mode) → None

Sets the new selection mode, preserving the current selection where possible.

Parameters:

selection_mode (SelectionMode) –

property widget_style: TableViewStyle

[Read-Only]

Type:

(TableViewStyle)