Navigation
API > API/Editor > API/Editor/EditorFramework
Interface for editor toolkits (asset editors and mode tools)
| Name | IToolkit |
| Type | class |
| Header File | /Engine/Source/Editor/EditorFramework/Public/Toolkits/IToolkit.h |
| Include Path | #include "Toolkits/IToolkit.h" |
Syntax
class IToolkit
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IToolkit() |
Toolkits/IToolkit.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BringToolkitToFront () |
Call this function to bring all of this toolkit's tabs to the foreground in their respective stacks. | Toolkits/IToolkit.h | |
FText GetBaseToolkitName() |
Returns the localized name of this toolkit type (typically just " |
Toolkits/IToolkit.h | |
FEditorModeTools & GetEditorModeManager() |
Gets the mode manager for this toolkit | Toolkits/IToolkit.h | |
TSharedPtr< SWidget > GetInlineContent() |
Toolkits/IToolkit.h | ||
| For asset editor toolkits, returns the UObjects for the assets currently being edited | Toolkits/IToolkit.h | ||
FText GetTabSuffix() |
Returns the localized tab suffix | Toolkits/IToolkit.h | |
FName GetToolkitContextFName() |
Returns the invariant name of this toolkit type, used for establishing the context for help, documentation and tutorials | Toolkits/IToolkit.h | |
FName GetToolkitFName() |
Returns the invariant name of this toolkit type | Toolkits/IToolkit.h | |
const TSharedRef< IToolkitHost > GetToolkitHost() |
Toolkits/IToolkit.h | ||
FText GetToolkitName() |
Returns the localized name of this toolkit | Toolkits/IToolkit.h | |
FText GetToolkitToolTipText() |
Returns the localized tooltip text of this toolkit | Toolkits/IToolkit.h | |
TSharedRef< FWorkspaceItem > GetWorkspaceMenuCategory() |
Returns the workspace menu category of this toolkit | Toolkits/IToolkit.h | |
FLinearColor GetWorldCentricTabColorScale() |
Toolkits/IToolkit.h | ||
FString GetWorldCentricTabPrefix() |
Returns the localize prefix string to use for tab labels in world-centric mode. | Toolkits/IToolkit.h | |
bool IsAssetEditor() |
Returns true if this toolkit is used to edit assets (even if it's not necessarily editing one right now.) | Toolkits/IToolkit.h | |
bool IsBlueprintEditor() |
Returns if this is a IBlueprintEditor derivation | Toolkits/IToolkit.h | |
bool IsHosted() |
Toolkits/IToolkit.h | ||
virtual bool IsSimpleAssetEditor() |
Returns true if this is the default generic asset editor used by multiple classes | Toolkits/IToolkit.h | |
bool ProcessCommandBindings
(
const FKeyEvent& InKeyEvent |
Processes any UI commands which are activated by the specified event | Toolkits/IToolkit.h | |
void RegisterTabSpawners
(
const TSharedRef< FTabManager >& TabManager |
Register tabs that this toolkit can spawn with the TabManager | Toolkits/IToolkit.h | |
virtual void SetModeUILayer
(
const TSharedPtr< FAssetEditorModeUILayer > InLayer |
Toolkits/IToolkit.h | ||
virtual void ToolkitBroughtToFront() |
Called when a toolkit has been brought to the 'front' | Toolkits/IToolkit.h | |
void UnregisterTabSpawners
(
const TSharedRef< FTabManager >& TabManager |
Unregister tabs that this toolkit can spawn | Toolkits/IToolkit.h |