FGlobalTabmanager

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FTabManager

FGlobalTabmanager

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

Name Description

Public variable

FOnOverrideDock...

 

OnOverrideDockableAreaRestore_Handler

Used to override dockable area restoration behavior

Constructors

No constructors are accessible with public or protected access.

Functions

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

 

CanSetAsActiveTab

(
    const TSharedPtr< SDockTab >& Tab
)

Can the manager activate this Tab as the new active tab?

Public function

void

 

DrawAttentionToTabManager

(
    const TSharedRef< FTabManager >& C...
)

Draw the user's attention to a child tab manager

Public function Static

const TShare...

 

Get()

Public function Const

TSharedPtr< ...

 

GetActiveTab()

Public function Const

const FText ...

 

GetApplicationTitle()

Public function

TSharedPtr< ...

 

GetMajorTabForTabManager

(
    const TSharedRef< FTabManager >& C...
)

Gets the major tab for the manager

Public function Const

int32

 

GetMaximumTabCount()

Returns the highest number of tabs that were open simultaneously during this session

Public function Const

int32

 

GetMaximumWindowCount()

Returns the highest number of parent windows that were open simultaneously during this session

Public function Const

TSharedPtr< ...

 

GetRootWindow()

The window under which all other windows in our app nest; might be null

Public function Const

FName

 

GetTabTypeForPotentiallyLegacyTab

(
    FName InTabType
)

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< ...

 

New()

Public function

TSharedRef< ...

 

NewTabManager

(
    const TSharedRef< SDockTab >& InOw...
)

Public function

FDelegateHan...

 

OnActiveTabChanged_Subscribe

(
    const FOnActiveTabChanged::FDelegat...
)

Subscribe to notifications about the active tab changing

Public function

void

 

OnActiveTabChanged_Unsubscribe

(
    FDelegateHandle Handle
)

Unsubscribe to notifications about the active tab changing

Public function

FDelegateHan...

 

OnTabForegrounded_Subscribe

(
    const FOnActiveTabChanged::FDelegat...
)

Subscribe to notifications about a foreground tab changing

Public function

void

 

OnTabForegrounded_Unsubscribe

(
    FDelegateHandle Handle
)

Unsubscribe to notifications about a foreground tab changing

Public function

FTabSpawnerE...

 

RegisterNomadTabSpawner

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

Register a new normad tab spawner with the tab manager.

Public function

void

 

SaveAllVisualState()

Persist and serialize the layout of every TabManager and the custom visual state of every Tab.

Public function

void

 

SetActiveTab

(
    const TSharedPtr< SDockTab >& NewA...
)

Activate the NewActiveTab. If NewActiveTab is NULL, the active tab is cleared.

Public function

void

 

SetApplicationTitle

(
    const FText& AppTitle
)

Public function

void

 

SetProxyTabManager

(
    TSharedPtr< FProxyTabmanager > InPr...
)

Public function

void

 

SetRootWindow

(
    const TSharedRef< SWindow > InRootW...
)

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

Public function

void

 

UnregisterNomadTabSpawner

(
    const FName TabId
)

Public function

void

 

UpdateMainMenu

(
    const TSharedRef< SDockTab >& ForT...,
    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

Name Description

Public function Virtual

bool

 

CanCloseManager

(
    const TSet< TSharedRef< SDockTab > ...
)

Check these all tabs to see if it is OK to close them. Ignore the TabsToIgnore

Protected function Virtual

void

 

OnTabClosing

(
    const TSharedRef< SDockTab >& TabB...
)

Protected function Virtual

void

 

OnTabForegrounded

(
    const TSharedPtr< SDockTab >& NewF...,
    const TSharedPtr< SDockTab >& Back...
)

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

 

OnTabManagerClosing()

Invoked when a tab manager is closing down.

Protected function Virtual

void

 

OnTabRelocated

(
    const TSharedRef< SDockTab >& Relo...,
    const TSharedPtr< SWindow >& NewOw...
)

Protected function Virtual

void

 

OpenUnmanagedTab

(
    FName PlaceholderId,
    const FSearchPreference& SearchPre...,
    const TSharedRef< SDockTab >& Unma...
)

Protected function Virtual

void

 

UpdateStats()

Called when tab(s) have been added or windows created

Typedefs

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss