DreamGUI
类参考

UDreamListViewBase

UDreamListViewBase

继承自 UDreamUIControl。

声明于 Public/Controls/DreamListView.h。

列表和树共有的一切,而这几乎是全部。

树就是一个会缩进的列表,而这个类正是为此而写的:视口、条、被滚动的列、行模板、行池、行的颜色和唯一选中的索引都在这里,每个具体控件只添加让它成为它自己的东西 —— 它带类型的样式,以及(对于树来说)每个条目的深度、每行的缩进和一个展开箭头。FDreamTreeViewStyle 也是以同样的方式构建的,它携带一整个 FDreamListStyle,而不是重述它的字段。

这个类是抽象的,并且不持有任何样式属性。这是有意为之的,也正是存在基类、而不是让 UDreamTreeView 继承自 UDreamListView 的原因:这个家族的约定是,一个控件的外观是唯一的一个决定(参见 UDreamUIControl),而一棵树继承一个它永远不会解析的多余的 FDreamListStyle,会成为第二个事实来源,却顶着和真正来源一样的名字。每个子类声明带类型的 Style,并用它的列表那一半来回答 ResolveListStyle()。

THE SHAPE

承载外观的面、被裁剪在它内部持有滚动行为的视口、在视口内滑动的列,以及沿着视口边缘的一条 —— UDreamScrollBox 的安排方式,理由也是它的理由。其中两点值得重述,因为它们并不显而易见:行为位于视口上,而条是视口的兄弟,因为滚动视图接受来自其自身控件内任意位置的拖拽,所以如果条挂在它下面,每次抓取手柄都会滚动内容;还有,列的高度是控件对可以滚动多远的声明,绝不是布局输出。

ROWS ARE PLACED, NOT ARRANGED

列中没有任何布局容器,每一行都声明自己的矩形:顶部锚定、横向拉伸,并按它的索引乘以行间距进行偏移。由此产生三件事,而且三件都重要:

  • 行的高度就是样式的 RowHeight,仅此而已。之前的形态把行放在一个垂直盒子里,使用等权重的 Fill 槽位,然后把列的高度设定为恰好 rows*RowHeight + gaps,这样盒子就会把它重新分配出来 —— 这是一个在两处求解的方程而且必须一致,而一旦有任何东西测量行的内容,它就不再一致;
  • 放置第 N 行的成本为零,且不依赖任何兄弟节点,这正是回收之所以可能的原因所在:盒子会安排它拥有的每一个子项,所以盒子永远无法为一百万项显示一个窗口;
  • 而且答案无需任何布局过程即可获得,这正是无头测试和设计师第一帧实际看到的东西。

VIRTUALIZATION IS A THRESHOLD, NOT A MODE

在 VirtualizationThreshold 个项目以下,每个项目有一个行控件,GetRowWidget 会为每个索引作出回答 —— 这是该控件一直以来的约定,也是让它在没有安排任何视口的无头测试中正确的原因。达到或超过它时,池的大小会调整为窗口加上一个过扫描量,并且行会随着视图移动重新绑定,这正是 UMG 的 ListView 所做的,也是十万行不会是卡死的唯一办法。GetRowWidget 这时对已实现的行作出回答,对其余行返回 null,这也是 UMG 的约定。

对某一行的导航按压由列表来回答(参见 UDreamListRowButton):沿着滚动轴,下一个或前一个项目 —— ResolveNavigationTarget,平铺视图会按行、按列来回答 —— 会被滚动到视图中,并且在 bSelectItemOnNavigation 开启时,会被选中,就像 SListView::OnNavigation 和 NavigationSelect 所做的那样。在列表内部无路可去的按压(越过任一端,或横穿单列列表)会被留给普通的几何扫描,它会把焦点带到列表旁边的任何东西上 —— STableViewBase::OnNavigation 的回答。从外部到达列表也是同样的扫描,它会落在最近的行上,且不会选中它。

MULTI SELECTION IS SListView's

在 Multi 模式下,点击按 STableRow::OnMouseButtonDown 和 OnMouseButtonUp 的方式选择:普通点击选中它落在的行,别的什么都不选;Ctrl 添加该行或将其移除;Shift 把从范围锚点到这一行的每一行添加到已经选中的内容中,Ctrl 加 Shift 做同样的事。锚点是上一次普通点击、Ctrl 点击、手指点按或普通导航步骤所落在的行 —— SListView 的 RangeSelectionStart —— 而 Shift 范围会把它留在原处。手指没有修饰键,STableRow::OnTouchEnded 给 Multi 模式下的点按赋予它唯一能有的含义:它添加它抬起时所在的行,并且从不移除任何行。这些键是 SListView::NavigationSelect 和 OnKeyDown 的:带 Shift 的方向键从锚点选到它移动到的行,别的都不选;带 Ctrl 和 Shift 则添加那个范围;只带 Ctrl 则添加它移动到的行;Ctrl+A 选中每一行。读取点击时所用的修饰键属于点击的玩家,按玩家控制器所持有的状态握在他们手下;Ctrl 的位置与 Cmd 共享。每一次选择仍然要问过否决(OnIsItemSelectableOrNavigable),而且点击仍然在完成它的释放时选中。

