Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UMGEditor > FWidgetBlueprintEditor

Light Theme

Dark Theme

FWidgetBlueprintEditor

Widget blueprint editor (extends Blueprint editor)

Inheritance Hierarchy

IBlueprintEditor

FGCObject

FNotifyHook

FTickableEditorObject

FEditorUndoClient

FNoncopyable

FBlueprintEditor

FWidgetBlueprintEditor

References

Module	UMGEditor
Header	/Engine/Source/Editor/UMGEditor/Public/WidgetBlueprintEditor.h
Include	#include "WidgetBlueprintEditor.h"

Syntax

class FWidgetBlueprintEditor : public FBlueprintEditor

Remarks

Widget blueprint editor (extends Blueprint editor)

Variables

	Name	Description
TSharedPtr< FUI...	DesignerCommandList	Command list for handling widget actions in the WidgetBlueprintEditor
FOnEnterWidgetD...	OnEnterWidgetDesigner	Fires after the mode change to Designer
FOnHoveredWidge...	OnHoveredWidgetCleared	Fires when there is no longer any widget being hovered over
FOnHoveredWidge...	OnHoveredWidgetSet	Fires whenever a new widget is being hovered over
FOnSelectedAnim...	OnSelectedAnimationChanged	Fires whenever the selected animation changes
FOnSelectedWidg...	OnSelectedWidgetsChanged	Fires whenever the selected set of widgets changes
FOnSelectedWidg...	OnSelectedWidgetsChanging	Fires whenever the selected set of widgets changing
FOnWidgetAnimat...	OnWidgetAnimationsUpdated	Notification for when the preview widget has been updated
FOnWidgetPrevie...	OnWidgetPreviewUpdated	Notification for when the preview widget has been updated
FVector2D	PasteDropLocation	Paste Metadata
TArray< TShared...	ToolPaletteCommands	Commands for switching between tool palettes

Constructors

	Name	Description
	FWidgetBlueprintEditor()

Destructors

	Name	Description
	~FWidgetBlueprintEditor()

Functions

	Name	Description
void	AddCreateCompileTabSubMenu ( FMenuBuilder& InMenuBuilder )
void	AddDismissCompileTabSubMenu ( FMenuBuilder& InMenuBuilder )
void	AddExternalEditorWidget ( FName ID, TSharedRef< SWidget > InExternalWid... )	Adds external widget whose lifetime should be managed by this editor
void	AddPostDesignerLayoutAction ( TFunction< void()> Action )
void	BindToolkitCommands()
void	CaptureThumbnail()
void	ChangeViewedAnimation ( UWidgetAnimation& InAnimationToVie... )	Changes the currently viewed animation in Sequencer to the new one
void	CleanSelection()	Removes removed widgets from the selection set.
void	ClearHoveredWidget()
void	ClearThumbnail()
TSharedPtr< ...	CreateMenuExtender()
TSharedRef< ...	CreateSequencerDrawerWidget()	Creates a sequencer widget, for anim drawer
TSharedRef< ...	CreateSequencerTabWidget()	Creates a sequencer widget
TSharedPtr< ...	CreateSequencerWidgetInternal()
void	CustomizeWidgetCompileOptions ( FMenuBuilder& InMenuBuilder )
void	DockInLayoutClicked()	Callback to dock anim tab into layout
void	FillAssetMenu ( FMenuBuilder& MenuBuilder )
void	FillFileMenu ( FMenuBuilder& MenuBuilder )
UWidgetAnima...	GetCurrentAnimation()	Get the current animation
EWidgetDesig...	GetCurrentDesignerFlags()	Get the current designer flags that are in effect for the current user widget we're editing.
TSharedPtr< ...	GetDrawerSequencer()
TSharedPtr< ...	GetExternalEditorWidget ( FName ID )	Gets external widget whose lifetime should be managed by this editor, NullWidget if not found
const FWidge...	GetHoveredWidget()
bool	GetIsRespectingLocks()
TSharedPtr< ...	GetLibraryViewModel()
FWidgetBluep...	GetOnWidgetBlueprintTransaction()
TSharedPtr< ...	GetPaletteViewModel()
UUserWidget ...	GetPreview()
FPreviewScen...	GetPreviewScene()
TArray< TFun...	GetQueuedDesignerActions()
FWidgetRefer...	GetReferenceFromPreview ( UWidget* PreviewWidget )	Creates a widget reference using the preview. Which is used to lookup the stable template pointer.
FWidgetRefer...	GetReferenceFromTemplate ( UWidget* TemplateWidget )	Creates a widget reference using the template.
TOptional< F...	GetSelectedNamedSlot()
const TSet< ...	GetSelectedObjects()
const TWeakO...	GetSelectedTemplate()
const FAsset...	GetSelectedUserWidget()
const TSet< ...	GetSelectedWidgets()
TSharedPtr< ...	GetSequencer()
bool	GetShowDashedOutlines()
TSharedPtr< ...	GetTabSequencer()
UWidgetBluep...	GetWidgetBlueprintObj()
TSharedPtr< ...	GetWidgetToolbarBuilder()
void	InitWidgetBlueprintEditor ( const EToolkitMode::Type Mode, const TSharedPtr< IToolkitHost >& ..., const TArray< UBlueprint* >& ..., bool bShouldOpenInDefaultsMode )
void	InvalidatePreview ( bool bViewOnly )	Causes the preview to be destroyed and a new one to be created next tick
bool	IsBindingSelected ( const FMovieSceneBinding& InBindin... )	Called to determine whether a binding is selected in the tree view
bool	IsCreateOnCompileSet ( EDisplayOnCompile InCreateOnCompile )
bool	IsDismissOnCompileSet ( EDisplayOnCompile InDismissOnCompil... )
bool	IsImageUsedAsThumbnail()
bool	IsPreviewWidgetInitialized()
bool	IsSimulating()
void	MigrateFromChain ( FEditPropertyChain* PropertyTh..., bool bIsModify )	Migrate a property change from the preview GUI to the template GUI.
void	NotifyWidgetAnimListChanged()	Callback for when widget animation list has been updated
void	OnCreateNativeBaseClassSuccessfully ( const FString& InClassName, const FString& InClassPath, const FString& InModuleName )
void	OnEnteringDesigner()
TSharedRef< ...	OnGetWidgetAnimSequencer()	Gets sequencer widget, for anim drawer
void	OnWidgetAnimDrawerSequencerDismissed ( const TSharedPtr< SWidget >& Newly... )	Callback for anim drawer closing
void	OnWidgetAnimDrawerSequencerOpened ( FName StatusBarWithDrawerName )	Callback for anim drawer opening
void	OnWidgetAnimTabSequencerClosed ( TSharedRef< SDockTab > ClosedTab )	Callback for anim tab closing
void	OnWidgetAnimTabSequencerOpened()	Callback for anim tab opening
void	OpenCreateNativeBaseClassDialog()
const UWidge...	RefreshCurrentAnimation()	Updates the current animation if it is invalid
void	RefreshPreview()	Immediately rebuilds the preview widget.
int32	RemoveExternalEditorWidget ( FName ID )	Removes external widget whose lifetime should be managed by this editor
void	SelectObjects ( const TSet< UObject* >& Objec... )	Sets the currently selected set of objects
void	SelectWidgets ( const TSet< FWidgetReference >& Wi..., bool bAppendOrToggle )	Sets the currently selected set of widgets
void	SetCreateOnCompileSetting ( EDisplayOnCompile InCreateOnCompile )
void	SetDismissOnCompileSetting ( EDisplayOnCompile InDismissOnCompil... )
void	SetHoveredWidget ( FWidgetReference& InHoveredWidget )	The widget we're now hovering over in any particular context, allows multiple views to synchronize feedback on where that widget is in their representation.
void	SetIsRespectingLocks ( bool Value )
void	SetIsSimulating ( bool bSimulating )
void	SetSelectedNamedSlot ( TOptional< FNamedSlotSelection > Se... )	Sets the selected named slot
void	SetSelectedTemplate ( TWeakObjectPtr< UClass > TemplateCl... )	Set the selected template widget
void	SetSelectedUserWidget ( FAssetData InSelectedUserWidget )	Set the selected user widget
void	SetShowDashedOutlines ( bool Value )
void	TakeSnapshot()
void	ToggleAnimDrawer()	Toggles Anim Drawer, only used for keyboard shortcut

