#include <TabManager.h>

Inheritance diagram for FGlobalTabmanager:

Public Member Functions
SLATE_API FDelegateHandle	OnActiveTabChanged_Subscribe (const FOnActiveTabChanged::FDelegate &InDelegate)

SLATE_API void	OnActiveTabChanged_Unsubscribe (FDelegateHandle Handle)

SLATE_API FDelegateHandle	OnTabForegrounded_Subscribe (const FOnActiveTabChanged::FDelegate &InDelegate)

SLATE_API void	OnTabForegrounded_Unsubscribe (FDelegateHandle Handle)

SLATE_API TSharedPtr< SDockTab >	GetActiveTab () const

SLATE_API bool	CanSetAsActiveTab (const TSharedPtr< SDockTab > &Tab)

SLATE_API void	SetActiveTab (const TSharedPtr< SDockTab > &NewActiveTab)

SLATE_API FTabSpawnerEntry &	RegisterNomadTabSpawner (const FName TabId, const FOnSpawnTab &OnSpawnTab, const FCanSpawnTab &CanSpawnTab=FCanSpawnTab())

SLATE_API void	UnregisterNomadTabSpawner (const FName TabId)

SLATE_API void	SetApplicationTitle (const FText &AppTitle)

SLATE_API const FText &	GetApplicationTitle () const

virtual SLATE_API bool	CanCloseManager (const TSet< TSharedRef< SDockTab > > &TabsToIgnore=TSet< TSharedRef< SDockTab > >()) override

SLATE_API TSharedPtr< SDockTab >	GetMajorTabForTabManager (const TSharedRef< FTabManager > &ChildManager)

SLATE_API TSharedPtr< FTabManager >	GetTabManagerForMajorTab (const TSharedPtr< SDockTab > DockTab) const

SLATE_API TSharedPtr< FTabManager >	GetSubTabManagerForWindow (const TSharedRef< SWindow > &InWindow) const

SLATE_API void	DrawAttentionToTabManager (const TSharedRef< FTabManager > &ChildManager)

SLATE_API TSharedRef< FTabManager >	NewTabManager (const TSharedRef< SDockTab > &InOwnerTab)

SLATE_API void	UpdateMainMenu (const TSharedRef< SDockTab > &ForTab, bool const bForce)

SLATE_API void	SaveAllVisualState ()

SLATE_API void	SetRootWindow (const TSharedRef< SWindow > InRootWindow)

SLATE_API TSharedPtr< SWindow >	GetRootWindow () const

SLATE_API void	AddLegacyTabType (FName InLegacyTabType, FName InNewTabType)

SLATE_API bool	IsLegacyTabType (FName InTabType) const

SLATE_API FName	GetTabTypeForPotentiallyLegacyTab (FName InTabType) const

int32	GetMaximumTabCount () const

int32	GetMaximumWindowCount () const

SLATE_API void	SetCanSavePersistentLayouts (bool bInCanSavePersistentLayouts)

SLATE_API bool	CanSavePersistentLayouts () const

SLATE_API void	SetProxyTabManager (TSharedPtr< FProxyTabmanager > InProxyTabManager)

SLATE_API bool	GetShouldUseMiddleEllipsisForDockTabLabel () const

SLATE_API void	SetShouldUseMiddleEllipsisForDockTabLabel (const bool bInShouldUseMiddleEllipsis)

	DECLARE_DELEGATE (FOnOverrideDockableAreaRestore)

virtual SLATE_API void	OnTabManagerClosing () override

SLATE_API void	SetInitialLayoutSP (TSharedPtr< FTabManager::FLayout > InLayout)

SLATE_API TSharedPtr< FTabManager::FLayout >	GetInitialLayoutSP ()

Public Member Functions inherited from FTabManager
	DECLARE_DELEGATE_OneParam (FOnPersistLayout, const TSharedRef< FLayout > &)

SLATE_API FTabManager::FPrivateApi &	GetPrivateApi ()

SLATE_API void	SetOnPersistLayout (const FOnPersistLayout &InHandler)

SLATE_API void	CloseAllAreas ()

SLATE_API TSharedRef< FTabManager::FLayout >	PersistLayout () const

