1. Epic GamesDeveloper
  3. FGlobalTabmanager

FGlobalTabmanager

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/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 FGlobalTabmanager : public FTabManager

Variables

  Type Name Description
Public variable FOnOverrideDockableAreaRestore OnOverrideDockableAreaRestore_Handler Used to override dockable area restoration behavior

Constructors

No constructors are accessible with public or protected access.

Functions

  Type Name Description
Public function void

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
Public function bool Can the manager activate this Tab as the new active tab?
Public function void

DrawAttentionToTabManager ( const TSharedRef< FTabManager >& ChildManager
)

 Draw the user's attention to a child tab manager
Public function Static const TSharedRef< FGlobalTabmanager > &

Get ()

  
Public function Const TSharedPtr< SDockTab >  
Public function Const const FText &  
Public function TSharedPtr< SDockTab >

GetMajorTabForTabManager ( const TSharedRef< FTabManager >& ChildManager
)

 Gets the major tab for the manager
Public function Const int32 Returns the highest number of tabs that were open simultaneously during this session
Public function Const int32 Returns the highest number of parent windows that were open simultaneously during this session
Public function Const TSharedPtr< SWindow > The window under which all other windows in our app nest; might be null
Public function Const TSharedPtr< FTabManager > Gets the tab manager that a major tab owns.
Public function Const FName If the specified TabType is deprecated, returns the new replacement tab type.
Public function Const bool

IsLegacyTabType ( FName InTabType
)

 Returns true if the specified tab type is registered as a legacy tab
Public function Static TSharedRef< FGlobalTabmanager >

New ()

  
Public function TSharedRef< FTabManager >

NewTabManager ( const TSharedRef< SDockTab >& InOwnerTab
)

  
Public function FDelegateHandle

OnActiveTabChanged_Subscribe ( const FOnActiveTabChanged::FDelegate& InDelegate
)

 Subscribe to notifications about the active tab changing
Public function void Unsubscribe to notifications about the active tab changing
Public function FDelegateHandle

OnTabForegrounded_Subscribe ( const FOnActiveTabChanged::FDelegate& InDelegate
)

 Subscribe to notifications about a foreground tab changing
Public function void Unsubscribe to notifications about a foreground tab changing
Public function FTabSpawnerEntry &

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

 Register a new normad tab spawner with the tab manager.
Public function void Persist and serialize the layout of every TabManager and the custom visual state of every Tab.
Public function void

SetActiveTab ( const TSharedPtr< SDockTab >& NewActiveTab
)

 Activate the NewActiveTab. If NewActiveTab is NULL, the active tab is cleared.
Public function void

SetApplicationTitle ( const FText& AppTitle
)

  
Public function void  
Public function void

SetRootWindow ( const TSharedRef< SWindow > InRootWindow
)

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

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.

Overridden from FTabManager

  Type Name Description
Public 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 Virtual void Called at the end of RestoreFrom for tab managers to complete any work after all tabs have been restored
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.
Public function Virtual void Invoked when a tab manager is closing down.
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
)

  
Protected function Virtual void Called when tab(s) have been added or windows created

Typedefs

Name Description
FOnOverrideDockableAreaRestore  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page