DreamGUI
类参考

UDreamScrollBar

UDreamScrollBar

继承自 UDreamUIControl。

声明于 Public/Controls/DreamScrollBar.h。

一个层级结构由代码而非资源定义的滚动条。

两个节点:一条轨道,以及轨道内部的一个滑块。BP_HorizontalScrollbar 和 BP_VerticalScrollbar 是两个资源,因为资源无法根据属性分支;而这是一个控件,因为代码可以,并且 Direction 是它们唯一意见不一致的地方。滑块的父级就是轨道,行为正是以轨道为基准测量值的——滚动条的滑块在整个轨道上滑动(不像滑块控件的滑块,它会被自身尺寸内缩),因为它的长度本身就会缩短行程。

本类不再做的事

它过去携带一个 UUIScrollbar 子类并自行重新放置滑块,因为该组件写入比例锚点,并且除了细节面板之外不向任何对象暴露 Handle 或 DirectionType。这三项现在都在源头修复了:UUIScrollbar 以绝对几何位置放置滑块,通过公开的 setter 接受这两种写入,并且拥有最小长度下限,连同它必须与之保持一致的拖拽缩放。这里剩下的就是一个控件该做的事——样式、设计师和 <-> 绑定可以访问的属性,以及到滚动视图的链接。

没有滚动视图的滚动条本身就是一个值控件:它的值是一个 0 到 1 的位置, HandleSize 是滑块覆盖轨道的比例。把它指向一个 UUIScrollView,这两个数字就都变成视图的了——进度输入,进度输出——独立滚动条就是以这种方式驱动滚动框的。

在滑块之外点击轨道会把滑块的中心放到点击轨道的位置,并钳制到两端,从此按下并拖拽就继续下去——这是 SScrollBar 的行为。在这次与 5.8 源码核对之前,点击轨道会向指针方向翻过一个滑块长度(Unity 的行为),所以现有界面现在会跳到它们过去逐步移动的位置。

轨道和箭头都不是手柄导航落点或 Tab 停靠点,这也是 SScrollBar 的行为方式:轨道的 UUIScrollbar 初始时 bCanNavigateHere 为关闭(见其类注释),而箭头在 WireParts 中也同样设置。按键和摇杆改为通过聚焦的控件滚动滚动条所跟随的内容。

属性

