IToolkit

Interface for editor toolkits (asset editors and mode tools)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IToolkit

FBaseToolkit

FAssetEditorToolkit

FModeToolkit

	FFractureEditorModeToolkit
	FModelingToolsEditorModeToolkit
	FMotionTrailEditorModeToolkit
	FSampleToolsEditorModeToolkit
	FTextureAlignMode

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/Toolkits/IToolkit.h
Include	#include "Toolkits/IToolkit.h"

Syntax

class IToolkit

Remarks

Interface for editor toolkits (asset editors and mode tools)

Functions

	Name	Description
void	BringToolkitToFront()	Call this function to bring all of this toolkit's tabs to the foreground in their respective stacks.
FText	GetBaseToolkitName()	Returns the localized name of this toolkit type (typically just " editor")
FEdMode *...	GetEditorMode()
FText	GetEditorModeDisplayName()
FSlateIcon	GetEditorModeIcon()
TSharedPtr< ...	GetInlineContent()
const TArray...	GetObjectsCurrentlyBeingEdited()	For asset editor toolkits, returns the UObjects for the assets currently being edited
UEdMode *...	GetScriptableEditorMode()
FText	GetTabSuffix()	Returns the localized tab suffix
FName	GetToolkitContextFName()	Returns the invariant name of this toolkit type, used for establishing the context for help, documentation and tutorials
FName	GetToolkitFName()	Returns the invariant name of this toolkit type
const TShare...	GetToolkitHost()
FText	GetToolkitName()	Returns the localized name of this toolkit
const TMap< ...	GetToolkitTabsInSpots()
FText	GetToolkitToolTipText()	Returns the localized tooltip text of this toolkit
TSharedRef< ...	GetWorkspaceMenuCategory()	Returns the workspace menu category of this toolkit
FLinearColor	GetWorldCentricTabColorScale()
FString	GetWorldCentricTabPrefix()	Returns the localize prefix string to use for tab labels in world-centric mode.
bool	IsAssetEditor()	Returns true if this toolkit is used to edit assets (even if it's not necessarily editing one right now.)
bool	IsBlueprintEditor()	Returns if this is a IBlueprintEditor derivation
bool	IsHosted()
bool	IsSimpleAssetEditor()	Returns true if this is the default generic asset editor used by multiple classes
bool	ProcessCommandBindings ( const FKeyEvent& InKeyEvent )	Processes any UI commands which are activated by the specified event
void	RegisterTabSpawners ( const TSharedRef< FTabManager >& T... )	Register tabs that this toolkit can spawn with the TabManager
void	ToolkitBroughtToFront()	Called when a toolkit has been brought to the 'front'
void	UnregisterTabSpawners ( const TSharedRef< FTabManager >& T... )	Unregister tabs that this toolkit can spawn

This API reference document refers to UE 5.1 or earlier. API docs for 5.2 or later are currently being finalized and will be available at a later date.