Overridden from FBlueprintEditor

	Name	Description
void	Compile()	Called when Compile button is clicked
TSubclassOf<...	GetDefaultSchemaClass()	Whenever new graphs need to be created it will use this schema by default.
FGraphAppear...	GetGraphAppearance ( UEdGraph* InGraph )	Get the graph appearance of a specific graph, GetCurrentGraphAppearance() uses the currently focused graph.
void	InitalizeExtenders()	Called during initialization of the blueprint editor to register commands and extenders.
void	RegisterApplicationModes ( const TArray< UBlueprint* >& ..., bool bShouldOpenInDefaultsMode, bool bNewlyCreated )	Called during initialization of the blueprint editor to register any application modes.

Overridden from FAssetEditorToolkit

	Name	Description
void	InitToolMenuContext ( FToolMenuContext& MenuContext )	Add context objects for menus and toolbars
bool	OnRequestClose()	Called when this toolkit is requested to close. Returns false if closing should be prevented.
void	OnToolkitHostingFinished ( const TSharedRef< IToolkit >& Tool... )	Called when another toolkit (such as a ed mode toolkit) is no longer being hosted in this asset editor toolkit.
void	OnToolkitHostingStarted ( const TSharedRef< IToolkit >& Tool... )	Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit.

Overridden from FBaseToolkit

		Name	Description
	void	CreateEditorModeManager()	Creates the Editor mode manager for your class. Default is to create none, for legacy reasons.

Overridden from IToolkit

	Name	Description
FText	GetBaseToolkitName()	Returns the localized name of this toolkit type (typically just " editor")
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
FLinearColor	GetWorldCentricTabColorScale()
FString	GetWorldCentricTabPrefix()	Returns the localize prefix string to use for tab labels in world-centric mode.

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.

Overridden from FTickableObjectBase

		Name	Description
	void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Overridden from FEditorUndoClient

		Name	Description
	void	PostRedo ( bool bSuccess )	Signal that client should run any PostRedo code
	void	PostUndo ( bool bSuccess )	Signal that client should run any PostUndo code

Classes

	Name	Description
	FOnEnterWidgetDesigner
	FOnWidgetBlueprintTransaction	Event called when an undo/redo transaction occurs

Typedefs

Name	Description
FOnHoveredWidgetCleared
FOnHoveredWidgetSet
FOnSelectedAnimationChanged	Called when animation selection changes
FOnSelectedWidgetsChanged
FOnSelectedWidgetsChanging
FOnWidgetAnimationsUpdated	Called when animation list changes
FOnWidgetPreviewUpdated	Called after the widget preview has been updated
Super

Deprecated Functions

		Name	Description
	void	OnWidgetAnimSequencerDismissed ( const TSharedPtr< SWidget >& Newly... )	OnWidgetAnimSequencerDismissed is deprecated, please use OnWidgetAnimDrawerSequencerDismissed instead.
	void	OnWidgetAnimSequencerOpened ( FName StatusBarWithDrawerName )	OnWidgetAnimSequencerOpened is deprecated, please use OnWidgetAnimDrawerSequencerOpened instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel