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

Light Theme

Dark Theme

FBaseToolkit

Base class for all toolkits (abstract).

Windows

MacOS

Linux

Inheritance Hierarchy

IToolkit

FBaseToolkit

FAssetEditorToolkit

FModeToolkit

	FFractureEditorModeToolkit
	FModelingToolsEditorModeToolkit
	FMotionTrailEditorModeToolkit
	FSampleToolsEditorModeToolkit
	FTextureAlignMode

References

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

Syntax

class FBaseToolkit : public IToolkit

Remarks

Base class for all toolkits (abstract).

Variables

	Name	Description
TSharedRef< FUI...	ToolkitCommands	List of UI commands for this toolkit. This should be filled in by the derived class!
TWeakPtr< ITool...	ToolkitHost	The host application for this editor.
EToolkitMode::T...	ToolkitMode	Asset editing mode, set at creation-time and never changes
TMap< EToolkitT...	ToolkitTabsInSpots	Map of toolkit tab spots to known tabs (these are weak pointers and may be invalid after tabs are closed.)
TSharedPtr< FWo...	WorkspaceMenuCategory	The workspace menu category of this toolkit

Constructors

	Name	Description
	FBaseToolkit()	FBaseToolkit constructor

Destructors

	Name	Description
	~FBaseToolkit()	Virtual destructor

Functions

	Name	Description
void	AddToolkitTab ( const TSharedRef< SDockableTab >& ..., const EToolkitTabSpot::Type TabSpot )	Adds an already-created toolkit tab to the toolkit.
FLinearColor	GetTabColorScale()
FString	GetTabPrefix()
const TShare...	GetToolkitCommands()
bool	IsWorldCentricAssetEditor()

Overridden from IToolkit

	Name	Description
void	BringToolkitToFront()	Call this function to bring all of this toolkit's tabs to the foreground in their respective stacks.
TSharedPtr< ...	GetInlineContent()
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
const TShare...	GetToolkitHost()
const TMap< ...	GetToolkitTabsInSpots()
TSharedRef< ...	GetWorkspaceMenuCategory()	Returns the workspace menu category of this toolkit
bool	IsBlueprintEditor()	Returns if this is a IBlueprintEditor derivation
bool	IsHosted()
bool	ProcessCommandBindings ( const FKeyEvent& InKeyEvent )	Processes any UI commands which are activated by the specified event

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

Take our survey

Dismiss