1. Epic GamesDeveloper
  3. UPanelWidget

UPanelWidget

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

API > API/Runtime > API/Runtime/UMG

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

   
Name UPanelWidget
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/PanelWidget.h
Include Path #include "Components/PanelWidget.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UPanelWidget : public UWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

UPanelWidget derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPanelWidget ( const FObjectInitializer& ObjectInitializer
)

   Components/PanelWidget.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UPanelSlot * AddChild ( UWidget* Content,
UPanelSlot* SlotTemplate
)

 Adds a new child widget to the container. Components/PanelWidget.h  

UPanelSlot * AddChild ( UWidget* Content
)

 Adds a new child widget to the container. Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

bool CanAddMoreChildren()

 Returns true if the panel can accept another child widget. Components/PanelWidget.h  

bool CanHaveMultipleChildren()

 Returns true if the panel supports more than one child. Components/PanelWidget.h  

virtual void ClearChildren()

 Remove all child widgets from the panel widget. Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

TArray< UWidget * > GetAllChildren()

 Gets all widgets in the container Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

UWidget * GetChildAt ( int32 Index
) const

 Gets the widget at an index. Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

int32 GetChildIndex ( const UWidget* Content
) const

 Gets the index of a specific child widget Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

int32 GetChildrenCount()

 Gets number of child widgets in the container. Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

virtual UClass * GetSlotClass()

   Components/PanelWidget.h  

const TArray< UPanelSlot * > & GetSlots()

 The slots in the widget holding the child widgets of this panel. Components/PanelWidget.h  

bool HasAnyChildren()

 Returns true if there are any child widgets in the panel Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

bool HasChild ( UWidget* Content
) const

 Returns true if panel contains this widget Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

UPanelSlot * InsertChildAt ( int32 Index,
UWidget* Content,
UPanelSlot* SlotTemplate
)

 Inserts a widget at a specific index. Components/PanelWidget.h  

UPanelSlot * InsertChildAt ( int32 Index,
UWidget* Content
)

 Inserts a widget at a specific index. Components/PanelWidget.h  

virtual bool LockToPanelOnDrag()

   Components/PanelWidget.h  

bool RemoveChild ( UWidget* Content
)

 Removes a specific widget from the container. Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

bool RemoveChildAt ( int32 Index
)

 Removes a child by it's index. Components/PanelWidget.h
  • BlueprintCallable
  • Category="Widget|Panel"

virtual bool ReplaceChild ( UWidget* CurrentChild,
UWidget* NewChild
)

 Swaps the child widget out of the slot, and replaces it with the new child widget. Components/PanelWidget.h  

bool ReplaceChildAt ( int32 Index,
UWidget* Content
)

 Swaps the widget out of the slot at the given index, replacing it with a different widget. Components/PanelWidget.h  

void ShiftChild ( int32 Index,
UWidget* Child
)

 Moves the child widget from its current index to the new index provided. Components/PanelWidget.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual void ConnectEditorData()

 Allows general fixups and connections only used at editor time. Components/PanelWidget.h  

virtual void SetDesignerFlags ( EWidgetDesignFlags NewFlags
)

 Sets the designer flags on the widget. Components/PanelWidget.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/PanelWidget.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

 Begin UObject. Components/PanelWidget.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnSlotAdded ( UPanelSlot* InSlot
)

   Components/PanelWidget.h  

virtual void OnSlotRemoved ( UPanelSlot* InSlot
)

   Components/PanelWidget.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildDesignWidget ( TSharedRef< SWidget > Content
)

   Components/PanelWidget.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page