1. Epic GamesDeveloper
  3. IToolkitHost

IToolkitHost

Base interface class for toolkit hosts

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

Inheritance Hierarchy

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
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

AddViewportOverlayWidget ( TSharedRef< SWidget > InOverlaidWidget,
TSharedPtr< IAssetViewport > InViewport
)

 Allows Toolkits to push widgets to the viewport.
Public function Virtual void

AddViewportOverlayWidget ( TSharedRef< SWidget > InOverlaidWidget,
int32 ZOrder,
TSharedPtr< IAssetViewport > InViewport
)

 Allows Toolkits to push widgets to the viewport with a specific Z-Order.
Public function void Brings this toolkit host's window (and tab, if it has one), to the front
Public function Virtual FVector2D Return the size of the active viewport, accounting for DPI Scale
Public function Const UTypedElementCommonActions * Returns the common actions implementation for this toolkit host
Public function Const FEditorModeTools & Returns the mode manager for this toolkit host. For standalone toolkits
Public function TSharedRef< class SWidget > Gets a widget that can be used to parent a modal window or pop-up to.
Public function Const FName Returns the status bar name that can be used with UStatusBarSubsystem to display messages in the status bar of this toolkit host.
Public function Const TSharedPtr< class FTabManager > Access the toolkit host's tab manager
Public function Const UWorld *  
Public function FOnActiveViewportChanged & Gets a multicast delegate which is executed whenever the toolkit host's active viewport changes.
Public function void

OnToolkitHostingFinished ( const TSharedRef< class IToolkit >& Toolkit
)

 Called when a toolkit is no longer being hosted within this host
Public function void

OnToolkitHostingStarted ( const TSharedRef< class IToolkit >& Toolkit
)

 Called when a toolkit is opened within this host
Public function Virtual void

RemoveViewportOverlayWidget ( TSharedRef< SWidget > InOverlaidWidget,
TSharedPtr< IAssetViewport > InViewport
)

  

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

On this page