unreal.SizeBoxComponent

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

Bases: UIComponent

This is a class for a Component that wraps the Owner widget with a Size Box.

C++ Source:

  • Module: UMG

  • File: SizeBoxComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • height_override (float): [Read-Write] When specified, ignore the content’s desired size and report the HeightOverride as the Box’s desired height.

  • horizontal_alignment (HorizontalAlignment): [Read-Write] This property is for the Widget that owns this Component. The alignment of the object horizontally.

  • max_aspect_ratio (float): [Read-Write]

  • max_desired_height (float): [Read-Write] When specified, will report the MaxDesiredHeight if smaller than the content’s desired height.

  • max_desired_width (float): [Read-Write] When specified, will report the MaxDesiredWidth if smaller than the content’s desired width.

  • min_aspect_ratio (float): [Read-Write]

  • min_desired_height (float): [Read-Write] When specified, will report the MinDesiredHeight if larger than the content’s desired height.

  • min_desired_width (float): [Read-Write] When specified, will report the MinDesiredWidth if larger than the content’s desired width.

  • override_height_override (bool): [Read-Write]

  • override_max_aspect_ratio (bool): [Read-Write]

  • override_max_desired_height (bool): [Read-Write]

  • override_max_desired_width (bool): [Read-Write]

  • override_min_aspect_ratio (bool): [Read-Write]

  • override_min_desired_height (bool): [Read-Write]

  • override_min_desired_width (bool): [Read-Write]

  • override_width_override (bool): [Read-Write]

  • padding (Margin): [Read-Write] This property is for the Widget that owns this Component. The padding area between the slot and the content it contains.

  • vertical_alignment (VerticalAlignment): [Read-Write] This property is for the Widget that owns this Component. The alignment of the object vertically.

  • width_override (float): [Read-Write] When specified, ignore the content’s desired size and report the WidthOverride as the Box’s desired width.

clear_height_override() → None

Clear Height Override

clear_max_aspect_ratio() → None

Clear Max Aspect Ratio

clear_max_desired_height() → None

Clear Max Desired Height

clear_max_desired_width() → None

Clear Max Desired Width

clear_min_aspect_ratio() → None

Clear Min Aspect Ratio

clear_min_desired_height() → None

Clear Min Desired Height

clear_min_desired_width() → None

Clear Min Desired Width

clear_width_override() → None

Clear Width Override

property height_override: float

[Read-Write] When specified, ignore the content’s desired size and report the HeightOverride as the Box’s desired height.

Type:

(float)

property horizontal_alignment: HorizontalAlignment

[Read-Write] This property is for the Widget that owns this Component. The alignment of the object horizontally.

Type:

(HorizontalAlignment)

property max_aspect_ratio: float

[Read-Write]

Type:

(float)

property max_desired_height: float

[Read-Write] When specified, will report the MaxDesiredHeight if smaller than the content’s desired height.

Type:

(float)

property max_desired_width: float

[Read-Write] When specified, will report the MaxDesiredWidth if smaller than the content’s desired width.

Type:

(float)

property min_aspect_ratio: float

[Read-Write]

Type:

(float)

property min_desired_height: float

[Read-Write] When specified, will report the MinDesiredHeight if larger than the content’s desired height.

Type:

(float)

property min_desired_width: float

[Read-Write] When specified, will report the MinDesiredWidth if larger than the content’s desired width.

Type:

(float)

property padding: Margin

[Read-Write] This property is for the Widget that owns this Component. The padding area between the slot and the content it contains.

Type:

(Margin)

property vertical_alignment: VerticalAlignment

[Read-Write] This property is for the Widget that owns this Component. The alignment of the object vertically.

Type:

(VerticalAlignment)

property width_override: float

[Read-Write] When specified, ignore the content’s desired size and report the WidthOverride as the Box’s desired width.

Type:

(float)