Navigation
API > API/Runtime > API/Runtime/Slate
| Name | FGlobalTabmanager |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Docking/TabManager.h |
| Include Path | #include "Framework/Docking/TabManager.h" |
Syntax
class FGlobalTabmanager : public FTabManager
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FTabManager → FGlobalTabmanager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGlobalTabmanager() |
Framework/Docking/TabManager.h |
Structs
| Name | Remarks |
|---|---|
| FindByManager | |
| FindByTab | |
| FSubTabManager | Pairs of Major Tab and the TabManager that manages tabs within it. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnOverrideDockableAreaRestore | TBaseDelegate_NoParams< void > | Framework/Docking/TabManager.h | |
| FTabAndManagerForDrawer | TPair< TSharedPtr< SDockTab >, TSharedPtr< FTabManager > > | Framework/Docking/TabManager.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnOverrideDockableAreaRestore_Handler | FOnOverrideDockableAreaRestore | Used to override dockable area restoration behavior | Framework/Docking/TabManager.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveTabPtr | TWeakPtr< SDockTab > | The currently active tab; NULL if there is no active tab. | Framework/Docking/TabManager.h | |
| AllAreasWindowMaxCount | int32 | Keeps track of the running-maximum number of unique parent windows in all dock areas and sub-managers during this session | Framework/Docking/TabManager.h | |
| AllTabsMaxCount | int32 | Keeps track of the running-maximum number of tabs in all dock areas and sub-managers during this session | Framework/Docking/TabManager.h | |
| AppTitle | FText | Framework/Docking/TabManager.h | ||
| bCanSavePersistentLayouts | bool | True if any layouts ( across all tab managers ) can be saved at this time. | Framework/Docking/TabManager.h | |
| bShouldUseMiddleEllipsisForDockTabLabel | bool | Whether tabs label should use MiddleEllipsis OverflowPolicy | Framework/Docking/TabManager.h | |
| InitialLayoutSP | TSharedPtr< FTabManager::FLayout > | The initial layout shared pointer, which can be used to get the current layout for tabs which were not spawned on initialization | Framework/Docking/TabManager.h | |
| LegacyTabTypeRedirectionMap | TMap< FName, FName > | A map that correlates deprecated tab types to new tab types | Framework/Docking/TabManager.h | |
| OnActiveTabChanged | FOnActiveTabChanged | Framework/Docking/TabManager.h | ||
| ProxyTabManager | TSharedPtr< FProxyTabmanager > | Framework/Docking/TabManager.h | ||
| RootWindowPtr | TWeakPtr< SWindow > | A window under which all of the windows in this application will nest. | Framework/Docking/TabManager.h | |
| SubTabManagers | TArray< FSubTabManager > | Framework/Docking/TabManager.h | ||
| TabForegrounded | FOnActiveTabChanged | Framework/Docking/TabManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| 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 | Framework/Docking/TabManager.h | ||
bool CanSavePersistentLayouts() |
Returns true if any layouts ( across all tab managers ) can be saved at this time. | Framework/Docking/TabManager.h | |
bool CanSetAsActiveTab
(
const TSharedPtr< SDockTab >& Tab |
Can the manager activate this Tab as the new active tab? | Framework/Docking/TabManager.h | |
void DrawAttentionToTabManager
(
const TSharedRef< FTabManager >& ChildManager |
Draw the user's attention to a child tab manager | Framework/Docking/TabManager.h | |
TSharedPtr< SDockTab > GetActiveTab() |
Framework/Docking/TabManager.h | ||
const FText & GetApplicationTitle() |
Framework/Docking/TabManager.h | ||
TSharedPtr< FTabManager::FLayout > 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 | Framework/Docking/TabManager.h | |
TSharedPtr< SDockTab > GetMajorTabForTabManager
(
const TSharedRef< FTabManager >& ChildManager |
Gets the major tab for the manager | Framework/Docking/TabManager.h | |
int32 GetMaximumTabCount() |
Returns the highest number of tabs that were open simultaneously during this session | Framework/Docking/TabManager.h | |
int32 GetMaximumWindowCount() |
Returns the highest number of parent windows that were open simultaneously during this session | Framework/Docking/TabManager.h | |
TSharedPtr< SWindow > GetRootWindow() |
The window under which all other windows in our app nest; might be null | Framework/Docking/TabManager.h | |
bool GetShouldUseMiddleEllipsisForDockTabLabel() |
Get if the DockTab label should use the MiddleEllipsis overflow policy | Framework/Docking/TabManager.h | |
TSharedPtr< FTabManager > GetSubTabManagerForWindow
(
const TSharedRef< SWindow >& InWindow |
Get the tab manager that manage the minor tabs for a window if there is one | Framework/Docking/TabManager.h | |
TSharedPtr< FTabManager > GetTabManagerForMajorTab
(
const TSharedPtr< SDockTab > DockTab |
Gets the tab manager that a major tab owns. | Framework/Docking/TabManager.h | |
FName GetTabTypeForPotentiallyLegacyTab
(
FName InTabType |
If the specified TabType is deprecated, returns the new replacement tab type. | Framework/Docking/TabManager.h | |
bool IsLegacyTabType
(
FName InTabType |
Returns true if the specified tab type is registered as a legacy tab | Framework/Docking/TabManager.h | |
TSharedRef< FTabManager > NewTabManager
(
const TSharedRef< SDockTab >& InOwnerTab |
Framework/Docking/TabManager.h | ||
FDelegateHandle OnActiveTabChanged_Subscribe
(
const FOnActiveTabChanged::FDelegate& InDelegate |
Subscribe to notifications about the active tab changing | Framework/Docking/TabManager.h | |
void OnActiveTabChanged_Unsubscribe
(
FDelegateHandle Handle |
Unsubscribe to notifications about the active tab changing | Framework/Docking/TabManager.h | |
FDelegateHandle OnTabForegrounded_Subscribe
(
const FOnActiveTabChanged::FDelegate& InDelegate |
Subscribe to notifications about a foreground tab changing | Framework/Docking/TabManager.h | |
void OnTabForegrounded_Unsubscribe
(
FDelegateHandle Handle |
Unsubscribe to notifications about a foreground tab changing | Framework/Docking/TabManager.h | |
FTabSpawnerEntry & RegisterNomadTabSpawner
(
const FName TabId, |
Register a new nomad tab spawner with the tab manager. | Framework/Docking/TabManager.h | |
void SaveAllVisualState() |
Persist and serialize the layout of every TabManager and the custom visual state of every Tab. | Framework/Docking/TabManager.h | |
void SetActiveTab
(
const TSharedPtr< SDockTab >& NewActiveTab |
Activate the NewActiveTab. If NewActiveTab is NULL, the active tab is cleared. | Framework/Docking/TabManager.h | |
void SetApplicationTitle
(
const FText& AppTitle |
Framework/Docking/TabManager.h | ||
void SetCanSavePersistentLayouts
(
bool bInCanSavePersistentLayouts |
Sets whether or not any layouts ( across all tab managers ) can be saved at this time. | Framework/Docking/TabManager.h | |
void 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 | Framework/Docking/TabManager.h | |
void SetProxyTabManager
(
TSharedPtr< FProxyTabmanager > InProxyTabManager |
Framework/Docking/TabManager.h | ||
void SetRootWindow
(
const TSharedRef< SWindow > InRootWindow |
Provide a window under which all other windows in this application should nest. | Framework/Docking/TabManager.h | |
void SetShouldUseMiddleEllipsisForDockTabLabel
(
const bool bInShouldUseMiddleEllipsis |
Set whether the DockTab label should use the MiddleEllipsis overflow policy | Framework/Docking/TabManager.h | |
void UnregisterNomadTabSpawner
(
const FName TabId |
Framework/Docking/TabManager.h | ||
void UpdateMainMenu
(
const TSharedRef< SDockTab >& ForTab, |
Update the native, global menu bar if it is being used for a specific tab managed by the global tab manager. | Framework/Docking/TabManager.h |
Overridden from FTabManager
| 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 | |
virtual void OnTabManagerClosing() |
Invoked when a tab manager is closing down. | Framework/Docking/TabManager.h |
Protected
Overridden from FTabManager
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
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 | |
virtual void OnTabClosing
(
const TSharedRef< SDockTab >& TabBeingClosed |
Framework/Docking/TabManager.h | ||
virtual void OnTabForegrounded
(
const TSharedPtr< SDockTab >& NewForegroundTab, |
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 OnTabRelocated
(
const TSharedRef< SDockTab >& RelocatedTab, |
Framework/Docking/TabManager.h | ||
virtual void OpenUnmanagedTab
(
FName PlaceholderId, |
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 const TSharedRef< FGlobalTabmanager > & Get() |
Framework/Docking/TabManager.h | ||
static TSharedRef< FGlobalTabmanager > New() |
Framework/Docking/TabManager.h |