Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Framework > Docking > FTabManager

Light Theme

Dark Theme

FTabManager

Inheritance Hierarchy

TSharedFromThis

FTabManager

	FGlobalTabmanager
	FProxyTabmanager

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Docking/TabManager.h
Include	#include "Framework/Docking/TabManager.h"

Syntax

class FTabManager : public TSharedFromThis< FTabManager >

Variables

	Name	Description
FName	ActiveLayoutName	The name of the layout being used
bool	bAllowPerWindowMenu	Whether or not this tab manager puts any registered menus in the windows menu bar area
bool	bCanDoDragOperation	Prevent or allow Drag operation.
TArray< TShared...	CollapsedDockAreas	CollapsedDockAreas refers to areas that were closed (e.g., by the user).
TArray< TWeakPt...	DockAreas
TArray< TShared...	InvalidDockAreas	InvalidDockAreas refers to areas that were not recognized by the Editor (e.g., LiveLink when its plugin its disabled).
int32	LastDocumentUID	Instance ID for document tabs.
TWeakPtr< SWind...	LastMajorDockWindow	The last window we docked a nomad or major tab into
TSharedPtr< FWo...	LocalWorkspaceMenuRoot	The root for the local editor's tab spawner workspace menu
TWeakPtr< const...	MainNonCloseableTab	The main tab, this tab cannot be closed.
TSharedPtr< FMu...	MenuMultiBox	The current menu multi-box for the tab, used to construct platform native main menus
TSharedPtr< SWi...	MenuWidget
TSharedRef< FTa...	NomadTabSpawner
FOnPersistLayou...	OnPersistLayout_Handler	Invoked when the tab manager is about to close
TWeakPtr< SDock...	OwnerTabPtr	A Major tab that contains this TabManager's widgets.
FTSTicker::FDel...	PendingLayoutSaveHandle	Handle to a pending layout save.
TSharedRef< FPr...	PrivateApi	Protected private API that must only be accessed by the docking framework internals
TSharedRef< FNa...	TabPermissionList	Allow systems to dynamically hide tabs
FTabSpawner	TabSpawner
TArray< TWeakPt...	TemporarilySidebaredTabs	Tabs which have been temporarily put in the a sidebar

Constructors

	Name	Description
	FTabManager ( const TSharedPtr< SDockTab >& InOw..., const TSharedRef< FTabManager::FTab... )

Destructors

	Name	Description
	~FTabManager()

Functions

	Name	Description
