PanelWidget.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Components/PanelSlot.h"
#include "Components/Widget.h"
#include "Blueprint/UserWidget.h"
#include "PanelWidget.generated.h"
 
UCLASS(Abstract, MinimalAPI)
class UPanelWidget : public UWidget
{
    GENERATED_UCLASS_BODY()
 
protected:
 
    UPROPERTY(Instanced)
    TArray<TObjectPtr<UPanelSlot>> Slots;
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API int32 GetChildrenCount() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API UWidget* GetChildAt(int32 Index) const;
    
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API TArray<UWidget*> GetAllChildren() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API int32 GetChildIndex(const UWidget* Content) const;
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API bool HasChild(UWidget* Content) const;
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API bool RemoveChildAt(int32 Index);
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API UPanelSlot* AddChild(UWidget* Content);
 
    UMG_API UPanelSlot* AddChild(UWidget* Content, UPanelSlot* SlotTemplate);
 
    UMG_API UPanelSlot* InsertChildAt(int32 Index, UWidget* Content);
 
    UMG_API UPanelSlot* InsertChildAt(int32 Index, UWidget* Content, UPanelSlot* SlotTemplate);
 
    UMG_API void ShiftChild(int32 Index, UWidget* Child);
 
#if WITH_EDITOR
 
    UMG_API bool ReplaceChildAt(int32 Index, UWidget* Content);
 
    UMG_API virtual bool ReplaceChild(UWidget* CurrentChild, UWidget* NewChild);
 
    UMG_API virtual void SetDesignerFlags(EWidgetDesignFlags NewFlags) override;
 
#endif
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API bool RemoveChild(UWidget* Content);
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API bool HasAnyChildren() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget|Panel")
    UMG_API virtual void ClearChildren();
 
    UMG_API const TArray<UPanelSlot*>& GetSlots() const;
 
    bool CanHaveMultipleChildren() const
    {
        return bCanHaveMultipleChildren;
    }
 
    bool CanAddMoreChildren() const
    {
        return CanHaveMultipleChildren() || GetChildrenCount() == 0;
    }
 
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
 
#if WITH_EDITOR
    virtual bool LockToPanelOnDrag() const
    {
        return false;
    }
 
    virtual void ConnectEditorData() override
    {
        for (UPanelSlot* PanelSlot : Slots)
        {
            if (PanelSlot)
            {
                PanelSlot->Parent = this;
                if (PanelSlot->Content)
                {
                    PanelSlot->Content->Slot = PanelSlot;
                }
            }
        }
    }
#endif
 
    // Begin UObject
    UMG_API virtual void PostLoad() override;
    // End UObject
 
    virtual UClass* GetSlotClass() const
    {
        return UPanelSlot::StaticClass();
    }
 
protected:
 
#if WITH_EDITOR
    UMG_API virtual TSharedRef<SWidget> RebuildDesignWidget(TSharedRef<SWidget> Content) override;
#endif
 
    virtual void OnSlotAdded(UPanelSlot* InSlot)
    {
 
    }
 
    virtual void OnSlotRemoved(UPanelSlot* InSlot)
    {
 
    }
 
protected:
    bool bCanHaveMultipleChildren;
};