unreal.TextLayoutWidget

class unreal.TextLayoutWidget(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: Widget

Base class for all widgets that use a text layout. Contains the common options that should be exposed for the underlying Slate widget.

C++ Source:

  • Module: UMG

  • File: TextWidgetTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Behavior: 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] Accessible Summary Behavior: 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] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] Accessible Text: When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • auto_wrap_text (bool): [Read-Write] Auto Wrap Text: True if we’re wrapping text automatically based on the computed horizontal space for this widget.

  • can_children_be_accessible (bool): [Read-Write] Can Children be Accessible: Whether or not children of this widget can appear as distinct accessible widgets.

  • clipping (WidgetClipping): [Read-Write] Clipping

  • cursor (MouseCursor): [Read-Write] Cursor

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference

  • is_enabled (bool): [Read-Write] Is Enabled

  • is_volatile (bool): [Read-Write] Is Volatile: 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] Justification: How the text should be aligned with the margin.

  • line_height_percentage (float): [Read-Write] Line Height Percentage: The amount to scale each lines height by.

  • margin (Margin): [Read-Write] Margin: The amount of blank space left around the edges of text area.

  • navigation (WidgetNavigation): [Read-Write] Navigation: 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 Accessible Defaults: Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write] Override Cursor

  • render_opacity (float): [Read-Write] Render Opacity

  • render_transform (WidgetTransform): [Read-Write] Render Transform

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot

  • shaped_text_options (ShapedTextOptions): [Read-Write] Shaped Text Options: Controls how the text within this widget should be shaped.

  • slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • tool_tip_text (Text): [Read-Write] Tool Tip Text

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget

  • visibility (SlateVisibility): [Read-Write] Visibility

  • wrap_text_at (float): [Read-Write] Wrap Text At: 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] Wrapping Policy: The wrapping policy to use.

property auto_wrap_text: bool

[Read-Only] Auto Wrap Text: True if we’re wrapping text automatically based on the computed horizontal space for this widget.

Type:

(bool)

property justification: TextJustify

[Read-Write] Justification: How the text should be aligned with the margin.

Type:

(TextJustify)

property line_height_percentage: float

[Read-Only] Line Height Percentage: The amount to scale each lines height by.

Type:

(float)

property margin: Margin

[Read-Only] Margin: The amount of blank space left around the edges of text area.

Type:

(Margin)

property shaped_text_options: ShapedTextOptions

[Read-Only] Shaped Text Options: Controls how the text within this widget should be shaped.

Type:

(ShapedTextOptions)

property wrap_text_at: float

[Read-Only] Wrap Text At: Whether text wraps onto a new line when it’s length exceeds this width; if this value is zero or negative, no wrapping occurs.

Type:

(float)

property wrapping_policy: TextWrappingPolicy

[Read-Only] Wrapping Policy: The wrapping policy to use.

Type:

(TextWrappingPolicy)