IToolkit

Interface for editor toolkits (asset editors and mode tools)

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/Toolkits/IToolkit.h

Include

#include "Toolkits/IToolkit.h"

Syntax

class IToolkit

Remarks

Interface for editor toolkits (asset editors and mode tools)

Functions

Name Description

Public function

void

 

BringToolkitToFront()

Call this function to bring all of this toolkit's tabs to the foreground in their respective stacks.

Public function Virtual

void

 

BuildToolPalette

(
    FName Palette,
    FToolBarBuilder& ToolbarBuilder
)

Public function Const

FText

 

GetBaseToolkitName()

Returns the localized name of this toolkit type (typically just " editor")

Public function Const

FEdMode *

 

GetEditorMode()

Public function Const

TSharedPtr< SWidget >

 

GetInlineContent()

Public function Const

const TArray< UObject * > *

 

GetObjectsCurrentlyBeingEdited()

For asset editor toolkits, returns the UObjects for the assets currently being edited

Public function Const

FText

 

GetTabSuffix()

Returns the localized tab suffix

Public function Const

FName

 

GetToolkitContextFName()

Returns the invariant name of this toolkit type, used for establishing the context for help, documentation and tutorials

Public function Const

FName

 

GetToolkitFName()

Returns the invariant name of this toolkit type

Public function Const

const TSharedRef< IToolkitHost >

 

GetToolkitHost()

Public function Const

FText

 

GetToolkitName()

Returns the localized name of this toolkit

Public function Const

const TMap< EToolkitTabSpot::Type, TArray< TWeakPtr< SDockableTab > > > &

 

GetToolkitTabsInSpots()

Public function Const

FText

 

GetToolkitToolTipText()

Returns the localized tooltip text of this toolkit

Public function Virtual

FText

 

GetToolPaletteDisplayName

(
    FName Palette
)

Public function Virtual Const

void

 

GetToolPaletteNames

(
    TArray< FName >& PaletteNames
)

Returns the number of Mode specific tabs in the mode toolbar

Public function Const

TSharedRef< FWorkspaceItem >

 

GetWorkspaceMenuCategory()

Returns the workspace menu category of this toolkit

Public function Const

FLinearColor

 

GetWorldCentricTabColorScale()

Public function Const

FString

 

GetWorldCentricTabPrefix()

Returns the localize prefix string to use for tab labels in world-centric mode.

Public function Const

bool

 

IsAssetEditor()

Returns true if this toolkit is used to edit assets (even if it's not necessarily editing one right now.)

Public function Const

bool

 

IsBlueprintEditor()

Returns if this is a IBlueprintEditor derivation

Public function Const

bool

 

IsHosted()

Public function Virtual Const

bool

 

IsSimpleAssetEditor()

Returns true if this is the default generic asset editor used by multiple classes

Public function Virtual

void

 

OnToolPaletteChanged

(
    FName NewActivePalette
)

Public function Const

bool

 

ProcessCommandBindings

(
    const FKeyEvent& InKeyEvent
)

Processes any UI commands which are activated by the specified event

Public function

void

 

RegisterTabSpawners

(
    const TSharedRef< FTabManager >& TabManager
)

Register tabs that this toolkit can spawn with the TabManager

Public function Virtual

void

 

ToolkitBroughtToFront()

Called when a toolkit has been brought to the 'front'

Public function

void

 

UnregisterTabSpawners

(
    const TSharedRef< FTabManager >& TabManager
)

Unregister tabs that this toolkit can spawn

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback