unreal.PanelWidget

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

Bases: Widget

The base class for all UMG panel widgets. Panel widgets layout a collection of child widgets.

C++ Source:

  • Module: UMG

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

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

  • 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

add_child(content) → PanelSlot

Adds a new child widget to the container. Returns the base slot type, requires casting to turn it into the type specific to the container.

Parameters:

content (Widget) –

Return type:

PanelSlot

clear_children() → None

Remove all child widgets from the panel widget.

get_all_children() → Array[Widget]

Gets all widgets in the container

Return type:

Array[Widget]

get_child_at(index) → Widget

Gets the widget at an index.

Parameters:

index (int32) – The index of the widget.

Returns:

The widget at the given index, or nothing if there is no widget there.

Return type:

Widget

get_child_index(content) → int32

Gets the index of a specific child widget

Parameters:

content (Widget) –

Return type:

int32

get_children_count() → int32

Gets number of child widgets in the container.

Return type:

int32

has_any_children() → bool

Returns true if there are any child widgets in the panel

Return type:

bool

has_child(content) → bool

Returns true if panel contains this widget

Parameters:

content (Widget) –

Return type:

bool

remove_child(content) → bool

Removes a specific widget from the container.

Parameters:

content (Widget) –

Returns:

true if the widget was found and removed.

Return type:

bool

remove_child_at(index) → bool

Removes a child by it’s index.

Parameters:

index (int32) –

Return type:

bool