DreamGUI
类参考

UDreamSpinBox

UDreamSpinBox

继承自 UDreamUIControl。

声明于 Public/Controls/DreamSpinBox.h。

一个层级是代码、而非资源的数字输入框。

USpinBox 的务实内核:一个数字、一个范围、一个步进——以三部分组成的行来表示,[-] 输入字段 [+],因为这一行可以用库中已有的东西构建出来。步进面承载 UIButton 行为,输入字段承载 UUITextInput,以文化无关文本托管该值,而 CONTROL 拥有这个数字:按钮和提交的文本是通往同一条钳制-赋值-推送-广播道路的两条路,因此输入字段、属性和事件永远不会对这个值是什么产生分歧。

向各部分推送的每一次都是 WithoutNotify——写入作者状态不是用户编辑—— 而 OnValueChanged 恰好在钳制后的值真正改变时触发。

拖拽擦除(DRAG TO SCRUB)是 USpinBox 的另一半,最终它并不需要自己的捕获管线:UUITextInput 在未被编辑时已经会把拖拽向上传递(它的 OnPointerBeginDrag 在 bInputActive 为假时返回“冒泡”),因此从空闲字段开始的拖拽会作为该控件自身的 NativeOnBeginDrag 到达这里,而在玩家正在编辑的字段内开始的拖拽则仍归文本选择所有。这恰恰是 SSpinBox 遵循的规则——点击输入,拖拽擦除——通过追问谁已经拥有这个手势、而不是发明一种模式来达成。

擦除在控件自身宽度上扫过 MinSliderValue..MaxSliderValue(默认是硬范围),由 SliderExponent 弯曲,使大范围在一端附近仍能精细操作。它从拖拽被识别的位置开始计数,而不是从按下开始:把按下变成拖拽的那段移动不会移动任何值,与 SSpinBox 一致,因此值不会在擦除开始的瞬间因拖拽阈值而跳变。

方向键可以步进它,正如 SSpinBox::OnKeyDown 所做的那样:只要焦点在控件内任意处且输入字段未被编辑,上键和右键增加一个步进,下键和左键减少一个,立即提交。步进为 StepSize,无论按住哪个修饰键;当 StepSize 为零时,使用 SSpinBox 的默认步进 ——在十个或更小的拖拽范围内为十分之一,在更大范围内为一——再乘以 Shift 的十倍、Shift+Alt 的百倍、Ctrl 的十分之一或 Ctrl+Alt 的百分之一。步进后的值保持在拖拽扫过的范围内,并落在 StepSize 网格上。这四个键在控件拥有焦点时归控件所有:它们不会像在 UMG 中那样把焦点移交到相邻控件。手柄的十字键不在其中,仍然用于导航,而在正在编辑的字段中,方向键归字段所有,用于移动其插入符。

/Script/DreamGUIControls.DreamSpinBox Count {
    Value = 5
    MaxValue = 10
    OnValueChanged -> HandleCount
}

属性

名称类型类别在细节面板中来自蓝图描述
StyleFDreamSpinBoxStyleSpin BoxyesGetStyle / SetStyle此实例自身的观感。当 StyleSource 如此表明且确实存在样式表时,项目样式表优先;如果项目中没有任何样式表,那么这就是实际生效的观感——正因如此它保持可编辑,而不是被枚举所限制:旧的编辑条件恰好把驱动该控件的那些值置灰了。
ValuefloatSpin BoxyesGetValue / SetValue写入的作者值;此后归控件所有。作为属性,以便 .dui 和绑定能看到它。
MinValuefloatSpin BoxyesGetMinValue / SetMinValue
MaxValuefloatSpin BoxyesGetMaxValue / SetMaxValue
StepSizefloatSpin BoxyesGetStepSize / SetStepSize点击一次步进面或按一次方向键,在钳制之前所增加或减少的量。UMG 称之为 Delta,与 Delta 一样,零会让方向键采用 SSpinBox 的默认步进,由修饰键按比例缩放(见类注释)。
MinSliderValuefloatSpin BoxyesGetMinSliderValue / SetMinSliderValue
MaxSliderValuefloatSpin BoxyesGetMaxSliderValue / SetMaxSliderValue
SliderExponentfloatSpin BoxyesGetSliderExponent / SetSliderExponent拖拽距离如何弯曲成值——UMG 的 SliderExponent。一为线性;更大的数值会把行程的更多部分给到范围的低端,这正是跨越多个数量级的范围在其底部可用所必需的。
bEnableSliderboolSpin BoxyesGetEnableSlider / SetEnableSlider拖拽字段是否擦除值——UMG 的 EnableSlider。
bAlwaysUsesDeltaSnapboolSpin BoxyesGetAlwaysUsesDeltaSnap / SetAlwaysUsesDeltaSnap每个值,无论以何种方式到达,都吸附到 StepSize 的倍数——UMG 的 AlwaysUsesDeltaSnap。关闭(默认)时,只有步进面和方向键以整步移动——方向键会落到 StepSize 网格上,正如 SSpinBox 把方向键提交吸附到 Delta——而拖拽或输入的值则不受限。
MinFractionalDigitsint32Spin BoxyesGetMinFractionalDigits / SetMinFractionalDigits数字如何被拼写——UMG 的 MinFractionalDigits / MaxFractionalDigits。
MaxFractionalDigitsint32Spin BoxyesGetMaxFractionalDigits / SetMaxFractionalDigits
bClearKeyboardFocusOnCommitboolSpin BoxyesGetClearKeyboardFocusOnCommit / SetClearKeyboardFocusOnCommit值提交后停止编辑字段——UMG 的 ClearKeyboardFocusOnCommit。
bSelectAllTextOnCommitboolSpin BoxyesGetSelectAllTextOnCommit / SetSelectAllTextOnCommit值提交后选中整个数字,随时可被覆盖输入。此处为 TRUE,而 UMG 的为 false:数字输入框是一个条目接一个条目地填写的,而这正是它一贯的做法。
JustificationEDreamUITextParagraphHorizontalAlignSpin BoxyesGetJustification / SetJustification数字横跨字段的对齐方式——UMG 的 Justification。默认居中,这正是内置树一贯放置它的位置。
MinDesiredWidthfloatSpin BoxyesGetMinDesiredWidth / SetMinDesiredWidth控件向内容自适应父级请求宽度时的宽度下限——UMG 的 MinDesiredWidth。零表示没有意见,这也是当今存在的每个数字输入框的情况。
KeyboardTypeTEnumAsByte<EVirtualKeyboardType::Type>Spin BoxyesGetKeyboardType / SetKeyboardType键入输入字段召唤哪个虚拟键盘。默认根据字段的类型推导。
VirtualKeyboardDismissActionEVirtualKeyboardDismissActionSpin BoxyesGetVirtualKeyboardDismissAction / SetVirtualKeyboardDismissAction关闭该键盘意味着什么——直接推送到字段的行为。
DecrementNodeTObjectPtr<UDreamWidget>Spin Box-read only
DecrementLabelNodeTObjectPtr<UDreamWidget>Spin Box-read only
FieldNodeTObjectPtr<UDreamWidget>Spin Box-read only
ClipNodeTObjectPtr<UDreamWidget>Spin Box-read only
ValueTextNodeTObjectPtr<UDreamWidget>Spin Box-read only
IncrementNodeTObjectPtr<UDreamWidget>Spin Box-read only
IncrementLabelNodeTObjectPtr<UDreamWidget>Spin Box-read only
DecrementBehaviourTObjectPtr<UUIButton>Spin Box-read only
IncrementBehaviourTObjectPtr<UUIButton>Spin Box-read only
InputBehaviourTObjectPtr<UUITextInput>Spin Box-read only

函数

函数类型描述
void ClearMaxSliderValue()callable清除最大滑块值
void ClearMaxValue()callable清除最大值
void ClearMinSliderValue()callable拖拽回退到 VALUE 范围,这正是滑块边界未设置时的含义。
void ClearMinValue()callable移除下限:值因此可以低至 float 自身的下限。
void Decrement()callable向下一步,并夹紧——即 [-] 面的行为,无需指针即可调用。
bool GetAlwaysUsesDeltaSnap()pure获取始终使用增量吸附
bool GetClearKeyboardFocusOnCommit()pure获取提交时清除键盘焦点
float GetDelta()pureStepSize 在 UMG 中的名称。一份实现,两种拼写,没有第二个真相。
bool GetEnableSlider()pure获取启用滑块
UDreamUIFontData_BaseObject* GetFont()pure绘制数字所用的字体——即 UMG 的 Font,减去 FSlateFontInfo 额外打包的内容:大小是 Style.FontSize,轮廓属于文本样式。读写 Style.Font,因此它像外观的其余部分一样遵循 StyleSource,null 意味着“让段落保持其现有字体”,也就是当今所有数值框的行为。
EDreamUITextParagraphHorizontalAlign GetJustification()pure获取对齐方式
TEnumAsByte<EVirtualKeyboardType::Type> GetKeyboardType()pure获取键盘类型
int32 GetMaxFractionalDigits()pure获取最大小数位数
float GetMaxSliderValue()pure获取最大滑块值
float GetMaxValue()pure获取最大值
float GetMinDesiredWidth()pure获取最小期望宽度
int32 GetMinFractionalDigits()pure获取最小小数位数
float GetMinSliderValue()pure获取最小滑块值
float GetMinValue()pureRANGE,以 UMG 的形式:边界是一个值加上是否存在边界。
bool GetSelectAllTextOnCommit()pure获取提交时全选文本
float GetSliderExponent()pure获取滑块指数
float GetSliderMaxValue()pure获取滑块最大值
float GetSliderMinValue()pureDRAG 所扫过范围的下限:覆盖时是 MinSliderValue,否则是 MinValue。
float GetStepSize()pure获取步长
FDreamSpinBoxStyle GetStyle()pure获取样式
float GetValue()pure获取值
EVirtualKeyboardDismissAction GetVirtualKeyboardDismissAction()pure获取虚拟键盘关闭操作
bool HasFiniteSliderRange()pure拖拽是否有两个真实端点可供扫过。开放范围不可拖动。
void Increment()callable向上一步,并夹紧——即 [+] 面的行为,无需指针即可调用。
bool IsSliderMoving()pure当前是否正在进行拖拽。
void SetAlwaysUsesDeltaSnap(bool bInAlwaysUsesDeltaSnap)callable启用它会吸附控件当前已持有的值,而不仅仅是下一个值。
void SetClearKeyboardFocusOnCommit(bool bInClearKeyboardFocusOnCommit)callable设置提交时清除键盘焦点
void SetDelta(float InDelta)callable设置增量
void SetEnableSlider(bool bInEnableSlider)callable设置启用滑块
void SetFont(UDreamUIFontData_BaseObject* InFont)callable设置字体
void SetJustification(EDreamUITextParagraphHorizontalAlign InJustification)callable设置对齐方式
void SetKeyboardType(TEnumAsByte<EVirtualKeyboardType::Type> InKeyboardType)callable设置键盘类型
void SetMaxFractionalDigits(int32 InMaxFractionalDigits)callable设置最大小数位数
void SetMaxSliderValue(float InMaxSliderValue)callable设置最大滑块值
void SetMaxValue(float InMaxValue)callable设置最大值
void SetMinDesiredWidth(float InMinDesiredWidth)callable设置最小期望宽度
void SetMinFractionalDigits(int32 InMinFractionalDigits)callable重新拼写已经显示的数字:没人应用的位数计数不算格式。
void SetMinSliderValue(float InMinSliderValue)callable设置最小滑块值
void SetMinValue(float InMinValue)callable声明下限,并将当前值夹紧到其中。
void SetSelectAllTextOnCommit(bool bInSelectAllTextOnCommit)callable设置提交时全选文本
void SetSliderExponent(float InSliderExponent)callable设置滑块指数
void SetStepSize(float InStepSize)callable设置步长
void SetStyle(FDreamSpinBoxStyle InStyle)callable设置样式
void SetValue(float InValue)callable夹紧到 [MinValue, MaxValue];仅当夹紧后的值不同时才广播。
void SetVirtualKeyboardDismissAction(EVirtualKeyboardDismissAction InDismissAction)callable设置虚拟键盘关闭操作

事件

事件签名描述
OnValueChangedvoid DreamSpinBoxValueChangedEvent__DelegateSignature(float Value)当夹紧后的值实际发生变化时触发,无论由哪条途径改变。
OnValueCommittedvoid DreamSpinBoxValueChangedEvent__DelegateSignature(float Value)当值被 COMMITTED(提交)时触发——键入的条目被提交、步进面被点击、拖拽被放开——与拖拽经过的每个中间值不同。
OnBeginSliderMovementvoid DreamSpinBoxValueChangedEvent__DelegateSignature(float Value)拖拽开始。与 OnEndSliderMovement 一起围绕一串 OnValueChanged。
OnEndSliderMovementvoid DreamSpinBoxValueChangedEvent__DelegateSignature(float Value)
OnValueChangedBPvoid DreamSpinBoxValueChangedEvent__DelegateSignature(float Value)<-> 约定:双向绑定针对这个确切名称合成其反向路径,因此值控件将其与它公开的事件一起携带。与它们同时触发。

与 UMG 对比

UMG 类的每个面向蓝图的成员,以及它的去向。adopt:同名同义。map:在此处换了名称或换到另一类型上。reject:有意缺失,并附原因。

UMG成员状态此处说明
USpinBoxValueadoptValue一条钳制-赋值-推送-广播的通路,因此属性、字段和事件永远不会对数字产生分歧。
USpinBoxWidgetStylemapStyleFDreamSpinBoxStyle:两个步进面的颜色集、字段的颜色集,外加尺寸。与 FSpinBoxStyle 角色相同,形态不同。
USpinBoxMinFractionalDigitsadoptMinFractionalDigits该 setter 会重新拼写已经显示的数字:没人应用的位数不算格式。
USpinBoxMaxFractionalDigitsadoptMaxFractionalDigits
USpinBoxbAlwaysUsesDeltaSnapadoptbAlwaysUsesDeltaSnap开启它会重新吸附控件当前持有的值,而不只是下一个值。
USpinBoxbEnableSlideradoptbEnableSlider在拖动过程中关闭它会结束该次拖动并提交,而不是留下一个没人会完成的手势。
USpinBoxDeltamapStepSize本库现有的拼写,保留是因为 .dui 以此书写。GetDelta/SetDelta 沿用 UMG 名称并转发到同一字段。
USpinBoxSliderExponentadoptSliderExponentSetter 将其钳制为远离零,与拖动运算所施加的下限相同。
USpinBoxFontmapFDreamSpinBoxStyle::Font一个字体数据资产,而不是 FSlateFontInfo:大小由 Style.FontSize 决定,描边属于文本样式。GetFont/SetFont 读写它。两个步进字形使用同一个——与旁边数字不同字体的减号是共享样式最不该产生的东西。为空时段落保持其现有字体。
USpinBoxJustificationadoptJustificationEDreamUITextParagraphHorizontalAlign,本库唯一的段落对齐枚举。默认 Center,内置树一直把数字放在那里。
USpinBoxMinDesiredWidthadoptMinDesiredWidth控件自身宽度的下限,也是值的段落向内容尺寸父级请求时的下限。0 = 不作要求。
USpinBoxKeyboardTypeadoptKeyboardType推送到键入字段的 UUITextInput。默认 Number,这是该字段已从其 DecimalNumber 输入类型推导出的键盘——同一个键盘,只是明说了。
USpinBoxVirtualKeyboardDismissActionadoptVirtualKeyboardDismissAction推送到字段的行为;默认 TextCommitOnDismiss,也就是它原本的做法。
USpinBoxClearKeyboardFocusOnCommitmapbClearKeyboardFocusOnCommit带 b 前缀。默认 false,与 UMG 的相同。
USpinBoxSelectAllTextOnCommitmapbSelectAllTextOnCommit默认 TRUE,而 UMG 的是 false:旋转框是一个条目接一个条目地填写的,而这正是它一直以来的做法。
USpinBoxForegroundColormapFDreamSpinBoxStyle::TextColor外观存放在样式结构体中;值文本与两个步进字形共享它。
USpinBoxOnValueChangedadoptOnValueChanged在拖动经过的每个值上触发。
USpinBoxOnValueCommittedmapOnValueCommitted同一时刻;只携带值,不带 UMG 的 ETextCommit——为何此处不使用该枚举见 EditableTextBox.json。
USpinBoxOnBeginSliderMovementadoptOnBeginSliderMovement携带拖动起始时的值,而 UMG 的什么都不携带。在识别到拖动时触发,此前的移动不改变值,如同 SSpinBox。
USpinBoxOnEndSliderMovementadoptOnEndSliderMovement
USpinBoxGetValueadoptGetValue
USpinBoxSetValueadoptSetValue
USpinBoxGetMinFractionalDigitsadoptGetMinFractionalDigits
USpinBoxSetMinFractionalDigitsadoptSetMinFractionalDigits
USpinBoxGetMaxFractionalDigitsadoptGetMaxFractionalDigits
USpinBoxSetMaxFractionalDigitsadoptSetMaxFractionalDigits
USpinBoxGetAlwaysUsesDeltaSnapadoptGetAlwaysUsesDeltaSnap
USpinBoxSetAlwaysUsesDeltaSnapadoptSetAlwaysUsesDeltaSnap
USpinBoxGetDeltaadoptGetDelta转发到 StepSize。
USpinBoxSetDeltaadoptSetDelta转发到 SetStepSize,后者在增量吸附开启时重新吸附持有的值。
USpinBoxGetMinValueadoptGetMinValue当边界被关闭时返回 float 的下限,与 UMG 的完全一致,因为那是所有调用方随后用来钳制的值。
USpinBoxSetMinValueadoptSetMinValue声明边界并将持有的值钳制其中,因此一个在值下方移动的范围无法把它留在外面。
USpinBoxClearMinValueadoptClearMinValuebOverride_MinValue 默认 TRUE,与 UMG 的不同:现存的每个旋转框都被钳制在 0..100 中,无边界默认值会改变它们全部。
USpinBoxGetMaxValueadoptGetMaxValue
USpinBoxSetMaxValueadoptSetMaxValue
USpinBoxClearMaxValueadoptClearMaxValue
USpinBoxGetMinSliderValueadoptGetMinSliderValue所声明的拖动下限,若没有则为 float 的下限。GetSliderMinValue 是有效值,会回退到值范围。
USpinBoxSetMinSliderValueadoptSetMinSliderValue
USpinBoxClearMinSliderValueadoptClearMinSliderValue拖动回退到值范围,这就是在滑动条边界出现之前它的做法。
USpinBoxGetMaxSliderValueadoptGetMaxSliderValue
USpinBoxSetMaxSliderValueadoptSetMaxSliderValue
USpinBoxClearMaxSliderValueadoptClearMaxSliderValue
USpinBoxSetForegroundColormapFDreamSpinBoxStyle::TextColor通过 SetStyle 或项目表进行更改;第二个 setter 写入内联结构体在 StyleSource 为表时会被静默忽略。
USpinBoxMinValueadoptMinValue与其旁的 bOverride_MinValue 配对,与 UMG 使用的是同一对。默认勾选,因为每个现存的旋转框都是有边界的。
USpinBoxMaxValueadoptMaxValue
USpinBoxMinSliderValueadoptMinSliderValue默认不勾选:除非有人收窄,拖动会扫过值范围。
USpinBoxMaxSliderValueadoptMaxSliderValue

本页目录