SLATE_API void	SavePersistentLayout ()

SLATE_API void	RequestSavePersistentLayout ()

SLATE_API void	ClearPendingLayoutSave ()

SLATE_API FTabSpawnerEntry &	RegisterTabSpawner (const FName TabId, const FOnSpawnTab &OnSpawnTab, const FCanSpawnTab &CanSpawnTab=FCanSpawnTab())

SLATE_API bool	UnregisterTabSpawner (const FName TabId)

SLATE_API void	UnregisterAllTabSpawners ()

SLATE_API TSharedPtr< SWidget >	RestoreFrom (const TSharedRef< FLayout > &Layout, const TSharedPtr< SWindow > &ParentWindow, const bool bEmbedTitleAreaContent=false, const EOutputCanBeNullptr RestoreAreaOutputCanBeNullptr=EOutputCanBeNullptr::Never)

SLATE_API TSharedPtr< SWidget >	RestorePanelDrawer (const TSharedRef< SWidget > &InContent, const TSharedRef< SWindow > &ParentWindow)

SLATE_API void	PopulateLocalTabSpawnerMenu (FMenuBuilder &PopulateMe)

SLATE_API void	PopulateTabSpawnerMenu (FMenuBuilder &PopulateMe, TSharedRef< FWorkspaceItem > MenuStructure)

SLATE_API void	PopulateTabSpawnerMenu (FMenuBuilder &PopulateMe, TSharedRef< FWorkspaceItem > MenuStructure, bool bIncludeOrphanedMenus)

SLATE_API void	PopulateTabSpawnerMenu (FMenuBuilder &PopulateMe, const FName &TabType)

virtual SLATE_API void	DrawAttention (const TSharedRef< SDockTab > &TabToHighlight)

SLATE_API void	InsertNewDocumentTab (FName PlaceholderId, FName NewTabId, const FSearchPreference &SearchPreference, const TSharedRef< SDockTab > &UnmanagedTab)

SLATE_API void	InsertNewDocumentTab (FName PlaceholderId, const FSearchPreference &SearchPreference, const TSharedRef< SDockTab > &UnmanagedTab)

SLATE_API void	InsertNewDocumentTab (FName PlaceholderId, ESearchPreference::Type SearchPreference, const TSharedRef< SDockTab > &UnmanagedTab)

SLATE_API void	RestoreDocumentTab (FName PlaceholderId, ESearchPreference::Type SearchPreference, const TSharedRef< SDockTab > &UnmanagedTab)

virtual SLATE_API TSharedPtr< SDockTab >	TryInvokeTab (const FTabId &TabId, bool bInvokeAsInactive=false)

SLATE_API TSharedPtr< SDockTab >	FindExistingLiveTab (const FTabId &TabId) const

SLATE_API TSharedPtr< SDockTab >	TryOpenTabInPanelDrawer (const FTabId &TabId, const TSharedPtr< SWindow > &ParentWindow, bool bForceInDrawerPanel=false)

SLATE_API TSharedPtr< SDockTab >	TryToggleTabInPanelDrawer (const FTabId &TabId, const TSharedPtr< SWindow > &ParentWindow, bool bForceInDrawerPanel=false)

virtual SLATE_API	~FTabManager ()

SLATE_API void	SetAllowWindowMenuBar (bool bInAllowWindowMenuBar)

bool	AllowsWindowMenuBar () const

SLATE_API void	SetMenuMultiBox (const TSharedPtr< FMultiBox > NewMenuMutliBox, const TSharedPtr< SWidget > MenuWidget)

SLATE_API void	UpdateMainMenu (TSharedPtr< SDockTab > ForTab, const bool bForce)

SLATE_API void	SetMainTab (const TSharedRef< const SDockTab > &InTab)

SLATE_API void	SetMainTab (const FTabId &InMainTabID)

SLATE_API bool	IsReadOnly ()

SLATE_API void	SetReadOnly (bool bInReadOnly)

FOnReadOnlyModeChanged &	GetOnReadOnlyModeChangedDelegate ()

void	SetCanDoDragOperation (bool CanDoDragOperation)

bool	GetCanDoDragOperation ()

SLATE_API bool	IsTabCloseable (const TSharedRef< const SDockTab > &InTab) const

SLATE_API bool	IsTabAllowedInSidebar (const FTabId TabId) const

TOptional< ETabReadOnlyBehavior >	GetTabReadOnlyBehavior (const FTabId &TabId) const

SLATE_API void	ToggleSidebarOpenTabs ()

SLATE_API const TSharedRef< FWorkspaceItem >	GetLocalWorkspaceMenuRoot () const

SLATE_API TSharedRef< FWorkspaceItem >	AddLocalWorkspaceMenuCategory (const FText &CategoryTitle)

SLATE_API void	AddLocalWorkspaceMenuItem (const TSharedRef< FWorkspaceItem > &CategoryItem)

SLATE_API void	ClearLocalWorkspaceMenuCategories ()

SLATE_API bool	HasTabSpawner (FName TabId) const

TSharedPtr< SDockTab >	GetOwnerTab ()

SLATE_API TSharedRef< FNamePermissionList > &	GetTabPermissionList ()

SLATE_API FUIAction	GetUIActionForTabSpawnerMenuEntry (TSharedPtr< FTabSpawnerEntry > InTabMenuEntry)

SLATE_API TArray< TWeakPtr< FTabSpawnerEntry > >	CollectSpawners ()

SLATE_API TSharedPtr< FTabSpawnerEntry >	FindTabSpawnerFor (FName TabId)

SLATE_API const TSharedPtr< const FTabSpawnerEntry >	FindTabSpawnerFor (FName TabId) const

SLATE_API bool	HasPanelDrawer (const TSharedPtr< SWindow > &ParentWindow) const

SLATE_API bool	IsPanelDrawerOpen (const TSharedPtr< SWindow > &ParentWindow) const

SLATE_API void	ClosePanelDrawer (const TSharedPtr< SWindow > &ParentWindow)

	DECLARE_MULTICAST_DELEGATE_OneParam (FOnPanelDrawerStateChanged, const FTabManager &)

PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS SLATE_API FDelegateHandle	RegisterOnPanelDrawerStateChanges (FOnPanelDrawerStateChanged::FDelegate &&InDelegate)

PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS SLATE_API void	UnregisterOnPanelDrawerStateChanges (FDelegateHandle InHandle)

SLATE_API bool	HasValidOpenTabs (const TSharedRef< FTabManager::FLayoutNode > &SomeNode) const

SLATE_API TSharedPtr< FArea >	GetAreaFromInitialLayoutWithTabType (const FTabId &InTabIdToMatch) const

Public Member Functions inherited from TSharedFromThis< FTabManager >
TSharedRef< FTabManager, Mode >	AsShared ()

TSharedRef< FTabManager const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< FTabManager, Mode >	AsWeak ()

TWeakPtr< FTabManager 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 const TSharedRef< FGlobalTabmanager > &	Get ()

static TSharedRef< FGlobalTabmanager >	New ()

Static Public Member Functions inherited from FTabManager
static TSharedRef< FLayout >	NewLayout (const FName LayoutName)

static TSharedRef< FArea >	NewPrimaryArea ()

static TSharedRef< FArea >	NewArea (const float Width, const float Height)

static TSharedRef< FArea >	NewArea (const FVector2D &WindowSize)

static TSharedRef< FStack >	NewStack ()

static TSharedRef< FSplitter >	NewSplitter ()

static void	RegisterDefaultTabWindowSize (const FTabId &TabName, const FVector2D DefaultSize)

static void	UnregisterDefaultTabWindowSize (const FTabId &TabName)

Public Attributes
FOnOverrideDockableAreaRestore	OnOverrideDockableAreaRestore_Handler

Protected Member Functions
virtual SLATE_API void	OnTabForegrounded (const TSharedPtr< SDockTab > &NewForegroundTab, const TSharedPtr< SDockTab > &BackgroundedTab) override

virtual SLATE_API void	OnTabRelocated (const TSharedRef< SDockTab > &RelocatedTab, const TSharedPtr< SWindow > &NewOwnerWindow) override

virtual SLATE_API void	OnTabClosing (const TSharedRef< SDockTab > &TabBeingClosed) override

virtual SLATE_API void	UpdateStats () override

virtual SLATE_API void	OpenUnmanagedTab (FName PlaceholderId, const FSearchPreference &SearchPreference, const TSharedRef< SDockTab > &UnmanagedTab) override

virtual SLATE_API void	FinishRestore () override

Protected Member Functions inherited from FTabManager
SLATE_API void	InvokeTabForMenu (FName TabId)

SLATE_API void	InsertDocumentTab (FName PlaceholderId, const FSearchPreference &SearchPreference, const TSharedRef< SDockTab > &UnmanagedTab, bool bPlaySpawnAnim)

SLATE_API void	InsertDocumentTab (FName PlaceholderId, FName NewTabId, const FSearchPreference &SearchPreference, const TSharedRef< SDockTab > &UnmanagedTab, bool bPlaySpawnAnim)

SLATE_API void	PopulateTabSpawnerMenu_Helper (FMenuBuilder &PopulateMe, struct FPopulateTabSpawnerMenu_Args Args)

SLATE_API void	MakeSpawnerMenuEntry (FMenuBuilder &PopulateMe, const TSharedPtr< FTabSpawnerEntry > &InSpawnerNode)

SLATE_API TSharedPtr< SDockTab >	InvokeTab_Internal (const FTabId &TabId, bool bInvokeAsInactive=false, bool bForceOpenWindowIfNeeded=false)

SLATE_API TSharedPtr< SDockTab >	FindLastTabInWindow (TSharedPtr< SWindow > Window) const

SLATE_API TSharedPtr< SDockingTabStack >	FindPotentiallyClosedTab (const FTabId &ClosedTabId)

SLATE_API	FTabManager (const TSharedPtr< SDockTab > &InOwnerTab, const TSharedRef< FTabManager::FTabSpawner > &InNomadTabSpawner)

SLATE_API TSharedPtr< SDockingArea >	RestoreArea (const TSharedRef< FArea > &AreaToRestore, const TSharedPtr< SWindow > &InParentWindow, const bool bEmbedTitleAreaContent=false, const EOutputCanBeNullptr OutputCanBeNullptr=EOutputCanBeNullptr::Never, bool bForceOpenWindowIfNeeded=false)

SLATE_API TSharedPtr< class SDockingNode >	RestoreArea_Helper (const TSharedRef< FLayoutNode > &LayoutNode, const TSharedPtr< SWindow > &ParentWindow, const bool bEmbedTitleAreaContent, FSidebarTabLists &OutSidebarTabs, const EOutputCanBeNullptr OutputCanBeNullptr=EOutputCanBeNullptr::Never, bool bForceOpenWindowIfNeeded=false)

SLATE_API bool	CanRestoreSplitterContent (TArray< TSharedRef< class SDockingNode > > &DockingNodes, const TSharedRef< FSplitter > &SplitterNode, const TSharedPtr< SWindow > &ParentWindow, FSidebarTabLists &OutSidebarTabs, const EOutputCanBeNullptr OutputCanBeNullptr)

SLATE_API void	RestoreSplitterContent (const TArray< TSharedRef< class SDockingNode > > &DockingNodes, const TSharedRef< class SDockingSplitter > &SplitterWidget)

SLATE_API void	RestoreSplitterContent (const TSharedRef< FSplitter > &SplitterNode, const TSharedRef< class SDockingSplitter > &SplitterWidget, const TSharedPtr< SWindow > &ParentWindow, FSidebarTabLists &OutSidebarTabs)

SLATE_API bool	IsValidTabForSpawning (const FTab &SomeTab) const

SLATE_API bool	IsAllowedTab (const FTabId &TabId) const

SLATE_API bool	IsAllowedTabType (const FName TabType) const

SLATE_API TSharedPtr< SDockTab >	SpawnTab (const FTabId &TabId, const TSharedPtr< SWindow > &ParentWindow, const bool bCanOutputBeNullptr=false)

SLATE_API TSharedPtr< class SDockingTabStack >	FindTabInLiveAreas (const FTabMatcher &TabMatcher) const

SLATE_API bool	HasValidTabs (const TSharedRef< FTabManager::FLayoutNode > &SomeNode) const