TAB SEES ONE STOP

列表是一个 Tab 停靠点,就像浏览器的列表框一样:TabNavigation 为 Once,Tab 从 ResolveTabEntry 的行进入 —— 选中项的行,否则是第一项的行,Shift+Tab 则是最后一项的行,按索引找到、滚动到视图中并构建,因为行只为显示的内容而存在 —— 而下一个 Tab 会离开列表。方向键在其中移动。Next 和 Prev 从不归这些行来逐步经过(HandleRowNavigation 把它们留给 Tab 遍历),而条根本不是停靠点。

WHY THE PLAIN SCROLL VIEW, NOT UUIListView

回收栈(UUIRecyclableScrollView,以及在其之上的 UUIListView)对于数据源来说是正确答案,对于控件来说则是错误答案,原因全都在那些文件里:

  • 它的单位是 UObject* 项,因为 IUIRecyclableScrollViewDataSource 是一个 UObject 协议。 Native.List 的自然项目是一行文本 —— 与 FDreamDropdownStyle 的选项所做的同一调用 —— 而喂给回收器将意味着为每个标签铸造一个 UObject;
  • 单元格只有在 Start() 之后才存在,而 Start() 需要一个活动世界、一棵已注册的树以及一个已安排的视口:InitializeOnDataSource 根据内容父级的局部空间范围来确定单元格池的大小。控件必须在它的属性被设置的那一刻就是正确的;
  • 而且 UUIListView::Awake 把它的数据源席位交给最先声明它的任何人,这就是一个 each 块的适配器进入的方式。承载一个这样的控件的控件会成为那个席位的第三方。

所以行在这里从模板构建,进入一个普通 UUIScrollView 内的列中 —— 这正是 UDreamDropdown 的选项列表所做的,因为这是同一个问题。

HOW THIS RELATES TO each

它们是同一需求的两半,而且它们并不竞争:

each Track in Tracks { ... } 是语言路线。它把一个重复的子树编译进生成的类,通过 UDreamUIEachAdapter 供给宿主可回收视图,并把每一行的字段绑定到项目的成员(Text <- Track.Title)。你可以获得任意的行形状和逐字段绑定,代价是你必须有一个 .dui 类来容纳它,以及一个必须自己绘制的行。

Native.List 是控件路线。一个标签、两个属性,你就有了一个看起来像项目中其他所有列表一样的列表,因为它的行来自样式表。

当行是有意思的部分时,用 each。当列表是有意思的部分时,用 Native.List。

属性

