FBaseToolkit

Base class for all toolkits (abstract).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

UnrealEd

Header

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

Include

#include "Toolkits/BaseToolkit.h"

Syntax

class FBaseToolkit : public IToolkit

Remarks

Base class for all toolkits (abstract).

Variables

Name Description

Protected variable

TSharedRef< FUI...

 

ToolkitCommands

List of UI commands for this toolkit. This should be filled in by the derived class!

Protected variable

TWeakPtr< ITool...

 

ToolkitHost

The host application for this editor.

Protected variable

EToolkitMode::T...

 

ToolkitMode

Asset editing mode, set at creation-time and never changes

Protected variable

TSharedPtr< FWo...

 

WorkspaceMenuCategory

The workspace menu category of this toolkit

Constructors

Name Description

Public function

FBaseToolkit()

FBaseToolkit constructor

Destructors

Name Description

Public function Virtual

~FBaseToolkit()

Virtual destructor

Functions

Name Description

Protected function Virtual

void

 

CreateEditorModeManager()

Creates the Editor mode manager for your class. Default is to create none, for legacy reasons.

Protected function Const

FLinearColor

 

GetTabColorScale()

Protected function Const

FString

 

GetTabPrefix()

Public function Const

const TShare...

 

GetToolkitCommands()

Public function Const

bool

 

IsWorldCentricAssetEditor()

Overridden from IToolkit

Name Description

Public function Virtual

void

 

BringToolkitToFront()

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

Public function Const

FEditorModeT...

 

GetEditorModeManager()

Gets the mode manager for this toolkit

Public function Virtual Const

TSharedPtr< ...

 

GetInlineContent()

Public function Virtual Const

FText

 

GetTabSuffix()

Returns the localized tab suffix

Public function Virtual Const

FName

 

GetToolkitContextFName()

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

Public function Virtual Const

const TShare...

 

GetToolkitHost()

Public function Virtual Const

TSharedRef< ...

 

GetWorkspaceMenuCategory()

Returns the workspace menu category of this toolkit

Public function Virtual Const

bool

 

IsBlueprintEditor()

Returns if this is a IBlueprintEditor derivation

Public function Virtual Const

bool

 

IsHosted()

Public function Virtual Const

bool

 

ProcessCommandBindings

(
    const FKeyEvent& InKeyEvent
)

Processes any UI commands which are activated by the specified event