FLayoutSaveRestore::LoadFromConfig

Given a named DefaultLayout, return any saved version of it from the given ini file, otherwise return the default, also default to open tabs based on bool.

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Docking/LayoutService.h

Include

#include "Framework/Docking/LayoutService.h"

Source

/Engine/Source/Runtime/Slate/Private/Framework/Docking/LayoutService.cpp

Syntax

static TSharedRef< FTabManager::FLayout > LoadFromConfig
(
    const FString & InConfigFileName,
    const TSharedRef< FTabManager::FLayout > & InDefaultLayout,
    const EOutputCanBeNullptr InPrimaryAreaOutputCanBeNullptr
)

Remarks

Given a named DefaultLayout, return any saved version of it from the given ini file, otherwise return the default, also default to open tabs based on bool.

Returns

Loaded layout or the default.

Parameters

Parameter

Description

InConfigFileName

File to be used to load an existing layout.

InDefaultLayout

The layout to be used if the file does not exist.

InPrimaryAreaOutputCanBeNullptr

Analog to the EOutputCanBeNullptr argument of FTabManager::RestoreFrom(), but only applied to the PrimaryArea. It specifies if the primary area can still be nullptr even if no valid tabs (or opened tabs) are found. By default, set to EOutputCanBeNullptr::Never.

InOutRemovedOlderLayoutVersions

If this TArray is not added, default behavior. If it is added as an argument, older versions of this layout field will be also cleaned from the layout ini file and their names returned in OutRemovedOlderLayoutVersions. To be precise, it will remove fields with a name that contains the same characters, other than the final number(s) and dot(s). E.g., for "UnrealEd_Layout_v1.4", any layout field starting by "UnrealEd_Layout_v" with some numbers and/or dots after the final "v".
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss