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 > EditorFramework > Toolkits > IToolkit

Light Theme

Dark Theme

IToolkit

Interface for editor toolkits (asset editors and mode tools)

Inheritance Hierarchy

IToolkit

FBaseToolkit

FAssetEditorToolkit

FBankEditorBase

FBankEditor

FBaseAssetToolkit

FBaseCharacterFXEditorToolkit

FExampleCharacterFXEditorToolkit

FSmartObjectAssetToolkit

FUVEditorToolkit

FContextualAnimAssetEditorToolkit

FDatabaseEditor

FDataflowEditorToolkit

FSimpleAssetEditor

FWaveformEditor

FWorkflowCentricApplication

ICascade

ICurveAssetEditor

ICurveTableEditor

ICustomizableObjectDebugger

ICustomizableObjectInstanceEditor

ICustomizableObjectEditor

ICustomizableObjectPopulationClassEditor

ICustomizableObjectPopulationEditor

IDataTableEditor

IEnvironmentQueryEditor

IFontEditor

IGroomCustomAssetEditorToolkit

FGroomCustomAssetEditorToolkit

ILevelSequenceEditorToolkit

IMassEntityEditor

IMassGameplayEditor

IMassMovementEditor

IMassNavigationEditor

IMetasoundEditor

ISoundClassEditor

ISoundCueEditor

ISoundSubmixEditor

IStateTreeEditor

IStaticMeshEditor

IStringTableEditor

IStructUtilsEditor

ITextureEditorToolkit

ITranslationEditor

IUserDefinedEnumEditor

IUserDefinedStructureEditor

IUTBTabEditor

FUTBTabEditor

IZoneGraphEditor

FModeToolkit

FAssetPlacementEdModeToolkit

FBaseCharacterFXEditorModeToolkit

FExampleCharacterFXEditorModeToolkit

FFractureEditorModeToolkit

FGameplayDebuggerToolkit

FModelingToolsEditorModeToolkit

FSampleToolsEditorModeToolkit

FScriptableToolsEditorModeToolkit

FStaticMeshEditorModelingToolkit

FTextureAlignMode

FUVEditorModeToolkit

FWidgetEditorToolPaletteToolkit

References

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

Syntax

class IToolkit

Remarks

Interface for editor toolkits (asset editors and mode tools)

Destructors

	Name	Description
	~IToolkit()

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")
FEditorModeT...	GetEditorModeManager()	Gets the mode manager for this toolkit
TSharedPtr< ...	GetInlineContent()
const TArray...	GetObjectsCurrentlyBeingEdited()	For asset editor toolkits, returns the UObjects for the assets currently being edited
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
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	SetModeUILayer ( const TSharedPtr< FAssetEditorModeU... )
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

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

Take our survey

Cancel