类参考
UDreamTextInput
UDreamTextInput
继承自 UDreamUIControl。
声明于 Public/Controls/DreamTextInput.h。
一个文本字段,其层级结构是代码,而不是资产。
两个预设蓝图都带有相同的四个节点——一个背景、一个占位符,以及一个容纳文本的裁剪区域——外加一个属性 bMultiLine,而预设是两个资产。裁剪区域不是装饰:字段的文本经常比字段本身更宽,没有裁剪,溢出部分会绘制到旁边的任何东西上。
UUITextInput 完成所有困难的工作(光标、选择、输入法、按键路由);这个类构建它所工作的几何体,并把各个部分交给它。
Properties
| Name | Type | Category | In the details panel | From Blueprint | Description |
|---|---|---|---|---|---|
Style | FDreamTextInputStyle | Text Input | yes | GetStyle / SetStyle | 此实例自身的外观。当 StyleSource 如此指明且项目中确实存在样式表时,项目样式表胜出;当项目中没有样式表时,这就是生效的外观——这就是为什么它保持可编辑,而不是受枚举限制:旧的编辑条件恰恰把驱动控件的那些值置灰了。 |
Text | FString | Text Input | yes | GetText / SetText | 编写的文本输入;字段输出的镜像。作为属性,.dui 和绑定可以看到它。 |
Placeholder | FText | Text Input | yes | GetPlaceholder / SetPlaceholder | 当 Text 为空且字段未被编辑时显示。 |
bMultiLine | bool | Text Input | yes | GetMultiLine / SetMultiLine | 一个属性,而预设是两个资产。 |
InputType | EUITextInputType | Text Input | yes | GetInputType / SetInputType | 该字段接受哪些字符。Standard 接受任何字符。 |
CustomValidation | TObjectPtr<UDreamTextInputCustomValidation> | Text Input | yes | GetCustomValidation / SetCustomValidation | 仅当 InputType 为 Custom 时才被参考。 |
DisplayType | EUITextInputDisplayType | Text Input | yes | GetDisplayType / SetDisplayType | Password 将每个字符绘制为 PasswordChar;它不改变字段接受的内容。 |
PasswordChar | FString | Text Input | yes | GetPasswordChar / SetPasswordChar | 密码字段绘制的字符。一个字符;更长的内容保留其第一个字符。 |
bReadOnly | bool | Text Input | yes | GetIsReadOnly / SetIsReadOnly | 可选择且可复制,但不可编辑。UMG 的 IsReadOnly。 |
MaxLength | int32 | Text Input | yes | GetMaxLength / SetMaxLength | 字段能容纳的最长文本。0 表示无限制。 |
IgnoreKeys | TArray<FKey> | Text Input | yes | GetIgnoreKeys / SetIgnoreKeys | 字段在被编辑时不得吞掉的按键——比如方向键,手柄的方向键应当离开字段。Tab 无需列出:它会结束编辑并自行继续(参见 bTabTypesTabCharacter)。 |
MultiLineSubmitFunctionKeys | TArray<FKey> | Text Input | yes | GetMultiLineSubmitFunctionKeys / SetMultiLineSubmitFunctionKeys | 在多行模式下,按住其中一个键时按 Enter 会提交,而不是添加一行。 |
bTabTypesTabCharacter | bool | Text Input | yes | GetTabTypesTabCharacter / SetTabTypesTabCharacter | 在多行模式下,Tab 输入一个制表符,Ctrl+Tab 离开字段——适用于笔记或代码框。关闭(默认)时,Tab 像单行字段那样离开:编辑结束,下一个控件获得焦点,如同浏览器的 textarea 那样。参见 UUITextInput::bTabTypesTabCharacter。 |
bSelectAllWhenActivateInput | bool | Text Input | yes | GetSelectAllWhenActivateInput / SetSelectAllWhenActivateInput | 当字段开始被编辑时选中整个值。UMG 的 SelectAllTextWhenFocused。 |
bAutoActivateInputWhenNavigateIn | bool | Text Input | yes | GetAutoActivateInputWhenNavigateIn / SetAutoActivateInputWhenNavigateIn | 当方向键或手柄落到字段上时立即开始编辑。当 UDreamGUISettings::bTabStartsTextEdit 时,Tab 无论如何都会启动它。 |
bSubmitWhenDeactivate | bool | Text Input | yes | GetSubmitWhenDeactivate / SetSubmitWhenDeactivate | 当编辑在没有按 Enter 的情况下结束时提交值——点击离开、导航离开。 |
bAllowContextMenu | bool | Text Input | yes | GetAllowContextMenu / SetAllowContextMenu | 右键单击 / 长按 / 手柄的 Menu 按钮上的编辑菜单。UMG 的 AllowContextMenu。 |
bRevertTextOnEscape | bool | Text Input | yes | GetRevertTextOnEscape / SetRevertTextOnEscape | Escape / Back 会丢弃编辑而不是保留它——UMG 的 RevertTextOnEscape。编辑开始时的那段文本会被放回(OnTextChanged 会为它触发),然后提交一次——OnTextCommitted 和 OnSubmitted 携带恢复的文本,正如 UMG 提交一次还原那样——然后编辑结束。没有改变任何内容的编辑会还原并提交空内容。关闭时,如同 UMG 的以及此字段在此开关存在之前的行为。 |
bClearKeyboardFocusOnCommit | bool | Text Input | yes | GetClearKeyboardFocusOnCommit / SetClearKeyboardFocusOnCommit | Enter 提交后停止编辑——UMG 的 ClearKeyboardFocusOnCommit。 |
bSelectAllTextOnCommit | bool | Text Input | yes | GetSelectAllTextOnCommit / SetSelectAllTextOnCommit | 在保持编辑继续的提交后选中值——UMG 的 SelectAllTextOnCommit。 |
bIsCaretMovedWhenGainFocus | bool | Text Input | yes | GetIsCaretMovedWhenGainFocus / SetIsCaretMovedWhenGainFocus | 获得编辑是否将光标移动到末尾——UMG 的 IsCaretMovedWhenGainFocus。 |
Justification | EDreamUITextParagraphHorizontalAlign | Text Input | yes | GetJustification / SetJustification | 输入的文本如何横向分布在字段上——UMG 的 Justification。 |
MinimumDesiredWidth | float | Text Input | yes | GetMinimumDesiredWidth / SetMinimumDesiredWidth | 控件向内容大小父级请求宽度的下限——UMG 的 MinimumDesiredWidth。零表示没有意见,这是当前存在的每个字段的情况。 |
TextFlowDirection | EDreamTextFlowDirection | Text Input | yes | GetTextFlowDirection / SetTextFlowDirection | 段落的阅读方向——UMG 的 ShapedTextOptions 中在这里有意义的那一半。 |
Language | FString | Text Input | yes | GetLanguage / SetLanguage | 字段输入所用的语言,以文化名称表示("ja"、"zh-Hans");空表示游戏的语言。选择字体为其准备的备用字体,以及每种语言下脚本绘制的形式——参见 UDreamText::Language。与流动方向一样,它是整个字段的:占位符和错误消息也会读取它。 |
TabSize | float | Text Input | yes | GetTabSize / SetTabSize | 以空格为单位的制表位,从行的起始边缘算起——CSS tab-size,浏览器中的 8。 |
TextJustify | EDreamTextJustify | Text Input | yes | GetTextJustify / SetTextJustify | 两端对齐的行在哪里获得额外空间。仅在 Justification 为 Justify 时读取。 |
LastLineAlign | EDreamTextLastLineAlign | Text Input | yes | GetLastLineAlign / SetLastLineAlign | 两端对齐段落最后一行,以及由换行符结束的一行,如何对齐。仅在 Justification 为 Justify 时读取。 |
SmallTextRaster | EDreamTextSmallTextRaster | Text Input | yes | GetSmallTextRaster / SetSmallTextRaster | 关闭时,字段的文本在任何大小下都保持在其字体的距离场上;参见 UDreamText::SmallTextRaster。 |
OverflowPolicy | ETextOverflowPolicy | Text Input | yes | GetTextOverflowPolicy / SetTextOverflowPolicy | 当值对框来说太长时,在无人编辑它的情况下会发生什么——UMG 的 OverflowPolicy。 |
KeyboardType | TEnumAsByte<EVirtualKeyboardType::Type> | 文本输入 | 是 | GetKeyboardType / SetKeyboardType | 移动平台唤起哪种虚拟键盘。默认从 InputType 推导。 |
VirtualKeyboardOptions | FVirtualKeyboardOptions | 文本输入 | 是 | - | 该键盘的平台选项——自动更正以及平台后续添加的内容。 |
VirtualKeyboardTrigger | EVirtualKeyboardTrigger | 文本输入 | 是 | GetVirtualKeyboardTrigger / SetVirtualKeyboardTrigger | 哪些激活方式会将其唤起。OnAllFocusEvents 保留该字段原有的行为。 |
VirtualKeyboardDismissAction | EVirtualKeyboardDismissAction | 文本输入 | 是 | GetVirtualKeyboardDismissAction / SetVirtualKeyboardDismissAction | 关闭它的含义。TextCommitOnDismiss 保留该字段原有的行为。 |
BackgroundNode | TObjectPtr<UDreamWidget> | 文本输入 | - | 只读 | |
PlaceholderNode | TObjectPtr<UDreamWidget> | 文本输入 | - | 只读 | |
ClipNode | TObjectPtr<UDreamWidget> | 文本输入 | - | 只读 | |
TextNode | TObjectPtr<UDreamWidget> | 文本输入 | - | 只读 | |
ErrorNode | TObjectPtr<UDreamWidget> | 文本输入 | - | 只读 | 错误消息所在的段落。这是一个可选部件:在错误状态存在之前为该控件编写的每个模板都没有该名称的节点,而将缺少这些节点报告为错误的控件,会让每一份现有资产把一次新增变成一个警告。 |
ErrorText | FText | 文本输入 | - | 只读 | 当前生效的消息,没有时为空。 |
InputBehaviour | TObjectPtr<UUITextInput> | 文本输入 | - | 只读 |
函数
| 函数 | 类型 | 描述 |
|---|---|---|
void ClearError() | 可调用 | 清除错误 |
bool GetAllowContextMenu() | 纯函数 | 获取允许上下文菜单 |
bool GetAutoActivateInputWhenNavigateIn() | 纯函数 | 获取导航进入时自动激活输入 |
bool GetClearKeyboardFocusOnCommit() | 纯函数 | 获取提交时清除键盘焦点 |
UDreamTextInputCustomValidation* GetCustomValidation() | 纯函数 | 获取自定义验证 |
EUITextInputDisplayType GetDisplayType() | 纯函数 | 获取显示类型 |
FText GetError() | 纯函数 | 错误状态——UMG 的文本框自存在起就有,而这个控件此前没有。 |
UDreamUIFontData_BaseObject* GetFont() | 纯函数 | 该字段绘制所用的字体——UMG 的 GetFont/SetFont,除去 FSlateFontInfo 额外打包的两项内容:字号是 Style.FontSize,而描边在文本样式中。 |
UMaterialInterface* GetFontMaterial() | 纯函数 | 绘制字形所用的材质——UMG 的 SetFontMaterial,有一个值得了解的差别:整个段落只有一个材质,而不是每个字体面一个,因为文本渲染器接收的就是这个。 |
FText GetHintText() | 纯函数 | UMG 的 HintText,在这里就是该控件的 Placeholder,只是用了 UMG 读者所熟悉的名称。转发;只有一个字符串和一个写入者,因此两种写法不会彼此偏离。 |
TArray<FKey> GetIgnoreKeys() | 纯函数 | 获取忽略按键 |
EUITextInputType GetInputType() | 纯函数 | 行为上的各项开关,其设置器会直接作用到它。 |
bool GetIsCaretMovedWhenGainFocus() | 纯函数 | 获取获得焦点时移动光标 |
bool GetIsPassword() | 纯函数 | UMG 的 IsPassword,在这里就是 DisplayType 的两个答案,只是用了 UMG 给它们的名称。 |
bool GetIsReadOnly() | 纯函数 | 获取是否只读 |
EDreamUITextParagraphHorizontalAlign GetJustification() | 纯函数 | 获取对齐方式 |
TEnumAsByte<EVirtualKeyboardType::Type> GetKeyboardType() | 纯函数 | 获取键盘类型 |
FString GetLanguage() | 纯函数 | 获取语言 |
EDreamTextLastLineAlign GetLastLineAlign() | 纯函数 | 获取末行对齐 |
int32 GetMaxLength() | 纯函数 | 获取最大长度 |
float GetMinimumDesiredWidth() | 纯函数 | 获取最小期望宽度 |
bool GetMultiLine() | 纯函数 | 获取是否多行 |
TArray<FKey> GetMultiLineSubmitFunctionKeys() | 纯函数 | 获取多行提交功能键 |
FString GetPasswordChar() | 纯函数 | 获取密码字符 |
FText GetPlaceholder() | 纯函数 | 获取占位符 |
bool GetRevertTextOnEscape() | 纯函数 | 获取按 Escape 时还原文本 |
bool GetSelectAllTextOnCommit() | 纯函数 | 获取提交时全选文本 |
bool GetSelectAllWhenActivateInput() | 纯函数 | 获取激活输入时全选 |
EDreamTextSmallTextRaster GetSmallTextRaster() | 纯函数 | 获取小字号文本光栅化 |
FDreamTextInputStyle GetStyle() | 纯函数 | 获取样式 |
bool GetSubmitWhenDeactivate() | 纯函数 | 获取停用时提交 |
float GetTabSize() | 纯函数 | 获取制表符大小 |
bool GetTabTypesTabCharacter() | 纯函数 | 获取制表符键入制表字符 |
FString GetText() | 纯函数 | 获取文本 |
EDreamTextFlowDirection GetTextFlowDirection() | 纯函数 | 获取文本流向 |
EDreamTextJustify GetTextJustify() | 纯函数 | 获取文本对齐方式 |
ETextOverflowPolicy GetTextOverflowPolicy() | 纯函数 | 获取文本溢出策略 |
EVirtualKeyboardDismissAction GetVirtualKeyboardDismissAction() | 纯函数 | 获取虚拟键盘关闭操作 |
EVirtualKeyboardTrigger GetVirtualKeyboardTrigger() | 纯函数 | 获取虚拟键盘触发方式 |
bool HasError() | 纯函数 | 是否有错误 |
bool IsAnyTextSelected() | 纯函数 | 该字段当前是否有任何选中内容——UMG 的 IsAnyTextSelected。 |
void SelectAllText() | 可调用 | 选中整个值,与 UMG 的 SelectAllText 相同。 |
void SetAllowContextMenu(bool bInAllowContextMenu) | 可调用 | 设置允许上下文菜单 |
void SetAutoActivateInputWhenNavigateIn(bool bInAutoActivate) | 可调用 | 设置导航进入时自动激活输入 |
void SetClearKeyboardFocusOnCommit(bool bInClearKeyboardFocusOnCommit) | 可调用 | 设置提交时清除键盘焦点 |
void SetCustomValidation(UDreamTextInputCustomValidation* InCustomValidation) | 可调用 | 设置自定义验证 |
void SetDisplayType(EUITextInputDisplayType InDisplayType) | 可调用 | 设置显示类型 |
void SetError(FText InError) | 可调用 | 显示一条消息。空消息即为清除,与 UMG 的 SetError 行为相同。 |
void SetFont(UDreamUIFontData_BaseObject* InFont) | 可调用 | 设置字体 |
void SetFontMaterial(UMaterialInterface* InMaterial) | 可调用 | 设置字体材质 |
void SetHintText(FText InHintText) | 可调用 | 设置提示文本 |
void SetIgnoreKeys(TArray<FKey> InIgnoreKeys) | 可调用 | 设置忽略按键 |
void SetInputType(EUITextInputType InInputType) | 可调用 | 接受哪些字符。会重新对字段中已有的文本运行规则。 |
void SetIsCaretMovedWhenGainFocus(bool bInIsCaretMovedWhenGainFocus) | 可调用 | 设置获得焦点时移动光标 |
void SetIsPassword(bool bInIsPassword) | 可调用 | 设置是否为密码 |
void SetIsReadOnly(bool bInReadOnly) | 可调用 | 可选择但不可编辑。开启时,正在输入的字段会停止编辑。 |
void SetJustification(EDreamUITextParagraphHorizontalAlign InJustification) | 可调用 | 同时作用于输入的文本和占位符:提示应出现在将要输入的位置。 |
void SetKeyboardType(TEnumAsByte<EVirtualKeyboardType::Type> InKeyboardType) | 可调用 | 设置键盘类型 |
void SetLanguage(FString InLanguage) | 可调用 | 作用于该字段的每个段落,与流向相同。 |
void SetLastLineAlign(EDreamTextLastLineAlign InLastLineAlign) | 可调用 | 设置末行对齐 |
void SetMaxLength(int32 InMaxLength) | 可调用 | 0 表示不限制。缩短长度会截断字段中已有的内容。 |
void SetMinDesiredWidth(float InMinDesiredWidth) | 可调用 | 设置最小期望宽度 |
void SetMinimumDesiredWidth(float InMinimumDesiredWidth) | 可调用 | UMG 将设置器命名为 SetMinDesiredWidth;此处两种写法都有,只有一份实现。 |
void SetMultiLine(bool bInMultiLine) | 可调用 | 单行或多行,立即重新推送。是整体样式推送,而不是行为上的单个标志:行数决定字段的高度以及其裁剪必须允许的范围,二者都写在那里。 |
void SetMultiLineSubmitFunctionKeys(TArray<FKey> InKeys) | 可调用 | 设置多行提交功能键 |
void SetPasswordChar(FString InPasswordChar) | 可调用 | 设置密码字符 |
void SetPlaceholder(FText InPlaceholder) | 可调用 | 字段为空时显示的灰色文字,立即重新推送。 |
void SetRevertTextOnEscape(bool bInRevertTextOnEscape) | 可调用 | 设置按 Escape 时还原文本 |
void SetSelectAllTextOnCommit(bool bInSelectAllTextOnCommit) | 可调用 | 设置提交时全选文本 |
void SetSelectAllWhenActivateInput(bool bInSelectAll) | 可调用 | 设置激活输入时全选 |
void SetSmallTextRaster(EDreamTextSmallTextRaster InSmallTextRaster) | 可调用 | 设置小字号文本光栅化 |
void SetStyle(FDreamTextInputStyle InStyle) | 可调用 | 一次性设置整个外观,重新推送。样式结构体是一个整体决策,因此作为一个整体移动。 |
void SetSubmitWhenDeactivate(bool bInSubmitWhenDeactivate) | 可调用 | 设置停用时提交 |
void SetTabSize(float InTabSize) | 可调用 | 设置制表符大小 |
void SetTabTypesTabCharacter(bool bInTabTypesTabCharacter) | 可调用 | 设置制表符键入制表字符 |
void SetText(FString InText) | 可调用 | 设置文本 |
void SetTextFlowDirection(EDreamTextFlowDirection InFlowDirection) | 可调用 | 设置文本流向 |
void SetTextJustify(EDreamTextJustify InTextJustify) | 可调用 | 设置文本对齐方式 |
void SetTextOverflowPolicy(ETextOverflowPolicy InOverflowPolicy) | 可调用 | 转发给行为,该行为拥有它与行模式共享的段落上的那个字段。 |
void SetVirtualKeyboardDismissAction(EVirtualKeyboardDismissAction InDismissAction) | 可调用 | 设置虚拟键盘关闭操作 |
void SetVirtualKeyboardTrigger(EVirtualKeyboardTrigger InTrigger) | 可调用 | 设置虚拟键盘触发方式 |
事件
| 事件 | 签名 | 描述 |
|---|---|---|
OnTextChanged | void DreamTextInputChangedEvent__DelegateSignature(FString Text) | 从行为转发而来,因此消费者绑定的是控件本身,而不是它的某个部分。 |
OnValueChangedBP | void DreamTextInputChangedEvent__DelegateSignature(FString Text) | <-> 约定:双向绑定会针对这个确切的名称合成其反向路由,因此值控件会和它公开的事件一起携带它。并与它们一同触发。 |
OnSubmitted | void DreamTextInputChangedEvent__DelegateSignature(FString Text) | Enter 键(或多行提交组合键)。OnTextCommitted 的兼容写法:两者在同一时刻以相同的字符串触发。新代码请使用 OnTextCommitted。 |
OnTextCommitted | void DreamTextInputChangedEvent__DelegateSignature(FString Text) | UMG 对同一时刻的写法(其可编辑文本将 OnTextChanged 与 OnTextCommitted 配对)。只携带字符串——UMG 的提交方法枚举描述的是本控件并不具备的 Slate 输入路由,伪造一个会在签名中撒谎。 |
与 UMG 的对比
UMG 类中所有面向蓝图的成员,以及它们去了哪里。adopt:同名,同义。map:在这里换了名字或换了类型。reject:刻意缺失,并附原因。
| UMG | 成员 | 状态 | 这里 | 说明 |
|---|---|---|---|---|
UEditableTextBox | Text | map | Text | 是 FString,不是 FText:该字段编辑的是普通字符串,进出 UUITextInput 的每一条路都使用它。现有的 .dui 也将其编写为字符串。 |
UEditableTextBox | WidgetStyle | map | Style | FDreamTextInputStyle。与 FEditableTextBoxStyle 角色相同,形状不同:按状态区分颜色,外加光标/选中/错误,没有 Slate 笔刷。 |
UEditableTextBox | HintText | map | Placeholder | GetHintText/SetHintText 转发到它,因此 UMG 的写法能到达同一个字符串。 |
UEditableTextBox | IsReadOnly | map | bReadOnly | 与本库中所有 bool 一样带 b 前缀。Get/SetIsReadOnly 采用 UMG 的写法;其 setter 会结束正在进行的编辑。 |
UEditableTextBox | IsPassword | map | DisplayType | 这里是一个双值枚举(Standard/Password),因为同一字段还携带 PasswordChar。Get/SetIsPassword 是在它之上的布尔写法。 |
UEditableTextBox | MinimumDesiredWidth | adopt | MinimumDesiredWidth | 控件自身宽度以及段落向内容自适应父级所请求宽度的下限。0 = 不发表意见,这也是所有现有字段的做法。 |
UEditableTextBox | IsCaretMovedWhenGainFocus | map | bIsCaretMovedWhenGainFocus | 推送到 UUITextInput::bIsCaretMovedWhenGainFocus;只有未指定位置的激活才会读取它。 |
UEditableTextBox | SelectAllTextWhenFocused | map | bSelectAllWhenActivateInput | 本库对同一时刻(一次编辑开始)的既有写法。保留是因为 .dui 已经在这样编写。 |
UEditableTextBox | RevertTextOnEscape | map | bRevertTextOnEscape | 由 UUITextInput::CancelInput 读取,也就是 Back 所走的路。与 UMG 的 RestoreOriginalText 类似,回退会以恢复后的文本提交一次(OnTextCommitted;此处不暴露提交方法)。有两点不同:恢复还会触发 OnTextChanged,因为 <-> 反向路由搭载在 OnValueChangedBP 上,静默恢复会让绑定的模型仍持有被放弃的编辑;并且编辑会结束,因为此处的 Escape 就是 Back。默认关闭,与 UMG 一样,也与该字段以往的行为一样。 |
UEditableTextBox | ClearKeyboardFocusOnCommit | map | bClearKeyboardFocusOnCommit | 默认 TRUE,而 UMG 为 false:Enter 在这里一直会结束编辑,而改变现有界面的默认值就不是默认值了。 |
UEditableTextBox | SelectAllTextOnCommit | map | bSelectAllTextOnCommit | 仅在提交后仍继续编辑时才生效;选中一个无人正在编辑的字段只会显示高亮,没有光标。 |
UEditableTextBox | AllowContextMenu | map | bAllowContextMenu | 原本已存在;现在带有一个 setter,可关闭已经打开的菜单。 |
UEditableTextBox | KeyboardType | adopt | KeyboardType | 相同的 TEnumAsByteEVirtualKeyboardType::Type。默认意味着“从 InputType 推导”,这也是该字段一直以来的做法;任何其他值都直接表明它。 |
UEditableTextBox | VirtualKeyboardOptions | adopt | VirtualKeyboardOptions | 没有蓝图访问器:FVirtualKeyboardOptions 没有 BlueprintType,与 UMG 中完全一样。已注册到 _BlueprintWritableExceptions.json。 |
UEditableTextBox | VirtualKeyboardTrigger | adopt | VirtualKeyboardTrigger | 默认 OnAllFocusEvents,而 UMG 为 OnFocusByPointer:以往每次激活都会唤起键盘,而手柄用户没有其他方式输入。 |
UEditableTextBox | VirtualKeyboardDismissAction | adopt | VirtualKeyboardDismissAction | 默认 TextCommitOnDismiss,这也是该字段以往的做法:Done 会提交,取消退出也会提交。 |
UEditableTextBox | Justification | adopt | Justification | 使用 EDreamUITextParagraphHorizontalAlign 而非 ETextJustify——本库唯一的段落对齐枚举,同样三种答案。占位符也遵循它。 |
UEditableTextBox | OverflowPolicy | map | OverflowPolicy | ETextOverflowPolicy,UMG 自己的枚举,但它只在无人编辑时生效。在可编辑字段上,段落的 EDreamUITextOverflowType 才是行模式开关本身(换行和光标的可见窗口都会读取它),因此编辑期间由行模式掌管,编辑之外由该策略掌管。Clip 是默认值,也是当前所有字段的做法。 |
UEditableTextBox | ShapedTextOptions | map | TextFlowDirection | 其中在此有意义的那一半:EDreamTextFlowDirection 即 UMG 的 TextFlowDirection,会被推送到值、提示和错误消息上。UMG 的另一半 TextShapingMethod 在控件上没有归属——塑形器是否运行是在编译插件时(WITH_HARFBUZZ)决定的,而不是按控件决定。 |
UEditableTextBox | OnTextChanged | map | OnTextChanged | 同名、同触发时机;携带 FString 而不是 FText,与它所报告的 Text 属性一样。 |
UEditableTextBox | OnTextCommitted | map | OnTextCommitted | 同名、同触发时机,但不带 UMG 的 ETextCommit:该枚举描述的是本控件并不具备的 Slate 输入路由,伪造一个会在签名中撒谎。 |
UEditableTextBox | GetText | map | GetText | 返回 FString;参见 Text 属性。 |
UEditableTextBox | SetText | map | SetText | 接受 FString;参见 Text 属性。 |
UEditableTextBox | SetHintText | adopt | SetHintText | 转发到 SetPlaceholder,后者会重新推送样式,因为提示是否激活是根据字段是否为空来判断的。 |
UEditableTextBox | SetError | adopt | SetError | 写入 Error 段落——右对齐显示在字段上方,没有消息时处于休眠状态,颜色由 FDreamTextInputStyle::ErrorColor 决定。空消息即为清除,与 UMG 一样。 |
UEditableTextBox | SetIsReadOnly | adopt | SetIsReadOnly | |
UEditableTextBox | SetIsPassword | adopt | SetIsPassword | 在 DisplayType 之上的布尔写法。 |
UEditableTextBox | ClearError | adopt | ClearError | |
UEditableTextBox | HasError | adopt | HasError | 从消息作答,因此即使模板没有 Error 节点也能知道自己有一条。 |
UEditableTextBox | SetJustification | adopt | SetJustification | 推送到已输入文本和占位符上。 |
UEditableTextBox | SetTextOverflowPolicy | adopt | SetTextOverflowPolicy | 转发到 UUITextInput::SetOverflowPolicy,它是段落溢出的唯一写入者,也是唯一知道此刻是行模式还是该策略在说话的地方。 |
UEditableTextBox | SetForegroundColor | map | FDreamTextInputStyle::TextColor | 外观位于样式结构体中,因此颜色通过 SetStyle 或项目表传递。若第二个 setter 写入内联结构体,则当 StyleSource 为项目表时会被静默忽略。 |
UEditableTextBox | FontFacesLoadingPaintPolicy | reject | Slate 的字体缓存会异步加载字体字形,此策略指定在此期间绘制什么。本库使用自己的字体数据资产(SDF 图集或 FreeType 渲染)进行渲染,不存在需要应对的异步字形加载。 | |
UEditableTextBox | OnAllFontFacesFinishLoading | reject | 原因同 FontFacesLoadingPaintPolicy:没有需要完成的异步字形加载。 | |
UMultiLineEditableTextBox | Text | map | Text | 多行框式字段是勾选了 bMultiLine 的 UDreamTextInput -- UMG 四个类中的一个轴在这里是一个属性。FString;参见 EditableTextBox.json。 |
UMultiLineEditableTextBox | HintText | map | Placeholder | |
UMultiLineEditableTextBox | WidgetStyle | map | Style | 两种行模式共用一个 FDreamTextInputStyle;行数改变的是字段的高度,而不是外观。 |
UMultiLineEditableTextBox | bIsReadOnly | map | bReadOnly | |
UMultiLineEditableTextBox | AllowContextMenu | map | bAllowContextMenu | |
UMultiLineEditableTextBox | VirtualKeyboardOptions | adopt | VirtualKeyboardOptions | 没有蓝图访问器;FVirtualKeyboardOptions 没有 BlueprintType,与 UMG 中完全一致。 |
UMultiLineEditableTextBox | VirtualKeyboardDismissAction | adopt | VirtualKeyboardDismissAction | |
UMultiLineEditableTextBox | OnTextChanged | map | OnTextChanged | 携带 FString。 |
UMultiLineEditableTextBox | OnTextCommitted | map | OnTextCommitted | 在多行模式下,提交时机为按住 MultiLineSubmitFunctionKeys 之一时按下 Enter,这是本库对“Enter 会换行,那什么来提交”的回答。 |
UMultiLineEditableTextBox | GetText | map | GetText | 返回 FString。 |
UMultiLineEditableTextBox | SetText | map | SetText | 接收 FString。 |
UMultiLineEditableTextBox | GetHintText | adopt | GetHintText | |
UMultiLineEditableTextBox | SetHintText | adopt | SetHintText | |
UMultiLineEditableTextBox | SetError | adopt | SetError | |
UMultiLineEditableTextBox | SetIsReadOnly | adopt | SetIsReadOnly | |
UMultiLineEditableTextBox | SetTextStyle | map | SetStyle | UMG 中组成框外观的 FTextBlockStyle 那一半。颜色和大小属于 FDreamTextInputStyle;轮廓/阴影/发光那一半是 UDreamText::TextStyle(FDreamTextStyle),控件尚未转发它 -- 关于字体和效果各自所在的位置,参见 EditableText.json 的 GetFont。 |
UMultiLineEditableTextBox | SetForegroundColor | map | FDreamTextInputStyle::TextColor | 外观位于样式结构体中;它通过 SetStyle 或项目表传递。 |