1. Epic GamesDeveloper
  3. FTabManager

FTabManager

API > API/Runtime > API/Runtime/Slate

   
Name FTabManager
Type class
Header File /Engine/Source/Runtime/Slate/Public/Framework/Docking/TabManager.h
Include Path #include "Framework/Docking/TabManager.h"

Syntax

class FTabManager : public TSharedFromThis< FTabManager >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

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

   Framework/Docking/TabManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FTabManager()

   Framework/Docking/TabManager.h  

Classes

Name Remarks
FArea  
FLastMajorOrNomadTab  
FLayout  
FLayoutNode  
FLiveTabSearch  
FPrivateApi  
FRequireClosedTab  
FSearchPreference  
FSplitter  
FStack  

Structs

Name Remarks
ESearchPreference  
FPanelDrawerSize  
FPanelDrawerTab  
FTab  

Typedefs

Name Type Remarks Include Path
FOnPanelDrawerStateChanged TMulticastDelegate_OneParam< void, const FTabManager & >   Framework/Docking/TabManager.h
FOnPersistLayout TBaseDelegate_OneParam< void, const TSharedRef< FLayout > & >   Framework/Docking/TabManager.h
FTabSpawner TMap< FName, TSharedRef< FTabSpawnerEntry > >   Framework/Docking/TabManager.h

Constants

Name Type Remarks Include Path
DefaultTabWindowSizeMap TMap< FTabId, FVector2D > Default tab window sizes for newly-created tabs Framework/Docking/TabManager.h
FallbackWindowSize const FVector2D The fallback size for a window Framework/Docking/TabManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedRef< FWorkspaceItem > AddLocalWorkspaceMenuCategory ( const FText& CategoryTitle
)

 Adds a category to the local workspace menu by name Framework/Docking/TabManager.h  

void AddLocalWorkspaceMenuItem ( const TSharedRef< FWorkspaceItem >& CategoryItem
)

 Adds an existing workspace item to the local workspace menu Framework/Docking/TabManager.h  

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. Framework/Docking/TabManager.h  

void ClearLocalWorkspaceMenuCategories()

 Clears all categories in the local workspace menu Framework/Docking/TabManager.h  

void ClearPendingLayoutSave()

 Clears the request for a deferred save of the layout Framework/Docking/TabManager.h  

void CloseAllAreas()

 Close all live areas and wipe all the persisted areas. Framework/Docking/TabManager.h  

void ClosePanelDrawer ( const TSharedPtr< SWindow >& ParentWindow
)

   Framework/Docking/TabManager.h  

TArray< TWeakPtr< FTabSpawnerEntry > > CollectSpawners()

 Return an array of all tab spawners that should have menu items in the main menu. Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

 Finds the first instance of an existing tab with the given tab id. Framework/Docking/TabManager.h  

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

 Find a tab spawner by name. Framework/Docking/TabManager.h  
Find a tab spawner by name. Framework/Docking/TabManager.h  

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

 Gets a TSharedPtr with the given FTabId if present, else it return nullptr Framework/Docking/TabManager.h  

bool GetCanDoDragOperation()

 Return true if we can do drag operation Framework/Docking/TabManager.h  

const TSharedRef< FWorkspaceItem > GetLocalWorkspaceMenuRoot()

   Framework/Docking/TabManager.h  

FOnReadOnlyModeChanged & GetOnReadOnlyModeChangedDelegate()

   Framework/Docking/TabManager.h  

TSharedPtr< SDockTab > GetOwnerTab()

 Returns the owner tab (if it exists) Framework/Docking/TabManager.h  

FTabManager::FPrivateApi & GetPrivateApi()

   Framework/Docking/TabManager.h  

TSharedRef< FNamePermissionList > & GetTabPermissionList()

 Returns filter for additional control over available tabs Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

FUIAction GetUIActionForTabSpawnerMenuEntry ( TSharedPtr< FTabSpawnerEntry > InTabMenuEntry
)

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

bool HasTabSpawner ( FName TabId
) const

   Framework/Docking/TabManager.h  

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

 It searches for valid and open tabs on SomeNode. Framework/Docking/TabManager.h  

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

 Insert a new UnmanagedTab document tab next to an existing tab (closed or open) that has the PlaceholdId. Framework/Docking/TabManager.h  

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

 Insert a new UnmanagedTab document tab next to an existing tab (closed or open) that has the PlaceholdId. Framework/Docking/TabManager.h  

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

 Insert a new UnmanagedTab document tab next to an existing tab (closed or open) that has the PlaceholdId. Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

bool IsReadOnly()

 Is this Tab Manager in Read Only mode i.e all interactions with panels are disabled Framework/Docking/TabManager.h  

bool IsTabAllowedInSidebar ( const FTabId TabId
) const

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

TSharedRef< FTabManager::FLayout > PersistLayout()

 Gather the persistent layout Framework/Docking/TabManager.h  

void PopulateLocalTabSpawnerMenu ( FMenuBuilder& PopulateMe
)

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

FDelegateHandle RegisterOnPanelDrawerStateChanges ( FOnPanelDrawerStateChanged::FDelegate&& InDelegate
)

   Framework/Docking/TabManager.h  

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

 Register a new tab spawner with the tab manager. Framework/Docking/TabManager.h  

void RequestSavePersistentLayout()

 Request a deferred save of the layout. Framework/Docking/TabManager.h  

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

 Much like InsertNewDocumentTab, but the UnmanagedTab is not seen by the user as newly-created. Framework/Docking/TabManager.h  

