- class unreal.RichTextBlock(outer=None, name='None')¶
The rich text block
Editor Properties: (see get_editor_property/set_editor_property)
accessible_behavior(SlateAccessibleBehavior): [Read-Write] Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
accessible_summary_behavior(SlateAccessibleBehavior): [Read-Write] How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
accessible_summary_text(Text): [Read-Write] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
accessible_text(Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
auto_wrap_text(bool): [Read-Write] True if we’re wrapping text automatically based on the computed horizontal space for this widget.
can_children_be_accessible(bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.
clipping(WidgetClipping): [Read-Write] Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.
NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.
cursor(MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget
decorator_classes(Array(type(Class))): [Read-Write] Decorator Classes
default_text_style_override(TextBlockStyle): [Read-Write] Text style to apply by default to text in this block
flow_direction_preference(FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction
is_enabled(bool): [Read-Write] Sets whether this widget can be modified interactively by the user
is_volatile(bool): [Read-Write] If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
justification(TextJustify): [Read-Write] How the text should be aligned with the margin.
line_height_percentage(float): [Read-Write] The amount to scale each lines height by.
margin(Margin): [Read-Write] The amount of blank space left around the edges of text area.
min_desired_width(float): [Read-Write] The minimum desired size for the text
navigation(WidgetNavigation): [Read-Write] The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.
override_accessible_defaults(bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.
override_cursor(bool): [Read-Write] Override Cursor
override_default_style(bool): [Read-Write] True to specify the default text style for this rich text inline, overriding any default provided in the style set table
render_opacity(float): [Read-Write] The opacity of the widget
render_transform(WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
render_transform_pivot(Vector2D): [Read-Write] The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
shaped_text_options(ShapedTextOptions): [Read-Write] Controls how the text within this widget should be shaped.
slot(PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
text(Text): [Read-Write] The text to display
text_style_set(DataTable): [Read-Write] Text Style Set
text_transform_policy(TextTransformPolicy): [Read-Write] The text transformation policy to apply to this text block
tool_tip_text(Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mouse
tool_tip_widget(Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mouse
visibility(SlateVisibility): [Read-Write] The visibility of the widget
wrap_text_at(float): [Read-Write] Whether text wraps onto a new line when it’s length exceeds this width; if this value is zero or negative, no wrapping occurs.
wrapping_policy(TextWrappingPolicy): [Read-Write] The wrapping policy to use.
- get_decorator_by_class(decorator_class) → RichTextBlockDecorator¶
Get Decorator by Class
- set_auto_wrap_text(auto_text_wrap) → None¶
Set the auto wrap for this rich text block
auto_text_wrap (bool) – to turn wrap on or off
- set_default_color_and_opacity(color_and_opacity) → None¶
Sets the color and opacity of the default text in this rich text block
color_and_opacity (SlateColor) – The new text color and opacity
- set_default_font(font_info) → None¶
Dynamically set the default font info for this rich text block
font_info (SlateFontInfo) – The new font info
- set_default_shadow_color_and_opacity(shadow_color_and_opacity) → None¶
Sets the color and opacity of the default text drop shadow Note: if opacity is zero no shadow will be drawn
shadow_color_and_opacity (LinearColor) – The new drop shadow color and opacity
- set_default_shadow_offset(shadow_offset) → None¶
Sets the offset that the default text drop shadow should be drawn at
shadow_offset (Vector2D) – The new offset
- set_default_strike_brush() → SlateBrush¶
Dynamically set the default strike brush for this rich text block
strike_brush (SlateBrush): The new brush to use to strike through text
- Return type
- set_default_text_style(default_text_style) → None¶
Wholesale override of the currently established default text style
default_text_style (TextBlockStyle) – The new text style to apply to all default (i.e. undecorated) text in the block
- set_min_desired_width(min_desired_width) → None¶
Set the minimum desired width for this rich text block
min_desired_width (float) – new minimum desired width
- set_text(text) → None¶
Directly sets the widget text. Warning: This will wipe any binding created for the Text property!
text (Text) – The text to assign to the widget
- set_text_style_set(new_text_style_set) → None¶
Set Text Style Set
new_text_style_set (DataTable) –
- set_text_transform_policy(transform_policy) → None¶
Set the text transformation policy for this text block.
transform_policy (TextTransformPolicy) – the new text transformation policy.