UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FProxyTabmanager Class Reference

#include <TabManager.h>

+ Inheritance diagram for FProxyTabmanager:

Public Member Functions

 FProxyTabmanager (TSharedRef< SWindow > InParentWindow)
 
virtual SLATE_API void OpenUnmanagedTab (FName PlaceholderId, const FSearchPreference &SearchPreference, const TSharedRef< SDockTab > &UnmanagedTab) override
 
virtual SLATE_API void DrawAttention (const TSharedRef< SDockTab > &TabToHighlight) override
 
SLATE_API bool IsTabSupported (const FTabId TabId) const
 
SLATE_API void SetParentWindow (TSharedRef< SWindow > InParentWindow)
 
- 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)
 
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
 

Public Attributes

FIsTabSupportedEvent OnIsTabSupported
 
FOnTabEvent OnTabOpened
 
FOnTabEvent OnAttentionDrawnToTab
 

Additional Inherited Members

- 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)
 
- Protected Types inherited from FTabManager
typedef TMap< FName, TSharedRef< FTabSpawnerEntry > > FTabSpawner
 
- 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 OnTabForegrounded (const TSharedPtr< SDockTab > &NewForegroundTab, const TSharedPtr< SDockTab > &BackgroundedTab)
 
virtual SLATE_API void OnTabRelocated (const TSharedRef< SDockTab > &RelocatedTab, const TSharedPtr< SWindow > &NewOwnerWindow)
 
virtual SLATE_API void OnTabOpening (const TSharedRef< SDockTab > &TabBeingOpened)
 
virtual SLATE_API void OnTabClosing (const TSharedRef< SDockTab > &TabBeingClosed)
 
virtual SLATE_API void OnTabManagerClosing ()
 
virtual SLATE_API bool CanCloseManager (const TSet< TSharedRef< SDockTab > > &TabsToIgnore=TSet< TSharedRef< SDockTab > >())
 
SLATE_API int32 FindTabInCollapsedAreas (const FTabMatcher &Matcher)
 
SLATE_API void RemoveTabFromCollapsedAreas (const FTabMatcher &Matcher)
 
virtual SLATE_API void UpdateStats ()
 
virtual void FinishRestore ()
 
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 ()
 
- 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
 

Constructor & Destructor Documentation

◆ FProxyTabmanager()

FProxyTabmanager::FProxyTabmanager ( TSharedRef< SWindow >  InParentWindow)
inline

Member Function Documentation

◆ DrawAttention()

void FProxyTabmanager::DrawAttention ( const TSharedRef< SDockTab > &  TabToHighlight)
overridevirtual

Reimplemented from FTabManager.

◆ IsTabSupported()

bool FProxyTabmanager::IsTabSupported ( const FTabId  TabId) const

◆ OpenUnmanagedTab()

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

Reimplemented from FTabManager.

◆ SetParentWindow()

void FProxyTabmanager::SetParentWindow ( TSharedRef< SWindow >  InParentWindow)

Member Data Documentation

◆ OnAttentionDrawnToTab

FOnTabEvent FProxyTabmanager::OnAttentionDrawnToTab

◆ OnIsTabSupported

FIsTabSupportedEvent FProxyTabmanager::OnIsTabSupported

◆ OnTabOpened

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