NameTypeCategoryIn the details panelFrom BlueprintDescription
StyleFDreamScrollBarStyleScroll BaryesGetStyle / SetStyle此实例自身的外观。当 StyleSource 这样指定且项目中确实存在样式表时,项目样式表优先;项目中若没有样式表,这里就是实际生效的外观。滚动框会用其自身样式的 Bar 整体覆盖它,因此一次样式编辑就能同时装扮滚动框及其滚动条。
DirectionEUIScrollbarDirectionTypeScroll BaryesGetDirection / SetDirection它运行的方向,以及哪一端是零。用一个属性代替两个蓝图资源。
ValuefloatScroll BaryesGetValue / SetValue编写的输入位置;行为输出的镜像。作为属性,以便 .dui 和绑定可以看到它。
HandleSizefloatScroll BaryesGetHandleSize / SetHandleSize滑块覆盖轨道的比例,0 到 1——即所滚动内容的可见比例。附加到滚动视图的滚动条在每次推送时都会从视图重写此值;裸滚动条显示四分之一,这样它读起来像滚动条而不像填满的轨道。
bAlwaysShowScrollbarboolScroll BaryesGetAlwaysShowScrollbar / SetAlwaysShowScrollbar在没有可滚动内容时滚动条是否保持显示——即 UMG 的 bAlwaysShowScrollbar。
bAlwaysShowScrollbarTrackboolScroll BaryesGetAlwaysShowScrollbarTrack / SetAlwaysShowScrollbarTrack轨道是否在滚动条隐藏自身后继续存在——即 UMG 的 bAlwaysShowScrollbarTrack,也就是桌面滚动条在其滑块无可表达时留下的凹槽。
MinHandleLengthfloatScroll BaryesGetMinHandleLength / SetMinHandleLength滑块绘制长度的下限,以本地单位计。推送到行为中,行为会将其同时应用于绘制长度和拖拽缩放——若滑块的绘制长度大于其拖拽所用的比例,那么在长列表的整个过程中都会以错误的速度运行。
NavigationChangeIntervalfloatScroll BaryesGetNavigationChangeInterval / SetNavigationChangeInterval一次导航按下移动值的距离。
bShowArrowsboolScroll BaryesGetShowArrows / SetShowArrows轨道两端的步进按钮——即桌面滚动条的箭头。
ArrowStepSizefloatScroll BaryesGetArrowStepSize / SetArrowStepSize一次箭头点击移动值的距离,以整个范围的比例计。
AcceptedMouseButtonsint32Scroll BaryesGetAcceptedMouseButtons / SetAcceptedMouseButtons哪些鼠标按键可以移动此滚动条——基于 EDreamUIMouseButtonType 的位掩码,默认仅左键,这是 SScrollBar 的规则:其 OnMouseButtonDown 只响应 EKeys::LeftMouseButton,别的都不响应,因此在滑块上右键拖拽或在轨道上右键单击都会让滚动条保持原位,并继续传递给其后面的对象。两个箭头响应相同的按键。
TrackNodeTObjectPtr<UDreamWidget>Scroll Bar-read only
HandleNodeTObjectPtr<UDreamWidget>Scroll Bar-read only
BarBehaviourTObjectPtr<UUIScrollbar>Scroll Bar-read only
ArrowStartNodeTObjectPtr<UDreamWidget>Scroll Bar-read only步进按钮。存在于内置树中,直到 bShowArrows 唤醒它们之前一直休眠。
ArrowEndNodeTObjectPtr<UDreamWidget>Scroll Bar-read only
ArrowStartGlyphNodeTObjectPtr<UDreamWidget>Scroll Bar-read only
ArrowEndGlyphNodeTObjectPtr<UDreamWidget>Scroll Bar-read only
ArrowStartBehaviourTObjectPtr<UUIButton>Scroll Bar-read only
ArrowEndBehaviourTObjectPtr<UUIButton>Scroll Bar-read only

函数

函数类型描述
int32 GetAcceptedMouseButtons()pure获取接受的鼠标按键
bool GetAlwaysShowScrollbar()pure获取始终显示滚动条
bool GetAlwaysShowScrollbarTrack()pure获取始终显示滚动条轨道
float GetArrowStepSize()pure获取箭头步长
EUIScrollbarDirectionType GetDirection()pure获取方向
float GetHandleSize()pure获取滑块大小
float GetMinHandleLength()pure获取最小滑块长度
float GetNavigationChangeInterval()pure获取导航变更间隔
UUIScrollView* GetScrollView()pure获取滚动视图
bool GetShowArrows()pure获取显示箭头
FDreamScrollBarStyle GetStyle()pure按值而非按引用:UFUNCTION 的返回值必须是值,而样式是一个小结构体。
float GetValue()pure获取值
bool IsHorizontal()pure对 LeftToRight 和 RightToLeft 为 true。这里所有与轴相关的逻辑都会询问它。
void RefreshFromScrollView()callable从附加的视图获取位置和可见比例。每当它移动时都会为你调用。
void SetAcceptedMouseButtons(int32 InAcceptedMouseButtons)callable写入位掩码并立即将其推送到滚动条的行为上——下一次按下就会查询它。
void SetAlwaysShowScrollbar(bool bInAlwaysShow)callable设置始终显示滚动条
void SetAlwaysShowScrollbarTrack(bool bInAlwaysShow)callable设置始终显示滚动条轨道
void SetArrowStepSize(float InStep)callable设置箭头步长
void SetDirection(EUIScrollbarDirectionType InDirection)callable它的走向决定了整个矩形,所以这是一次样式推送,而不是字段写入。
void SetHandleSize(float InFraction)callable设置滑块大小
void SetMinHandleLength(float InLength)callable设置最小滑块长度
void SetNavigationChangeInterval(float InInterval)callable设置导航变更间隔
void SetScrollView(UUIScrollView* InView)callable用此滚动条双向驱动一个滚动视图。
void SetShowArrows(bool bInShowArrows)callable唤醒或休眠箭头,并重新内缩轨道,这就是为什么它是一次完整的样式推送。
void SetState(float InOffsetFraction, float InThumbSizeFraction, bool bInCollapseIfNecessary)callable一次调用同时设置位置和可见比例——UMG 的 SetState,也是滚动视图实际推送的形式:这两个数字总是同时移动,而逐个写入它们会让滑块为一次变更布局两次。
void SetStyle(FDreamScrollBarStyle InStyle)callable替换整个外观并重新推送——粗细和边距是几何,不是涂装。
void SetValue(float InValue)callable设置值
void SetValueWithoutNotify(float InValue)callable用于跟随者:移动滑块而不通知任何人,因此双向链接不会形成环。

事件

事件签名描述
OnValueChangedvoid DreamScrollBarValueChangedEvent__DelegateSignature(float Value)从行为重新广播,因此消费方绑定的是控件,而不是它的某个部分。
OnValueChangedBPvoid DreamScrollBarValueChangedEvent__DelegateSignature(float Value)<-> 约定:双向绑定会针对这个确切的名称合成它们的反向路由,因此值控件会将其与自身声明的事件一起携带。与它们一同触发。

与 UMG 对比

UMG 类中每个面向蓝图的成员,以及它去了哪里。adopt:同名,同义。map:在这里换了个名字或换到了另一个类型上。reject:故意缺失,并给出原因。

UMG成员状态此处备注
UScrollBarWidgetStylemapStyleFDreamScrollBarStyle,针对项目样式表解析。Get/SetStyle。
UScrollBarbAlwaysShowScrollbaradoptbAlwaysShowScrollbar默认 true,而不是 UMG 的 false:此滚动条始终绘制它所放置进去的任何内容,而一个在其列表刚放下时就消失的滚动条的屏幕,会是一个在所有人眼皮底下改变了的布局。只有附加到滚动视图的滚动条才能隐藏自身——单独的滚动条是一个值控件,没有“无可滚动内容”的状态。
UScrollBarbAlwaysShowScrollbarTrackadoptbAlwaysShowScrollbarTrack在滑块休眠时让滚动条保持在屏幕上。仅在 bAlwaysShowScrollbar 关闭且附加视图适配时才会被查询。
UScrollBarOrientationmapDirectionEUIScrollbarDirectionType,它说明它的走向以及哪一端为零——UMG 的 EOrientation 有两个答案,而它有四个。Get/SetDirection。
UScrollBarThicknessmapFDreamScrollBarStyle::Thickness在样式中,因为它就是绘制滚动条的来源。一个 float:滚动条沿自身轴只有一个粗细,而它的长度是它所滚动的任何内容。
UScrollBarPaddingmapFDreamScrollBarStyle::BarPadding新样式字段,默认 FMargin(0) = 每个滚动条一直以来绘制的结果。作用于滚动条的矩形,而不是轨道的矩形,因此轨道仍然能够到达滚动条所跨越的两端。
UScrollBarSetStateadoptSetState一次调用同时设置位置和可见比例,这正是滚动视图实际推送的形式:逐个写入它们会让滑块为一次变更布局两次。指针只有在 AcceptedMouseButtons 中的鼠标按键下才会移动位置——默认只有左键,这是 SScrollBar 的规则(它的 OnMouseButtonDown 测试 EKeys::LeftMouseButton);AcceptedMouseButtons 是此控件自己的旋钮,就像 UDreamButton 上那样,而触摸始终算数。在滑块之外的轨道上点击会将滑块的中心放在那里,就像 SScrollBar 的 ExecuteOnUserScrolled 那样,而不是翻页。

本页目录