Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Components > UPanelWidget

Light Theme

Dark Theme

UPanelWidget

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

Windows

MacOS

Linux

Inheritance Hierarchy

References

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

Syntax

class UPanelWidget : public UWidget

Remarks

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

Variables

		Name	Description
	bool	bCanHaveMultipleChildren	Can this panel allow for multiple children?
	TArray< UPanelS...	Slots	The slots in the widget holding the child widgets of this panel.

Constructors

	Name	Description
	UPanelWidget ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
UPanelSlot &...	AddChild ( UWidget* Content )	Adds a new child widget to the container.
bool	CanAddMoreChildren()	Returns true if the panel can accept another child widget.
bool	CanHaveMultipleChildren()	Returns true if the panel supports more than one child.
void	ClearChildren()	Remove all child widgets from the panel widget.
TArray< UWid...	GetAllChildren()	Gets all widgets in the container
UWidget *...	GetChildAt ( int32 Index )	Gets the widget at an index.
int32	GetChildIndex ( const UWidget* Content )	Gets the index of a specific child widget
int32	GetChildrenCount()	Gets number of child widgets in the container.
UClass *	GetSlotClass()
const TArray...	GetSlots()	The slots in the widget holding the child widgets of this panel.
bool	HasAnyChildren()	Returns true if there are any child widgets in the panel
bool	HasChild ( UWidget* Content )	Returns true if panel contains this widget
UPanelSlot &...	InsertChildAt ( int32 Index, UWidget* Content )	Inserts a widget at a specific index.
bool	LockToPanelOnDrag()
void	OnSlotAdded ( UPanelSlot* InSlot )
void	OnSlotRemoved ( UPanelSlot* InSlot )
bool	RemoveChild ( UWidget* Content )	Removes a specific widget from the container.
bool	RemoveChildAt ( int32 Index )	Removes a child by it's index.
bool	ReplaceChild ( UWidget* CurrentChild, UWidget* NewChild )	Swaps the child widget out of the slot, and replaces it with the new child widget.
bool	ReplaceChildAt ( int32 Index, UWidget* Content )	Swaps the widget out of the slot at the given index, replacing it with a different widget.
void	ShiftChild ( int32 Index, UWidget* Child )	Moves the child widget from its current index to the new index provided.

Overridden from UWidget

	Name	Description
void	ConnectEditorData()	Allows general fixups and connections only used at editor time.
TSharedRef< ...	RebuildDesignWidget ( TSharedRef< SWidget > Content )
void	SetDesignerFlags ( EWidgetDesignFlags NewFlags )	Sets the designer flags on the widget.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostLoad()	Begin UObject.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss