Navigation
API > API/Editor > API/Editor/UnrealEd
| Name | FDocumentTracker |
| Type | class |
| Header File | /Engine/Source/Editor/UnrealEd/Public/WorkflowOrientedApp/WorkflowTabManager.h |
| Include Path | #include "WorkflowOrientedApp/WorkflowTabManager.h" |
Syntax
class FDocumentTracker : public TSharedFromThis< FDocumentTracker >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDocumentTracker
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDocumentTracker
(
FName InDefaultDocumentId |
WorkflowOrientedApp/WorkflowTabManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FDocumentTracker() |
WorkflowOrientedApp/WorkflowTabManager.h |
Enums
Public
| Name | Remarks |
|---|---|
| EOpenDocumentCause | Are we opening a new document, or restoring a previously opened document |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FTabList | TArray< TSharedPtr< FTabInfo > > | List of open tabs; used to bring one to front and focus it. | WorkflowOrientedApp/WorkflowTabManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentHistoryIndex | int32 | Current history index | WorkflowOrientedApp/WorkflowTabManager.h | |
| DefaultDocumentId | FName | Document ID to use when inserting documents into the tab manager. | WorkflowOrientedApp/WorkflowTabManager.h | |
| History | TArray< TSharedPtr< FGenericTabHistory > > | List of history data nodes | WorkflowOrientedApp/WorkflowTabManager.h | |
| HostingAppPtr | TWeakPtr< FAssetEditorToolkit > | The hosting application we're associated with. | WorkflowOrientedApp/WorkflowTabManager.h | |
| OnActiveTabChangedDelegateHandle | FDelegateHandle | Handle to the registered OnActiveTabChanged delegate | WorkflowOrientedApp/WorkflowTabManager.h | |
| PotentialTabFactories | TMap< FName, TSharedPtr< class FDocumentTabFactory > > | List of allowable tab spawning mechanisms. | WorkflowOrientedApp/WorkflowTabManager.h | |
| SpawnedTabs | FTabList | List of currently spawned tool panels. | WorkflowOrientedApp/WorkflowTabManager.h | |
| TabForegroundedDelegateHandle | FDelegateHandle | Handle to the registered OnTabForegrounded delegate | WorkflowOrientedApp/WorkflowTabManager.h | |
| TabManager | TSharedPtr< FTabManager > | The Slate tab manager for the application we are managing documents for. | WorkflowOrientedApp/WorkflowTabManager.h | |
| WeakLastEditedTabInfo | TWeakPtr< FTabInfo > | The last active tab info to be selected, used for opening new documents in the most recently used tab. | WorkflowOrientedApp/WorkflowTabManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CleanInvalidTabs() |
Cleans any invalid tabs, either moving them to a valid place in history or closing the tab altogether | WorkflowOrientedApp/WorkflowTabManager.h | |
void ClearDocumentFactories() |
WorkflowOrientedApp/WorkflowTabManager.h | ||
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) | WorkflowOrientedApp/WorkflowTabManager.h | |
void FindAllTabsForFactory
(
const TWeakPtr< FDocumentTabFactory >& Factory, |
Finds all tabs that match the specified identifier, placing them in the specified array. | WorkflowOrientedApp/WorkflowTabManager.h | |
void FindMatchingTabs
(
TSharedPtr< FTabPayload > Payload, |
Finds all tabs that match the specified identifier and optional payload, placing them in the specified array. | WorkflowOrientedApp/WorkflowTabManager.h | |
TSharedPtr< FDocumentTabFactory > FindSupportingFactory
(
TSharedRef< FTabPayload > Payload |
Finds a factory that can deal with the supplied payload. | WorkflowOrientedApp/WorkflowTabManager.h | |
TSharedPtr< SDockTab > GetActiveTab() |
Returns the current active tab | WorkflowOrientedApp/WorkflowTabManager.h | |
TArray< TSharedPtr< SDockTab > > GetAllDocumentTabs() |
Get all the live documents tracked by this tracker | WorkflowOrientedApp/WorkflowTabManager.h | |
void Initialize
(
TSharedPtr< FAssetEditorToolkit > InHostingApp |
Creates a new tab manager. | WorkflowOrientedApp/WorkflowTabManager.h | |
TSharedPtr< SDockTab > OpenDocument
(
TSharedPtr< FTabPayload > InPayload, |
Handles opening a document and handling tab navigation or forcing a new tab to be opened | WorkflowOrientedApp/WorkflowTabManager.h | |
void RefreshAllTabs() |
Calls OnTabRefreshed for each open tab (on the factories that created them) | WorkflowOrientedApp/WorkflowTabManager.h | |
void RegisterDocumentFactory
(
TSharedPtr< class FDocumentTabFactory > Factory |
WorkflowOrientedApp/WorkflowTabManager.h | ||
void ReplacePayloadInTab
(
TSharedPtr< SDockTab > TargetTab, |
Replaces the open payload in the specified tab with a new one; recreating the contents. | WorkflowOrientedApp/WorkflowTabManager.h | |
void SaveAllState() |
Saves the state of all tabs. | WorkflowOrientedApp/WorkflowTabManager.h | |
void SetTabManager
(
const TSharedRef< FTabManager >& InTabManager |
WorkflowOrientedApp/WorkflowTabManager.h |