DreamGUI
类参考

UDreamExpandableArea

UDreamExpandableArea

继承自 UDreamUIControl。

声明于 Public/Controls/DreamExpandableArea.h。

一个可切换的头部,以及它所隐藏的内容。

三个节点和一种行为:一个列、一个可点击的头部界面(上面带有一个指示器和一个标签),以及下方的一个内容列。头部是位于自身界面上的一个 UUIButton,与 DreamButton 构建它的方式完全一致——展开器就是一个按钮,其点击意味着“显示其余部分”——因此悬停、按下和导航都来自该库的同一个可选中项,而不是来自第二套交互叙事。

使用者如何向其中放入内容,以及那是哪种惯用法,因为此代码库中有两种,而从这里只有一种可达:

Native.ExpandableArea Details {
    Label = "Advanced"
    Text Body { Text = "..." }
}

直接嵌套即可。文本构建器会把节点的子节点挂到它刚刚构建的控件上(BuildNode 的 TrySetParent),因此这些控件会作为这个控件的子节点到来,与该控件为自身构建的树并排——而内容列正是该控件的默认命名槽,所以它们会被顺带移入其中。

这里以前是一段手写的接管流程,并配有注释说明为何不能使用 UDreamNamedSlot:宿主的 NamedSlotContent 由 InitializeWidgetStatic 挂载,而该函数对于没有 widget-tree 原型的类会立即返回,原生控件从来就没有这种原型——因此在这里声明的槽会是一个无人能填的洞。那道关卡已经不存在了(现在槽由 UDreamUserWidget::Initialize 填充,位于 NativeOnInitialized 之后,这是两类内容同时存在的最早时刻),随之消失的还有手工实现这一点的理由。手工组装层级的代码仍然可以调用 SetContent;设计器拖入此控件的内容会作为一个子节点落地,与上面 .dui 的路径相同。

部件名称,模板的作者必须一字不差地拼写,因为部件是按显示名称绑定的,除了缺失部件的日志行之外没有任何东西检查拼写:

ExpandableArea   the outer column
HeaderFace       the clickable header face; the node whose height IS HeaderHeight
HeaderRow        the indicator-and-label row inside the face
Arrow            the glyph indicator          (optional)
ArrowMark        the image indicator          (optional)
Label            the stock header text
Header           the header HOLE -- a UDreamNamedSlot  (optional)
Content          the body, and this control's default UDreamNamedSlot

面之所以叫“HeaderFace”而并非“Header”是有意为之。命名槽的名字就是其宿主节点的显示名称(UDreamNamedSlot::GetSlotName),因此这个洞必须叫 Header——该字符串就是 HeaderSlotName,一个公共绑定键,也是 GetNativeSlotNames 承诺的两个名字之一。部件遍历会先遇到祖先再遇到后代,所以一个同样叫 Header 的面会同时应答两者,于是当洞被填充时收起内置标签的那次替换会读到一个空的洞,并让整个头部休眠。模板若把自己的头部面命名为 Header,就会精确复现这一点:头部消失,唯一的痕迹是一条关于 HeaderFace 的缺失部件日志。

与 UMG 对齐是 UExpandableArea 的核心:bIsExpanded、SetIsExpanded、OnExpansionChanged——再加上库的 OnValueChangedBP,因为展开标志是一个值,<-> 会针对它进行绑定。

折叠时,该控件只按头部来测量,仅此而已:Auto 槽会向控件询问其尺寸,而一个保留展开高度的展开器会在它所在的每个列表中留下一个空洞。

属性

名称类型类别在细节面板中来自蓝图描述
StyleFDreamExpandableAreaStyleExpandable Area是GetStyle / SetStyle此实例自身的外观。当 StyleSource 如此指示并且确实存在样式表时,项目样式表胜出;如果项目中没有样式表,那么这本身就是生效的外观——这就是为什么它保持可编辑,而不是被枚举值门控:旧的编辑条件恰恰把驱动该控件的那些值变灰了。
LabelFTextExpandable Area是GetLabel / SetLabel头部上的文字。
bIsExpandedboolExpandable Area是GetIsExpanded / SetIsExpanded内容是否显示。它是一个属性,因此 .dui、设计器和绑定都能看到它,作者也能直接发布一个已展开的区块;所有改变它的途径都经由 SetIsExpanded,而后者是唯一会进行广播的东西。
MaxHeightfloatExpandable Area是GetMaxHeight / SetMaxHeight对内容在控件高度中所占份额的上限,以本地单位计——即 UMG 的 MaxHeight。
ExpansionDurationfloatExpandable Area是GetExpansionDuration / SetExpansionDuration打开和关闭所花费的时长,以秒为单位。零(默认值)表示瞬时完成。
RootNodeTObjectPtr<UDreamWidget>Expandable Area-只读
HeaderNodeTObjectPtr<UDreamWidget>Expandable Area-只读可点击的界面,以及其高度就是样式 HeaderHeight 的那个节点。从名为 "HeaderFace" 的部件绑定而来——FIELD 保留其名称,而部件不会;关于两者为何不同,请参见类注释。
HeaderRowNodeTObjectPtr<UDreamWidget>Expandable Area-只读头部内的指示器加标签行。关于它为何是独立节点,请参见树结构注释。
ArrowNodeTObjectPtr<UDreamWidget>Expandable Area-只读内置的图形指示器。只要状态的笔刷改为携带图像,它就会休眠。
ArrowMarkNodeTObjectPtr<UDreamWidget>Expandable Area-只读图像指示器,即图形的替代者。两者中恰有一个处于唤醒状态。
LabelNodeTObjectPtr<UDreamWidget>Expandable Area-只读
ContentNodeTObjectPtr<UDreamWidget>Expandable Area-只读使用者内容所在之处,也是折叠时被关闭的那个节点。
HeaderBehaviourTObjectPtr<UUIButton>Expandable Area-只读
HeaderSlotNodeTObjectPtr<UDreamWidget>Expandable Area-只读头部的孔位,位于内建标签的位置。为空是正常状态。

函数

函数类型描述
UDreamWidget* GetContent()pure内容列中的第一个控件,为空时返回 null。
float GetExpansionDuration()pure获取展开时长
bool GetIsExpanded()pure获取是否已展开
FText GetLabel()pure获取标签
float GetMaxHeight()pure获取最大高度
FDreamExpandableAreaStyle GetStyle()pure获取样式
void SetContent(UDreamWidget* InContent)callable将 InContent 放入内容列,并从它当前所悬挂的位置取走。
void SetExpansionDuration(float InExpansionDuration)callable下一次打开或关闭所花费的时长。不会重新运行任何东西:时长描述的是尚未发生的移动,而为了遵循新的速度而重放当前动画,会让玩家已经完成打开过程的区块再次播放动画。
void SetIsExpanded(bool bInIsExpanded)callable当标志未发生变化时静默;否则推送视觉效果并广播两个事件。
void SetLabel(FText InLabel)callable头部上的文字,直写到控件所拥有的标签上。
void SetMaxHeight(float InMaxHeight)callable立即重新测量:上限是此控件所声明高度的一部分。
void SetStyle(FDreamExpandableAreaStyle InStyle)callable此实例的整体外观,被替换并推送。有关注意事项,请参见 UDreamButton::SetStyle。
void ToggleExpansion()callable头部点击所执行的操作,无需指针即可调用。

事件

事件签名描述
OnExpansionChangedvoid DreamExpandableAreaExpansionChangedEvent__DelegateSignature(bool bIsExpanded)每当展开标志发生变化时触发,无论是来自点击还是来自代码。
OnValueChangedBPvoid DreamExpandableAreaExpansionChangedEvent__DelegateSignature(bool bIsExpanded)<-> 约定:双向绑定会针对这个确切的名称合成其反向路径,因此值控件会将其与自身所声明的事件一起携带。与它们同时触发。

与 UMG 的比较

UMG 类中每一个面向蓝图的成员,以及它们的去向。adopt:名称相同,含义相同。map:在此处使用另一个名称或位于另一种类型上。reject:有意缺失,并给出原因。

UMGMemberStatusHereNote
UExpandableAreaStyleadoptStyleFDreamExpandableAreaStyle:标题的高度、它的五种状态颜色、标签,以及内容区域的背景和内边距。
UExpandableAreaBorderBrushmapFDreamExpandableAreaStyle::ContentBackground是一个颜色而不是 FSlateBrush:内容区域是一个过程化矩形,在这个家族中,展开器的框架就是该矩形的填充。内容背后的图片是围绕它的一个 Native.Border。
UExpandableAreaBorderColormapFDreamExpandableAreaStyle::ContentBackground只用一个颜色,而 UMG 在其上有一个画刷和一个叠加的着色,原因同上:这里没有画刷供第二个颜色相乘。
UExpandableAreabIsExpandedadoptbIsExpanded创作时即设为展开或折叠;所有改变它的路径都经过 SetIsExpanded,后者才会广播。
UExpandableAreaMaxHeightadoptMaxHeight零表示无上限,这也是该控件一直以来的行为。
UExpandableAreaHeaderPaddingmapFDreamExpandableAreaStyle::HeaderPadding放在样式中,因为项目分区标题的内缩方式是主题层面的决定。
UExpandableAreaAreaPaddingmapFDreamExpandableAreaStyle::ContentPadding按它所填充的内容命名,而不是按它所在的控件命名。
UExpandableAreaOnExpansionChangedadoptOnExpansionChanged点击和代码都会触发。
UExpandableAreaGetIsExpandedadoptGetIsExpanded
UExpandableAreaSetIsExpandedadoptSetIsExpanded
UExpandableAreaSetIsExpanded_AnimatedmapExpansionDuration是一个时长而不是第二个函数:展开器是否做动画是展开器自身的属性,而不是调用方的属性,因此所有路径(点击、绑定、代码)都会得到相同的展开。零表示瞬间完成,这也是每个已创作过的展开器的行为。
UExpandableAreaSetStyleadoptSetStyleUExpandableArea 根本没有样式设置器(它的 Style 仅为 EditAnywhere);这是该家族在运行时替换外观的写法。

本页目录