UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FTabManager::FLayout Class Reference

#include <TabManager.h>

+ Inheritance diagram for FTabManager::FLayout:

Public Member Functions

TSharedRef< FLayoutAddArea (const TSharedRef< FArea > &InArea)
 
const TWeakPtr< FArea > & GetPrimaryArea () const
 
TConstArrayView< TSharedRef< FArea > > GetAreas () const
 
SLATE_API FName GetLayoutName () const
 
SLATE_API TSharedRef< FJsonObjectToJson () const
 
SLATE_API FString ToString () const
 
SLATE_API void ProcessExtensions (const FLayoutExtender &Extender)
 
- Public Member Functions inherited from TSharedFromThis< FLayout >
TSharedRef< FLayout, Mode > AsShared ()
 
TSharedRef< FLayout const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FLayout, Mode > AsWeak ()
 
TWeakPtr< FLayout const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Static Public Member Functions

static SLATE_API TSharedPtr< FTabManager::FLayoutNewFromString (const FString &LayoutAsText)
 
static SLATE_API TSharedPtr< FTabManager::FLayoutNewFromJson (const TSharedPtr< FJsonObject > &LayoutAsJson)
 

Static Public Attributes

static SLATE_API const TSharedRef< FTabManager::FLayoutNullLayout = FTabManager::NewLayout("NullLayout")->AddArea(FTabManager::NewPrimaryArea())
 

Protected Member Functions

 FLayout (const FName &InLayoutName)
 
- Protected Member Functions inherited from TSharedFromThis< FLayout >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Static Protected Member Functions

static SLATE_API TSharedRef< class FJsonObjectPersistToString_Helper (const TSharedRef< FLayoutNode > &NodeToPersist)
 
static SLATE_API TSharedRef< FLayoutNodeNewFromString_Helper (TSharedPtr< FJsonObject > JsonObject)
 
- Static Protected Member Functions inherited from TSharedFromThis< FLayout >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Protected Attributes

TWeakPtr< FAreaPrimaryArea
 
TArray< TSharedRef< FArea > > Areas
 
FName LayoutName
 

Friends

class FTabManager
 

Constructor & Destructor Documentation

◆ FLayout()

FTabManager::FLayout::FLayout ( const FName InLayoutName)
inlineprotected

Member Function Documentation

◆ AddArea()

TSharedRef< FLayout > FTabManager::FLayout::AddArea ( const TSharedRef< FArea > &  InArea)
inline

A dummy layout meant to spawn nothing during (e.g., asset editor) initialization

◆ GetAreas()

TConstArrayView< TSharedRef< FArea > > FTabManager::FLayout::GetAreas ( ) const
inline

◆ GetLayoutName()

FName FTabManager::FLayout::GetLayoutName ( ) const

◆ GetPrimaryArea()

const TWeakPtr< FArea > & FTabManager::FLayout::GetPrimaryArea ( ) const
inline

◆ NewFromJson()

TSharedPtr< FTabManager::FLayout > FTabManager::FLayout::NewFromJson ( const TSharedPtr< FJsonObject > &  LayoutAsJson)
static

◆ NewFromString()

TSharedPtr< FTabManager::FLayout > FTabManager::FLayout::NewFromString ( const FString &  LayoutAsText)
static

◆ NewFromString_Helper()

TSharedRef< FTabManager::FLayoutNode > FTabManager::FLayout::NewFromString_Helper ( TSharedPtr< FJsonObject JsonObject)
staticprotected

◆ PersistToString_Helper()

TSharedRef< FJsonObject > FTabManager::FLayout::PersistToString_Helper ( const TSharedRef< FLayoutNode > &  NodeToPersist)
staticprotected

◆ ProcessExtensions()

void FTabManager::FLayout::ProcessExtensions ( const FLayoutExtender Extender)

◆ ToJson()

TSharedRef< FJsonObject > FTabManager::FLayout::ToJson ( ) const

◆ ToString()

FString FTabManager::FLayout::ToString ( ) const

Friends And Related Symbol Documentation

◆ FTabManager

friend class FTabManager
friend

Member Data Documentation

◆ Areas

TArray< TSharedRef<FArea> > FTabManager::FLayout::Areas
protected

◆ LayoutName

FName FTabManager::FLayout::LayoutName
protected

The layout will be saved into a config file with this name. E.g. LevelEditorLayout or MaterialEditorLayout

◆ NullLayout

const TSharedRef< FTabManager::FLayout > FTabManager::FLayout::NullLayout = FTabManager::NewLayout("NullLayout")->AddArea(FTabManager::NewPrimaryArea())
static

◆ PrimaryArea

TWeakPtr< FArea > FTabManager::FLayout::PrimaryArea
protected

The documentation for this class was generated from the following files: