IToolkitHost

Base interface class for toolkit hosts

Unreal Engine C++ API Reference > Editor > EditorFramework > Toolkits

Inheritance Hierarchy

  • IToolkitHost

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
  ~IToolkitHost ()  

Functions

Type 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library