1. Epic GamesDeveloper
  3. UPanelWidget

UPanelWidget

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

Unreal Engine C++ API Reference > Runtime > UMG > Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/PanelWidget.h
Include #include "Components/PanelWidget.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UPanelWidget : public UWidget

Remarks

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

Variables

  Type Name Description
Protected variable bool bCanHaveMultipleChildren Can this panel allow for multiple children?
Protected variable UProperty instanced TArray< TObjectPtr< UPanelSlot > > Slots The slots in the widget holding the child widgets of this panel.

Constructors

  Type Name Description
Public function  

UPanelWidget ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category UPanelSlot *

AddChild ( UWidget* Content
)

 Adds a new child widget to the container.
Public function Const bool Returns true if the panel can accept another child widget.
Public function Const bool Returns true if the panel supports more than one child.
Public function Virtual UFunction BlueprintCallable, Category void Remove all child widgets from the panel widget.
Public function Const UFunction BlueprintCallable, Category TArray< UWidget * > Gets all widgets in the container
Public function Const UFunction BlueprintCallable, Category UWidget *

GetChildAt ( int32 Index
)

 Gets the widget at an index.
Public function Const UFunction BlueprintCallable, Category int32

GetChildIndex ( const UWidget* Content
)

 Gets the index of a specific child widget
Public function Const UFunction BlueprintCallable, Category int32 Gets number of child widgets in the container.
Protected function Virtual Const UClass *  
Public function Const const TArray< UPanelSlot * > & The slots in the widget holding the child widgets of this panel.
Public function Const UFunction BlueprintCallable, Category bool Returns true if there are any child widgets in the panel
Public function Const UFunction BlueprintCallable, Category bool

HasChild ( UWidget* Content
)

 Returns true if panel contains this widget
Public function UPanelSlot *

InsertChildAt ( int32 Index,
UWidget* Content
)

 Inserts a widget at a specific index.
Public function Virtual Const bool  
Protected function Virtual void

OnSlotAdded ( UPanelSlot* InSlot
)

  
Protected function Virtual void  
Public function Virtual void Begin UObject.
Public function UFunction BlueprintCallable, Category bool

RemoveChild ( UWidget* Content
)

 Removes a specific widget from the container.
Public function UFunction BlueprintCallable, Category bool

RemoveChildAt ( int32 Index
)

 Removes a child by it's index.
Public function Virtual bool

ReplaceChild ( UWidget* CurrentChild,
UWidget* NewChild
)

 Swaps the child widget out of the slot, and replaces it with the new child widget.
Public function bool

ReplaceChildAt ( int32 Index,
UWidget* Content
)

 Swaps the widget out of the slot at the given index, replacing it with a different widget.
Public function void

ShiftChild ( int32 Index,
UWidget* Child
)

 Moves the child widget from its current index to the new index provided.

Overridden from UWidget

  Type Name Description
Public function Virtual void Allows general fixups and connections only used at editor time.
Protected function Virtual TSharedRef< SWidget >

RebuildDesignWidget ( TSharedRef< SWidget > Content
)

  
Public function Virtual void Sets the designer flags on the widget.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page