Navigation
API > API/Editor > API/Editor/EditorFramework
Base interface class for toolkit hosts
| Name | IToolkitHost |
| Type | class |
| Header File | /Engine/Source/Editor/EditorFramework/Public/Toolkits/IToolkitHost.h |
| Include Path | #include "Toolkits/IToolkitHost.h" |
Syntax
class IToolkitHost
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IToolkitHost() |
Toolkits/IToolkitHost.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnActiveViewportChanged | TMulticastDelegate_TwoParams< void, TSharedPtr< IAssetViewport >, TSharedPtr< IAssetViewport > > | Notificaton when the active viewport changed | Toolkits/IToolkitHost.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddViewportOverlayWidget
(
TSharedRef< SWidget > InOverlaidWidget, |
Allows Toolkits to push widgets to the viewport. | Toolkits/IToolkitHost.h | |
virtual void AddViewportOverlayWidget
(
TSharedRef< SWidget > InOverlaidWidget, |
Allows Toolkits to push widgets to the viewport with a specific Z-Order. | Toolkits/IToolkitHost.h | |
void BringToFront() |
Brings this toolkit host's window (and tab, if it has one), to the front | Toolkits/IToolkitHost.h | |
virtual FVector2D GetActiveViewportSize() |
Return the size of the active viewport, accounting for DPI Scale | Toolkits/IToolkitHost.h | |
virtual FVector2f GetActiveViewportWidgetSize() |
Return the size of the active viewport, accounting for DPI Scale | Toolkits/IToolkitHost.h | |
UTypedElementCommonActions * GetCommonActions() |
Returns the common actions implementation for this toolkit host | Toolkits/IToolkitHost.h | |
FEditorModeTools & GetEditorModeManager() |
Returns the mode manager for this toolkit host. For standalone toolkits | Toolkits/IToolkitHost.h | |
TSharedRef< class SWidget > GetParentWidget () |
Gets a widget that can be used to parent a modal window or pop-up to. | Toolkits/IToolkitHost.h | |
| Returns the status bar name that can be used with UStatusBarSubsystem to display messages in the status bar of this toolkit host. | Toolkits/IToolkitHost.h | ||
TSharedPtr< class FTabManager > GetTabManager() |
Access the toolkit host's tab manager | Toolkits/IToolkitHost.h | |
UWorld * GetWorld() |
Toolkits/IToolkitHost.h | ||
FOnActiveViewportChanged & OnActiveViewportChanged() |
Gets a multicast delegate which is executed whenever the toolkit host's active viewport changes. | Toolkits/IToolkitHost.h | |
void OnToolkitHostingFinished
(
const TSharedRef< class IToolkit >& Toolkit |
Called when a toolkit is no longer being hosted within this host | Toolkits/IToolkitHost.h | |
void OnToolkitHostingStarted
(
const TSharedRef< class IToolkit >& Toolkit |
Called when a toolkit is opened within this host | Toolkits/IToolkitHost.h | |
virtual void RemoveViewportOverlayWidget
(
TSharedRef< SWidget > InOverlaidWidget, |
Toolkits/IToolkitHost.h |