IToolkit

Interface for editor toolkits (asset editors and mode tools)

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

Inheritance Hierarchy

  • IToolkit

References

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

Syntax

class IToolkit  

Remarks

Interface for editor toolkits (asset editors and mode tools)

Destructors

Type Name Description
  ~IToolkit ()  

Functions

Type Name Description
void BringToolkitToFront () Call this function to bring all of this toolkit's tabs to the foreground in their respective stacks.
FText GetBaseToolkitName () Returns the localized name of this toolkit type (typically just " editor")
FEditorModeT... GetEditorModeManager () Gets the mode manager for this toolkit
TSharedPtr< ... GetInlineContent ()  
const TArray... GetObjectsCurrentlyBeingEdited () For asset editor toolkits, returns the UObjects for the assets currently being edited
FText GetTabSuffix () Returns the localized tab suffix
FName GetToolkitContextFName () Returns the invariant name of this toolkit type, used for establishing the context for help, documentation and tutorials
FName GetToolkitFName () Returns the invariant name of this toolkit type
const TShare... GetToolkitHost ()  
FText GetToolkitName () Returns the localized name of this toolkit
FText GetToolkitToolTipText () Returns the localized tooltip text of this toolkit
TSharedRef< ... GetWorkspaceMenuCategory () Returns the workspace menu category of this toolkit
FLinearColor GetWorldCentricTabColorScale ()  
FString GetWorldCentricTabPrefix () Returns the localize prefix string to use for tab labels in world-centric mode.
bool IsAssetEditor () Returns true if this toolkit is used to edit assets (even if it's not necessarily editing one right now.)
bool IsBlueprintEditor () Returns if this is a IBlueprintEditor derivation
bool IsHosted ()  
bool IsSimpleAssetEditor () Returns true if this is the default generic asset editor used by multiple classes
bool ProcessCommandBindings ( const FKeyEvent& InKeyEvent ) Processes any UI commands which are activated by the specified event
void RegisterTabSpawners ( const TSharedRef< FTabManager >& T... ) Register tabs that this toolkit can spawn with the TabManager
void SetModeUILayer ( const TSharedPtr< FAssetEditorModeU... )  
void ToolkitBroughtToFront () Called when a toolkit has been brought to the 'front'
void UnregisterTabSpawners ( const TSharedRef< FTabManager >& T... ) Unregister tabs that this toolkit can spawn

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library