名称类型类别在细节面板中来自蓝图说明
ItemsTArray<FText>列表是GetItems / SetItems行,以文本形式呈现。这是最常见的情况,而该控件的职责正是应对最常见的情况——与 UDreamDropdown 的 Options 所做的调用相同。当二者同时提供时,与 ItemObjects 平行对应:对象承载数据,此项承载内置行所显示的内容。
ItemObjectsTArray<TObjectPtr<UObject> >列表是读 / 写行,以对象形式呈现。非空时,此项决定行数以及每一行的条目;标签则来自 Items 中对应的条目,若没有对应条目则来自对象的名称。这是 UUIListView 自身 Items 数组所占据的位置,保留它是为了让已经将行建模为 UObject 的使用方不必先把它们解包成文本。
RowTemplateClassTSubclassOf<UDreamUserWidget>列表是GetRowTemplateClass / SetRowTemplateClass一行的内容,在别处制作:每个行控件内部都会创建该类的一个实例来填充它,内置标签则让位。行的外观、高度、悬停和选中状态仍由控件掌控,因此模板只需绘制一个条目。
SelectedIndexint32列表是GetSelectedIndex / SetSelectedIndex选中的行,作为源(SOURCE)中的索引——而非屏幕上各行中的索引。对于列表而言二者相同;对于树则不然,而一个在折叠后仍然有效的索引才值得交给绑定。‑1 表示没有。
SelectionModeEUIListSelectionMode列表是GetSelectionMode / SetSelectionMode一次可以选中多少行,采用 UUIListView 的四种模式——同一个枚举,因为它们就是同样四种答案,再另起一个枚举把它们重新拼写一遍就多了一个需要保持一致的东西。None 忽略点击;Single 始终恰好选中一行;SingleToggle 允许再次点击已选中的行来取消选择;Multi 的选中方式与 SListView 一致——普通点击选中一行,Ctrl 加选或减选一行,Shift 选中一个范围,手指点按再加选一行(参见上文的 MULTI SELECTION)。
SelectedIndicesTArray<int32>列表是GetSelectedIndices / SetSelectedIndices所有选中的行,以源索引表示,按选择顺序排列。可手动设置,但通常的做法是 SetItemSelection / SetSelectedIndex——它们会让 SelectedIndex 保持同步并重绘。
bAlternatingRowColorsbool列表是GetAlternatingRowColors / SetAlternatingRowColors每隔一行使用 FDreamListStyle::RowAlternate。关闭时就是 UMG 绘制的紧凑列表。
bShowScrollBarbool列表是GetShowScrollBar / SetShowScrollBar关闭意味着完全没有滚动条,视口仍保留原本会因它而占用的边距。
ScrollBarVisibilityEDreamScrollBoxScrollbarVisibility列表是GetScrollBarVisibility / SetScrollBarVisibility当所有行都放得下时,滚动条是保持不动还是消失。Hidden 从不绘制它,但列表仍可滚动,并在行溢出时保留其边距,正如 Hidden 的 Slate 滚动条会保留其槽位。
VirtualizationThresholdint32列表是GetVirtualizationThreshold / SetVirtualizationThreshold超过这么多行时,列表会复用一组控件窗口,而不是为每个条目都构建一个。
VirtualizationOverscanint32列表是GetVirtualizationOverscan / SetVirtualizationOverscan在窗口两侧各边缘之外额外保留已实例化的行数,使快速滚动时不会出现空白。
WheelScrollMultiplierfloat列表是GetWheelScrollMultiplier / SetWheelScrollMultiplier滚轮每格滚动多少行。1 是列表能够不加猜测地表达的唯一灵敏度——它是内容所构成的单位——而此项则是它的倍数,用于一次一行都太慢的长列表。0 则滚轮不再滚动。
OrientationEDreamPanelOrientation列表是GetOrientation / SetOrientation行的排列方向——即 UMG 的 Orientation,也是整个控件所依据的轴。
ConsumeMouseWheelEDreamScrollBoxConsumeMouseWheel列表是GetConsumeMouseWheel / SetConsumeMouseWheel滚轮是在此处被吞掉,还是在到达极限时交给外层可滚动的祖先——与滚动框给出的同样三种答案、同样的枚举。
bAllowOverscrollbool列表是GetAllowOverscroll / SetAllowOverscroll允许行被拉过端点并弹回——即 UMG 的 AllowOverscroll。
bEnableTouchScrollingbool列表是GetEnableTouchScrolling / SetEnableTouchScrolling触摸(TOUCH)拖动是否滚动行——即 UMG 的 bEnableTouchScrolling。鼠标拖动不受影响。
bEnableRightClickScrollingbool列表是GetEnableRightClickScrolling / SetEnableRightClickScrolling用右键(RIGHT)拖动是否滚动行——即 UMG 的 bEnableRightClickScrolling。
ScrollIntoViewDestinationEDreamUIScrollDestination列表是GetScrollIntoViewDestination / SetScrollIntoViewDestination由 ScrollIndexIntoView 或导航所显示的行最终停在何处——UMG 将此称为 ScrollIntoViewAlignment 并表示为浮点数;而这是滚动框和滚动行为已经共用的四答案枚举,因为它们本就是同一个问题。
bEnableFixedLineOffsetbool列表是GetEnableFixedLineOffset / SetEnableFixedLineOffset将显示出来的行固定在窗口的某个固定比例处,而不是仅仅把它带进视野——即 UMG 的 bEnableFixedLineOffset。
FixedLineScrollOffsetfloat列表是GetFixedLineScrollOffset / SetFixedLineScrollOffset该行在窗口中被固定的位置,0 = 近端边缘,1 = 远端边缘。0.5 为中间。
bSelectItemOnNavigationbool列表是GetSelectItemOnNavigation / SetSelectItemOnNavigation通过导航落到某一行时是否也将其选中(SELECT)——即 UMG 的 bSelectItemOnNavigation。
bAllowKeepPreselectedItemsbool列表是GetAllowKeepPreselectedItems / SetAllowKeepPreselectedItems在条目到达之前所做的选择是否被记住(REMEMBERED)——即 UMG 的 bAllowKeepPreselectedItems。
bClearScrollVelocityOnSelectionbool列表是GetClearScrollVelocityOnSelection / SetClearScrollVelocityOnSelection选择某一行时是否也停止甩动——即 UMG 的 bClearScrollVelocityOnSelection。
bEnableScrollAnimationbool列表是GetEnableScrollAnimation / SetEnableScrollAnimation显示和滚轮滚动是滑动(GLIDE)过去还是直接跳过去——即 UMG 的 bEnableScrollAnimation。
ScrollingAnimationInterpolationSpeedfloat列表是GetScrollingAnimationInterpolationSpeed / SetScrollingAnimationInterpolationSpeed该滑动拉近距离的速度——即 UMG 的 ScrollingAnimationInterpolationSpeed,及其参数化方式:一个速度(SPEED),而滚动行为自身的补间则采用持续时间。
bEnableTouchAnimatedScrollingbool列表是GetEnableTouchAnimatedScrolling / SetEnableTouchAnimatedScrolling触摸(TOUCH)拖动是否也滑动——即 UMG 的 bInEnableTouchAnimatedScrolling。
bIsPointerScrollingEnabledbool列表是GetIsPointerScrollingEnabled / SetIsPointerScrollingEnabled指针(POINTER)是否能够滚动此列表——即 UMG 的 bIsPointerScrollingEnabled。
bIsGamepadScrollingEnabledbool列表是GetIsGamepadScrollingEnabled / SetIsGamepadScrollingEnabled模拟摇杆是否能够滚动它——即 UMG 的 bIsGamepadScrollingEnabled。
bReturnFocusToSelectionbool列表是GetReturnFocusToSelection / SetReturnFocusToSelection焦点到达列表(LIST)时是否转交给选中的行——即 UMG 的 bReturnFocusToSelection。
bEnableShadowBrushbool列表是GetEnableShadowBrush / SetEnableShadowBrush当窗口之外还有更多列表内容时,在窗口两端绘制淡出效果——即 UMG 的 bEnableShadowBrush。
ShadowBrushFDreamUIFaceBrush列表是SetShadowBrush该淡出效果用什么来绘制——即 UMG 的 ShadowBrushStyle。
ShadowBrushThicknessfloatList是GetShadowBrushThickness / SetShadowBrushThickness渐变深入窗口的深度,以本地单位计。
bAllowDraggingboolListDrag是GetAllowDragging / SetAllowDragging
bAllowDragDropboolListDrag是GetAllowDragDrop / SetAllowDragDrop
FingerDragEDreamListFingerDragListDrag是GetFingerDrag / SetFingerDrag
DragDropVisualPivotFVector2DListDrag是SetDragDropVisualPivot
DragDropVisualOffsetFVector2DListDrag是SetDragDropVisualOffset
DragDropVisualEntryClassTSubclassOf<UDreamUserWidget>ListDrag是SetDragDropVisualEntryClass
DragDropOperationClassTSubclassOf<UDreamDragDropOperation>ListDrag是SetDragDropOperationClass
DragOperationTagFNameListDrag是SetDragOperationTag
bEnableDragEdgeScrollingboolListDrag是GetEnableDragEdgeScrolling / SetEnableDragEdgeScrolling
DragEdgeScrollBandSizefloatListDrag是GetDragEdgeScrollBandSize / SetDragEdgeScrollBandSize
DragEdgeScrollSpeedfloatListDrag是GetDragEdgeScrollSpeed / SetDragEdgeScrollSpeed
OnIsItemSelectableOrNavigableFDreamListItemSelectableQueryList-读 / 写某个项是否可以被选中或导航到 -- 即 UMG 的 BP_OnIsItemSelectableOrNavigable。
FaceNodeTObjectPtr<UDreamWidget>List-只读表面:列表自身的外观,以及在圆角边缘处将一切裁切掉的部分。
ViewportNodeTObjectPtr<UDreamWidget>List-只读行在其后滑动的窗口,也是滚动行为所在之处。
ColumnNodeTObjectPtr<UDreamWidget>List-只读滚动内容:与所有行一样高,而视口只显示能容纳的部分。
RowTemplateNodeTObjectPtr<UDreamWidget>List-只读行的复制来源 -- 只编写一次,处于非活动状态,自身从不绘制。公开是因为它是"交给它一个模板"这一说法的一半:在首次重建之前添加到此节点下的任何内容都会随之进入每一行。
RowLabelNodeTObjectPtr<UDreamWidget>List-只读模板的标签。每一行都有一份它的副本,通过显示名称查找。
ScrollBarNodeTObjectPtr<UDreamScrollBar>List-只读一个真正的 Native.ScrollBar,因此锚点规则所规定的把手几何形状只存在一次。
ScrollBehaviourTObjectPtr<UUIScrollView>List-只读
RowNodesTArray<TObjectPtr<UDreamWidget> >List-只读已存在的行控件,按池顺序排列 -- 仅在列表未回收时才是视觉顺序。RowSourceIndices 说明了每个行控件当前正在显示什么。
RowSourceIndicesTArray<int32>List-只读与 RowNodes 平行:每个池行代表哪个源项,或在停用时为 -1。

