FWidgetBlueprintEditor

Widget blueprint editor (extends Blueprint editor)

Windows
MacOS
Linux

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

Name Description

Public variable

TSharedPtr< FUI...

 

DesignerCommandList

Command list for handling widget actions in the WidgetBlueprintEditor

Public variable

FOnEnterWidgetD...

 

OnEnterWidgetDesigner

Fires after the mode change to Designer

Public variable

FOnHoveredWidge...

 

OnHoveredWidgetCleared

Fires when there is no longer any widget being hovered over

Public variable

FOnHoveredWidge...

 

OnHoveredWidgetSet

Fires whenever a new widget is being hovered over

Public variable

FOnSelectedWidg...

 

OnSelectedWidgetsChanged

Fires whenever the selected set of widgets changes

Public variable

FOnSelectedWidg...

 

OnSelectedWidgetsChanging

Fires whenever the selected set of widgets changing

Public variable

FOnWidgetPrevie...

 

OnWidgetPreviewUpdated

Notification for when the preview widget has been updated

Public variable

FVector2D

 

PasteDropLocation

Paste Metadata

Constructors

Name Description

Public function

FWidgetBlueprintEditor()

Destructors

Name Description

Public function Virtual

~FWidgetBlueprintEditor()

Functions

Name Description

Public function

void

 

AddPostDesignerLayoutAction

(
    TFunction< void()> Action
)

Protected function

void

 

BindToolkitCommands()

Public function

void

 

ChangeViewedAnimation

(
    UWidgetAnimation& InAnimationToVie...
)

Changes the currently viewed animation in Sequencer to the new one

Public function

void

 

CleanSelection()

Removes removed widgets from the selection set.

Public function

void

 

ClearHoveredWidget()

Protected function

TSharedPtr< ...

 

CreateMenuExtender()

Public function

TSharedRef< ...

 

CreateSequencerWidget()

Creates a sequencer widget

Protected function

void

 

FillFileMenu

(
    FMenuBuilder& MenuBuilder
)

Public function

UWidgetAnima...

 

GetCurrentAnimation()

Get the current animation

Public function Const

EWidgetDesig...

 

GetCurrentDesignerFlags()

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

Public function Const

const FWidge...

 

GetHoveredWidget()

Public function Const

bool

 

GetIsRespectingLocks()

Public function

FWidgetBluep...

 

GetOnWidgetBlueprintTransaction()

Public function

TSharedPtr< ...

 

GetPaletteViewModel()

Public function Const

UUserWidget ...

 

GetPreview()

Public function

FPreviewScen...

 

GetPreviewScene()

Public function

TArray< TFun...

 

GetQueuedDesignerActions()

Public function

FWidgetRefer...

 

GetReferenceFromPreview

(
    UWidget* PreviewWidget
)

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

Public function

FWidgetRefer...

 

GetReferenceFromTemplate

(
    UWidget* TemplateWidget
)

Creates a widget reference using the template.

Public function Const

TOptional< F...

 

GetSelectedNamedSlot()

Public function Const

const TSet< ...

 

GetSelectedObjects()

Public function Const

const TWeakO...

 

GetSelectedTemplate()

Public function Const

const FAsset...

 

GetSelectedUserWidget()

Public function Const

const TSet< ...

 

GetSelectedWidgets()

Public function

TSharedPtr< ...

 

GetSequencer()

Public function Const

bool

 

GetShowDashedOutlines()

Public function Const

UWidgetBluep...

 

GetWidgetBlueprintObj()

Public function

TSharedPtr< ...

 

GetWidgetToolbarBuilder()

Public function

void

 

InitWidgetBlueprintEditor

(
    const EToolkitMode::Type Mode,
    const TSharedPtr< IToolkitHost >& ...,
    const TArray< UBlueprint* >& ...,
    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& InBindin...
)

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

Public function Const

bool

 

IsSimulating()

Public function

void

 

MigrateFromChain

(
    FEditPropertyChain* PropertyTh...,
    bool bIsModify
)

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

Protected function

void

 

OnCreateNativeBaseClassSuccessfully

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

Public function

void

 

OnEnteringDesigner()

Protected function

void

 

OpenCreateNativeBaseClassDialog()

Public function

const UWidge...

 

RefreshCurrentAnimation()

Updates the current animation if it is invalid

Public function

void

 

RefreshPreview()

Immediately rebuilds the preview widget.

Public function

void

 

SelectObjects

(
    const TSet< UObject* >& Objec...
)

Sets the currently selected set of objects

Public function

void

 

SelectWidgets

(
    const TSet< FWidgetReference >& Wi...,
    bool bAppendOrToggle
)

Sets the currently selected set of widgets

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

 

SetSelectedNamedSlot

(
    TOptional< FNamedSlotSelection > Se...
)

Sets the selected named slot

Public function

void

 

SetSelectedTemplate

(
    TWeakObjectPtr< UClass > TemplateCl...
)

Set the selected template widget

Public function

void

 

SetSelectedUserWidget

(
    FAssetData InSelectedUserWidget
)

Set the selected user widget

Public function

void

 

SetShowDashedOutlines

(
    bool Value
)

Overridden from FBlueprintEditor

Name Description

Protected function Virtual

void

 

AppendExtraCompilerResults

(
    TSharedPtr< class IMessageLogListin...
)

Public function Virtual

void

 

Compile()

Called when Compile button is clicked

Protected function Virtual Const

TSubclassOf<...

 

GetDefaultSchemaClass()

Whenever new graphs need to be created it will use this schema by default.

Protected function Virtual Const

FGraphAppear...

 

GetGraphAppearance

(
    UEdGraph* InGraph
)

Get the graph appearance of a specific graph, GetCurrentGraphAppearance() uses the currently focused graph.

Protected function Virtual

void

 

InitalizeExtenders()

Called during initialization of the blueprint editor to register commands and extenders.

Protected function Virtual

void

 

RegisterApplicationModes

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

Begin FBlueprintEditor.

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

FGCObjectInterface

Overridden from FTickableObjectBase

Name Description

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

FBlueprintEditor interface

Overridden from FEditorUndoClient

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

Name

Description

Public class

FOnEnterWidgetDesigner

Public class

FOnWidgetBlueprintTransaction

Event called when an undo/redo transaction occurs

Typedefs

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