SLATE_API void	SetTabsTo (const TSharedRef< FTabManager::FLayoutNode > &SomeNode, const ETabState::Type NewTabState, const ETabState::Type OriginalTabState) const

virtual SLATE_API void	OnTabOpening (const TSharedRef< SDockTab > &TabBeingOpened)

SLATE_API int32	FindTabInCollapsedAreas (const FTabMatcher &Matcher)

SLATE_API void	RemoveTabFromCollapsedAreas (const FTabMatcher &Matcher)

TSharedPtr< SDockingArea >	GetDockingAreaForWindow (const TSharedRef< SWindow > &InWindow) const

TSharedPtr< SDockingArea >	GetDockingAreaForPanelDrawer (const TSharedPtr< SWindow > &InWindow) const

SLATE_API bool	HasTabSpawnerFor (FName TabId) const

Protected Member Functions inherited from TSharedFromThis< FTabManager >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Additional Inherited Members
Protected Types inherited from FTabManager
typedef TMap< FName, TSharedRef< FTabSpawnerEntry > >	FTabSpawner

Static Protected Member Functions inherited from FTabManager
static TSharedRef< FTabManager >	New (const TSharedPtr< SDockTab > &InOwnerTab, const TSharedRef< FTabSpawner > &InNomadTabSpawner)

static SLATE_API TSharedPtr< class SDockingTabStack >	FindTabInLiveArea (const FTabMatcher &TabMatcher, const TSharedRef< SDockingArea > &InArea)

static bool	HasAnyMatchingTabs (const TSharedRef< FTabManager::FLayoutNode > &SomeNode, const TFunctionRef< bool(const FTab &)> &Matcher)

static SLATE_API void	GetAllStacks (const TSharedRef< SDockingArea > &InDockArea, TArray< TSharedRef< SDockingTabStack > > &OutTabStacks)

static SLATE_API TSharedPtr< FTabManager::FStack >	FindTabUnderNode (const FTabMatcher &Matcher, const TSharedRef< FTabManager::FLayoutNode > &NodeToSearchUnder)

static SLATE_API FVector2D	GetDefaultTabWindowSize (const FTabId &TabId)

Static Protected Member Functions inherited from TSharedFromThis< FTabManager >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Protected Attributes inherited from FTabManager
FTabSpawner	TabSpawner

TSharedRef< FTabSpawner >	NomadTabSpawner

TArray< TWeakPtr< SDockingArea > >	DockAreas

TArray< TSharedRef< FTabManager::FArea > >	CollapsedDockAreas

TArray< TSharedRef< FTabManager::FArea > >	InvalidDockAreas

TSharedPtr< FWorkspaceItem >	LocalWorkspaceMenuRoot

TWeakPtr< SDockTab >	OwnerTabPtr

TSharedPtr< FMultiBox >	MenuMultiBox

TSharedPtr< SWidget >	MenuWidget

TSharedRef< FPrivateApi >	PrivateApi

FName	ActiveLayoutName

FOnPersistLayout	OnPersistLayout_Handler

int32	LastDocumentUID

FTabId	MainNonCloseableTabID

TSharedPtr< const SDockTab >	PendingMainNonClosableTab

bool	bEnforceMainTab = false

TWeakPtr< SWindow >	LastMajorDockWindow

bool	bCanDoDragOperation = true

bool	bCanDoDeferredLayoutSave = true

bool	bAllowPerWindowMenu = false

FTSTicker::FDelegateHandle	PendingLayoutSaveHandle

TSharedRef< FNamePermissionList >	TabPermissionList

TArray< TWeakPtr< SDockTab > >	TemporarilySidebaredTabs

bool	bReadOnly = false

FOnReadOnlyModeChanged	OnReadOnlyModeChanged

PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS FOnPanelDrawerStateChanged	OnPanelDrawerStateChangedDelegate

PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS TMap< FTabId, TSharedRef< SDockTab > >	PanelDrawerActiveHiddenTabs

Static Protected Attributes inherited from FTabManager
SLATE_API static const FVector2D	FallbackWindowSize

static SLATE_API TMap< FTabId, FVector2D >	DefaultTabWindowSizeMap

Member Function Documentation

◆ AddLegacyTabType()

void FGlobalTabmanager::AddLegacyTabType	(	FName	InLegacyTabType,
		FName	InNewTabType
	)

Adds a legacy tab type to the tab type redirection map so tabs loaded with this type will be automatically converted to the new type

◆ CanCloseManager()

bool FGlobalTabmanager::CanCloseManager ( const TSet< TSharedRef< SDockTab > > & TabsToIgnore = TSet< TSharedRef<SDockTab> >() )

overridevirtual

Check these all tabs to see if it is OK to close them. Ignore the TabsToIgnore

Ignore locked tabs

Reimplemented from FTabManager.

◆ CanSavePersistentLayouts()

bool FGlobalTabmanager::CanSavePersistentLayouts ( ) const

Returns true if any layouts ( across all tab managers ) can be saved at this time.

◆ CanSetAsActiveTab()

bool FGlobalTabmanager::CanSetAsActiveTab ( const TSharedPtr< SDockTab > & Tab )

Can the manager activate this Tab as the new active tab?

◆ DECLARE_DELEGATE()

FGlobalTabmanager::DECLARE_DELEGATE ( FOnOverrideDockableAreaRestore )

◆ DrawAttentionToTabManager()

void FGlobalTabmanager::DrawAttentionToTabManager ( const TSharedRef< FTabManager > & ChildManager )

Draw the user's attention to a child tab manager

◆ FinishRestore()

void FGlobalTabmanager::FinishRestore ( )

overrideprotectedvirtual

Called at the end of RestoreFrom for tab managers to complete any work after all tabs have been restored

Grab the primary area and restore its PanelDrawer. When restoring the via global manager they don't restore themselves right away

Reimplemented from FTabManager.

◆ Get()

const TSharedRef< FGlobalTabmanager > & FGlobalTabmanager::Get ( )

static

◆ GetActiveTab()

TSharedPtr< class SDockTab > FGlobalTabmanager::GetActiveTab ( ) const

Returns: the currently active tab; NULL pointer if there is no active tab

◆ GetApplicationTitle()

const FText & FGlobalTabmanager::GetApplicationTitle ( ) const

◆ GetInitialLayoutSP()

TSharedPtr< FTabManager::FLayout > FGlobalTabmanager::GetInitialLayoutSP ( )

Gets the initial layout shared pointer, which can be used later to get the current layout for tabs which were not spawned on initialization

◆ GetMajorTabForTabManager()

TSharedPtr< SDockTab > FGlobalTabmanager::GetMajorTabForTabManager ( const TSharedRef< FTabManager > & ChildManager )

Gets the major tab for the manager

◆ GetMaximumTabCount()

int32 FGlobalTabmanager::GetMaximumTabCount ( ) const

inline

Returns the highest number of tabs that were open simultaneously during this session

◆ GetMaximumWindowCount()

int32 FGlobalTabmanager::GetMaximumWindowCount ( ) const

inline

Returns the highest number of parent windows that were open simultaneously during this session

◆ GetRootWindow()

TSharedPtr< SWindow > FGlobalTabmanager::GetRootWindow ( ) const

The window under which all other windows in our app nest; might be null

◆ GetShouldUseMiddleEllipsisForDockTabLabel()

bool FGlobalTabmanager::GetShouldUseMiddleEllipsisForDockTabLabel ( ) const

Get if the DockTab label should use the MiddleEllipsis overflow policy

◆ GetSubTabManagerForWindow()

TSharedPtr< FTabManager > FGlobalTabmanager::GetSubTabManagerForWindow ( const TSharedRef< SWindow > & InWindow ) const

Get the tab manager that manage the minor tabs for a window if there is one

◆ GetTabManagerForMajorTab()

TSharedPtr< FTabManager > FGlobalTabmanager::GetTabManagerForMajorTab ( const TSharedPtr< SDockTab > DockTab ) const

Gets the tab manager that a major tab owns. The returned tab manager is the tab manager that manages the minor tabs for a major tab. Note: this is not the same as DockTab->GetTabManager(). That function returns the tab manager the major tab is in

◆ GetTabTypeForPotentiallyLegacyTab()

FName FGlobalTabmanager::GetTabTypeForPotentiallyLegacyTab ( FName InTabType ) const

If the specified TabType is deprecated, returns the new replacement tab type. Otherwise, returns InTabType

◆ IsLegacyTabType()

bool FGlobalTabmanager::IsLegacyTabType ( FName InTabType ) const

Returns true if the specified tab type is registered as a legacy tab

◆ New()

static TSharedRef< FGlobalTabmanager > FGlobalTabmanager::New ( )

inlinestatic

◆ NewTabManager()

TSharedRef< FTabManager > FGlobalTabmanager::NewTabManager ( const TSharedRef< SDockTab > & InOwnerTab )

◆ OnActiveTabChanged_Subscribe()

FDelegateHandle FGlobalTabmanager::OnActiveTabChanged_Subscribe ( const FOnActiveTabChanged::FDelegate & InDelegate )

Subscribe to notifications about the active tab changing

◆ OnActiveTabChanged_Unsubscribe()

void FGlobalTabmanager::OnActiveTabChanged_Unsubscribe ( FDelegateHandle Handle )

Unsubscribe to notifications about the active tab changing

◆ OnTabClosing()

void FGlobalTabmanager::OnTabClosing ( const TSharedRef< SDockTab > & TabBeingClosed )

overrideprotectedvirtual

Reimplemented from FTabManager.

◆ OnTabForegrounded()

void FGlobalTabmanager::OnTabForegrounded	(	const TSharedPtr< SDockTab > &	NewForegroundTab,
		const TSharedPtr< SDockTab > &	BackgroundedTab
	)

overrideprotectedvirtual

Notify the tab manager that the NewForegroundTab was brought to front and the BackgroundedTab was send to the background as a result.

Reimplemented from FTabManager.

◆ OnTabForegrounded_Subscribe()

FDelegateHandle FGlobalTabmanager::OnTabForegrounded_Subscribe ( const FOnActiveTabChanged::FDelegate & InDelegate )

Subscribe to notifications about a foreground tab changing

◆ OnTabForegrounded_Unsubscribe()

void FGlobalTabmanager::OnTabForegrounded_Unsubscribe ( FDelegateHandle Handle )

Unsubscribe to notifications about a foreground tab changing

◆ OnTabManagerClosing()

void FGlobalTabmanager::OnTabManagerClosing ( )

overridevirtual

Invoked when a tab manager is closing down.

Reimplemented from FTabManager.

◆ OnTabRelocated()

void FGlobalTabmanager::OnTabRelocated	(	const TSharedRef< SDockTab > &	RelocatedTab,
		const TSharedPtr< SWindow > &	NewOwnerWindow
	)

overrideprotectedvirtual

Reimplemented from FTabManager.

◆ OpenUnmanagedTab()

void FGlobalTabmanager::OpenUnmanagedTab	(	FName	PlaceholderId,
		const FSearchPreference &	SearchPreference,
		const TSharedRef< SDockTab > &	UnmanagedTab
	)

overrideprotectedvirtual

Reimplemented from FTabManager.

◆ RegisterNomadTabSpawner()

FTabSpawnerEntry & FGlobalTabmanager::RegisterNomadTabSpawner	(	const FName	TabId,
		const FOnSpawnTab &	OnSpawnTab,
		const FCanSpawnTab &	CanSpawnTab = `FCanSpawnTab()`
	)

Register a new nomad tab spawner with the tab manager. The spawner will be called when anyone calls InvokeTab(). A nomad tab is a tab that can be placed with major tabs or minor tabs in any tab well.

Parameters

TabId	The TabId to register the spawner for.
OnSpawnTab	The callback that will be used to spawn the tab.
CanSpawnTab	The callback that will be used to ask if spawning the tab is allowed.

Returns: The registration entry for the spawner.

◆ SaveAllVisualState()

void FGlobalTabmanager::SaveAllVisualState ( )

Persist and serialize the layout of every TabManager and the custom visual state of every Tab.

◆ SetActiveTab()

void FGlobalTabmanager::SetActiveTab ( const TSharedPtr< SDockTab > & NewActiveTab )

