CanvasPanel.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 "Widgets/SWidget.h"
#include "Widgets/Layout/SConstraintCanvas.h"
#include "Components/PanelWidget.h"
#include "CanvasPanel.generated.h"
 
class UCanvasPanelSlot;
 
UCLASS(meta = (ShortTooltip = "A designer-friendly panel useful for laying out top-level widgets. Use sparingly."), MinimalAPI)
class UCanvasPanel : public UPanelWidget
{
    GENERATED_UCLASS_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Canvas Panel")
    UMG_API UCanvasPanelSlot* AddChildToCanvas(UWidget* Content);
 
    UMG_API TSharedPtr<class SConstraintCanvas> GetCanvasWidget() const;
 
    UMG_API bool GetGeometryForSlot(int32 SlotIndex, FGeometry& ArrangedGeometry) const;
 
    UMG_API bool GetGeometryForSlot(UCanvasPanelSlot* Slot, FGeometry& ArrangedGeometry) const;
 
    UMG_API void ReleaseSlateResources(bool bReleaseChildren) override;
 
#if WITH_EDITOR
    // UWidget interface
    UMG_API virtual const FText GetPaletteCategory() override;
    // End UWidget interface
 
    // UWidget interface
    virtual bool LockToPanelOnDrag() const override
    {
        return true;
    }
    // End UWidget interface
#endif
 
protected:
 
    // UPanelWidget
    UMG_API virtual UClass* GetSlotClass() const override;
    UMG_API virtual void OnSlotAdded(UPanelSlot* Slot) override;
    UMG_API virtual void OnSlotRemoved(UPanelSlot* Slot) override;
    // End UPanelWidget
 
protected:
 
    TSharedPtr<class SConstraintCanvas> MyCanvas;
 
protected:
    // UWidget interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    // End of UWidget interface
};