unreal.CommonRichTextBlock

class unreal.CommonRichTextBlock(outer: Object | None = None, name: Name | str = 'None')

Bases: RichTextBlock

Text block that supports custom scaling for mobile platforms, with option to only show icons if space is sparse.

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

  • File: CommonRichTextBlock.h

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.

  • apply_line_height_to_bottom_line (bool): [Read-Write] Whether to leave extra space below the last line due to line height.

  • auto_collapse_with_empty_text (bool): [Read-Write] True to automatically collapse this rich text block when set to display an empty string. Conversely, will be SelfHitTestInvisible when showing a non-empty string.

  • 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]

  • default_text_style_override (TextBlockStyle): [Read-Write] Text style to apply by default to text in this block

  • default_text_style_override_class (type(Class)): [Read-Write]

  • display_all_caps (bool): [Read-Write] True to always display text in ALL CAPS deprecated: bDisplayAllCaps is deprecated. Please use TextTransformPolicy instead.

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction

  • inline_icon_display_mode (RichTextInlineIconDisplayMode): [Read-Write]

  • is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user

  • is_scrolling_enabled (bool): [Read-Write] If scrolling is enabled/disabled initially, this can be updated in blueprint

  • 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

  • mobile_text_block_scale (float): [Read-Write] Mobile font size multiplier. Activated by default on mobile. See CVar Mobile_PreviewFontSize

  • 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_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

  • pixel_snapping (WidgetPixelSnapping): [Read-Write] If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation

  • 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.

  • scroll_style (type(Class)): [Read-Write] References the scroll style asset to use, no reference disables scrolling

  • 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_overflow_policy (TextOverflowPolicy): [Read-Write] Sets what happens to text that is clipped and doesn’t fit within the clip rect for this widget

  • text_style_set (DataTable): [Read-Write]

  • text_transform_policy (TextTransformPolicy): [Read-Write] The text transformation policy to apply to this text block

  • tint_inline_icon (bool): [Read-Write] Toggle it on if the text color should also tint the inline icons.

  • 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.

property auto_collapse_with_empty_text: bool

[Read-Only] True to automatically collapse this rich text block when set to display an empty string. Conversely, will be SelfHitTestInvisible when showing a non-empty string.

Type:

(bool)

property display_all_caps: bool

[Read-Write] True to always display text in ALL CAPS deprecated: bDisplayAllCaps is deprecated. Please use TextTransformPolicy instead.

Type:

(bool)

property is_scrolling_enabled: bool

[Read-Only] If scrolling is enabled/disabled initially, this can be updated in blueprint

Type:

(bool)

property scroll_style: Class

[Read-Only] References the scroll style asset to use, no reference disables scrolling

Type:

(type(Class))

set_scrolling_enabled(is_scrolling_enabled) → None

Set Scrolling Enabled

Parameters:

is_scrolling_enabled (bool) –