Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > Kismet > WorkflowOrientedApp > FDocumentTracker

Light Theme

Dark Theme

FDocumentTracker

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FDocumentTracker

References

Module	Kismet
Header	/Engine/Source/Editor/Kismet/Public/WorkflowOrientedApp/WorkflowTabManager.h
Include	#include "WorkflowOrientedApp/WorkflowTabManager.h"

Syntax

class FDocumentTracker : public TSharedFromThis< FDocumentTracker >

Constructors

	Name	Description
	FDocumentTracker()

Destructors

	Name	Description
	~FDocumentTracker()

Functions

	Name	Description
void	CleanInvalidTabs()	Cleans any invalid tabs, either moving them to a valid place in history or closing the tab altogether
void	ClearDocumentFactories()
void	CloseTab ( TSharedPtr< FTabPayload > Payload )	Closes any tabs of the specified type that match the payload (or all of them if the payload is NULL)
void	FindAllTabsForFactory ( const TWeakPtr< FDocumentTabFactory..., TArray< TSharedPtr< SDockTab > >& ... )	Finds all tabs that match the specified identifier, placing them in the specified array.
void	FindMatchingTabs ( TSharedPtr< FTabPayload > Payload, TArray< TSharedPtr< SDockTab > >& ... )	Finds all tabs that match the specified identifier and optional payload, placing them in the specified array.
TSharedPtr< ...	FindSupportingFactory ( TSharedRef< FTabPayload > Payload )	Finds a factory that can deal with the supplied payload.
TSharedPtr< ...	GetActiveTab()	Returns the current active tab
TArray< TSha...	GetAllDocumentTabs()	Get all the live documents tracked by this tracker
void	Initialize ( TSharedPtr< FAssetEditorToolkit > I... )	Creates a new tab manager.
TSharedPtr< ...	OpenDocument ( TSharedPtr< FTabPayload > InPayload, EOpenDocumentCause InOpenCause )	Handles opening a document and handling tab navigation or forcing a new tab to be opened
void	RefreshAllTabs()	Calls OnTabRefreshed for each open tab (on the factories that created them)
void	RegisterDocumentFactory ( TSharedPtr< class FDocumentTabFacto... )
void	ReplacePayloadInTab ( TSharedPtr< SDockTab > TargetTab, TSharedPtr< FTabPayload > NewPayloa... )	Replaces the open payload in the specified tab with a new one; recreating the contents.
void	SaveAllState()	Saves the state of all tabs.
void	SetTabManager ( const TSharedRef< FTabManager >& I... )

Enums

	Name	Description
	EOpenDocumentCause	Are we opening a new document, or restoring a previously opened document

Typedefs

Name	Description
FTabList	List of open tabs; used to bring one to front and focus it.

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

Take our survey

Dismiss