1. Epic GamesDeveloper
  3. FWidgetBlueprintEditor

FWidgetBlueprintEditor

Widget blueprint editor (extends Blueprint editor)

API > API/Editor > API/Editor/UMGEditor

Inheritance Hierarchy

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

  Type Name Description
Public variable TSharedPtr< FUICommandList > DesignerCommandList Command list for handling widget actions in the WidgetBlueprintEditor
Public variable FOnEnterWidgetDesigner OnEnterWidgetDesigner Fires after the mode change to Designer
Public variable FOnHoveredWidgetCleared OnHoveredWidgetCleared Fires when there is no longer any widget being hovered over
Public variable FOnHoveredWidgetSet OnHoveredWidgetSet Fires whenever a new widget is being hovered over
Public variable FOnSelectedAnimationChanged OnSelectedAnimationChanged Fires whenever the selected animation changes
Public variable FOnSelectedWidgetsChanged OnSelectedWidgetsChanged Fires whenever the selected set of widgets changes
Public variable FOnSelectedWidgetsChanged OnSelectedWidgetsChanging Fires whenever the selected set of widgets changing
Public variable FOnWidgetAnimationsUpdated OnWidgetAnimationsUpdated Notification for when the preview widget has been updated
Public variable FOnWidgetPreviewUpdated OnWidgetPreviewUpdated Notification for when the preview widget has been updated
Public variable FVector2D PasteDropLocation Paste Metadata
Public variable TArray< TSharedPtr< FUICommandInfo > > ToolPaletteCommands Commands for switching between tool palettes

Constructors

  Type Name Description
Public function FWidgetBlueprintEditor::FOnEnterWidgetDesigner TBaseMulticastDelegate_NoParams  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Static void  
Protected function Static void  
Public function void

AddExternalEditorWidget ( FName ID,
TSharedRef< SWidget > InExternalWidget
)

 Adds external widget whose lifetime should be managed by this editor
Public function void  
Protected function void  
Protected function void  
Public function void

ChangeViewedAnimation ( UWidgetAnimation& InAnimationToView
)

 Changes the currently viewed animation in Sequencer to the new one
Public function void Removes removed widgets from the selection set.
Public function void  
Protected function void  
Protected function TSharedPtr< FExtender >  
Public function TSharedRef< SWidget > Creates a sequencer widget, for anim drawer
Public function TSharedRef< SWidget > Creates a sequencer widget
Protected function TSharedPtr< ISequencer >  
Protected function void  
Public function void Callback to dock anim tab into layout
Protected function void

FillAssetMenu ( FMenuBuilder& MenuBuilder
)

  
Protected function void

FillFileMenu ( FMenuBuilder& MenuBuilder
)

  
Public function UWidgetAnimation * Get the current animation
Public function Const EWidgetDesignFlags Get the current designer flags that are in effect for the current user widget we're editing.
Public function TSharedPtr< ISequencer > &  
Public function TSharedPtr< SWidget > Gets external widget whose lifetime should be managed by this editor, NullWidget if not found
Public function Const const FWidgetReference &  
Public function Const bool  
Public function TSharedPtr< FLibraryViewModel >  
Public function FWidgetBlueprintEditor::FOnWidgetBlueprintTransaction TBaseMulticastDelegate_NoParams  
Public function TSharedPtr< FPaletteViewModel >  
Public function Const UUserWidget *  
Public function Const TSharedPtr< UE::UMG::Editor::FPreviewMode > Get the relative info for the Debug mode.
Public function FPreviewScene *  
Public function TArray< TFunction< void()> > &  
Public function FWidgetReference

GetReferenceFromPreview ( UWidget* PreviewWidget
)

 Creates a widget reference using the preview. Which is used to lookup the stable template pointer.
Public function FWidgetReference

GetReferenceFromTemplate ( UWidget* TemplateWidget
)

 Creates a widget reference using the template.
Public function Const TOptional< FNamedSlotSelection >  
Public function Const const TSet< TWeakObjectPtr< UObject > > &  
Public function Const const TWeakObjectPtr< UClass >  
Public function Const const FAssetData  
Public function Const const TSet< FWidgetReference > &  
Public function TSharedPtr< ISequencer > &  
Public function Const bool  
Public function TSharedPtr< ISequencer > &  
Public function Const UWidgetBlueprint *  
Public function TSharedPtr< class FWidgetBlueprintEditorToolbar >  
Public function void

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

  
Public function void

InvalidatePreview ( bool bViewOnly
)

 Causes the preview to be destroyed and a new one to be created next tick
Public function bool

IsBindingSelected ( const FMovieSceneBinding& InBinding
)

 Called to determine whether a binding is selected in the tree view
