FLayoutExtender Class Reference

#include <LayoutExtender.h>

Inheritance diagram for FLayoutExtender:

Public Member Functions
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
template<typename AllocatorType >
void	FindStackExtensions (FName ExtensionID, ELayoutExtensionPosition Position, TArray< FTabManager::FTab, AllocatorType > &OutValues) const
void	ExtendAreaRecursive (const TSharedRef< FTabManager::FArea > &Area) const
Public Member Functions inherited from TSharedFromThis< FLayoutExtender >
TSharedRef< FLayoutExtender, Mode >	AsShared ()
TSharedRef< FLayoutExtender const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FLayoutExtender, Mode >	AsWeak ()
TWeakPtr< FLayoutExtender 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

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FLayoutExtender >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FLayoutExtender >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Class used for extending default layouts

Member Function Documentation

ExtendArea()

void FLayoutExtender::ExtendArea	(	FName	ExtensionId,
		const FAreaExtension &	AreaExtension
	)

Extend the area identified by the specified extension ID

Parameters

ExtensionId	The ID of the area to extend (FTabManager::FArea::ExtensionId)
AreaExtensions	A callback to call with the default layout for the desired area

ExtendAreaRecursive()

void FLayoutExtender::ExtendAreaRecursive

(

const TSharedRef< FTabManager::FArea > &

Area

)

const

Recursively extend the specified area

ExtendLayout()

void FLayoutExtender::ExtendLayout	(	FTabId	PredicateTabId,
		ELayoutExtensionPosition	Position,
		FTabManager::FTab	TabToAdd
	)

Extend the layout by defining a tab before or after the specified predicate tab ID

Parameters

PredicateTabId	The existing tab to place the extended tab before/after
Position	Whether to place the new tab before or after this tab
TabToAdd	The new tab definition

ExtendStack()

SLATE_API void FLayoutExtender::ExtendStack	(	FName	ExtensionId,
		ELayoutExtensionPosition	Position,
		FTabManager::FTab	TabToAdd
	)

Extend the tab stack identified by the specified extension ID

Parameters

ExtensionId	The ID of the area to extend (FTabManager::FStack::ExtensionId)
AreaExtensions	A callback to call with the default layout for the desired area
Position	Whether to place the new tab at the start or end of this stack. Above and below are not used for this case.
TabToAdd	The new tab definition

FindStackExtensions()

template<typename AllocatorType >

void FLayoutExtender::FindStackExtensions ( FName  ExtensionID, ELayoutExtensionPosition  Position, TArray< FTabManager::FTab, AllocatorType > &  OutValues  ) const

inline

Populate the specified container with the tabs that relate to the specified stack

Parameters

TabId	The existing tab that may be extended
Position	The position to acquire extensions for (before/after)
OutValues	The container to populate with extended tabs

FindTabExtensions()

template<typename AllocatorType >

void FLayoutExtender::FindTabExtensions ( FTabId  TabId, ELayoutExtensionPosition  Position, TArray< FTabManager::FTab, AllocatorType > &  OutValues  ) const

inline

Populate the specified container with the tabs that relate to the specified tab ID

Parameters

TabId	The existing tab that may be extended
Position	The position to acquire extensions for (before/after)
OutValues	The container to populate with extended tabs

---

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

• Engine/Source/Runtime/Slate/Public/Framework/Docking/LayoutExtender.h
• Engine/Source/Runtime/Slate/Private/Framework/Docking/LayoutExtender.cpp