TSharedRef< ...	AddLocalWorkspaceMenuCategory ( const FText& CategoryTitle )	Adds a category to the local workspace menu by name
void	AddLocalWorkspaceMenuItem ( const TSharedRef< FWorkspaceItem > ... )	Adds an existing workspace item to the local workspace menu
bool	AllowsWindowMenuBar()	Whether or not this tab manager supports a custom menu bar for the active major tab that will be shown on top of the major tab area in the window this tab manager resides in.
bool	CanCloseManager ( const TSet< TSharedRef< SDockTab > ... )	Check these all tabs to see if it is OK to close them. Ignore the TabsToIgnore
bool	CanRestoreSplitterContent ( TArray< TSharedRef< class SDockingN..., const TSharedRef< FSplitter >& Spl..., const TSharedPtr< SWindow >& Paren..., FSidebarTabLists& OutSidebarTabs, const EOutputCanBeNullptr OutputCan... )	Use CanRestoreSplitterContent + RestoreSplitterContent when the output of its internal RestoreArea_Helper can be a nullptr.
void	ClearLocalWorkspaceMenuCategories()	Clears all categories in the local workspace menu
void	CloseAllAreas()	Close all live areas and wipe all the persisted areas.
void	DrawAttention ( const TSharedRef< SDockTab >& TabT... )
TSharedPtr< ...	FindExistingLiveTab ( const FTabId& TabId )	Finds the first instance of an existing tab with the given tab id.
TSharedPtr< ...	FindLastTabInWindow ( TSharedPtr< SWindow > Window )	Finds the last major or nomad tab in a particular window.
TSharedPtr< ...	FindPotentiallyClosedTab ( const FTabId& ClosedTabId )
int32	FindTabInCollapsedAreas ( const FTabMatcher& Matcher )
TSharedPtr< ...	FindTabInLiveArea ( const FTabMatcher& TabMatcher, const TSharedRef< SDockingArea >& ... )
TSharedPtr< ...	FindTabInLiveAreas ( const FTabMatcher& TabMatcher )
const TShare...	FindTabSpawnerFor ( FName TabId )
TSharedPtr< ...	FindTabSpawnerFor ( FName TabId )
TSharedPtr< ...	FindTabUnderNode ( const FTabMatcher& Matcher, const TSharedRef< FTabManager::FLay... )
void	FinishRestore()	Called at the end of RestoreFrom for tab managers to complete any work after all tabs have been restored
void	GetAllStacks ( const TSharedRef< SDockingArea >& ..., TArray< TSharedRef< SDockingTabStac... )
bool	GetCanDoDragOperation()	Return true if we can do drag operation
FVector2D	GetDefaultTabWindowSize ( const FTabId& TabId )	Returns the default window size for the TabId, or the fallback window size if it wasn't registered
const TShare...	GetLocalWorkspaceMenuRoot()
TSharedPtr< ...	GetOwnerTab()	Returns the owner tab (if it exists)
FTabManager:...	GetPrivateApi()
TSharedRef< ...	GetTabPermissionList()	Returns filter for additional control over available tabs
FUIAction	GetUIActionForTabSpawnerMenuEntry ( TSharedPtr< FTabSpawnerEntry > InTa... )
bool	HasAnyMatchingTabs ( const TSharedRef< FTabManager::FLay..., const MatchFunctorType& Matcher )
bool	HasTabSpawner ( FName TabId )
bool	HasTabSpawnerFor ( FName TabId )
bool	HasValidOpenTabs ( const TSharedRef< FTabManager::FLay... )	It searches for valid and open tabs on SomeNode.
bool	HasValidTabs ( const TSharedRef< FTabManager::FLay... )
void	InsertDocumentTab ( FName PlaceholderId, const FSearchPreference& SearchPre..., const TSharedRef< SDockTab >& Unma..., bool bPlaySpawnAnim )
void	InsertDocumentTab ( FName PlaceholderId, FName NewTabId, const FSearchPreference& SearchPre..., const TSharedRef< SDockTab >& Unma..., bool bPlaySpawnAnim )
void	InsertNewDocumentTab ( FName PlaceholderId, const FSearchPreference& SearchPre..., const TSharedRef< SDockTab >& Unma... )	Insert a new UnmanagedTab document tab next to an existing tab (closed or open) that has the PlaceholdId.
void	InsertNewDocumentTab ( FName PlaceholderId, ESearchPreference::Type SearchPrefe..., const TSharedRef< SDockTab >& Unma... )	Insert a new UnmanagedTab document tab next to an existing tab (closed or open) that has the PlaceholdId.
void	InsertNewDocumentTab ( FName PlaceholderId, FName NewTabId, const FSearchPreference& SearchPre..., const TSharedRef< SDockTab >& Unma... )	Insert a new UnmanagedTab document tab next to an existing tab (closed or open) that has the PlaceholdId.
TSharedPtr< ...	InvokeTab_Internal ( const FTabId& TabId, bool bInvokeAsInactive )
void	InvokeTabForMenu ( FName TabId )
bool	IsAllowedTab ( const FTabId& TabId )
bool	IsAllowedTabType ( const FName TabType )
bool	IsTabAllowedInSidebar ( const FTabId TabId )
bool	IsTabCloseable ( const TSharedRef< const SDockTab > ... )
bool	IsValidTabForSpawning ( const FTab& SomeTab )
void	MakeSpawnerMenuEntry ( FMenuBuilder& PopulateMe, const TSharedPtr< FTabSpawnerEntry ... )
TSharedRef< ...	New ( const TSharedPtr< SDockTab >& InOw..., const TSharedRef< FTabSpawner >& I... )
TSharedRef< ...	NewArea ( const float Width, const float Height )
TSharedRef< ...	NewArea ( const FVector2D& WindowSize )
TSharedRef< ...	NewLayout ( const FName LayoutName )
TSharedRef< ...	NewPrimaryArea()
TSharedRef< ...	NewSplitter()
TSharedRef< ...	NewStack()
void	OnTabClosing ( const TSharedRef< SDockTab >& TabB... )
void	OnTabForegrounded ( const TSharedPtr< SDockTab >& NewF..., const TSharedPtr< SDockTab >& Back... )	Notify the tab manager that the NewForegroundTab was brought to front and the BackgroundedTab was send to the background as a result.
void	OnTabManagerClosing()	Invoked when a tab manager is closing down.
void	OnTabOpening ( const TSharedRef< SDockTab >& TabB... )
void	OnTabRelocated ( const TSharedRef< SDockTab >& Relo..., const TSharedPtr< SWindow >& NewOw... )
void	OpenUnmanagedTab ( FName PlaceholderId, const FSearchPreference& SearchPre..., const TSharedRef< SDockTab >& Unma... )
TSharedRef< ...	PersistLayout()	Gather the persistent layout
void	PopulateLocalTabSpawnerMenu ( FMenuBuilder& PopulateMe )
void	PopulateTabSpawnerMenu ( FMenuBuilder& PopulateMe, TSharedRef< FWorkspaceItem > MenuSt... )
void	PopulateTabSpawnerMenu ( FMenuBuilder& PopulateMe, TSharedRef< FWorkspaceItem > MenuSt..., bool bIncludeOrphanedMenus )
void	PopulateTabSpawnerMenu ( FMenuBuilder& PopulateMe, const FName& TabType )
void	PopulateTabSpawnerMenu_Helper ( FMenuBuilder& PopulateMe, FPopulateTabSpawnerMenu_Args Args )
void	RegisterDefaultTabWindowSize ( const FTabId& TabName, const FVector2D DefaultSize )
FTabSpawnerE...	RegisterTabSpawner ( const FName TabId, const FOnSpawnTab& OnSpawnTab, const FCanSpawnTab& CanSpawnTab )	Register a new tab spawner with the tab manager.
void	RemoveTabFromCollapsedAreas ( const FTabMatcher& Matcher )
void	RequestSavePersistentLayout()	Request a deferred save of the layout.
TSharedPtr< ...	RestoreArea ( const TSharedRef< FArea >& AreaToR..., const TSharedPtr< SWindow >& InPar..., const bool bEmbedTitleAreaContent, const EOutputCanBeNullptr OutputCan... )
TSharedPtr< ...	RestoreArea_Helper ( const TSharedRef< FLayoutNode >& L..., const TSharedPtr< SWindow >& Paren..., const bool bEmbedTitleAreaContent, FSidebarTabLists& OutSidebarTabs, const EOutputCanBeNullptr OutputCan... )
void	RestoreDocumentTab ( FName PlaceholderId, ESearchPreference::Type SearchPrefe..., const TSharedRef< SDockTab >& Unma... )	Much like InsertNewDocumentTab, but the UnmanagedTab is not seen by the user as newly-created.
TSharedPtr< ...	RestoreFrom ( const TSharedRef< FLayout >& Layou..., const TSharedPtr< SWindow >& Paren..., const bool bEmbedTitleAreaContent, const EOutputCanBeNullptr RestoreAr... )
void	RestoreSplitterContent ( const TArray< TSharedRef< class SDo..., const TSharedRef< class SDockingSpl... )
void	RestoreSplitterContent ( const TSharedRef< FSplitter >& Spl..., const TSharedRef< class SDockingSpl..., const TSharedPtr< SWindow >& Paren..., FSidebarTabLists& OutSidebarTabs )	Use this standalone RestoreSplitterContent when the output of its internal RestoreArea_Helper cannot be a nullptr.
void	SavePersistentLayout()	Gather the persistent layout and execute the custom delegate for saving it to persistent storage (e.g. into config files)
void	SetAllowWindowMenuBar ( bool bInAllowWindowMenuBar )	Sets whether or not this tab manager supports a custom menu bar for the active major tab that will be shown on top of the major tab area in the window this tab manager resides in.
void	SetCanDoDragOperation ( bool CanDoDragOperation )	Prevent or allow all tabs to be drag
void	SetMainTab ( const TSharedRef< const SDockTab > ... )	Provide a tab that will be the main tab and cannot be closed.
void	SetMenuMultiBox ( const TSharedPtr< FMultiBox > NewMe..., const TSharedPtr< SWidget > MenuWid... )	Set the multi-box to use for generating a global menu bar.
void	SetOnPersistLayout ( const FOnPersistLayout& InHandler )
void	SetTabsTo ( const TSharedRef< FTabManager::FLay..., const ETabState::Type NewTabState, const ETabState::Type OriginalTabSt... )	It sets the desired (or all) tabs in the FTabManager::FLayoutNode to the desired value.
TSharedPtr< ...	SpawnTab ( const FTabId& TabId, const TSharedPtr< SWindow >& Paren..., const bool bCanOutputBeNullptr )
void	ToggleSidebarOpenTabs()	Temporarily moves all open tabs in this tab manager to a sidebar or restores them from a temporary state
TSharedPtr< ...	TryInvokeTab ( const FTabId& TabId, bool bInvokeAsInactive )	Try to open tab if it is closed at the last known location.
void	UnregisterAllTabSpawners()	Unregisters all tab spawners.
void	UnregisterDefaultTabWindowSize ( const FTabId& TabName )
bool	UnregisterTabSpawner ( const FName TabId )	Unregisters the tab spawner matching the provided TabId.
void	UpdateMainMenu ( TSharedPtr< SDockTab > ForTab, const bool bForce )	Update the native, global menu bar if it is being used.
void	UpdateStats()	Called when tab(s) have been added or windows created

Classes

	Name	Description
	ESearchPreference
	FArea
	FLastMajorOrNomadTab
	FLayout
	FLayoutNode
	FLiveTabSearch
	FPrivateApi
	FRequireClosedTab
	FSearchPreference
	FSplitter
	FStack
	FTab

Typedefs

Name	Description
FOnPersistLayout
FTabSpawner

Constants

Name	Description
DefaultTabWindowSizeMap	Default tab window sizes for newly-created tabs
FallbackWindowSize	The fallback size for a window

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel