unreal.WrapBox

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

Bases: 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

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

  • explicit_wrap_size (bool): [Read-Write] Explicit Wrap Size

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

  • horizontal_alignment (HorizontalAlignment): [Read-Write] Horizontal Alignment

  • inner_slot_padding (Vector2D): [Read-Write] Inner Slot Padding

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

  • 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

  • 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

  • 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_size (float): [Read-Write] Wrap Size

add_child_to_wrap_box(content) → WrapBoxSlot

Add Child to Wrap Box

Parameters:

content (Widget) –

Return type:

WrapBoxSlot

add_child_wrap_box(content: Widget) → WrapBoxSlot

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

property explicit_wrap_size: bool

[Read-Write] Explicit Wrap Size

Type:

(bool)

property horizontal_alignment: HorizontalAlignment

[Read-Write] Horizontal Alignment

Type:

(HorizontalAlignment)

property inner_slot_padding: Vector2D

[Read-Write] Inner Slot Padding

Type:

(Vector2D)

property orientation: Orientation

[Read-Write] Orientation

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: float

[Read-Write] Wrap Size

Type:

(float)