Navigation
API > API/Editor > API/Editor/EditorFramework > API/Editor/EditorFramework/Toolkits
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
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddViewportOverlayWidget
(
TSharedRef< SWidget > InOverlaidWidget, |
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 | Return the size of the active viewport, accounting for DPI Scale | ||
| UTypedElementCommonActions * | Returns the common actions implementation for this toolkit host | ||
| FEditorModeTools & | Returns the mode manager for this toolkit host. For standalone toolkits | ||
| TSharedRef< class SWidget > | Gets a widget that can be used to parent a modal window or pop-up to. | ||
| FName | Returns the status bar name that can be used with UStatusBarSubsystem to display messages in the status bar of this toolkit host. | ||
| TSharedPtr< class FTabManager > | Access the toolkit host's tab manager | ||
| UWorld * | GetWorld () |
||
| FOnActiveViewportChanged & | Gets a multicast delegate which is executed whenever the toolkit host's active viewport changes. | ||
| void | OnToolkitHostingFinished
(
const TSharedRef< class IToolkit >& Toolkit |
Called when a toolkit is no longer being hosted within this host | |
| void | OnToolkitHostingStarted
(
const TSharedRef< class IToolkit >& Toolkit |
Called when a toolkit is opened within this host | |
| void | RemoveViewportOverlayWidget
(
TSharedRef< SWidget > InOverlaidWidget, |
Typedefs
| Name | Description |
|---|---|
| FOnActiveViewportChanged | Notificaton when the active viewport changed |