类参考
UDreamRichTextBlock
UDreamRichTextBlock
继承自 UDreamUIControl。
声明于 Public/Controls/DreamRichTextBlock.h。
一种层次结构由代码而非资源定义的富文本块:一个读取标记的段落。
UMG 的 RichTextBlock 针对装饰器集合解析 <Tag>text</Tag>;本库的文本栈自诞生起就有着相同的理念——UDreamText::bRichText 加上两个数据资源,一个将标签映射到样式,一个将标签映射到图像——而缺失的是一个把它开启的控件。这就是这个类的全部:一个设置了标志位的文本节点、两个暴露出来的资源,以及像其他所有控件一样来自项目样式表的颜色和大小。
为什么它是控件而不是文本节点上的标志位
该标志位已经存在于节点上,希望将它设在那里的作者仍然可以设置。控件增加的是标志位无法提供的:一个读取项目文本颜色和大小的 Native.RichText 标签,使项目能在一处重新设定其正文样式,以及一个让两个数据资源按实例编写而无需任何人深入可视化的地方。
标记的含义不是这个控件的职责,此处也不重述——标签词汇、过滤器标志和两种资源格式属于 UDreamText 及其解析器,在控件头文件中第二次描述它们就是第二件需要保持一致的事。
属性
| 名称 | 类型 | 类别 | 在细节面板中 | 可从蓝图访问 | 描述 |
|---|---|---|---|---|---|
Style | FDreamRichTextStyle | Rich Text | 是 | GetStyle / SetStyle | 此实例自身的外观。当 StyleSource 如此指示且样式表确实存在时,项目样式表优先;项目中无样式表时,这本身就是生效的外观。 |
Text | FText | Rich Text | 是 | GetText / SetText | 正文,包括标记在内。 |
TagFilterFlags | int32 | Rich Text | 是 | GetTagFilterFlags / SetTagFilterFlags | 解析器被允许作用的标签。默认为全部。 |
CustomStyleData | TObjectPtr<UDreamUIRichTextCustomStyleData> | Rich Text | 是 | GetCustomStyleData / SetCustomStyleData | <MyTag> 的含义,作为一种样式。为空时,自定义标签留给字符选择消费者处理。 |
ImageData | TObjectPtr<UDreamUIRichTextImageData_BaseObject> | Rich Text | 是 | GetImageData / SetImageData | <img=key/> 的含义。为空时,图像标签不绘制任何内容。标签还可给出尺寸和图像在其行上的位置:<img=key,24/>、<img=key,24,32/>、<img=key,24,baseline/> —— middle(默认,居中)、baseline、top 或 bottom。图像若高于其行,会使该行变高。 |
HorizontalAlignment | EDreamUITextParagraphHorizontalAlign | Rich Text | 是 | GetHorizontalAlignment / SetHorizontalAlignment | 段落如何位于控件的矩形内。 |
VerticalAlignment | EDreamUITextParagraphVerticalAlign | Rich Text | 是 | GetVerticalAlignment / SetVerticalAlignment | |
OverflowType | EDreamUITextOverflowType | Rich Text | 是 | GetOverflowType / SetOverflowType | 一行对于控件来说太长时如何处理。VerticalOverflow 是会换行的那个,这正是正文通常想要的,也是富文本块几乎总是采用的。 |
bAutoWrapText | bool | Rich Text | 是 | GetAutoWrapText / SetAutoWrapText | 将放不下的行断开,而不是让它继续延伸——UMG 的 AutoWrapText。 |
TextTransformPolicy | EDreamUITextTransformPolicy | Rich Text | 是 | GetTextTransformPolicy / SetTextTransformPolicy | 正文绘制时的大小写——UMG 的 TextTransformPolicy。编写的字符串不受影响。 |
MinDesiredWidth | float | Rich Text | 是 | GetMinDesiredWidth / SetMinDesiredWidth | 段落在向内容自适应父级请求宽度时的下限——UMG 的 MinDesiredWidth。零表示不发表意见,这是当今存在的每个块的情况。 |
Language | FString | Rich Text | 是 | GetLanguage / SetLanguage | 正文所书写语言,以文化名表示("ja"、"zh-Hans");为空则为游戏语言。它会选择字体为其准备的备选字体,以及文字按语言绘制所采用的形态——参见 UDreamText::Language。对于标签所含内容,<lang=xx> 仍会覆盖它。 |
TabSize | float | Rich Text | 是 | GetTabSize / SetTabSize | 制表位,以空格计,从行起始边算起——CSS 的 tab-size,浏览器采用 8。 |
TextJustify | EDreamTextJustify | Rich Text | 是 | GetTextJustify / SetTextJustify | 两端对齐的行获得额外空间的位置。仅在 HorizontalAlignment 为 Justify 时读取。 |
LastLineAlign | EDreamTextLastLineAlign | Rich Text | 是 | GetLastLineAlign / SetLastLineAlign | 两端对齐段落的最后一行,以及由换行符结束的一行,如何对齐。仅在 HorizontalAlignment 为 Justify 时读取。 |
SmallTextRaster | EDreamTextSmallTextRaster | Rich Text | 是 | GetSmallTextRaster / SetSmallTextRaster | 关闭后,正文在任何字号下都保持在其字体的距离场上;参见 UDreamText::SmallTextRaster。 |
TextNode | TObjectPtr<UDreamWidget> | Rich Text | - | 只读 | 段落本身。公开是因为控件下的一切都可通过名称访问。 |
函数
| 函数 | 类型 | 描述 |
|---|---|---|
bool GetAutoWrapText() | pure | 获取自动换行文本 |
UDreamUIRichTextCustomStyleData* GetCustomStyleData() | pure | 获取自定义样式数据 |
UMaterialInstanceDynamic* GetDefaultDynamicMaterial() | callable | 该块自身独有的材质实例,在首次请求时基于样式的材质创建——即 UMG 的 GetDefaultDynamicMaterial。 |
UDreamUIFontData_BaseObject* GetDefaultFont() | pure | 用于无装饰正文的默认字体——即 UMG 的 SetDefaultFont,但不包含 FSlateFontInfo 额外打包的内容:字号为 Style.FontSize,轮廓为 Style.TextStyle。标记仍可按运行切换字体;这是没有任何声明的运行所获得的字体。 |
EDreamUITextParagraphHorizontalAlign GetHorizontalAlignment() | pure | 获取水平对齐 |
UDreamUIRichTextImageData_BaseObject* GetImageData() | pure | 获取图像数据 |
FString GetLanguage() | pure | 获取语言 |
EDreamTextLastLineAlign GetLastLineAlign() | pure | 获取末行对齐 |
float GetMinDesiredWidth() | pure | 获取最小期望宽度 |
EDreamUITextOverflowType GetOverflowType() | pure | 获取溢出类型 |
EDreamTextSmallTextRaster GetSmallTextRaster() | pure | 获取小号文本光栅 |
FDreamRichTextStyle GetStyle() | pure | 获取样式 |
float GetTabSize() | pure | 获取制表符大小 |
int32 GetTagFilterFlags() | pure | 获取标签过滤标志 |
FText GetText() | pure | 获取文本 |
EDreamTextJustify GetTextJustify() | pure | 获取文本对齐方式 |
EDreamUITextTransformPolicy GetTextTransformPolicy() | pure | 获取文本变换策略 |
EDreamUITextParagraphVerticalAlign GetVerticalAlignment() | pure | 获取垂直对齐 |
void RefreshTextLayout() | callable | 重新解析标记并重新排版段落——即 UMG 的 RefreshTextLayout。 |
void SetAutoWrapText(bool bInAutoWrapText) | callable | 设置自动换行文本 |
void SetCustomStyleData(UDreamUIRichTextCustomStyleData* InCustomStyleData) | callable | 自定义标签的含义。即 UMG 的 TextStyleSet 在本库中的名称:一个将标签映射到样式的数据资产,与其 RichTextStyleRow 表所做的是同一件事。 |
void SetDefaultFont(UDreamUIFontData_BaseObject* InFont) | callable | 设置默认字体 |
void SetHorizontalAlignment(EDreamUITextParagraphHorizontalAlign InHorizontalAlignment) | callable | 设置水平对齐 |
void SetImageData(UDreamUIRichTextImageData_BaseObject* InImageData) | callable | 设置图像数据 |
void SetJustification(EDreamUITextParagraphHorizontalAlign InJustification) | callable | UMG 的 Justification,在段落上即为水平对齐。只有一个实现。 |
void SetLanguage(FString InLanguage) | callable | 设置语言 |
void SetLastLineAlign(EDreamTextLastLineAlign InLastLineAlign) | callable | 设置末行对齐 |
void SetMinDesiredWidth(float InMinDesiredWidth) | callable | 设置最小期望宽度 |
void SetOverflowType(EDreamUITextOverflowType InOverflowType) | callable | 设置溢出类型 |
void SetSmallTextRaster(EDreamTextSmallTextRaster InSmallTextRaster) | callable | 设置小号文本光栅 |
void SetStyle(FDreamRichTextStyle InStyle) | callable | 一次性重新推送整个外观。 |
void SetTabSize(float InTabSize) | callable | 设置制表符大小 |
void SetTagFilterFlags(int32 InTagFilterFlags) | callable | 设置标签过滤标志 |
void SetText(FText InText) | callable | 替换正文。导入时重新解析,这就是标记的代价。 |
void SetTextJustify(EDreamTextJustify InTextJustify) | callable | 设置文本对齐方式 |
void SetTextOverflowPolicy(EDreamUITextOverflowType InOverflowPolicy) | callable | UMG 对同一决策的命名。转发,因此只有一个写入者和一个真相。 |
void SetTextTransformPolicy(EDreamUITextTransformPolicy InTransformPolicy) | callable | 设置文本变换策略 |
void SetVerticalAlignment(EDreamUITextParagraphVerticalAlign InVerticalAlignment) | callable | 设置垂直对齐 |
与 UMG 对比
UMG 类中每个面向蓝图的成员,以及它们的去向。adopt:名称相同、含义相同。map:在此处以其他名称或其他类型出现。reject:刻意缺失,并附有原因。
| UMG | 成员 | 状态 | 此处 | 备注 |
|---|---|---|---|---|
URichTextBlock | Text | adopt | Text | 此处为 FText,与 UMG 相同——富文本块是正文,不是字段的值。 |
URichTextBlock | TextStyleSet | map | CustomStyleData | 是一个将标签映射到样式的数据资产,而非 RichTextStyleRow 的 UDataTable,在本库自身的形态中做的是同一件事。其兄弟 ImageData 应答 <img=key/>,UMG 将其表示为装饰器。 |
URichTextBlock | DecoratorClasses | map | ImageData | 这里的标记扩展点是一对数据资产,而非子类列表:ImageData 应答 <img=key/>,方式与 UMG 内置图像装饰器从其画刷表应答完全相同,而 CustomStyleData 应答 。二者都是带有会重新解析的 setter 的创作属性,这正是 UMG 中装饰器列表所能带来的全部。 |
URichTextBlock | DefaultTextStyleOverride | map | Style | FDreamRichTextStyle 就是内联默认样式:颜色、字号,以及现在的轮廓/阴影/发光结构体。其中哪部分是生效的由 EDreamUIStyleSource 以及逐字段的 bOverride_ 位决定,而非一个 bOverrideDefaultStyle 标志。 |
URichTextBlock | MinDesiredWidth | adopt | MinDesiredWidth | 被推送到段落上,这正是内容自适应父级所测量的:富文本块就是其段落,拉伸到控件的矩形。 |
URichTextBlock | bOverrideDefaultStyle | map | UDreamUIControl::StyleSource | 同一个问题,但有三个答案而非两个:项目表、此实例,或者项目表外加写在其上的此实例已勾选的字段。位于 UDreamUIControl 上,由该家族中的每个控件共享。 |
URichTextBlock | TextTransformPolicy | adopt | TextTransformPolicy | EDreamUITextTransformPolicy——本库自己的 None/ToLower/ToUpper。所创作的字符串不受影响;只有绘制会改变。 |
URichTextBlock | TextOverflowPolicy | map | OverflowType | EDreamUITextOverflowType,拥有 UMG 的两个答案(Truncate 即 Clip,Ellipsis 即 Ellipsis)外加决定长行是否换行的两个。SetTextOverflowPolicy 沿用 UMG 的名称。 |
URichTextBlock | SetDefaultColorAndOpacity | map | FDreamRichTextStyle::TextColor | 外观位于样式结构体中,因此颜色通过 SetStyle 或项目表来变更。第二个写入内联结构体的 setter 在 StyleSource 为项目表时会静默失效。 |
URichTextBlock | SetDefaultShadowColorAndOpacity | map | FDreamTextStyle::UnderlayColor | 这里的投影是下衬(UNDERLAY),由 FDreamRichTextStyle::TextStyle 承载。Alpha 为零表示无阴影,这是默认发布状态,因此也是每个现有块的绘制结果。 |
URichTextBlock | SetDefaultShadowOffset | map | FDreamTextStyle::UnderlayOffset | 以 em 而非像素为单位,因此阴影在任何字号下看起来都一致。 |
URichTextBlock | SetDefaultFont | map | FDreamRichTextStyle::Font | 是字体数据资产而非 FSlateFontInfo:字号为 Style.FontSize,轮廓为 Style.TextStyle。SetDefaultFont/GetDefaultFont 读写 Style.Font,标记仍可按运行切换字体——这是没有任何声明的运行所获得的。Null 会让段落保持其现有字体。 |
URichTextBlock | SetDefaultStrikeBrush | reject | 这里的删除线由文本渲染器根据 UDreamText::bStrikethrough 绘制,而非由可替换的 Slate 画刷合成。该路径中没有图像可供画刷使用。 | |
URichTextBlock | SetMinDesiredWidth | adopt | SetMinDesiredWidth | |
URichTextBlock | SetAutoWrapText | adopt | SetAutoWrapText | 默认关闭,段落自身的默认值。它只在尚未换行的溢出类型下生效——VerticalOverflow 总是换行。 |
URichTextBlock | SetTextTransformPolicy | adopt | SetTextTransformPolicy | |
URichTextBlock | SetTextOverflowPolicy | adopt | SetTextOverflowPolicy | 转发到 SetOverflowType;一个写入者,两种拼写。 |
URichTextBlock | SetDefaultTextStyle | map | SetStyle | 一次性设置整个默认外观,这正是样式结构体的作用。 |
URichTextBlock | SetDefaultMaterial | map | FDreamRichTextStyle::OverrideMaterial | Null 保留本库自己的文本材质,这是每个现有块所使用的。 |
URichTextBlock | ClearAllDefaultStyleOverrides | map | UDreamUIControl::SetStyleSource | 回到项目表就是这里清除覆盖的含义:SetStyleSource(ProjectStyleSheet)。逐字段清除是结构体上的 bOverride_ 位。 |
URichTextBlock | GetDefaultDynamicMaterial | adopt | GetDefaultDynamicMaterial | 在该样式的材质上创建实例,并将其推送到段落;询问两次,返回同一个实例。当样式未指定材质时为 null——库中共享文本材质的实例会让一个调用者能够编辑项目中的每一个段落。 |
URichTextBlock | SetDecorators | map | SetImageData | 替换标记解析所依据的内容,这正是 UMG 中 SetDecorators 所做的事。SetCustomStyleData 对标签样式而言是同一条路。两者都会重新解析,因为哪个标签意味着什么是在解析时读取的,而不是之后。 |
URichTextBlock | GetText | adopt | GetText | |
URichTextBlock | SetText | adopt | SetText | 在传入时重新解析,这正是标记的开销所在。 |
URichTextBlock | GetTextStyleSet | map | GetCustomStyleData | |
URichTextBlock | SetTextStyleSet | map | SetCustomStyleData | 重新解析,因为哪个标签意味着什么是在解析时读取的,而不是之后。 |
URichTextBlock | GetDecoratorByClass | reject | 没有可返回的装饰器对象。FRichTextParser 会直接针对两个数据资产评估每个标签,并将结果交给文本渲染器;该路径中没有任何东西是可以交给调用者、让调用者持有或重新配置的对象。这里的扩展方式是通过编写数据资产完成的,而不是通过子类化装饰器。 | |
URichTextBlock | RefreshTextLayout | adopt | RefreshTextLayout | 将同一段文本再次送入解析器,这正是拾取自上次解析以来被就地编辑的样式或图像资产的方式。 |