Activate the NewActiveTab. If NewActiveTab is NULL, the active tab is cleared.

◆ SetApplicationTitle()

void FGlobalTabmanager::SetApplicationTitle ( const FText & AppTitle )

◆ SetCanSavePersistentLayouts()

void FGlobalTabmanager::SetCanSavePersistentLayouts ( bool bInCanSavePersistentLayouts )

Sets whether or not any layouts ( across all tab managers ) can be saved at this time.

◆ SetInitialLayoutSP()

void FGlobalTabmanager::SetInitialLayoutSP ( TSharedPtr< FTabManager::FLayout > InLayout )

Sets the initial layout shared pointer, which can be used later to get the current layout for tabs which were not spawned on initialization

Parameters

InLayout the FLayout which was loaded at layout load time

◆ SetProxyTabManager()

void FGlobalTabmanager::SetProxyTabManager ( TSharedPtr< FProxyTabmanager > InProxyTabManager )

◆ SetRootWindow()

void FGlobalTabmanager::SetRootWindow ( const TSharedRef< SWindow > InRootWindow )

Provide a window under which all other windows in this application should nest.

◆ SetShouldUseMiddleEllipsisForDockTabLabel()

void FGlobalTabmanager::SetShouldUseMiddleEllipsisForDockTabLabel ( const bool bInShouldUseMiddleEllipsis )

Set whether the DockTab label should use the MiddleEllipsis overflow policy

◆ UnregisterNomadTabSpawner()

void FGlobalTabmanager::UnregisterNomadTabSpawner ( const FName TabId )

◆ UpdateMainMenu()

void FGlobalTabmanager::UpdateMainMenu	(	const TSharedRef< SDockTab > &	ForTab,
		bool const	bForce
	)

Update the native, global menu bar if it is being used for a specific tab managed by the global tab manager.

Parameters

ForTab	The tab to update the main menu.
bForce	Used to force an update even if the parent window doesn't contain the widget with keyboard focus.

◆ UpdateStats()

void FGlobalTabmanager::UpdateStats ( )

overrideprotectedvirtual

Called when tab(s) have been added or windows created

Reimplemented from FTabManager.

Member Data Documentation

◆ OnOverrideDockableAreaRestore_Handler

FOnOverrideDockableAreaRestore FGlobalTabmanager::OnOverrideDockableAreaRestore_Handler

Used to override dockable area restoration behavior

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ AddLegacyTabType()

◆ CanCloseManager()

◆ CanSavePersistentLayouts()

◆ CanSetAsActiveTab()

◆ DECLARE_DELEGATE()

◆ DrawAttentionToTabManager()

◆ FinishRestore()

◆ Get()

◆ GetActiveTab()

◆ GetApplicationTitle()

◆ GetInitialLayoutSP()

◆ GetMajorTabForTabManager()

◆ GetMaximumTabCount()

◆ GetMaximumWindowCount()

◆ GetRootWindow()

◆ GetShouldUseMiddleEllipsisForDockTabLabel()

◆ GetSubTabManagerForWindow()

◆ GetTabManagerForMajorTab()

◆ GetTabTypeForPotentiallyLegacyTab()

◆ IsLegacyTabType()

◆ New()

◆ NewTabManager()

◆ OnActiveTabChanged_Subscribe()

◆ OnActiveTabChanged_Unsubscribe()

◆ OnTabClosing()

◆ OnTabForegrounded()

◆ OnTabForegrounded_Subscribe()

◆ OnTabForegrounded_Unsubscribe()

◆ OnTabManagerClosing()

◆ OnTabRelocated()

◆ OpenUnmanagedTab()

◆ RegisterNomadTabSpawner()

◆ SaveAllVisualState()

◆ SetActiveTab()

◆ SetApplicationTitle()

◆ SetCanSavePersistentLayouts()

◆ SetInitialLayoutSP()

◆ SetProxyTabManager()

◆ SetRootWindow()

◆ SetShouldUseMiddleEllipsisForDockTabLabel()

◆ UnregisterNomadTabSpawner()

◆ UpdateMainMenu()

◆ UpdateStats()

Member Data Documentation

◆ OnOverrideDockableAreaRestore_Handler