1. Epic GamesDeveloper
  3. FTabManager

FTabManager

Unreal Engine C++ API Reference > Runtime > Slate > Framework > Docking

Inheritance Hierarchy

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

  Type Name Description
Protected variable FName ActiveLayoutName The name of the layout being used
Protected variable bool bAllowPerWindowMenu Whether or not this tab manager puts any registered menus in the windows menu bar area
Protected variable bool bCanDoDragOperation Prevent or allow Drag operation.
Protected variable bool bEnforceMainTab If true, this tab manager will always have one non-closable tab
Protected variable TArray< TSharedRef< FTabManager::FArea > > CollapsedDockAreas CollapsedDockAreas refers to areas that were closed (e.g., by the user).
Protected variable TArray< TWeakPtr< SDockingArea > > DockAreas  
Protected variable TArray< TSharedRef< FTabManager::FArea > > InvalidDockAreas InvalidDockAreas refers to areas that were not recognized by the Editor (e.g., LiveLink when its plugin its disabled).
Protected variable int32 LastDocumentUID Instance ID for document tabs.
Protected variable TWeakPtr< SWindow > LastMajorDockWindow The last window we docked a nomad or major tab into
Protected variable TSharedPtr< FWorkspaceItem > LocalWorkspaceMenuRoot The root for the local editor's tab spawner workspace menu
Protected variable FTabId MainNonCloseableTabID The ID of the main tab, which cannot be closed
Protected variable TSharedPtr< FMultiBox > MenuMultiBox The current menu multi-box for the tab, used to construct platform native main menus
Protected variable TSharedPtr< SWidget > MenuWidget  
Protected variable TSharedRef< FTabSpawner > NomadTabSpawner  
Protected variable FOnPersistLayout OnPersistLayout_Handler Invoked when the tab manager is about to close
Protected variable TWeakPtr< SDockTab > OwnerTabPtr A Major tab that contains this TabManager's widgets.
Protected variable FTSTicker::FDelegateHandle PendingLayoutSaveHandle Handle to a pending layout save.
Protected variable TSharedPtr< const SDockTab > PendingMainNonClosableTab To keep track of any pending tabs that want to be the main tab, but don't have their ID set yet
Protected variable TSharedRef< FPrivateApi > PrivateApi Protected private API that must only be accessed by the docking framework internals
Protected variable TSharedRef< FNamePermissionList > TabPermissionList Allow systems to dynamically hide tabs
Protected variable FTabSpawner TabSpawner  
Protected variable TArray< TWeakPtr< SDockTab > > TemporarilySidebaredTabs Tabs which have been temporarily put in the a sidebar

Constructors

  Type Name Description
Protected function  

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

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TSharedRef< FWorkspaceItem >

AddLocalWorkspaceMenuCategory ( const FText& CategoryTitle
)

 Adds a category to the local workspace menu by name
Public function void Adds an existing workspace item to the local workspace menu
Public function Const bool 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.
Protected function Virtual bool

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

 Check these all tabs to see if it is OK to close them. Ignore the TabsToIgnore
Protected function 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.
Public function void Clears all categories in the local workspace menu
Public function void Clears the request for a deferred save of the layout
Public function void Close all live areas and wipe all the persisted areas.
Public function TArray< TWeakPtr< FTabSpawnerEntry > > Return an array of all tab spawners that should have menu items in the main menu.
Public function Virtual void

DrawAttention ( const TSharedRef< SDockTab >& TabToHighlight
)

  
Public function Const TSharedPtr< SDockTab >

FindExistingLiveTab ( const FTabId& TabId
)

 Finds the first instance of an existing tab with the given tab id.
Protected function Const TSharedPtr< SDockTab > Finds the last major or nomad tab in a particular window.
Protected function TSharedPtr< SDockingTabStack >

FindPotentiallyClosedTab ( const FTabId& ClosedTabId
)

  
Protected function int32

FindTabInCollapsedAreas ( const FTabMatcher& Matcher
)

  
Protected function Static TSharedPtr< class SDockingTabStack >

FindTabInLiveArea ( const FTabMatcher& TabMatcher,
const TSharedRef< SDockingArea >& InArea
)

  
Protected function Const TSharedPtr< class SDockingTabStack >

FindTabInLiveAreas ( const FTabMatcher& TabMatcher
)

  
Public function Const const TSharedPtr< const FTabSpawnerEntry > Find a tab spawner by name.
Public function TSharedPtr< FTabSpawnerEntry > Find a tab spawner by name.
Protected function Static TSharedPtr< FTabManager::FStack >

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

  
Protected function Virtual void Called at the end of RestoreFrom for tab managers to complete any work after all tabs have been restored
Protected function Static void

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

  
Public function bool Return true if we can do drag operation
Protected function Static FVector2D

GetDefaultTabWindowSize ( const FTabId& TabId
)

 Returns the default window size for the TabId, or the fallback window size if it wasn't registered