函数

函数类型描述
void AddItem(UObject* InItem)callable向数据源追加一个对象并重建 -- 对应 UMG 的 AddItem。
void AddItemAt(UObject* InItem, int32 InItemIndex)callable在数据源的指定索引处插入一个对象并重建 -- 对应 UMG 的 AddItemAt。
void AddItems(TArray<UObject*> InItems)callable追加多个对象并仅重建一次 -- 对应 UMG 的 AddItems。
void AddItemsAt(TArray<UObject*> InItems, int32 InItemIndex)callable在数据源的指定索引处插入多个对象并仅重建一次 -- 对应 UMG 的 AddItemsAt。
void AddTextItem(FText InItem)callable向数据源追加一行文本并重建。这是文本数据源中对应 AddItem 的那一半。
bool CancelListViewDragDrop()callable结束一次来自此列表且未放置的拖拽 -- 对应 UMG 的 CancelListViewDragDrop。
void ClearListItems()callable清空两个数据源,清除选中状态并重建 -- 对应 UMG 的 ClearListItems。
void ClearSelection()callable清空选中。若一开始就没有任何选中项,则不会发出通知。
void EndInertialScrolling()callable停止惯性滑动,保持当前位置 -- 对应 UMG 的 EndInertialScrolling。
bool FocusSelectedRow()callable若选中行的控件在屏幕上存在,则将键盘焦点置于其上。
bool GetAllowDragDrop()pure获取允许拖放
bool GetAllowDragging()pure获取允许拖拽
bool GetAllowKeepPreselectedItems()pure获取允许保留预选项
bool GetAllowOverscroll()pure获取允许过度滚动
bool GetAlternatingRowColors()pure获取交替行颜色
bool GetClearScrollVelocityOnSelection()pure获取选择时清除滚动速度
EDreamScrollBoxConsumeMouseWheel GetConsumeMouseWheel()pure获取消耗鼠标滚轮
float GetDragEdgeScrollBandSize()pure获取拖拽边缘滚动区域大小
float GetDragEdgeScrollSpeed()pure获取拖拽边缘滚动速度
int32 GetDraggedItemIndex()pure正在进行中的拖拽所携带项的数据源索引 —— 当对象数据源在拖拽过程中被移动时,即为其当前位置 —— 若未拖拽任何项则为 -1。
bool GetEnableDragEdgeScrolling()pure获取启用拖拽边缘滚动
bool GetEnableFixedLineOffset()pure获取启用固定行偏移
bool GetEnableRightClickScrolling()pure获取启用右键滚动
bool GetEnableScrollAnimation()pure获取启用滚动动画
bool GetEnableShadowBrush()pure获取启用阴影画刷
bool GetEnableTouchAnimatedScrolling()pure获取启用触摸动画滚动
bool GetEnableTouchScrolling()pure获取启用触摸滚动
EDreamListFingerDrag GetFingerDrag()pure获取手指拖拽
float GetFixedLineScrollOffset()pure获取固定行滚动偏移
int32 GetIndexForItem(UObject* InItem)pure对象在数据源中的位置,若不在其中则为 -1 -- 对应 UMG 的 GetIndexForItem。
bool GetIsDraggingListItem()pure当此列表的某一行正在被拖拽时为真 -- 对应 UMG 的 bIsDragging / GetIsDraggingListItem。
bool GetIsGamepadScrollingEnabled()pure获取是否启用游戏手柄滚动
bool GetIsPointerScrollingEnabled()pure获取是否启用指针滚动
UObject* GetItemAt(int32 InItemIndex)pure位于数据源指定索引处的对象;对于纯文本数据源或索引越界的情况则返回空。
int32 GetItemCount()pure数据源容纳了多少项 -- 若有对象则为对象数量,否则为文本数量。
TArray<FText> GetItems()pure获取项
TArray<UObject*> GetListItems()pure对象数据源,以裸指针形式呈现 -- 对应 UMG 的 GetListItems。
int32 GetNumItems()pure数据源容纳了多少项 -- 即 UMG 对 GetItemCount 的命名。
int32 GetNumItemsSelected()pure有多少行被选中 -- 对应 UMG 的 GetNumItemsSelected。
EDreamPanelOrientation GetOrientation()pure获取方向
float GetOverscroll()pure超过某一端的带符号距离,以本地单位计 -- 对应 UMG 的 GetOverscroll。
int32 GetRealizedRowCount()pure存在多少个行控件。在列表开始循环复用之前与 GetRowCount 相等。
bool GetReturnFocusToSelection()pure获取将焦点返回给选中项
int32 GetRowCount()pure列表正在显示多少行 -- 对于树来说即为可见数量,这正是树存在的意义。并非控件数量:请参阅 GetRealizedRowCount。
int32 GetRowItemIndex(int32 InPoolIndex)pure某个池中的行当前正在显示哪个数据源项,若其处于停用状态则为 -1。
TSubclassOf<UDreamUserWidget> GetRowTemplateClass()pure获取行模板类
UDreamWidget* GetRowWidget(int32 InItemIndex)pure代表某个数据源项的行,若该项当前没有行则返回空 -- 例如在树节点下折叠、已从数据源中移除,或(在循环复用期间)已滚动出窗口。
EDreamScrollBoxScrollbarVisibility GetScrollBarVisibility()pure获取滚动条可见性
float GetScrollingAnimationInterpolationSpeed()pure获取滚动动画插值速度
EDreamUIScrollDestination GetScrollIntoViewDestination()pure获取滚动到视图的目标位置
float GetScrollOffset()pure视口当前位于该列向下多远处,以本地单位计。
int32 GetSelectedIndex()pure获取选中索引
TArray<int32> GetSelectedIndices()pure每一个被选中的行,以其数据源索引表示,并按被选中的顺序排列。
TArray<UObject*> GetSelectedItems()pure以项的 OBJECT 形式表示被选中的行,适用于拥有这些对象的数据源 -- 对应 UMG 的 GetSelectedItems。纯文本数据源没有可用于应答的对象,因此此处返回空,而应改问 GetSelectedIndices。
EUIListSelectionMode GetSelectionMode()pure获取选择模式
bool GetSelectItemOnNavigation()pure获取导航时选中项
float GetShadowBrushThickness()pure获取阴影画刷粗细
bool GetShowScrollBar()pure获取显示滚动条
float GetViewFraction()pure当前在屏幕上可见的行所占的比例,0..1。当全部可见时为 1。
int32 GetVirtualizationOverscan()pure获取虚拟化过扫描
int32 GetVirtualizationThreshold()pure获取虚拟化阈值
float GetWheelScrollMultiplier()pure获取滚轮滚动倍率
bool IsItemSelectableOrNavigable(int32 InItemIndex)pure否决逻辑是否允许此项目被选择或导航至。当未绑定任何内容时为真。
bool IsItemSelected(int32 InItemIndex)pure是否选中项
bool IsItemVisible(int32 InItemIndex)pure当某项当前有代表它的行控件时为真 -- 对应 UMG 的 IsItemVisible。
bool IsVirtualizing()pure当列表显示的是一个控件窗口而非每一项对应一个控件时为真。
void NavigateToIndex(int32 InItemIndex)callable选中某项所在的行并将其带入视野 -- 对应 UMG 的 NavigateToIndex。
void RebuildRows()callable丢弃所有行并根据数据源重新构建它们。ApplyStyle 会为你调用它 -- 行的几何形状与行颜色都属于样式,因此不存在不触发它就能重新设置样式的情况 -- 每一个移动数据源的 setter 也会调用它。
void RemoveItem(UObject* InItem)callable从数据源中移除一个对象并重建 -- 对应 UMG 的 RemoveItem。
void RemoveItemAt(int32 InItemIndex)callable移除位于数据源指定索引处的项并重建。越界时不做任何操作。
void RemoveItems(TArray<UObject*> InItems)callable移除多个对象并仅重建一次 -- 对应 UMG 的 RemoveItems。
EDreamItemDropZone ResolveDropZone(float InFractionAlongRow, float InEdgeFraction)pure某个点落在哪个区域,以沿行的主轴方向的比例表示。
void ScrollIndexIntoView(int32 InItemIndex)callable将某项所在的行带入视野而不改动选中状态 -- 对应 UMG 的 ScrollIndexIntoView。
bool ScrollItemIntoView(int32 InItemIndex, bool bInAnimate)callable以最小的滚动距离将某项所在的行完整带入视口。
void ScrollToBottom()callable跳转到最后一行 -- 对应 UMG 的 ScrollToBottom。
void ScrollToTop()callable跳转到第一行 -- 对应 UMG 的 ScrollToTop。
void SetAllowDragDrop(bool bInAllow)callable设置允许拖放
void SetAllowDragging(bool bInAllow)callable设置允许拖拽
void SetAllowKeepPreselectedItems(bool bInAllow)callable设置允许保留预选项
void SetAllowOverscroll(bool bInAllow)callable设置允许过度滚动
void SetAlternatingRowColors(bool bInAlternating)callable以下五个开关仅由样式推送或行构建过程读取,因此每个 setter 写入相应字段后,自身即执行该推送 -- 这就是 BlueprintSetter 在此处带来的全部作用。重新设置样式永远不会创建或销毁行(参见列表的重新设置样式同一性测试),因此前三个开销很低;而两个虚拟化开关会改变行的存在数量,正因如此它们会经由 RebuildRows 处理。
void SetClearScrollVelocityOnSelection(bool bInClear)callable设置选择时清除滚动速度
void SetConsumeMouseWheel(EDreamScrollBoxConsumeMouseWheel InConsume)callable设置消耗鼠标滚轮
void SetDragDropOperationClass(TSubclassOf<UDreamDragDropOperation> InOperationClass)callable设置拖放操作类
void SetDragDropVisualEntryClass(TSubclassOf<UDreamUserWidget> InEntryClass)callableSet Drag Drop Visual Entry Class
void SetDragDropVisualOffset(FVector2D InOffset)callableSet Drag Drop Visual Offset
void SetDragDropVisualPivot(FVector2D InPivot)callable以下五项在拖动开始时读取,因此 setter 只需设置即可;已经处于进行中的拖动会保持它开始时所用的视觉效果与操作。
void SetDragEdgeScrollBandSize(float InBandSize)callable在零处进行钳制。每一步都会读取,因此更改可以作用到已经处于进行中的拖动。
void SetDragEdgeScrollSpeed(float InSpeed)callable在零处进行钳制。与 band 一样,每一步都会读取。
void SetDragOperationTag(FName InTag)callableSet Drag Operation Tag
void SetEnableDragEdgeScrolling(bool bInEnable)callable在拖动中途将其关闭会停止已在进行的滚动,并宣告其已完成。
void SetEnableFixedLineOffset(bool bInEnable)callableSet Enable Fixed Line Offset
void SetEnableRightClickScrolling(bool bInEnable)callableSet Enable Right Click Scrolling
void SetEnableScrollAnimation(bool bInEnable)callableSet Enable Scroll Animation
void SetEnableShadowBrush(bool bInEnable)callableSet Enable Shadow Brush
void SetEnableTouchAnimatedScrolling(bool bInEnable)callableSet Enable Touch Animated Scrolling
void SetEnableTouchScrolling(bool bInEnable)callableSet Enable Touch Scrolling
void SetFingerDrag(EDreamListFingerDrag InFingerDrag)callable当手指的拖动开始时读取:已经处于进行中的拖动会按其开始时的状态继续。
void SetFixedLineScrollOffset(float InOffset)callableSet Fixed Line Scroll Offset
void SetIsGamepadScrollingEnabled(bool bInEnable)callableSet Is Gamepad Scrolling Enabled
void SetIsPointerScrollingEnabled(bool bInEnable)callableSet Is Pointer Scrolling Enabled
void SetItemObjects(TArray<UObject*> InItems)callable替换对象源并重建。
void SetItems(TArray<FText> InItems)callable替换文本源并重建。
void SetItemSelection(int32 InItemIndex, bool bInSelected, bool bInClearOthers)callable从选择中添加或移除一行,这是唯一能够表达多选的调用。除了 Multi 之外,所有模式都隐含 bInClearOthers。
void SetOrientation(EDreamPanelOrientation InOrientation)callable将整个控件旋转九十度。
void SetReturnFocusToSelection(bool bInReturn)callableSet Return Focus to Selection
void SetRowTemplateClass(TSubclassOf<UDreamUserWidget> InClass)callable替换每行内容所基于的类。
void SetScrollBarVisibility(EDreamScrollBoxScrollbarVisibility InVisibility)callableSet Scroll Bar Visibility
void SetScrollingAnimationInterpolationSpeed(float InSpeed)callableSet Scrolling Animation Interpolation Speed
void SetScrollIntoViewDestination(EDreamUIScrollDestination InDestination)callableSet Scroll Into View Destination
void SetScrollOffset(float InOffset)callable将视口置于列中某个偏移位置,以本地单位计。受滚动范围钳制。
void SetSelectedIndex(int32 InIndex)callable移动高亮并触发两个选择事件。超出范围则不选中任何内容。
void SetSelectedIndexWithoutNotify(int32 InIndex)callable相同的移动,但静默进行:用于推入已设定的值,而非用户选择。
void SetSelectedIndices(TArray<int32> InIndices)callable一次性替换整个选择。保持锚点与各行的绘制与之同步。
void SetSelectionMode(EUIListSelectionMode InMode)callable由哪种模式决定可以选择多少行。必要时重新收窄选择,并在其发生变化时宣告一次——None 会丢弃整个选择,Multi 到单选模式会保留锚点——这样双向绑定就不会再持有一个没有任何内容选择的行。
void SetSelectItemOnNavigation(bool bInSelect)callableSet Select Item on Navigation
void SetShadowBrush(FDreamUIFaceBrush InShadowBrush)callable当还有可滚动内容时,绘制在视口边缘之上的图像。立即推入。
void SetShadowBrushThickness(float InThickness)callableSet Shadow Brush Thickness
void SetShowScrollBar(bool bInShowScrollBar)callableSet Show Scroll Bar
void SetVirtualizationOverscan(int32 InOverscan)callableSet Virtualization Overscan
void SetVirtualizationThreshold(int32 InThreshold)callable跨越阈值会改变列表是否进行池化,因此这会重建而非仅重新设置样式。
void SetWheelScrollMultiplier(float InMultiplier)callableSet Wheel Scroll Multiplier

