SDockingNode.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Input/Reply.h"
#include "Widgets/SCompoundWidget.h"
#include "Framework/Docking/TabManager.h"
#include "Widgets/Layout/SSplitter.h"
 
class SDockingArea;
class SDockingSplitter;
 
class SDockingNode : public SCompoundWidget
{
public:
    enum Type
    {
        DockTabStack,
        DockSplitter,
        DockArea,
        PlaceholderNode
    };
 
    enum RelativeDirection
    {
        LeftOf,
        Above,
        RightOf,
        Below,
        Center
    };
 
    struct FOverlayManagement
    {
        FOverlayManagement()
            : bShowingCross(false)
        {
        }
 
        TSharedPtr<SOverlay> ContentAreaOverlay;
 
        bool bShowingCross;
    };
 
    virtual Type GetNodeType() const = 0;
 
    virtual void SetParentNode( TSharedRef<SDockingSplitter> InParent )
    {
        ParentNodePtr = InParent;
    }
 
    enum ELayoutModification
    {
        TabRemoval_DraggedOut,
        TabRemoval_Closed,
        TabRemoval_Sidebar,
        TabRemoval_None
    };
    
 
    SLATE_API virtual TSharedPtr<SDockingArea> GetDockArea();
    SLATE_API virtual TSharedPtr<const SDockingArea> GetDockArea() const;
    
    virtual TArray< TSharedRef<SDockTab> > GetAllChildTabs() const {return TArray< TSharedRef<SDockTab> >();}
 
    virtual int32 GetNumTabs() const { return 0; }
 
    SLATE_API virtual FReply OnUserAttemptingDock( SDockingNode::RelativeDirection Direction, const FDragDropEvent& DragDropEvent );
 
    virtual SSplitter::ESizeRule GetSizeRule() const { return SSplitter::FractionOfParent; }
 
    SLATE_API float GetSizeCoefficient() const;
 
    SLATE_API void SetSizeCoefficient( float InSizeCoefficient );
 
    //virtual bool IsShowingLiveTabs() const;
 
    virtual TSharedPtr<FTabManager::FLayoutNode> GatherPersistentLayout() const = 0;
 
    enum ECleanupRetVal
    {
        VisibleTabsUnderNode,
        HistoryTabsUnderNode,
        NoTabsUnderNode
    };
    virtual SDockingNode::ECleanupRetVal CleanUpNodes(){ return NoTabsUnderNode; }
 
protected:
 
    SLATE_API SDockingNode();
 
    SLATE_API virtual void OnLiveTabAdded();
 
    virtual void OnResized() {}
 
    TWeakPtr<SDockingSplitter> ParentNodePtr;
 
    float SizeCoefficient = 1.0f;
};