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

IToolkitHost

Base interface class for toolkit hosts

Inheritance Hierarchy

IToolkitHost

ILevelEditor

References

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

Syntax

class IToolkitHost

Remarks

Base interface class for toolkit hosts

Destructors

	Name	Description
	~IToolkitHost()

Functions

	Name	Description
void	AddViewportOverlayWidget ( TSharedRef< SWidget > InOverlaidWid..., TSharedPtr< IAssetViewport > InView... )	Allows Toolkits to push widgets to the viewport.
void	BringToFront()	Brings this toolkit host's window (and tab, if it has one), to the front
FVector2D	GetActiveViewportSize()	Return the size of the active viewport, accounting for DPI Scale
UTypedElemen...	GetCommonActions()	Returns the common actions implementation for this toolkit host
FEditorModeT...	GetEditorModeManager()	Returns the mode manager for this toolkit host. For standalone toolkits
TSharedRef< ...	GetParentWidget()	Gets a widget that can be used to parent a modal window or pop-up to.
FName	GetStatusBarName()	Returns the status bar name that can be used with UStatusBarSubsystem to display messages in the status bar of this toolkit host.
TSharedPtr< ...	GetTabManager()	Access the toolkit host's tab manager
UWorld *	GetWorld()
FOnActiveVie...	OnActiveViewportChanged()	Gets a multicast delegate which is executed whenever the toolkit host's active viewport changes.
void	OnToolkitHostingFinished ( const TSharedRef< class IToolkit > ... )	Called when a toolkit is no longer being hosted within this host
void	OnToolkitHostingStarted ( const TSharedRef< class IToolkit > ... )	Called when a toolkit is opened within this host
void	RemoveViewportOverlayWidget ( TSharedRef< SWidget > InOverlaidWid..., TSharedPtr< IAssetViewport > InView... )

Typedefs

Name	Description
FOnActiveViewportChanged	Notificaton when the active viewport changed

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

Take our survey

Cancel