FModeToolkit | Unreal Engine 5.3 Documentation

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Toolkits

Inheritance Hierarchy

References


Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/Toolkits/BaseToolkit.h
Include	#include "Toolkits/BaseToolkit.h"

Syntax

class FModeToolkit :  
    public FBaseToolkit,  
    public TSharedFromThis< FModeToolkit >

Remarks

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.

Variables

Type	Name	Description
TArray< FEdModeToolbarRow >	ActiveToolBarRows	All toolbar rows generated by active modes.
bool	bUsesToolkitBuilder	A feature flag that can be set to true in order to make and use a ToolkitBuilder, if one is defined for a given mode.
TArray< TSharedPtr< SDockTab > >	CreatedTabs
FName	CurrentPaletteName
TSharedPtr< IDetailsView >	DetailsView
TSharedPtr< SBorder >	InlineContentHolder	Inline content area for editor modes
TSharedPtr< IDetailsView >	ModeDetailsView
TWeakPtr< SVerticalBox >	ModeToolbarBox	The actual toolbar rows will be placed in this vertical box
TSharedPtr< SBorder >	ModeToolBarContainer	The container holding the mode toolbar
TWeakPtr< SWidgetSwitcher >	ModeToolbarPaletteSwitcher	The modes palette toolbar
TWeakPtr< SDockTab >	ModeToolbarTab	The dock tab for any modes that generate a toolbar
TSharedPtr< SBorder >	ModeToolHeader	The active tool header area
TWeakPtr< FAssetEditorModeUILayer >	ModeUILayer
FOnPaletteChanged	OnPaletteChangedDelegate
TWeakObjectPtr< UEdMode >	OwningEditorMode
TWeakPtr< SDockTab >	PrimaryTab
FMinorTabConfig	PrimaryTabInfo
FMinorTabConfig	ToolbarInfo
TSharedPtr< FToolkitBuilder >	ToolkitBuilder	The FToolkitBuilder which will build the UI for this mode, if defined
TSharedPtr< FToolkitSections >	ToolkitSections	The sections of the toolkit, defined for the ToolkitBuilder (if present)
TSharedPtr< SWidget >	ToolkitWidget

Destructors

	Type	Name	Description
		~FModeToolkit ()

Functions

Type	Name	Description
void	BuildToolPalette ( FName Palette, FToolBarBuilder& ToolbarBuilder )
TSharedRef< SWidget >	CreatePaletteWidget ( TSharedPtr< FUICommandList > InCommandList, FName InToolbarCustomizationName, FName InPaletteName )	Creates the entire tool palette widget, override to specify toolbar style
TSharedRef< SDockTab >	CreatePrimaryModePanel ( const FSpawnTabArgs& Args )
void	CustomizeDetailsViewArgs ( FDetailsViewArgs& ArgsInOut )
void	CustomizeModeDetailsViewArgs ( FDetailsViewArgs& ArgsInOut )
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
FText	GetActiveToolDisplayName ()
FText	GetActiveToolMessage ()
FName	GetCurrentPalette ()
FEdMode *	GetEditorMode ()
FText	GetEditorModeDisplayName ()
FSlateIcon	GetEditorModeIcon ()
const FEditorModeInfo *	GetEditorModeInfo ()
EVisibility	GetInlineContentHolderVisibility ()
EVisibility	GetNoToolSelectedTextVisibility ()
TWeakObjectPtr< UEdMode >	GetScriptableEditorMode ()
FText	GetToolPaletteDisplayName ( FName Palette )
void	GetToolPaletteNames ( TArray< FName >& PaletteNames )	Returns the number of Mode specific tabs in the mode toolbar
bool	HasExclusiveToolPalettes ()	Exclusive Tool Palettes only allow users to use tools from one palette at a time
bool	HasIntegratedToolPalettes ()	Integrated Tool Palettes show up in the same panel as their details
bool	HasToolkitBuilder ()	Returns whether or not this FModeToolkit has a ToolkitBuilder defined
void	Init ( const TSharedPtr< IToolkitHost >& InitToolkitHost )	Initializes the mode toolkit
void	Init ( const TSharedPtr< IToolkitHost >& InitToolkitHost, TWeakObjectPtr< UEdMode > InOwningMode )	Initializes the mode toolkit
void	InvokeUI ()
TSharedRef< SDockTab >	MakeModeToolbarTab ( const FSpawnTabArgs& Args )	Creates the mode toolbar tab if needed
void	OnModeIDChanged ( const FEditorModeID& InID, bool bIsEntering )
FOnPaletteChanged &	OnPaletteChanged ()
void	OnToolEnded ( UInteractiveToolManager* Manager, UInteractiveTool* Tool )
void	OnToolPaletteChanged ( FName PaletteName )
void	OnToolStarted ( UInteractiveToolManager* Manager, UInteractiveTool* Tool )
void	RebuildModeToolBar ()
void	RebuildModeToolPalette ()	Force the Mode Toolbar/Palette to be repopulated with the current ToolPaletteNames
void	RequestModeUITabs ()
void	SetCurrentPalette ( FName InName )
void	SetModeSettingsObject ( UObject* InSettingsObject )
bool	ShouldShowModeToolbar ()	Whether or not the mode toolbar should be shown.
void	SpawnOrUpdateModeToolbar ()
void	UpdatePrimaryModePanel ()

Overridden from IToolkit

Type	Name	Description
FText	GetBaseToolkitName ()	Returns the localized name of this toolkit type (typically just " editor")
FEditorModeTools &	GetEditorModeManager ()	Gets the mode manager for this toolkit
TSharedPtr< SWidget >	GetInlineContent ()
const TArray< UObject * > *	GetObjectsCurrentlyBeingEdited ()	For asset editor toolkits, returns the UObjects for the assets currently being edited
FName	GetToolkitFName ()	Returns the invariant name of this toolkit type
FText	GetToolkitName ()	Returns the localized name of this toolkit
FText	GetToolkitToolTipText ()	Returns the localized tooltip text 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.)
void	RegisterTabSpawners ( const TSharedRef< FTabManager >& TabManager )	Register tabs that this toolkit can spawn with the TabManager
void	SetModeUILayer ( const TSharedPtr< FAssetEditorModeUILayer > InLayer )
void	UnregisterTabSpawners ( const TSharedRef< FTabManager >& TabManager )	Unregister tabs that this toolkit can spawn