Events

EventSignatureDescription
OnSelectionChangedvoid DreamListSelectionChangedEvent__DelegateSignature(int32 SelectedIndex)从各行重新广播,因此使用者绑定到控件,而不是绑定到其某个部分。
OnValueChangedBPvoid DreamListSelectionChangedEvent__DelegateSignature(int32 SelectedIndex)<-> 约定:双向绑定会针对这个确切名称合成其反向路由,因此值控件会将其与自身对外声明的事件一起携带。会与它们一同触发。
OnRowGeneratedvoid DreamListRowEvent__DelegateSignature(int32 ItemIndex, UDreamWidget* Row, UObject* Item)每行一个,每当它被绑定到某个项时触发——在回收时,就是该行每次轮回到新项时,而不是在其生命周期中仅一次;并且列表每次重新推入时(重建、样式推入、尺寸调整)在每一行上触发,因为那会重写该行的外观。滚动时若使某行保持在其项上则不进行任何绑定。总是在针对该行先前所代表的任何内容的 OnRowReleased 之后发生,因此两者成对出现。对于行内容比标签更丰富但又不愿编写整个类的使用者而言,这是钩子:行下方的一切都可以从这里通过显示名称访问。
OnRowReleasedvoid DreamListRowEvent__DelegateSignature(int32 ItemIndex, UDreamWidget* Row, UObject* Item)OnRowGenerated 的对应事件:池中的某一行即将不再代表此项,因为它被重新绑定——绑定到另一项,或因重新推入而再次绑定到此项——被停用或销毁。携带该行原先绑定到的项,包括对象,即使源自那之后已发生变化。即 UMG 的 OnEntryReleased,也是用于撤销 OnRowGenerated 对该行所做任何操作的钩子。
OnItemClickedvoid DreamListItemEvent__DelegateSignature(int32 ItemIndex, UObject* Item)某行被点击——每一次点击,无论选择模式如何处理它。与 OnSelectionChanged 分开,因为点击已选中的行仍然是点击,而且 SelectionMode 为 None 的列表仍然希望知道。
OnItemDoubleClickedvoid DreamListItemEvent__DelegateSignature(int32 ItemIndex, UObject* Item)在事件系统的 DoubleClickTime 内对同一行的两次点击。
OnItemIsHoveredChangedvoid DreamListItemHoverEvent__DelegateSignature(int32 ItemIndex, UObject* Item, bool bIsHovered)指针进入或离开某行——即 UMG 的 OnItemIsHoveredChanged。
OnListViewScrolledvoid DreamListScrolledEvent__DelegateSignature(float CurrentOffset, float ViewFraction)列表发生移动——即 UMG 的 OnListViewScrolled。携带偏移和可见比例,这是自行绘制位置指示器的使用者所需且无法独自算出的内容。
OnListViewFinishedScrollingvoid DreamListScrolledEvent__DelegateSignature(float CurrentOffset, float ViewFraction)列表停止移动——即 UMG 的 OnListViewFinishedScrolling。
OnRowInitializedvoid DreamListRowEvent__DelegateSignature(int32 ItemIndex, UDreamWidget* Row, UObject* Item)某行控件刚刚被创建——即 UMG 的 OnEntryInitialized,且在该控件生命周期中仅发生一次。
OnRowsGeneratedvoid DreamListEntriesGeneratedEvent__DelegateSignature(int32 RealizedRowCount)整个重建已完成——即 UMG 的 BP_OnEntriesGenerated。
OnItemScrolledIntoViewvoid DreamListRowEvent__DelegateSignature(int32 ItemIndex, UDreamWidget* Row, UObject* Item)某个项进入了已实现窗口——即 UMG 的 BP_OnItemScrolledIntoView。
OnListViewTouchStartvoid DreamListScrolledEvent__DelegateSignature(float CurrentOffset, float ViewFraction)在行上开始了触摸拖动——即 UMG 的 BP_OnListViewTouchStart。偏移与可见比例。
OnListViewTouchMovevoid DreamListScrolledEvent__DelegateSignature(float CurrentOffset, float ViewFraction)
OnListViewTouchEndvoid DreamListScrolledEvent__DelegateSignature(float CurrentOffset, float ViewFraction)
OnItemDragDetectedvoid DreamListItemDragEvent__DelegateSignature(int32 ItemIndex, UObject* Item, UDreamDragDropOperation* Operation)某行被拿起——即 UMG 的 BP_OnItemDragDetected。此处操作仍然可编辑。
OnItemDragEntervoid DreamListItemDragEvent__DelegateSignature(int32 ItemIndex, UObject* Item, UDreamDragDropOperation* Operation)拖动进入了某行——即 UMG 的 BP_OnItemDragEnter。任何拖动,不仅限于此列表自身的拖动。
OnItemDragLeavevoid DreamListItemDragEvent__DelegateSignature(int32 ItemIndex, UObject* Item, UDreamDragDropOperation* Operation)
OnItemAcceptDropvoid DreamListItemDropEvent__DelegateSignature(int32 ItemIndex, UObject* Item, UDreamDragDropOperation* Operation, EDreamItemDropZone DropZone)放置落到了某行上——即 UMG 的 BP_OnItemAcceptDrop,并带有其落入的区域。
OnItemDragCancelledvoid DreamListItemDragEvent__DelegateSignature(int32 ItemIndex, UObject* Item, UDreamDragDropOperation* Operation)从此列表发起的拖动以无人接受而结束——即 UMG 的 BP_OnItemDragCancelled。
OnDraggingStateChangedvoid DreamListDraggingStateEvent__DelegateSignature(bool bIsDragging)此列表开始或停止拖动其某一行——即 UMG 的 BP_OnListViewDraggingStateChanged。

本页目录