LayoutExtender.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Templates/SharedPointer.h"
#include "Templates/Function.h"
#include "UObject/NameTypes.h"
#include "Framework/Docking/TabManager.h"
 
typedef TFunction<void(TSharedRef<FTabManager::FArea>)> FAreaExtension;
 
enum class ELayoutExtensionPosition
{
    Before,
    After,
    Above,
    Below,
};
 
class FLayoutExtender : public TSharedFromThis<FLayoutExtender>
{
public:
 
    SLATE_API void ExtendLayout(FTabId PredicateTabId, ELayoutExtensionPosition Position, FTabManager::FTab TabToAdd);
 
 
    SLATE_API void ExtendArea(FName ExtensionId, const FAreaExtension& AreaExtension);
 
    SLATE_API void ExtendStack(FName ExtensionId, ELayoutExtensionPosition Position, FTabManager::FTab TabToAdd);
 
 
    template<typename AllocatorType>
    void FindTabExtensions(FTabId TabId, ELayoutExtensionPosition Position, TArray<FTabManager::FTab, AllocatorType>& OutValues) const
    {
        OutValues.Reset();
 
        TArray<FExtendedTab, TInlineAllocator<2>> Extensions;
        TabExtensions.MultiFind(TabId, Extensions, true);
 
        for (FExtendedTab& Extension : Extensions)
        {
            if (Extension.Position == Position)
            {
                OutValues.Add(Extension.TabToAdd);
            }
        }
    }
 
    template<typename AllocatorType>
    void FindStackExtensions(FName ExtensionID, ELayoutExtensionPosition Position, TArray<FTabManager::FTab, AllocatorType>& OutValues) const
    {
        OutValues.Reset();
 
        TArray<FExtendedTab, TInlineAllocator<2>> Extensions;
        StackExtensions.MultiFind(ExtensionID, Extensions, true);
 
        for (FExtendedTab& Extension : Extensions)
        {
            if (Extension.Position == Position)
            {
                OutValues.Add(Extension.TabToAdd);
            }
        }
    }
 
    void ExtendAreaRecursive(const TSharedRef<FTabManager::FArea>& Area) const;
 
private:
    
    struct FExtendedTab
    {
        FExtendedTab(ELayoutExtensionPosition InPosition, const FTabManager::FTab& InTabToAdd)
            : Position(InPosition), TabToAdd(InTabToAdd)
        {}
 
        ELayoutExtensionPosition Position;
        FTabManager::FTab TabToAdd;
    };
 
    struct FExtendedArea
    {
        FExtendedArea(const FAreaExtension& InExtensionCallback)
            : ExtensionCallback(InExtensionCallback)
        {}
 
        FAreaExtension ExtensionCallback;
    };
 
    TMultiMap<FTabId, FExtendedTab> TabExtensions;
 
    TMultiMap<FName, FExtendedTab> StackExtensions;
 
    TMultiMap<FName, FExtendedArea> AreaExtensions;
};