LayoutService.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Framework/Docking/TabManager.h"
 
struct FLayoutSaveRestore
{
    static SLATE_API const FString& GetAdditionalLayoutConfigIni();
 
    static SLATE_API void SaveToConfig(const FString& InConfigFileName, const TSharedRef<FTabManager::FLayout>& InLayoutToSave );
 
    static SLATE_API TSharedRef<FTabManager::FLayout> LoadFromConfig(const FString& InConfigFileName, const TSharedRef<FTabManager::FLayout>& InDefaultLayout,
        const EOutputCanBeNullptr InPrimaryAreaOutputCanBeNullptr = EOutputCanBeNullptr::Never);
    static SLATE_API TSharedRef<FTabManager::FLayout> LoadFromConfig(const FString& InConfigFileName, const TSharedRef<FTabManager::FLayout>& InDefaultLayout,
        const EOutputCanBeNullptr InPrimaryAreaOutputCanBeNullptr, TArray<FString>& OutRemovedOlderLayoutVersions);
 
    static SLATE_API void SaveSectionToConfig(const FString& InConfigFileName, const FString& InSectionName, const FString& InSectionValue);
 
    UE_DEPRECATED(5.7, "SaveSectionToConfig using FText value is deprecated. Please use the SaveSectionToConfig function using FString.")
    static SLATE_API void SaveSectionToConfig(const FString& InConfigFileName, const FString& InSectionName, const FText& InSectionValue);
 
    static SLATE_API FText LoadSectionFromConfig(const FString& InConfigFileName, const FString& InSectionName, const bool bIsOptional = false);
 
    static SLATE_API void MigrateConfig(const FString& OldConfigFileName, const FString& NewConfigFileName);
 
    static SLATE_API bool DuplicateConfig(const FString& SourceConfigFileName, const FString& TargetConfigFileName);
 
    static SLATE_API bool IsValidConfig(const FString& InConfigFileName, bool bAllowFallback = true);
 
private:
 
    static TSharedRef<FTabManager::FLayout> LoadFromConfigPrivate(const FString& InConfigFileName, const TSharedRef<FTabManager::FLayout>& InDefaultLayout,
        const EOutputCanBeNullptr InPrimaryAreaOutputCanBeNullptr, const bool bInRemoveOlderLayoutVersions, TArray<FString>& OutRemovedOlderLayoutVersions);
};