FModeToolkit | Unreal Engine 5.6 Documentation

API > API/Editor > API/Editor/UnrealEd

This FModeToolkit just creates a basic UI panel that allows various InteractiveTools to be initialized, and a DetailsView used to show properties of the active Tool.


Name	FModeToolkit
Type	class
Header File	/Engine/Source/Editor/UnrealEd/Public/Toolkits/BaseToolkit.h
Include Path	#include "Toolkits/BaseToolkit.h"

Syntax

class FModeToolkit :  
    public FBaseToolkit ,  
    public TSharedFromThis< FModeToolkit >

Inheritance Hierarchy

FSharedFromThisBase → TSharedFromThis → FModeToolkit

Implements Interfaces

IToolkit

Derived Classes

FModeToolkit derived class hierarchy

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FModeToolkit()		Toolkits/BaseToolkit.h

Structs

Name	Remarks
FEdModeToolbarRow

Typedefs

Name	Type	Remarks	Include Path
FOnPaletteChanged	TMulticastDelegate_OneParam< void, FName >		Toolkits/BaseToolkit.h

Functions

Public

Name	Remarks	Include Path
virtual void BuildToolPalette ( FName Palette, FToolBarBuilder& ToolbarBuilder )		Toolkits/BaseToolkit.h
virtual void ExtendSecondaryModeToolbar ( UToolMenu* InModeToolbarMenu )	Override this function to extend the secondary mode toolbar (that appears below the main toolbar) for your mode by filling in the UToolMenu that is passed in	Toolkits/BaseToolkit.h
virtual FText GetActiveToolDisplayName()		Toolkits/BaseToolkit.h
virtual FText GetActiveToolMessage()		Toolkits/BaseToolkit.h
FName GetCurrentPalette()		Toolkits/BaseToolkit.h
virtual FEdMode * GetEditorMode()		Toolkits/BaseToolkit.h
virtual FText GetEditorModeDisplayName()		Toolkits/BaseToolkit.h
virtual FSlateIcon GetEditorModeIcon()		Toolkits/BaseToolkit.h
virtual TWeakObjectPtr< UEdMode > GetScriptableEditorMode()		Toolkits/BaseToolkit.h
virtual FText GetToolPaletteDisplayName ( FName Palette ) const		Toolkits/BaseToolkit.h
virtual void GetToolPaletteNames ( TArray< FName >& PaletteNames ) const	Returns the number of Mode specific tabs in the mode toolbar	Toolkits/BaseToolkit.h
virtual bool HasExclusiveToolPalettes()	Exclusive Tool Palettes only allow users to use tools from one palette at a time	Toolkits/BaseToolkit.h
virtual bool HasIntegratedToolPalettes()	Integrated Tool Palettes show up in the same panel as their details	Toolkits/BaseToolkit.h
virtual void Init ( const TSharedPtr< IToolkitHost >& InitToolkitHost )	Initializes the mode toolkit	Toolkits/BaseToolkit.h
virtual void Init ( const TSharedPtr< IToolkitHost >& InitToolkitHost, TWeakObjectPtr< UEdMode > InOwningMode )		Toolkits/BaseToolkit.h
virtual void InvokeUI()		Toolkits/BaseToolkit.h
FOnPaletteChanged & OnPaletteChanged()		Toolkits/BaseToolkit.h
virtual void OnToolPaletteChanged ( FName PaletteName )		Toolkits/BaseToolkit.h
virtual void RebuildModeToolPalette()	Force the Mode Toolbar/Palette to be repopulated with the current ToolPaletteNames	Toolkits/BaseToolkit.h
void SetCurrentPalette ( FName InName )		Toolkits/BaseToolkit.h
void SetModeSettingsObject ( UObject* InSettingsObject )		Toolkits/BaseToolkit.h
virtual void ShutdownUI ()	Override this function to perform any UI cleanup before the ModeUILayer is no longer valid.	Toolkits/BaseToolkit.h

Overridden from IToolkit

Name	Remarks	Include Path	Unreal Specifiers
virtual FText GetBaseToolkitName()		Toolkits/BaseToolkit.h
virtual FEditorModeTools & GetEditorModeManager()		Toolkits/BaseToolkit.h
virtual TSharedPtr< SWidget > GetInlineContent()		Toolkits/BaseToolkit.h
virtual const TArray< UObject * > * GetObjectsCurrentlyBeingEdited()		Toolkits/BaseToolkit.h
virtual FName GetToolkitFName()		Toolkits/BaseToolkit.h
virtual FText GetToolkitName()		Toolkits/BaseToolkit.h
virtual FText GetToolkitToolTipText()		Toolkits/BaseToolkit.h
virtual FLinearColor GetWorldCentricTabColorScale()		Toolkits/BaseToolkit.h
virtual FString GetWorldCentricTabPrefix()		Toolkits/BaseToolkit.h
virtual bool IsAssetEditor()		Toolkits/BaseToolkit.h
virtual void RegisterTabSpawners ( const TSharedRef< FTabManager >& TabManager )		Toolkits/BaseToolkit.h
virtual void SetModeUILayer ( const TSharedPtr< FAssetEditorModeUILayer > InLayer )		Toolkits/BaseToolkit.h
virtual void UnregisterTabSpawners ( const TSharedRef< FTabManager >& TabManager )		Toolkits/BaseToolkit.h

Protected

Name	Remarks	Include Path
virtual TSharedRef< SWidget > CreatePaletteWidget ( TSharedPtr< FUICommandList > InCommandList, FName InToolbarCustomizationName, FName InPaletteName )	Creates the entire tool palette widget, override to specify toolbar style	Toolkits/BaseToolkit.h
TSharedRef< SDockTab > CreatePrimaryModePanel ( const FSpawnTabArgs& Args )		Toolkits/BaseToolkit.h
virtual void CustomizeDetailsViewArgs ( FDetailsViewArgs& ArgsInOut )		Toolkits/BaseToolkit.h
virtual void CustomizeModeDetailsViewArgs ( FDetailsViewArgs& ArgsInOut )		Toolkits/BaseToolkit.h
const FEditorModeInfo * GetEditorModeInfo()		Toolkits/BaseToolkit.h
EVisibility GetInlineContentHolderVisibility()		Toolkits/BaseToolkit.h
EVisibility GetNoToolSelectedTextVisibility()		Toolkits/BaseToolkit.h
bool HasToolkitBuilder()	Returns whether or not this FModeToolkit has a ToolkitBuilder defined	Toolkits/BaseToolkit.h
TSharedRef< SDockTab > MakeModeToolbarTab ( const FSpawnTabArgs& Args )	Creates the mode toolbar tab if needed	Toolkits/BaseToolkit.h
void OnModeIDChanged ( const FEditorModeID& InID, bool bIsEntering )		Toolkits/BaseToolkit.h
virtual void OnToolEnded ( UInteractiveToolManager* Manager, UInteractiveTool* Tool )		Toolkits/BaseToolkit.h
virtual void OnToolStarted ( UInteractiveToolManager* Manager, UInteractiveTool* Tool )		Toolkits/BaseToolkit.h
virtual void RebuildModeToolBar()		Toolkits/BaseToolkit.h
virtual void RequestModeUITabs()		Toolkits/BaseToolkit.h
virtual bool ShouldShowModeToolbar ()	Whether or not the mode toolbar should be shown.	Toolkits/BaseToolkit.h
void SpawnOrUpdateModeToolbar()		Toolkits/BaseToolkit.h
void UpdatePrimaryModePanel()		Toolkits/BaseToolkit.h

Navigation