SDockingSplitter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Framework/Docking/TabManager.h"
#include "Framework/Docking/SDockingNode.h"
 
class SDockingTabStack;
 
class SDockingSplitter : public SDockingNode
{
public:
    SLATE_BEGIN_ARGS(SDockingSplitter){}
    SLATE_END_ARGS()
 
    SLATE_API void Construct( const FArguments& InArgs, const TSharedRef<FTabManager::FSplitter>& PersistentNode );
 
    virtual Type GetNodeType() const override
    {
        return SDockingNode::DockSplitter;
    }
 
    SLATE_API void AddChildNode( const TSharedRef<SDockingNode>& InChild, int32 InLocation = INDEX_NONE);
 
    SLATE_API void ReplaceChild( const TSharedRef<SDockingNode>& InChildToReplace, const TSharedRef<SDockingNode>& Replacement );
 
    SLATE_API void RemoveChild( const TSharedRef<SDockingNode>& ChildToRemove );
    
    SLATE_API void RemoveChildAt( int32 IndexOfChildToRemove );
 
    SLATE_API void PlaceNode( const TSharedRef<SDockingNode>& NodeToPlace, SDockingNode::RelativeDirection Direction, const TSharedRef<SDockingNode>& RelativeToMe );
 
    SLATE_API void SetOrientation(EOrientation NewOrientation);
 
    SLATE_API const TArray< TSharedRef<SDockingNode> >& GetChildNodes() const;
 
    SLATE_API TArray< TSharedRef<SDockingNode> > GetChildNodesRecursively() const;
    
    SLATE_API virtual TArray< TSharedRef<SDockTab> > GetAllChildTabs() const override;
 
    SLATE_API virtual int32 GetNumTabs() const override;
 
    SLATE_API virtual SSplitter::ESizeRule GetSizeRule() const override;
 
    SLATE_API float GetSizeCoefficientForSlot(int32 Index) const;
 
    SLATE_API EOrientation GetOrientation() const;
 
    SLATE_API virtual TSharedPtr<FTabManager::FLayoutNode> GatherPersistentLayout() const override;
 
    SLATE_API TSharedRef<SDockingTabStack> FindTabStackToHouseWindowControls() const;
 
    SLATE_API TSharedRef<SDockingTabStack> FindTabStackToHouseWindowIcon() const;
 
protected:
 
    static SLATE_API bool DoesDirectionMatchOrientation( SDockingNode::RelativeDirection InDirection, EOrientation InOrientation );
 
    static SLATE_API SDockingNode::ECleanupRetVal MostResponsibility( SDockingNode::ECleanupRetVal A, SDockingNode::ECleanupRetVal B );
 
    SLATE_API virtual SDockingNode::ECleanupRetVal CleanUpNodes() override;
 
    SLATE_API virtual void OnResized() override;
 
    SLATE_API float ComputeChildCoefficientTotal() const;
 
    enum class ETabStackToFind
    {
        UpperLeft,
        UpperRight
    };
 
    SLATE_API TSharedRef<SDockingNode> FindTabStack(ETabStackToFind FindMe) const;
 
    TSharedPtr<SSplitter> Splitter;
    
    TArray< TSharedRef<class SDockingNode> > Children;
 
    SLATE_API void AdjustDockedTabsIfNeeded();
};