unreal.WrapBox

class unreal.WrapBox(outer=None, name='None')

Bases: unreal.PanelWidget

Arranges widgets left-to-right or top-to-bottom dependently of the orientation. When the widgets exceed the wrapSize it will place widgets on the next line.

  • Many Children

  • Flows

  • Wraps

C++ Source:

  • Module: UMG

  • File: WrapBox.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.

  • 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: 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] Cursor: The cursor to show when the mouse is over the widget

  • explicit_wrap_size (bool): [Read-Write] Explicit Wrap Size: Use explicit wrap size whenever possible. It greatly simplifies layout calculations and reduces likelihood of “wiggling UI”

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

  • horizontal_alignment (HorizontalAlignment): [Read-Write] Horizontal Alignment: The alignment of each line of wrapped content.

  • inner_slot_padding (Vector2D): [Read-Write] Inner Slot Padding: The inner slot padding goes between slots sharing borders

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

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

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

  • orientation (Orientation): [Read-Write] Orientation: Determines if the Wrap Box should arranges the widgets left-to-right or top-to-bottom

  • 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: The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] Render Transform: The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot: 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.

  • 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: Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget: Tooltip widget to show when the user hovers over the widget with the mouse

  • visibility (SlateVisibility): [Read-Write] Visibility: The visibility of the widget

  • wrap_size (float): [Read-Write] Wrap Size: When this size is exceeded, elements will start appearing on the next line.

add_child_to_wrap_box(content) → WrapBoxSlot

Add Child to Wrap Box

Parameters

content (Widget) –

Return type

WrapBoxSlot

add_child_wrap_box(content)

deprecated: ‘add_child_wrap_box’ was renamed to ‘add_child_to_wrap_box’.

property explicit_wrap_size

[Read-Only] Explicit Wrap Size: Use explicit wrap size whenever possible. It greatly simplifies layout calculations and reduces likelihood of “wiggling UI”

Type

(bool)

property horizontal_alignment

[Read-Only] Horizontal Alignment: The alignment of each line of wrapped content.

Type

(HorizontalAlignment)

property inner_slot_padding

[Read-Only] Inner Slot Padding: The inner slot padding goes between slots sharing borders

Type

(Vector2D)

property orientation

[Read-Only] Orientation: Determines if the Wrap Box should arranges the widgets left-to-right or top-to-bottom

Type

(Orientation)

set_horizontal_alignment(horizontal_alignment) → None

Set Horizontal Alignment

Parameters

horizontal_alignment (HorizontalAlignment) –

set_inner_slot_padding(padding) → None

Sets the inner slot padding goes between slots sharing borders

Parameters

padding (Vector2D) –

property wrap_size

[Read-Only] Wrap Size: When this size is exceeded, elements will start appearing on the next line.

Type

(float)