class

AListView

Module
Arc
Header
#include "Arc/Widgets/AListView.h"
Namespace
Arcf
Template
template<typename ItemType>

Type aliases

AliasDescription
using COnGenerateRow = std::function<TSharedPtr<AWidget>(const ItemType&, uint32_t )>
using COnRefreshRow = std::function<void(const TSharedPtr<AWidget>& , const ItemType&, uint32_t )>
using COnSelectionChanged = ArcDelegate<void(const ItemType& , uint32_t )>

Properties

TypeNameDescription
static constexpr floatSCROLLBAR_GUTTERDefault 12.0f.
COnSelectionChangedOnSelectionChanged
COnSelectionChangedOnItemActivatedEnter / double-click on a row (U1) — "open" semantics.

Public functions

ReturnsNameDescription
ARC_WIDGET_ARGS
voidSetEmptyTextContextual empty-state line ("no actors", "nothing matches") — settable at runtime so filters can explain themselves.
voidSetEmptyWidgetWhat the list shows, filling it, while it has no items: an AEmptyState or a panel's own hint.
TSharedPtr<AWidget>GetEmptyWidget
boolIsShowingEmptyWidgetWhether the empty widget is the list's content right now.
voidSetItems
int32_tUpdateItemsSetItems for a list whose shape stayed: with the same item count, every row unchanged(old, new) accepts keeps the widget it has and only the others are built again.
voidSetItemHeightFnEach item's own height; null puts every row back on ItemHeight.
voidSetRowPaintsOwnStatesRows the predicate names paint their own hover, press and selection (APropertyRow does, by its own spec); the list keeps only the keyboard ring under them.
floatGetRowTop
floatGetRowHeight
floatContentHeight
int32_tIndexAtYThe row under a content-space y; the item count past the last row.
voidSetOnGenerateRow
voidSetOnRefreshRowRe-points a pooled row at a new item.
uint64_tGetGeneratedRowCountRows built by OnGenerateRow / re-pointed by OnRefreshRow so far.
uint64_tGetRefreshedRowCount
voidSetItemHeight
floatGetItemHeight
int32_tGetSelectedIndex
const ItemType*GetSelectedItem
voidSetSelectedIndexThe painted set follows the anchor: setting only the anchor left the old highlight on screen.
voidClearSelection
voidScrollToEnd
voidEnsureIndexVisible
ArcVec2ComputeDesiredSize
boolCanCacheDesiredSizeA constant.
boolDesiredSizeDependsOnChildren
boolCanSkipArrangeRefused: rows are recycled here.
boolCanRetainPaintRefused for the same reason: the rows a replay would reproduce are the ones the previous window recycled, and the selection highlight moves without a write anyone can see.
voidArrangeChildren
int32_tOnPaint
CReplyOnMouseWheel
boolIsFocusable
CReplyOnKeyDownKeyboard model (U1): arrows move the anchor, Home/End jump, PageUp/Down step a viewport, Enter activates.
CReplyOnMouseButtonDoubleClick
CReplyOnMouseButtonDown
CReplyOnMouseMove
CReplyOnMouseButtonUp
voidOnMouseLeave
EFocusVisualGetFocusVisualThe keyboard row carries list-row.json's inset ring, not the list.
boolPaintsOwnFocus
int32_tGetNumChildren
TSharedPtr<AWidget>GetChildAt
const char*GetTypeName

Function details

ARC_WIDGET_ARGS

C++
ARC_WIDGET_ARGS(AListView) ARC_ARG(float, ItemHeight) ARC_ARG(CText, EmptyText) ARC_WIDGET_ARGS_END() void Construct(const CArguments& args)

SetEmptyText

C++
void SetEmptyText(const CText& text)

Contextual empty-state line ("no actors", "nothing matches") — settable at runtime so filters can explain themselves.

SetEmptyWidget

C++
void SetEmptyWidget(TSharedPtr<AWidget> widget)

What the list shows, filling it, while it has no items: an AEmptyState or a panel's own hint. Takes the empty text's place.

GetEmptyWidget

C++
TSharedPtr<AWidget> GetEmptyWidget() const

IsShowingEmptyWidget

C++
bool IsShowingEmptyWidget() const

Whether the empty widget is the list's content right now.

SetItems

C++
void SetItems(const std::vector<ItemType>& items)

UpdateItems

C++
template<typename FUnchanged> int32_t UpdateItems(const std::vector<ItemType>& items, FUnchanged&& unchanged)

SetItems for a list whose shape stayed: with the same item count, every row unchanged(old, new) accepts keeps the widget it has and only the others are built again. A different count is a different list and is replaced whole. Returns how many rows were rebuilt, or -1 when the list was replaced.

SetItemHeightFn

C++
void SetItemHeightFn(std::function<float(const ItemType&)> fn)

Each item's own height; null puts every row back on ItemHeight.

SetRowPaintsOwnStates

C++
void SetRowPaintsOwnStates(std::function<bool(const ItemType&)> fn)

Rows the predicate names paint their own hover, press and selection (APropertyRow does, by its own spec); the list keeps only the keyboard ring under them.

GetRowTop

C++
float GetRowTop(int32_t index) const

GetRowHeight

C++
float GetRowHeight(int32_t index) const

ContentHeight

C++
float ContentHeight() const

IndexAtY

C++
int32_t IndexAtY(float y) const

The row under a content-space y; the item count past the last row.

SetOnGenerateRow

C++
void SetOnGenerateRow(COnGenerateRow func)

SetOnRefreshRow

C++
void SetOnRefreshRow(COnRefreshRow func)

Re-points a pooled row at a new item. Must leave the row showing exactly what OnGenerateRow would have built for that item.

GetGeneratedRowCount

C++
uint64_t GetGeneratedRowCount() const

Rows built by OnGenerateRow / re-pointed by OnRefreshRow so far.

GetRefreshedRowCount

C++
uint64_t GetRefreshedRowCount() const

SetItemHeight

C++
void SetItemHeight(float height)

GetItemHeight

C++
float GetItemHeight() const

GetSelectedIndex

C++
int32_t GetSelectedIndex() const

GetSelectedItem

C++
const ItemType* GetSelectedItem() const

SetSelectedIndex

C++
void SetSelectedIndex(int32_t idx)

The painted set follows the anchor: setting only the anchor left the old highlight on screen.

ClearSelection

C++
void ClearSelection()

ScrollToEnd

C++
void ScrollToEnd()

EnsureIndexVisible

C++
void EnsureIndexVisible(const CGeometry& geo, int32_t index)

ComputeDesiredSize

C++
ArcVec2 ComputeDesiredSize(float ) const override

CanCacheDesiredSize

C++
bool CanCacheDesiredSize() const override

A constant. Rows are generated during arrange and never enter this widget's own measure, so scrolling and regeneration cannot move it.

DesiredSizeDependsOnChildren

C++
bool DesiredSizeDependsOnChildren() const override

CanSkipArrange

C++
bool CanSkipArrange() const override

Refused: rows are recycled here. The visible window, the row widgets bound to it and the scrollbar state are all produced by the arrange body, so a skipped pass shows the previous window.

CanRetainPaint

C++
bool CanRetainPaint() const override

Refused for the same reason: the rows a replay would reproduce are the ones the previous window recycled, and the selection highlight moves without a write anyone can see.

ArrangeChildren

C++
void ArrangeChildren(const CGeometry& allottedGeo) override

OnPaint

C++
int32_t OnPaint(const CArcPaintArgs& args, const CGeometry& geo, CArcUIRenderer& renderer, int32_t layerId) const override

OnMouseWheel

C++
CReply OnMouseWheel(const CGeometry& geo, const CPointerEvent& event) override

IsFocusable

C++
bool IsFocusable() const override

OnKeyDown

C++
CReply OnKeyDown(const CGeometry& geo, const CKeyEvent& event) override

Keyboard model (U1): arrows move the anchor, Home/End jump, PageUp/Down step a viewport, Enter activates. Shift extends the range the same way a shift-click does.

OnMouseButtonDoubleClick

C++
CReply OnMouseButtonDoubleClick(const CGeometry& geo, const CPointerEvent& event) override

OnMouseButtonDown

C++
CReply OnMouseButtonDown(const CGeometry& geo, const CPointerEvent& event) override

OnMouseMove

C++
CReply OnMouseMove(const CGeometry& geo, const CPointerEvent& event) override

OnMouseButtonUp

C++
CReply OnMouseButtonUp(const CGeometry& , const CPointerEvent& ) override

OnMouseLeave

C++
void OnMouseLeave(const CPointerEvent& event) override

GetFocusVisual

C++
EFocusVisual GetFocusVisual() const override

The keyboard row carries list-row.json's inset ring, not the list.

PaintsOwnFocus

C++
bool PaintsOwnFocus() const override

GetNumChildren

C++
int32_t GetNumChildren() const override

GetChildAt

C++
TSharedPtr<AWidget> GetChildAt(int32_t index) const override

GetTypeName

C++
const char* GetTypeName() const override
Generated from Arc/Widgets/AListView.h via arc.json · Nov 5, 2026Version 1.0.0