TabManager.h File Reference

#include "CoreMinimal.h"
#include "SlateFwd.h"
#include "Containers/Ticker.h"
#include "Containers/ContainersFwd.h"
#include "Misc/Attribute.h"
#include "Textures/SlateIcon.h"
#include "Widgets/SWindow.h"
#include "Framework/Docking/WorkspaceItem.h"
#include "Framework/Commands/UIAction.h"
#include "Templates/Function.h"

Go to the source code of this file.

Classes
struct	FTabId
class	FSpawnTabArgs
struct	FTabSpawnerEntry
class	FTabManager
class	FTabManager::FLayoutNode
struct	FTabManager::FTab
class	FTabManager::FStack
class	FTabManager::FSplitter
struct	FTabManager::FPanelDrawerSize
struct	FTabManager::FPanelDrawerTab
class	FTabManager::FArea
class	FTabManager::FLayout
class	FTabManager::FPrivateApi
class	FTabManager::FSearchPreference
class	FTabManager::FRequireClosedTab
class	FTabManager::FLiveTabSearch
class	FTabManager::FLastMajorOrNomadTab
struct	FTabManager::ESearchPreference
class	FGlobalTabmanager
class	FProxyTabmanager

Namespaces
namespace	UE
namespace	UE::Editor
namespace	UE::Editor::HomeScreen
namespace	ETabSpawnerMenuType
namespace	ETabState

Enumerations
enum class	ESidebarLocation : uint8 { Left , Right , None }
enum class	ETabIdFlags : uint8 { None = 0x0 , SaveLayout = 0x1 }
enum class	ETabReadOnlyBehavior : int32 { Disabled , Hidden , Custom }
enum class	EOutputCanBeNullptr { Never , IfNoTabValid , IfNoOpenTabValid }

Functions
bool	UE::Editor::HomeScreen::IsHomeScreenEnabled ()
	DECLARE_MULTICAST_DELEGATE_TwoParams (FOnActiveTabChanged, TSharedPtr< SDockTab >, TSharedPtr< SDockTab >)
	ENUM_CLASS_FLAGS (ETabIdFlags)
	DECLARE_DELEGATE_RetVal_OneParam (TSharedRef< SDockTab >, FOnSpawnTab, const FSpawnTabArgs &)
	DECLARE_DELEGATE_RetVal_OneParam (bool, FCanSpawnTab, const FSpawnTabArgs &)
	DECLARE_DELEGATE_RetVal_OneParam (TSharedPtr< SDockTab >, FOnFindTabToReuse, const FTabId &) struct FMinorTabConfig
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnReadOnlyModeChanged, bool)
	DECLARE_MULTICAST_DELEGATE_TwoParams (FIsTabSupportedEvent, FTabId, bool &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnTabEvent, TSharedPtr< SDockTab >)

Enumeration Type Documentation

EOutputCanBeNullptr

enum class EOutputCanBeNullptr

strong

Enumerator
Never	RestoreArea_Helper() will always return a SWidget. It will return an "Unrecognized Tab" dummy SWidget if it cannot find the way to create the desired SWidget. Default behavior and the only one used before UE 4.24. This is the most strict condition and will never return nullptr.
IfNoTabValid	RestoreArea_Helper() will return nullptr if its parent FTabManager::FStack does not contain at least a valid tab. Useful for docked SWidgets that contain closed Tabs. With IfNoTabValid, if a previously docked Tab is re-opened (i.e., its ETabState value changes from ClosedTab to OpenedTab), it will be displayed in the same place it was placed before being initially closed. However, with IfNoOpenTabValid, if that Tab were re-opened, it might be instead displayed in a new standalone SWidget.
IfNoOpenTabValid	RestoreArea_Helper() will return nullptr if its parent FTabManager::FStack does not contain at least a valid tab whose ETabState is set to OpenedTab. Useful for standalone SWidgets that otherwise will display a blank UI with no Tabs on it. This is the most relaxed condition and the one that will return nullptr the most.

ESidebarLocation

enum class ESidebarLocation : uint8

strong

Enumerator
Left	Tab is in a sidebar on the left side of its parent area
Right	Tab is in a sidebar on the right side of its parent area
None	Tab is not in a sidebar

ETabIdFlags

enum class ETabIdFlags : uint8

strong

Enumerator
None
SaveLayout

ETabReadOnlyBehavior

enum class ETabReadOnlyBehavior : int32

strong

An enum to describe how TabSpawnerEntries behave when the tab manager is in read only mode

Enumerator
Disabled
Hidden
Custom

Function Documentation

DECLARE_DELEGATE_RetVal_OneParam() [1/3]

DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FCanSpawnTab	,
		const FSpawnTabArgs &
	)

DECLARE_DELEGATE_RetVal_OneParam() [2/3]

DECLARE_DELEGATE_RetVal_OneParam	(	TSharedPtr< SDockTab >	,
		FOnFindTabToReuse	,
		const FTabId &
	)

Allows users to provide custom logic when searching for a tab to reuse. The TabId that is being searched for is provided as a courtesy, but does not have to be respected.

DECLARE_DELEGATE_RetVal_OneParam() [3/3]

DECLARE_DELEGATE_RetVal_OneParam	(	TSharedRef< SDockTab >	,
		FOnSpawnTab	,
		const FSpawnTabArgs &
	)

Invoked when a tab needs to be spawned.

DECLARE_MULTICAST_DELEGATE_OneParam() [1/2]

DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnReadOnlyModeChanged	,
		bool
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [2/2]

DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnTabEvent	,
		TSharedPtr< SDockTab >
	)

DECLARE_MULTICAST_DELEGATE_TwoParams() [1/2]

DECLARE_MULTICAST_DELEGATE_TwoParams	(	FIsTabSupportedEvent	,
		FTabId	,
		bool &
	)

DECLARE_MULTICAST_DELEGATE_TwoParams() [2/2]

DECLARE_MULTICAST_DELEGATE_TwoParams	(	FOnActiveTabChanged	,
		TSharedPtr< SDockTab >	,
		TSharedPtr< SDockTab >
	)

ENUM_CLASS_FLAGS()

ENUM_CLASS_FLAGS

(

ETabIdFlags

)