1. Epic GamesDeveloper
  3. FWidgetBlueprintEditor

FWidgetBlueprintEditor

Widget blueprint editor (extends Blueprint editor)

API > API/Editor > API/Editor/UMGEditor

Widget blueprint editor (extends Blueprint editor)

   
Name FWidgetBlueprintEditor
Type class
Header File /Engine/Source/Editor/UMGEditor/Public/WidgetBlueprintEditor.h
Include Path #include "WidgetBlueprintEditor.h"

Syntax

class FWidgetBlueprintEditor : public FBlueprintEditor

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FWidgetBlueprintEditor()

   WidgetBlueprintEditor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FWidgetBlueprintEditor()

   WidgetBlueprintEditor.h  

Classes

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

Typedefs

Name Type Remarks Include Path
FOnHoveredWidgetCleared TMulticastDelegate_NoParams< void >   WidgetBlueprintEditor.h
FOnHoveredWidgetSet TMulticastDelegate_OneParam< void, const FWidgetReference & >   WidgetBlueprintEditor.h
FOnSelectedAnimationChanged TMulticastDelegate_NoParams< void > Called when animation selection changes WidgetBlueprintEditor.h
FOnSelectedWidgetsChanged TMulticastDelegate_NoParams< void >   WidgetBlueprintEditor.h
FOnSelectedWidgetsChanging TMulticastDelegate_NoParams< void >   WidgetBlueprintEditor.h
FOnWidgetAnimationsUpdated TMulticastDelegate_NoParams< void > Called when animation list changes WidgetBlueprintEditor.h
FOnWidgetPreviewUpdated TMulticastDelegate_NoParams< void > Called after the widget preview has been updated WidgetBlueprintEditor.h
Super FBlueprintEditor   WidgetBlueprintEditor.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DesignerCommandList TSharedPtr< FUICommandList > Command list for handling widget actions in the WidgetBlueprintEditor WidgetBlueprintEditor.h  
FOnWidgetPreviewReady FWidgetBlueprintEditor::FOnEnterWidgetDesigner Called after the widget preview has fully recreated WidgetBlueprintEditor.h  
OnEnterWidgetDesigner FOnEnterWidgetDesigner Fires after the mode change to Designer WidgetBlueprintEditor.h  
OnHoveredWidgetCleared FOnHoveredWidgetCleared Fires when there is no longer any widget being hovered over WidgetBlueprintEditor.h  
OnHoveredWidgetSet FOnHoveredWidgetSet Fires whenever a new widget is being hovered over WidgetBlueprintEditor.h  
OnSelectedAnimationChanged FOnSelectedAnimationChanged Fires whenever the selected animation changes WidgetBlueprintEditor.h  
OnSelectedWidgetsChanged FOnSelectedWidgetsChanged Fires whenever the selected set of widgets changes WidgetBlueprintEditor.h  
OnSelectedWidgetsChanging FOnSelectedWidgetsChanged Fires whenever the selected set of widgets changing WidgetBlueprintEditor.h  
OnWidgetAnimationsUpdated FOnWidgetAnimationsUpdated Notification for when animations have been updated WidgetBlueprintEditor.h  
OnWidgetPreviewReady FOnWidgetPreviewReady Notification for when the preview widget has been fully recreated WidgetBlueprintEditor.h  
OnWidgetPreviewUpdated FOnWidgetPreviewUpdated Notification for when the preview widget has been updated WidgetBlueprintEditor.h  
PasteDropLocation FVector2D Paste Metadata WidgetBlueprintEditor.h  
ToolPaletteCommands TArray< TSharedPtr< FUICommandInfo > > Commands for switching between tool palettes WidgetBlueprintEditor.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AnimDrawerWidget TSharedPtr< SWidget > Widget created for anim drawer WidgetBlueprintEditor.h  
bIsPreviewWidgetSelected bool True when the selected object is the preview widget. WidgetBlueprintEditor.h  
bIsRealTime bool   WidgetBlueprintEditor.h  
bIsSequencerDrawerOpen bool True if sequencer drawer is open WidgetBlueprintEditor.h  
bIsSimulateEnabled bool   WidgetBlueprintEditor.h  
bPreviewInvalidated bool The preview becomes invalid and needs to be rebuilt on the next tick. WidgetBlueprintEditor.h  
bRefreshGeneratedClassAnimations bool When true the animation data in the generated class should be replaced with the current animation data. WidgetBlueprintEditor.h  
bRespectLocks bool   WidgetBlueprintEditor.h  
bShowDashedOutlines bool Should the designer show outlines when it creates widgets? WidgetBlueprintEditor.h  
bUpdatingExternalSelection bool When true the external selection is being updated from changes to the sequencer selection. WidgetBlueprintEditor.h  
bUpdatingSequencerSelection bool When true the sequencer selection is being updated from changes to the external selection. WidgetBlueprintEditor.h  
CurrentAnimation TWeakObjectPtr< UWidgetAnimation > The currently viewed animation, if any. WidgetBlueprintEditor.h  
DrawerSequencer TSharedPtr< ISequencer > Sequencer for creating and previewing widget animations in drawer WidgetBlueprintEditor.h  
DrawerSequencerOverlay TWeakPtr< SOverlay > Overlay used to display UI on top of drawer sequencer WidgetBlueprintEditor.h  
ExternalEditorWidgets TMap< FName, TSharedPtr< SWidget > > For external widgets to have lifetimes bound to this editor instance WidgetBlueprintEditor.h  
HoveredWidget FWidgetReference The widget currently being hovered over WidgetBlueprintEditor.h  
LibraryViewModel TSharedPtr< FLibraryViewModel > ViewModel used by the Library View WidgetBlueprintEditor.h  
ModeUILayer TSharedPtr< class FWidgetEditorModeUILayer > Used to spawn sidebar tool palette WidgetBlueprintEditor.h  
NoAnimationTextBlockDrawer TWeakPtr< STextBlock > A text block which is displayed in the overlay when no animation is selected in drawer. WidgetBlueprintEditor.h  
NoAnimationTextBlockTab TWeakPtr< STextBlock > A text block which is displayed in the overlay when no animation is selected. WidgetBlueprintEditor.h  
OnWidgetBlueprintTransaction FOnWidgetBlueprintTransaction Delegate called when a undo/redo transaction happens WidgetBlueprintEditor.h  
PaletteViewModel TSharedPtr< FPaletteViewModel > ViewModel used by the Palette and Palette Favorite Views WidgetBlueprintEditor.h  
PreviewBlueprint UWidgetBlueprint * The Blueprint associated with the current preview WidgetBlueprintEditor.h  
PreviewMode TSharedPtr< UE::UMG::Editor::FPreviewMode >   WidgetBlueprintEditor.h  
PreviewScene FPreviewScene The preview scene that owns the preview GUI WidgetBlueprintEditor.h  
PreviewWidgetPtr TWeakObjectPtr< UUserWidget > The preview GUI object WidgetBlueprintEditor.h  
QueuedDesignerActions TArray< TFunction< void()> >   WidgetBlueprintEditor.h  
SelectedNamedSlot TOptional< FNamedSlotSelection > The currently selected named slot WidgetBlueprintEditor.h  
SelectedObjects TSet< TWeakObjectPtr< UObject > > The currently selected objects in the designer WidgetBlueprintEditor.h  
SelectedTemplate TWeakObjectPtr< UClass > The last selected template widget in the palette view WidgetBlueprintEditor.h  
SelectedUserWidget FAssetData AssetData of Selected UserWidget WidgetBlueprintEditor.h  
SelectedWidgets TSet< FWidgetReference > The currently selected preview widgets in the preview GUI WidgetBlueprintEditor.h  
SequencerAddTrackExtenderHandle FDelegateHandle   WidgetBlueprintEditor.h  
Sequencers TArray< TWeakPtr< ISequencer > > List of created sequencers WidgetBlueprintEditor.h  
TabSequencer TSharedPtr< ISequencer > Sequencer for creating and previewing widget animations in tabs WidgetBlueprintEditor.h  
TabSequencerOverlay TWeakPtr< SOverlay > Overlay used to display UI on top of tab sequencer WidgetBlueprintEditor.h  
WidgetHandlePool TArray< TWeakPtr< FWidgetHandle > > The widget references out in the ether that may need to be updated after being issued. WidgetBlueprintEditor.h  
WidgetToolbar TSharedPtr< class FWidgetBlueprintEditorToolbar > The toolbar builder associated with this editor WidgetBlueprintEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddExternalEditorWidget ( FName ID,
TSharedRef< SWidget > InExternalWidget
)

 Adds external widget whose lifetime should be managed by this editor WidgetBlueprintEditor.h  

void AddPostDesignerLayoutAction ( TFunction< void()> Action
)

   WidgetBlueprintEditor.h  

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   WidgetBlueprintEditor.h  

void ChangeViewedAnimation ( UWidgetAnimation& InAnimationToView
)

 Changes the currently viewed animation in Sequencer to the new one WidgetBlueprintEditor.h  

void CleanSelection()

 Removes removed widgets from the selection set. WidgetBlueprintEditor.h  

void ClearHoveredWidget()

   WidgetBlueprintEditor.h  

virtual void Compile()

   WidgetBlueprintEditor.h  

void CreateEditorModeManager()

   WidgetBlueprintEditor.h  

TSharedRef< SWidget > CreateSequencerDrawerWidget()

 Creates a sequencer widget, for anim drawer WidgetBlueprintEditor.h  

TSharedRef< SWidget > CreateSequencerTabWidget()

 Creates a sequencer widget WidgetBlueprintEditor.h  

void DockInLayoutClicked()

 Callback to dock anim tab into layout WidgetBlueprintEditor.h  

virtual FText GetBaseToolkitName()

   WidgetBlueprintEditor.h  

UWidgetAnimation * GetCurrentAnimation()

 Get the current animation WidgetBlueprintEditor.h  

EWidgetDesignFlags GetCurrentDesignerFlags()

 Get the current designer flags that are in effect for the current user widget we're editing. WidgetBlueprintEditor.h  

TSharedPtr< ISequencer > & GetDrawerSequencer()

   WidgetBlueprintEditor.h  

TSharedPtr< SWidget > GetExternalEditorWidget ( FName ID
)

 Gets external widget whose lifetime should be managed by this editor, NullWidget if not found WidgetBlueprintEditor.h  

const FWidgetReference & GetHoveredWidget()

   WidgetBlueprintEditor.h  

bool GetIsRespectingLocks()

   WidgetBlueprintEditor.h  

TSharedPtr< FLibraryViewModel > GetLibraryViewModel()

   WidgetBlueprintEditor.h  

FWidgetBlueprintEditor::FOnWidgetBlueprintTransaction TBaseMulticastDelegate_NoParams GetOnWidgetBlueprintTransaction()

   WidgetBlueprintEditor.h  

TSharedPtr< FPaletteViewModel > GetPaletteViewModel()

   WidgetBlueprintEditor.h  

UUserWidget * GetPreview()

   WidgetBlueprintEditor.h  
Get the relative info for the Debug mode. WidgetBlueprintEditor.h  

FPreviewScene * GetPreviewScene()

   WidgetBlueprintEditor.h  

TArray< TFunction< void()> > & GetQueuedDesignerActions()

   WidgetBlueprintEditor.h  

FWidgetReference GetReferenceFromPreview ( UWidget* PreviewWidget
)

 Creates a widget reference using the preview. Which is used to lookup the stable template pointer. WidgetBlueprintEditor.h  

FWidgetReference GetReferenceFromTemplate ( UWidget* TemplateWidget
)

 Creates a widget reference using the template. WidgetBlueprintEditor.h  

TOptional< FNamedSlotSelection > GetSelectedNamedSlot()

   WidgetBlueprintEditor.h  

const TSet< TWeakObjectPtr< UObject > > & GetSelectedObjects()

   WidgetBlueprintEditor.h  

const TWeakObjectPtr< UClass > GetSelectedTemplate()

   WidgetBlueprintEditor.h  

const FAssetData GetSelectedUserWidget()

   WidgetBlueprintEditor.h  

const TSet< FWidgetReference > & GetSelectedWidgets()

   WidgetBlueprintEditor.h  

TSharedPtr< ISequencer > & GetSequencer()

   WidgetBlueprintEditor.h  

bool GetShowDashedOutlines()

   WidgetBlueprintEditor.h  

TSharedPtr< ISequencer > & GetTabSequencer()

   WidgetBlueprintEditor.h  

virtual FName GetToolkitContextFName()

   WidgetBlueprintEditor.h  

virtual FName GetToolkitFName()

   WidgetBlueprintEditor.h  

UWidgetBlueprint * GetWidgetBlueprintObj()

   WidgetBlueprintEditor.h  

TSharedPtr< class FWidgetBlueprintEditorToolbar > GetWidgetToolbarBuilder()

   WidgetBlueprintEditor.h  

virtual FLinearColor GetWorldCentricTabColorScale()

   WidgetBlueprintEditor.h  

virtual FString GetWorldCentricTabPrefix()

   WidgetBlueprintEditor.h  

virtual void InitToolMenuContext ( FToolMenuContext& MenuContext
)

   WidgetBlueprintEditor.h  

void InitWidgetBlueprintEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
const TArray< UBlueprint* >& InBlueprints,
bool bShouldOpenInDefaultsMode
)

   WidgetBlueprintEditor.h  

void InvalidatePreview ( bool bViewOnly
)

 Causes the preview to be destroyed and a new one to be created next tick WidgetBlueprintEditor.h  

bool IsBindingSelected ( const FMovieSceneBinding& InBinding
)

 Called to determine whether a binding is selected in the tree view WidgetBlueprintEditor.h  

bool IsSimulating()

   WidgetBlueprintEditor.h  

void MigrateFromChain ( const FPropertyChangedEvent* PropertyChangedEvent,
FEditPropertyChain* PropertyThatChanged,
bool bIsModify
)

 Migrate a property change from the preview GUI to the template GUI. WidgetBlueprintEditor.h  

void NotifyWidgetAnimListChanged()

 Callback for when widget animation list has been updated WidgetBlueprintEditor.h  

void OnEnteringDesigner()

   WidgetBlueprintEditor.h  

TSharedRef< SWidget > OnGetWidgetAnimSequencer()

 Gets sequencer widget, for anim drawer WidgetBlueprintEditor.h  

virtual bool OnRequestClose ( EAssetEditorCloseReason InCloseReason
)

   WidgetBlueprintEditor.h  

void OnToolkitHostingFinished ( const TSharedRef< IToolkit >& Toolkit
)

   WidgetBlueprintEditor.h  

void OnToolkitHostingStarted ( const TSharedRef< IToolkit >& Toolkit
)

   WidgetBlueprintEditor.h  

void OnWidgetAnimDrawerSequencerDismissed ( const TSharedPtr< SWidget >& NewlyFocusedWidget
)

 Callback for anim drawer closing WidgetBlueprintEditor.h  

void OnWidgetAnimDrawerSequencerOpened ( FName StatusBarWithDrawerName
)

 Callback for anim drawer opening WidgetBlueprintEditor.h  

void OnWidgetAnimSequencerDismissed ( const TSharedPtr< SWidget >& NewlyFocusedWidget
)

   WidgetBlueprintEditor.h  

void OnWidgetAnimSequencerOpened ( FName StatusBarWithDrawerName
)

   WidgetBlueprintEditor.h  

void OnWidgetAnimTabSequencerClosed ( TSharedRef< SDockTab > ClosedTab
)

 Callback for anim tab closing WidgetBlueprintEditor.h  

void OnWidgetAnimTabSequencerOpened()

 Callback for anim tab opening WidgetBlueprintEditor.h  

virtual void PostRedo ( bool bSuccessful
)

   WidgetBlueprintEditor.h  

virtual void PostUndo ( bool bSuccessful
)

   WidgetBlueprintEditor.h  

const UWidgetAnimation * RefreshCurrentAnimation()

 Updates the current animation if it is invalid WidgetBlueprintEditor.h  

void RefreshPreview()

 Immediately rebuilds the preview widget. WidgetBlueprintEditor.h  

int32 RemoveExternalEditorWidget ( FName ID
)

 Removes external widget whose lifetime should be managed by this editor WidgetBlueprintEditor.h  

void SelectObjects ( const TSet< UObject* >& Objects
)

 Sets the currently selected set of objects WidgetBlueprintEditor.h  

void SelectWidgets ( const TSet< FWidgetReference >& Widgets,
bool bAppendOrToggle
)

 Sets the currently selected set of widgets WidgetBlueprintEditor.h  

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. WidgetBlueprintEditor.h  

void SetIsRespectingLocks ( bool Value
)

   WidgetBlueprintEditor.h  

void SetIsSimulating ( bool bSimulating
)

   WidgetBlueprintEditor.h  

void SetSelectedNamedSlot ( TOptional< FNamedSlotSelection > SelectedNamedSlot
)

 Sets the selected named slot WidgetBlueprintEditor.h  

void SetSelectedTemplate ( TWeakObjectPtr< UClass > TemplateClass
)

 Set the selected template widget WidgetBlueprintEditor.h  

void SetSelectedUserWidget ( FAssetData InSelectedUserWidget
)

 Set the selected user widget WidgetBlueprintEditor.h  

void SetShowDashedOutlines ( bool Value
)

   WidgetBlueprintEditor.h  

virtual void Tick ( float DeltaTime
)

   WidgetBlueprintEditor.h  

void ToggleAnimDrawer()

 Toggles Anim Drawer, only used for keyboard shortcut WidgetBlueprintEditor.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BindToolkitCommands()

   WidgetBlueprintEditor.h  

void CaptureThumbnail()

   WidgetBlueprintEditor.h  

void ClearThumbnail()

   WidgetBlueprintEditor.h  

TSharedPtr< FExtender > CreateMenuExtender()

   WidgetBlueprintEditor.h  

TSharedPtr< ISequencer > CreateSequencerWidgetInternal()

   WidgetBlueprintEditor.h  

void CustomizeWidgetCompileOptions ( FMenuBuilder& InMenuBuilder
)

   WidgetBlueprintEditor.h  

void FillAssetMenu ( FMenuBuilder& MenuBuilder
)

   WidgetBlueprintEditor.h  

void FillFileMenu ( FMenuBuilder& MenuBuilder
)

   WidgetBlueprintEditor.h  

virtual TSubclassOf< UEdGraphSchema > GetDefaultSchemaClass()

   WidgetBlueprintEditor.h  

virtual FGraphAppearanceInfo GetGraphAppearance ( UEdGraph* InGraph
) const

   WidgetBlueprintEditor.h  

virtual void InitalizeExtenders()

   WidgetBlueprintEditor.h  

bool IsImageUsedAsThumbnail()

   WidgetBlueprintEditor.h  

bool IsPreviewWidgetInitialized()

   WidgetBlueprintEditor.h  

void OnCreateNativeBaseClassSuccessfully ( const FString& InClassName,
const FString& InClassPath,
const FString& InModuleName
)

   WidgetBlueprintEditor.h  

void OpenCreateNativeBaseClassDialog()

   WidgetBlueprintEditor.h  

virtual void RegisterApplicationModes ( const TArray< UBlueprint* >& InBlueprints,
bool bShouldOpenInDefaultsMode,
bool bNewlyCreated
)

   WidgetBlueprintEditor.h  

void TakeSnapshot()

   WidgetBlueprintEditor.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddCreateCompileTabSubMenu ( FMenuBuilder& InMenuBuilder
)

   WidgetBlueprintEditor.h  

static void AddDismissCompileTabSubMenu ( FMenuBuilder& InMenuBuilder
)

   WidgetBlueprintEditor.h  

static bool IsCreateOnCompileSet ( EDisplayOnCompile InCreateOnCompile
)

   WidgetBlueprintEditor.h  

static bool IsDismissOnCompileSet ( EDisplayOnCompile InDismissOnCompile
)

   WidgetBlueprintEditor.h  

static void SetCreateOnCompileSetting ( EDisplayOnCompile InCreateOnCompile
)

   WidgetBlueprintEditor.h  

static void SetDismissOnCompileSetting ( EDisplayOnCompile InDismissOnCompile
)

   WidgetBlueprintEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page