unreal.SizeBox

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

Bases: ContentWidget

A widget that allows you to specify the size it reports to have and desire. Not all widgets report a desired size that you actually desire. Wrapping them in a SizeBox lets you have the Size Box force them to be a particular size.

  • Single Child

  • Fixed Size

C++ Source:

  • Module: UMG

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

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

  • height_override (float): [Read-Write] Height Override

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

  • max_aspect_ratio (float): [Read-Write] Max Aspect Ratio

  • max_desired_height (float): [Read-Write] Max Desired Height

  • max_desired_width (float): [Read-Write] Max Desired Width

  • min_aspect_ratio (float): [Read-Write] Min Aspect Ratio

  • min_desired_height (float): [Read-Write] Min Desired Height

  • min_desired_width (float): [Read-Write] Min Desired Width

  • 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

  • override_height_override (bool): [Read-Write] Override Height Override

  • override_max_aspect_ratio (bool): [Read-Write] Override Max Aspect Ratio

  • override_max_desired_height (bool): [Read-Write] Override Max Desired Height

  • override_max_desired_width (bool): [Read-Write] Override Max Desired Width

  • override_min_aspect_ratio (bool): [Read-Write] Override Min Aspect Ratio

  • override_min_desired_height (bool): [Read-Write] Override Min Desired Height

  • override_min_desired_width (bool): [Read-Write] Override Min Desired Width

  • override_width_override (bool): [Read-Write] Override Width Override

  • 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

  • width_override (float): [Read-Write] Width Override

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] Height Override

Type:

(float)

property max_aspect_ratio: float

[Read-Write] Max Aspect Ratio

Type:

(float)

property max_desired_height: float

[Read-Write] Max Desired Height

Type:

(float)

property max_desired_width: float

[Read-Write] Max Desired Width

Type:

(float)

property min_aspect_ratio: float

[Read-Write] Min Aspect Ratio

Type:

(float)

property min_desired_height: float

[Read-Write] Min Desired Height

Type:

(float)

property min_desired_width: float

[Read-Write] Min Desired Width

Type:

(float)

set_height_override(height_override) → None

When specified, ignore the content’s desired size and report the HeightOverride as the Box’s desired height.

Parameters:

height_override (float) –

set_max_aspect_ratio(max_aspect_ratio) → None

Set Max Aspect Ratio

Parameters:

max_aspect_ratio (float) –

set_max_desired_height(max_desired_height) → None

When specified, will report the MaxDesiredHeight if smaller than the content’s desired height.

Parameters:

max_desired_height (float) –

set_max_desired_width(max_desired_width) → None

When specified, will report the MaxDesiredWidth if smaller than the content’s desired width.

Parameters:

max_desired_width (float) –

set_min_aspect_ratio(min_aspect_ratio) → None

Set Min Aspect Ratio

Parameters:

min_aspect_ratio (float) –

set_min_desired_height(min_desired_height) → None

When specified, will report the MinDesiredHeight if larger than the content’s desired height.

Parameters:

min_desired_height (float) –

set_min_desired_width(min_desired_width) → None

When specified, will report the MinDesiredWidth if larger than the content’s desired width.

Parameters:

min_desired_width (float) –

set_width_override(width_override) → None

When specified, ignore the content’s desired size and report the WidthOverride as the Box’s desired width.

Parameters:

width_override (float) –

property width_override: float

[Read-Write] Width Override

Type:

(float)