TSharedPtr< SWidget > RestoreFrom ( const TSharedRef< FLayout >& Layout,
const TSharedPtr< SWindow >& ParentWindow,
const bool bEmbedTitleAreaContent,
const EOutputCanBeNullptr RestoreAreaOutputCanBeNullptr
)

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

void SavePersistentLayout()

 Gather the persistent layout and execute the custom delegate for saving it to persistent storage (e.g. into config files) Framework/Docking/TabManager.h  

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. Framework/Docking/TabManager.h  

void SetCanDoDragOperation ( bool CanDoDragOperation
)

 Prevent or allow all tabs to be drag Framework/Docking/TabManager.h  

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

 Provide a tab that will be the main tab and cannot be closed. Framework/Docking/TabManager.h  

void SetMainTab ( const FTabId& InMainTabID
)

   Framework/Docking/TabManager.h  

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

 Set the multi-box to use for generating a global menu bar. Framework/Docking/TabManager.h  

void SetOnPersistLayout ( const FOnPersistLayout& InHandler
)

   Framework/Docking/TabManager.h  

void SetReadOnly ( bool bInReadOnly
)

   Framework/Docking/TabManager.h  

void ToggleSidebarOpenTabs()

 Temporarily moves all open tabs in this tab manager to a sidebar or restores them from a temporary state Framework/Docking/TabManager.h  

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

 Try to open tab if it is closed at the last known location. Framework/Docking/TabManager.h  

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

 Try to open tab in the PanelDrawer. Framework/Docking/TabManager.h  

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

 Try to open tab in the PanelDrawer. Framework/Docking/TabManager.h  

void UnregisterAllTabSpawners()

 Unregisters all tab spawners. Framework/Docking/TabManager.h  

void UnregisterOnPanelDrawerStateChanges ( FDelegateHandle InHandle
)

   Framework/Docking/TabManager.h  

bool UnregisterTabSpawner ( const FName TabId
)

 Unregisters the tab spawner matching the provided TabId. Framework/Docking/TabManager.h  

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

 Update the native, global menu bar if it is being used. Framework/Docking/TabManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 Check these all tabs to see if it is OK to close them. Ignore the TabsToIgnore Framework/Docking/TabManager.h  

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

 Use CanRestoreSplitterContent + RestoreSplitterContent when the output of its internal RestoreArea_Helper can be a nullptr. Framework/Docking/TabManager.h  

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

 Finds the last major or nomad tab in a particular window. Framework/Docking/TabManager.h  

TSharedPtr< SDockingTabStack > FindPotentiallyClosedTab ( const FTabId& ClosedTabId
)

   Framework/Docking/TabManager.h  

int32 FindTabInCollapsedAreas ( const FTabMatcher& Matcher
)

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

virtual void FinishRestore()

 Called at the end of RestoreFrom for tab managers to complete any work after all tabs have been restored Framework/Docking/TabManager.h  

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

 Search the docking area to see if we have one that is part of the window. Framework/Docking/TabManager.h  

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

 Search the docking area to see if we have one that is part of the window. Framework/Docking/TabManager.h  

bool HasTabSpawnerFor ( FName TabId
) const

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

void InvokeTabForMenu ( FName TabId
)

   Framework/Docking/TabManager.h  

bool IsAllowedTab ( const FTabId& TabId
) const

   Framework/Docking/TabManager.h  

bool IsAllowedTabType ( const FName TabType
) const

   Framework/Docking/TabManager.h  

bool IsValidTabForSpawning ( const FTab& SomeTab
) const

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

 Notify the tab manager that the NewForegroundTab was brought to front and the BackgroundedTab was send to the background as a result. Framework/Docking/TabManager.h  

virtual void OnTabManagerClosing()

 Invoked when a tab manager is closing down. Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

void PopulateTabSpawnerMenu_Helper ( FMenuBuilder& PopulateMe,
FPopulateTabSpawnerMenu_Args Args
)

   Framework/Docking/TabManager.h  

void RemoveTabFromCollapsedAreas ( const FTabMatcher& Matcher
)

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

 Use this standalone RestoreSplitterContent when the output of its internal RestoreArea_Helper cannot be a nullptr. Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

 It sets the desired (or all) tabs in the FTabManager::FLayoutNode to the desired value. Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

virtual void UpdateStats()

 Called when tab(s) have been added or windows created Framework/Docking/TabManager.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

static FVector2D GetDefaultTabWindowSize ( const FTabId& TabId
)

 Returns the default window size for the TabId, or the fallback window size if it wasn't registered Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

static TSharedRef< FTabManager > New ( const TSharedPtr< SDockTab >& InOwnerTab,
const TSharedRef< FTabSpawner >& InNomadTabSpawner
)

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

static TSharedRef< FLayout > NewLayout ( const FName LayoutName
)

   Framework/Docking/TabManager.h  

static TSharedRef< FArea > NewPrimaryArea()

   Framework/Docking/TabManager.h  

static TSharedRef< FSplitter > NewSplitter()

   Framework/Docking/TabManager.h  

static TSharedRef< FStack > NewStack()

   Framework/Docking/TabManager.h  

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

   Framework/Docking/TabManager.h  

static void UnregisterDefaultTabWindowSize ( const FTabId& TabName
)

   Framework/Docking/TabManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page