| TSharedFromThis
|
Module |
|
Header |
/Engine/Source/Runtime/Slate/Public/Framework/Docking/TabManager.h |
Include |
#include "Framework/Docking/TabManager.h" |
class FTabManager : public TSharedFromThis< FTabManager >
Name | Description | ||
---|---|---|---|
|
ActiveLayoutName |
The name of the layout being used |
|
|
bCanDoDragOperation |
Prevent or allow Drag operation. |
|
|
bIsSavingVisualState |
Defensive: True when we are saving the visual state. |
|
|
CollapsedDockAreas |
CollapsedDockAreas refers to areas that were closed (e.g., by the user). |
|
|
DockAreas |
||
|
InvalidDockAreas |
InvalidDockAreas refers to areas that were not recognized by the Editor (e.g., LiveLink when its plugin its disabled). |
|
|
LastDocumentUID |
Instance ID for document tabs. |
|
|
LastMajorDockWindow |
The last window we docked a nomad or major tab into |
|
|
TSharedPtr< FWo... |
LocalWorkspaceMenuRoot |
The root for the local editor's tab spawner workspace menu |
|
TWeakPtr< const... |
MainNonCloseableTab |
The main tab, this tab cannot be closed. |
|
TSharedPtr< FMu... |
MenuMultiBox |
The current menu multi-box for the tab, used to construct platform native main menus |
|
TSharedRef< FTa... |
NomadTabSpawner |
|
|
OnPersistLayout_Handler |
Invoked when the tab manager is about to close |
|
|
OwnerTabPtr |
A Major tab that contains this TabManager's widgets. |
|
|
TSharedRef< FPr... |
PrivateApi |
Protected private API that must only be accessed by the docking framework internals |
|
TSharedRef< FBl... |
TabBlacklist |
Allow systems to dynamically hide tabs |
|
TabSpawner |
Name | Description | |
---|---|---|
|
FTabManager ( |
Name | Description | |
---|---|---|
|
~FTabManager() |
Name | Description | ||
---|---|---|---|
|
TSharedRef< ... |
AddLocalWorkspaceMenuCategory ( |
Adds a category to the local workspace menu by name |
|
AddLocalWorkspaceMenuItem ( |
Adds an existing workspace item to the local workspace menu |
|
|
CanCloseManager ( |
Check these all tabs to see if it is OK to close them. Ignore the TabsToIgnore |
|
|
CanRestoreSplitterContent ( |
Use CanRestoreSplitterContent + RestoreSplitterContent when the output of its internal RestoreArea_Helper can be a nullptr. |
|
|
ClearLocalWorkspaceMenuCategories() |
Clears all categories in the local workspace menu |
|
|
CloseAllAreas() |
Close all live areas and wipe all the persisted areas. |
|
|
DrawAttention ( |
||
|
TSharedPtr< ... |
FindExistingLiveTab ( |
Finds the first instance of an existing tab with the given tab id. |
|
TSharedPtr< ... |
FindLastTabInWindow ( |
Finds the last major or nomad tab in a particular window. |
|
TSharedPtr< ... |
FindPotentiallyClosedTab ( |
|
|
FindTabInCollapsedAreas ( |
||
|
TSharedPtr< ... |
FindTabInLiveArea ( |
|
|
TSharedPtr< ... |
FindTabInLiveAreas ( |
|
|
TSharedPtr< ... |
FindTabSpawnerFor ( |
|
|
TSharedPtr< ... |
FindTabUnderNode ( |
|
|
GetAllStacks ( |
||
|
GetCanDoDragOperation() |
Return true if we can do drag operation |
|
|
GetDefaultTabWindowSize ( |
Returns the default window size for the TabId, or the fallback window size if it wasn't registered |
|
|
const TShare... |
GetLocalWorkspaceMenuRoot() |
|
|
TSharedPtr< ... |
GetOwnerTab() |
Returns the owner tab (if it exists) |
|
FTabManager:... |
GetPrivateApi() |
|
|
TSharedRef< ... |
GetTabBlacklist() |
Returns filter for additional control over available tabs |
|
HasAnyMatchingTabs ( |
||
|
HasTabSpawner ( |
||
|
HasTabSpawnerFor ( |
||
|
HasValidOpenTabs ( |
It searches for valid and open tabs on SomeNode. |
|
|
HasValidTabs ( |
||
|
InsertDocumentTab ( |
||
|
InsertNewDocumentTab ( |
Insert a new UnmanagedTab document tab next to an existing tab (closed or open) that has the PlaceholdId. |
|
|
InsertNewDocumentTab ( |
Insert a new UnmanagedTab document tab next to an existing tab (closed or open) that has the PlaceholdId. |
|
|
TSharedPtr< ... |
InvokeTab_Internal ( |
|
|
InvokeTabForMenu ( |
||
|
IsAllowedTab ( |
||
|
IsAllowedTabType ( |
||
|
IsTabCloseable ( |
||
|
IsValidTabForSpawning ( |
||
|
MakeSpawnerMenuEntry ( |
||
|
TSharedRef< ... |
New ( |
|
|
TSharedRef< ... |
NewArea ( |
|
|
TSharedRef< ... |
NewArea ( |
|
|
TSharedRef< ... |
NewLayout ( |
|
|
TSharedRef< ... |
NewPrimaryArea() |
|
|
TSharedRef< ... |
NewSplitter() |
|
|
TSharedRef< ... |
NewStack() |
|
|
OnTabClosing ( |
||
|
OnTabForegrounded ( |
Notify the tab manager that the NewForegroundTab was brought to front and the BackgroundedTab was send to the background as a result. |
|
|
OnTabManagerClosing() |
Invoked when a tab manager is closing down. |
|
|
OnTabOpening ( |
||
|
OnTabRelocated ( |
||
|
OpenUnmanagedTab ( |
||
|
TSharedRef< ... |
PersistLayout() |
Gather the persistent layout |
|
PopulateLocalTabSpawnerMenu ( |
||
|
PopulateTabSpawnerMenu ( |
||
|
PopulateTabSpawnerMenu ( |
||
|
PopulateTabSpawnerMenu ( |
||
|
PopulateTabSpawnerMenu_Helper ( |
||
|
RegisterDefaultTabWindowSize |
||
|
FTabSpawnerE... |
RegisterTabSpawner ( |
Register a new tab spawner with the tab manager. |
|
RemoveTabFromCollapsedAreas ( |
||
|
TSharedPtr< ... |
RestoreArea ( |
|
|
TSharedPtr< ... |
RestoreArea_Helper ( |
|
|
RestoreDocumentTab ( |
Much like InsertNewDocumentTab, but the UnmanagedTab is not seen by the user as newly-created. |
|
|
TSharedPtr< ... |
RestoreFrom ( |
|
|
RestoreSplitterContent ( |
||
|
RestoreSplitterContent ( |
Use this standalone RestoreSplitterContent when the output of its internal RestoreArea_Helper cannot be a nullptr. |
|
|
SavePersistentLayout() |
Gather the persistent layout and execute the custom delegate for saving it to persistent storage (e.g. into config files) |
|
|
SetCanDoDragOperation ( |
Prevent or allow all tabs to be drag |
|
|
SetMainTab ( |
Provide a tab that will be the main tab and cannot be closed. |
|
|
SetMenuMultiBox ( |
Set the multi-box to use for generating a native, global menu bar. |
|
|
SetOnPersistLayout ( |
||
|
SetTabsTo ( |
It sets the desired (or all) tabs in the FTabManager::FLayoutNode to the desired value. |
|
|
TSharedPtr< ... |
SpawnTab ( |
|
|
TSharedPtr< ... |
TryInvokeTab ( |
Try to open tab if it is closed at the last known location. |
|
UnregisterAllTabSpawners() |
Unregisters all tab spawners. |
|
|
UnregisterDefaultTabWindowSize ( |
||
|
UnregisterTabSpawner ( |
Unregisters the tab spawner matching the provided TabId. |
|
|
UpdateMainMenu ( |
Update the native, global menu bar if it is being used. |
|
|
UpdateStats() |
Called when tab(s) have been added or windows created |
Name |
Description |
---|---|
FOnPersistLayout |
|
FTabSpawner |
Name |
Description |
---|---|
DefaultTabWindowSizeMap |
Default tab window sizes for newly-created tabs |
FallbackWindowSize |
The fallback size for a window |
Name | Description | ||
---|---|---|---|
|
CanSpawnTab ( |
CanSpawnTab has been replaced by HasTabSpawner |
|
|
TSharedRef< ... |
InvokeTab ( |
FTabManager::InvokeTab is deprecated. Please use TryInvokeTab instead! |