Protected function Static bool

IsCreateOnCompileSet ( EDisplayOnCompile InCreateOnCompile
)

  
Protected function Static bool

IsDismissOnCompileSet ( EDisplayOnCompile InDismissOnCompile
)

  
Protected function bool  
Protected function bool  
Public function Const bool  
Public function void

MigrateFromChain ( FEditPropertyChain* PropertyThatChanged,
bool bIsModify
)

 Migrate a property change from the preview GUI to the template GUI.
Public function void Callback for when widget animation list has been updated
Protected function void

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

  
Public function void  
Public function TSharedRef< SWidget > Gets sequencer widget, for anim drawer
Public function void

OnWidgetAnimDrawerSequencerDismissed ( const TSharedPtr< SWidget >& NewlyFocusedWidget
)

 Callback for anim drawer closing
Public function void

OnWidgetAnimDrawerSequencerOpened ( FName StatusBarWithDrawerName
)

 Callback for anim drawer opening
Public function void Callback for anim tab closing
Public function void Callback for anim tab opening
Protected function void  
Public function const UWidgetAnimation * Updates the current animation if it is invalid
Public function void Immediately rebuilds the preview widget.
Public function int32 Removes external widget whose lifetime should be managed by this editor
Public function void

SelectObjects ( const TSet< UObject* >& Objects
)

 Sets the currently selected set of objects
Public function void

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

 Sets the currently selected set of widgets
Protected function Static void

SetCreateOnCompileSetting ( EDisplayOnCompile InCreateOnCompile
)

  
Protected function Static void

SetDismissOnCompileSetting ( EDisplayOnCompile InDismissOnCompile
)

  
Public function 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.
Public function void

SetIsRespectingLocks ( bool Value
)

  
Public function void

SetIsSimulating ( bool bSimulating
)

  
Public function void Sets the selected named slot
Public function void Set the selected template widget
Public function void

SetSelectedUserWidget ( FAssetData InSelectedUserWidget
)

 Set the selected user widget
Public function void

SetShowDashedOutlines ( bool Value
)

  
Protected function void  
Public function void Toggles Anim Drawer, only used for keyboard shortcut

Overridden from FBlueprintEditor

  Type Name Description
Public function Virtual void

Compile ()

 Called when Compile button is clicked
Protected function Virtual Const TSubclassOf< UEdGraphSchema > Whenever new graphs need to be created it will use this schema by default.
Protected function Virtual Const FGraphAppearanceInfo Get the graph appearance of a specific graph, GetCurrentGraphAppearance() uses the currently focused graph.
Protected function Virtual void Called during initialization of the blueprint editor to register commands and extenders.
Protected function Virtual void

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

 Called during initialization of the blueprint editor to register any application modes.

Overridden from FAssetEditorToolkit

  Type Name Description
Public function Virtual void Add context objects for menus and toolbars
Public function Virtual bool

OnRequestClose ( EAssetEditorCloseReason InCloseReason
)

 Called when this toolkit is requested to close. Returns false if closing should be prevented.
Public function Virtual void Called when another toolkit (such as a ed mode toolkit) is no longer being hosted in this asset editor toolkit.
Public function Virtual void Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit.

Overridden from FBaseToolkit

  Type Name Description
Public function Virtual void Creates the Editor mode manager for your class. Default is to create none, for legacy reasons.

Overridden from IToolkit

  Type Name Description
Public function Virtual Const FText Returns the localized name of this toolkit type (typically just " editor")
Public function Virtual Const FName Returns the invariant name of this toolkit type, used for establishing the context for help, documentation and tutorials
Public function Virtual Const FName Returns the invariant name of this toolkit type
Public function Virtual Const FLinearColor  
Public function Virtual Const FString Returns the localize prefix string to use for tab labels in world-centric mode.

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Overridden from FEditorUndoClient

  Type Name Description
Public function Virtual void

PostRedo ( bool bSuccess
)

 Signal that client should run any PostRedo code
Public function Virtual void

PostUndo ( bool bSuccess
)

 Signal that client should run any PostUndo code

Classes

  Type Name Description
Public class FOnEnterWidgetDesigner    
Public class 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

  Type Name Description
Public function void

OnWidgetAnimSequencerDismissed ( const TSharedPtr< SWidget >& NewlyFocusedWidget
)

 OnWidgetAnimSequencerDismissed is deprecated, please use OnWidgetAnimDrawerSequencerDismissed instead.
Public function void

OnWidgetAnimSequencerOpened ( FName StatusBarWithDrawerName
)

 OnWidgetAnimSequencerOpened is deprecated, please use OnWidgetAnimDrawerSequencerOpened instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page