DreamGUI
类参考

UDreamEditableText

UDreamEditableText

继承自 UDreamTextInput。

声明于 Public/Controls/DreamEditableText.h。

一个没有边框的文本字段:即 UMG 的 EditableText,而 Native.TextInput 则是它的 EditableTextBox。

UMG 为一个字段提供了四个类——EditableText、EditableTextBox、MultiLineEditableText、 MultiLineEditableTextBox——而它划分它们所依据的两个维度是“它是否绘制边框”以及“它是否接受多行”。本库早已将第二个维度作为属性提供(UDreamTextInput::bMultiLine),所以真正缺失的只有第一个:一个在文本后方不绘制任何内容的字段。

所以这就是一个不绘制外观的 UDreamTextInput,仅此而已。每一个属性、事件、验证器和按键规则都保持原样,这正是重点所在:Native.TextInput 的含义没有改变,想要带边框字段的作者只需像以前一样书写即可。

“没有边框”的确切含义,因为含糊其辞的回答正是控件最终变成一个悬停时仍会着色的不可见边框的原因:外观的笔刷被清空,并且行为的全部五种状态颜色都被推为透明——因此没有静止填充、没有悬停着色,也没有聚焦着色。光标和选区高亮才是显示该字段处于活动状态的东西,这也是 UMG 的 EditableText 所做的。样式的内边距、字体、文本颜色和光标颜色仍然全部适用:无边框字段仍然是一个有样式的字段。

与 UMG 的对比

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

UMG成员状态此处说明
UEditableTextTextmapText继承自 UDreamTextInput,无边框字段是它的子类,只是关闭了外观。FString;参见 EditableTextBox.json。
UEditableTextHintTextmapPlaceholderGetHintText/SetHintText 转发到它。
UEditableTextWidgetStylemapStyle与带边框字段相同的 FDreamTextInputStyle:无边框的版本通过清空外观来区分,而不是通过使用不同的样式。
UEditableTextIsReadOnlymapbReadOnly
UEditableTextIsPasswordmapDisplayTypeGet/SetIsPassword 是在它之上的布尔拼写。
UEditableTextMinimumDesiredWidthadoptMinimumDesiredWidth
UEditableTextIsCaretMovedWhenGainFocusmapbIsCaretMovedWhenGainFocus
UEditableTextSelectAllTextWhenFocusedmapbSelectAllWhenActivateInput本库对同一时刻的既有拼写。
UEditableTextRevertTextOnEscapemapbRevertTextOnEscape
UEditableTextClearKeyboardFocusOnCommitmapbClearKeyboardFocusOnCommit默认为 TRUE,而 UMG 的为 false;参见 EditableTextBox.json。
UEditableTextSelectAllTextOnCommitmapbSelectAllTextOnCommit
UEditableTextAllowContextMenumapbAllowContextMenu
UEditableTextKeyboardTypeadoptKeyboardType
UEditableTextVirtualKeyboardOptionsadoptVirtualKeyboardOptions没有蓝图访问器;FVirtualKeyboardOptions 没有 BlueprintType,与 UMG 中完全一样。
UEditableTextVirtualKeyboardTriggeradoptVirtualKeyboardTrigger
UEditableTextVirtualKeyboardDismissActionadoptVirtualKeyboardDismissAction
UEditableTextJustificationadoptJustificationEDreamUITextParagraphHorizontalAlign,本库唯一的段落对齐枚举。
UEditableTextOverflowPolicymapOverflowPolicyETextOverflowPolicy,仅在无人编辑时起作用——关于为何编辑期间由行模式掌管段落的溢出,参见 EditableTextBox.json。默认裁剪。
UEditableTextShapedTextOptionsmapTextFlowDirectionEDreamTextFlowDirection 就是 UMG 的 TextFlowDirection;此处的 TextShapingMethod 是编译期决定的(WITH_HARFBUZZ),而非按控件设置。
UEditableTextOnTextChangedmapOnTextChanged携带 FString。
UEditableTextOnTextCommittedmapOnTextCommitted没有 UMG 的 ETextCommit;参见 EditableTextBox.json。
UEditableTextGetTextmapGetText返回 FString。
UEditableTextSetTextmapSetText接收 FString。
UEditableTextSetIsPasswordadoptSetIsPassword
UEditableTextGetHintTextadoptGetHintText转发到 GetPlaceholder。
UEditableTextSetHintTextadoptSetHintText转发到 SetPlaceholder。
UEditableTextSetMinimumDesiredWidthadoptSetMinimumDesiredWidthSetMinDesiredWidth 也在此处,是 UMG 对它的另一种拼写,转发到同一实现。
UEditableTextSetIsReadOnlyadoptSetIsReadOnly
UEditableTextGetJustificationadoptGetJustification
UEditableTextSetJustificationadoptSetJustification
UEditableTextSetTextOverflowPolicyadoptSetTextOverflowPolicy转发到 UUITextInput::SetOverflowPolicy,这是段落溢出的唯一写入方。
UEditableTextGetFontmapFDreamTextInputStyle::Font此处的字体是字体数据资产(UDreamUIFontData_BaseObject),而不是 FSlateFontInfo:大小是 Style.FontSize,轮廓在文本样式中,这三者合起来才是 UMG 打包进一个结构体的内容。GetFont/SetFont 读写 Style.Font,因此字体样式像其余外观一样遵循 StyleSource。
UEditableTextSetFontmapFDreamTextInputStyle::Font写入 Style.Font 并重新推送。Null 表示“让段落保持它当前的字体”,这是如今存在的每个字段的情况——样式只会添加字体样式,无法将其移除。
UEditableTextSetFontMaterialmapUDreamText::SetOverrideMaterial整个段落只有一个材质,而不是每个字体外观一个,因为这才是文本渲染器所接受的。控件将其(SetFontMaterial/GetFontMaterial)仅转发到 VALUE 的段落上——为密码字段字形准备的材质没有理由出现在“Enter your name”这些字上。
UEditableTextSetFontOutlineMaterialreject此处的轮廓和字形外观由一个 SDF 材质的单次渲染绘制——轮廓是其中的距离阈值,而不是用其自身材质进行的第二次绘制。不存在可供分配材质的单独通道。
UEditableTextToggleVirtualKeyboardmapUUITextInput::ActivateInput在此处升起键盘就是开始编辑:ActivateInput 会召唤它(受 VirtualKeyboardTrigger 约束),而 DeactivateInput 会将其收起。不存在独立于需要它的编辑之外可切换的键盘。
UEditableTextEnableIntegratedKeyboardrejectSlate 的集成键盘是一个视口内键盘控件,由平台层为游戏主机替换进来。本库在世界空间中绘制自己的 UI,没有这样的控件,也没有提供它的平台途径。
UEditableTextFontFacesLoadingPaintPolicyreject没有需要绕过的异步字体外观加载:本库从自己的字体数据资产进行渲染。
UEditableTextOnAllFontFacesFinishLoadingreject原因与 FontFacesLoadingPaintPolicy 相同。

本页目录