Public function Const const TSharedRef< FWorkspaceItem >  
Public function TSharedPtr< SDockTab > Returns the owner tab (if it exists)
Public function FTabManager::FPrivateApi &  
Public function TSharedRef< FNamePermissionList > & Returns filter for additional control over available tabs
Public function FUIAction  
Protected function Static bool

HasAnyMatchingTabs ( const TSharedRef< FTabManager::FLayoutNode >& SomeNode,
const MatchFunctorType& Matcher
)

  
Public function Const bool

HasTabSpawner ( FName TabId
)

  
Protected function Const bool  
Public function Const bool It searches for valid and open tabs on SomeNode.
Protected function Const bool  
Protected function void

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

  
Protected function void

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

  
Public function 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.
Public function 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.
Public function 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.
Protected function TSharedPtr< SDockTab >

InvokeTab_Internal ( const FTabId& TabId,
bool bInvokeAsInactive
)

  
Protected function void  
Protected function Const bool

IsAllowedTab ( const FTabId& TabId
)

  
Protected function Const bool

IsAllowedTabType ( const FName TabType
)

  
Public function Const bool

IsTabAllowedInSidebar ( const FTabId TabId
)

  
Public function Const bool

IsTabCloseable ( const TSharedRef< const SDockTab >& InTab
)

  
Protected function Const bool

IsValidTabForSpawning ( const FTab& SomeTab
)

  
Protected function void

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

  
Protected function Static TSharedRef< FTabManager >

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

  
Public function Static TSharedRef< FArea >

NewArea ( const float Width,
const float Height
)

  
Public function Static TSharedRef< FArea >

NewArea ( const FVector2D& WindowSize
)

  
Public function Static TSharedRef< FLayout >

NewLayout ( const FName LayoutName
)

  
Public function Static TSharedRef< FArea >  
Public function Static TSharedRef< FSplitter >  
Public function Static TSharedRef< FStack >  
Protected function Virtual void

OnTabClosing ( const TSharedRef< SDockTab >& TabBeingClosed
)

  
Protected function 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.
Protected function Virtual void Invoked when a tab manager is closing down.
Protected function Virtual void

OnTabOpening ( const TSharedRef< SDockTab >& TabBeingOpened
)

  
Protected function Virtual void

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

  
Protected function Virtual void

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

  
Public function Const TSharedRef< FTabManager::FLayout > Gather the persistent layout
Public function void  
Public function void

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

  
Public function void

PopulateTabSpawnerMenu ( FMenuBuilder& PopulateMe,
const FName& TabType
)

  
Public function void

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

  
Protected function void

PopulateTabSpawnerMenu_Helper ( FMenuBuilder& PopulateMe,
FPopulateTabSpawnerMenu_Args Args
)

  
Public function Static void

RegisterDefaultTabWindowSize ( const FTabId& TabName,
const FVector2D DefaultSize
)

  
Public function FTabSpawnerEntry &

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

 Register a new tab spawner with the tab manager.
Protected function void

RemoveTabFromCollapsedAreas ( const FTabMatcher& Matcher
)

  
Public function void Request a deferred save of the layout.
Protected function TSharedPtr< SDockingArea >

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

  
Protected function TSharedPtr< class SDockingNode >

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

  
Public function 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.
Public function TSharedPtr< SWidget >

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

  
Protected function 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.
Protected function void

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

  
Public function void Gather the persistent layout and execute the custom delegate for saving it to persistent storage (e.g. into config files)
Public function 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.
Public function void

SetCanDoDragOperation ( bool CanDoDragOperation
)

 Prevent or allow all tabs to be drag
Public function void

SetMainTab ( const TSharedRef< const SDockTab >& InTab
)

 Provide a tab that will be the main tab and cannot be closed.
Public function void

SetMainTab ( const FTabId& InMainTabID
)

 Provide a tab that will be the main tab and cannot be closed.
Public function void

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

 Set the multi-box to use for generating a global menu bar.
Public function void

SetOnPersistLayout ( const FOnPersistLayout& InHandler
)

  
Protected function Const void

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

 It sets the desired (or all) tabs in the FTabManager::FLayoutNode to the desired value.
Protected function TSharedPtr< SDockTab >

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

  
Public function void Temporarily moves all open tabs in this tab manager to a sidebar or restores them from a temporary state
Public function Virtual TSharedPtr< SDockTab >

TryInvokeTab ( const FTabId& TabId,
bool bInvokeAsInactive
)

 Try to open tab if it is closed at the last known location.
Public function void Unregisters all tab spawners.
Public function Static void  
Public function bool

UnregisterTabSpawner ( const FName TabId
)

 Unregisters the tab spawner matching the provided TabId.
Public function void

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

 Update the native, global menu bar if it is being used.
Protected function Virtual void Called when tab(s) have been added or windows created

Classes

  Type Name Description
Public struct ESearchPreference    
Public class FArea    
Public class FLastMajorOrNomadTab    
Public class FLayout    
Public class FLayoutNode    
Public class FLiveTabSearch    
Public class FPrivateApi    
Public class FRequireClosedTab    
Public class FSearchPreference    
Public class FSplitter    
Public class FStack    
Public struct 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page