FWidgetBlueprintOperationUtils

Utility functions for programmatic Widget Blueprint manipulation.

API > API/Editor > API/Editor/UMGEditor

Utility functions for programmatic Widget Blueprint manipulation.

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

Syntax

class FWidgetBlueprintOperationUtils

Functions

Static

Name Remarks Include Path Unreal Specifiers

static UWidget * AddUIComponent ( UWidgetBlueprint* WidgetBlueprint,
UClass* ComponentClass,
FName WidgetName,
FText& OutErrorMessage
)

 Adds a UI component of the given class to the named widget. WidgetBlueprintOperationUtils.h  

static bool AddWidget ( UWidgetBlueprint* WidgetBlueprint,
UWidget* NewWidget,
UWidget* ParentWidget,
int32 ChildIndex,
FText& OutErrorMessage
)

 Adds a widget to the blueprint's widget tree. WidgetBlueprintOperationUtils.h  

static bool BindToEventProperty ( UWidgetBlueprint* WidgetBlueprint,
FName EventName,
FName PropertyName,
UClass* PropertyClass,
bool bShouldJumpToNode,
FText& OutErrorMessage
)

 Adds a Blueprint event handler graph node bound to a widget's multicast delegate event, equivalent to clicking an event button on a widget variable in the Details panel. WidgetBlueprintOperationUtils.h  

static bool CanAddToParent ( UWidgetBlueprint* WidgetBlueprint,
UWidget* ParentWidget,
FText& OutErrorMessage
)

 Returns true if a widget can be added to the specified parent in the given blueprint. WidgetBlueprintOperationUtils.h  

static int32 ComputeWidgetTreeDepth ( const UWidgetBlueprint* WidgetBlueprint,
const UWidget* StartWidget
)

 Returns the maximum depth of the widget tree from StartWidget. WidgetBlueprintOperationUtils.h  

static UWidgetBlueprint * CreateWidgetBlueprint ( UObject* InParent,
FName Name,
EBlueprintType BlueprintType,
TSubclassOf< UUserWidget > ParentClass,
TSubclassOf< UWidget > RootWidgetClass,
FName CallingContext,
bool bRegisterAndCompile
)

 Lower-level overload that creates a Widget Blueprint directly into InParent with the given Name. WidgetBlueprintOperationUtils.h  

static UWidget * CreateWidgetFromAsset ( UWidgetBlueprint* WidgetBlueprint,
const FAssetData& AssetData,
UWidgetTree* RootWidgetTree,
FText& OutErrorMessage
)

 Creates a widget instance based on the class of the asset. WidgetBlueprintOperationUtils.h  

static bool DoesFunctionExistInClass ( UClass* Class,
UFunction* Function,
FText& OutError
)

 Returns true if Class declares (or inherits) a function with Function's name and a signature compatible with Function. WidgetBlueprintOperationUtils.h  

static bool DoesPropertyExistInClass ( UClass* Class,
FProperty* Property,
FText& OutError
)

 Returns true if Class declares (or inherits) a property with Property's name and a compatible type. WidgetBlueprintOperationUtils.h  

static void FixupWidgetBlueprintReferences ( UWidgetBlueprint* WidgetBlueprint,
UClass* OldClass,
UClass* NewWidgetClass,
FName VariableName
)

   WidgetBlueprintOperationUtils.h  

static bool IsParentChildCycleFree ( UWidgetBlueprint* WidgetBlueprint,
UWidget* ChildWidget,
UWidget* ParentWidget
)

 Returns true if making ChildWidget a child of ParentWidget would not create a cycle in the widget hierarchy. WidgetBlueprintOperationUtils.h  

static bool MoveUIComponent ( UWidgetBlueprint* WidgetBlueprint,
UClass* ComponentClassToMove,
UClass* RelativeToComponentClass,
FName WidgetName,
bool bMoveAfter,
FText& OutErrorMessage
)

 Moves a UI component before or after another component on the same widget. Returns true on success. WidgetBlueprintOperationUtils.h  

static bool MoveWidget ( UWidgetBlueprint* WidgetBlueprint,
UWidget* Widget,
UPanelWidget* NewParent,
int32 ChildIndex,
FText& OutErrorMessage
)

 Moves a widget to a new parent panel at the specified child index (-1 appends). WidgetBlueprintOperationUtils.h  

static void RemoveTransientWidgetFromTree ( UWidgetBlueprint* WidgetBlueprint,
UWidget* Widget
)

 Removes a widget instance that was freshly added to the tree. WidgetBlueprintOperationUtils.h  

static bool RemoveUIComponent ( UWidgetBlueprint* WidgetBlueprint,
UClass* ComponentClass,
FName WidgetName,
FText& OutErrorMessage
)

 Removes a UI component of the given class from the named widget. Returns true on success. WidgetBlueprintOperationUtils.h  

static bool RemoveWidget ( UWidgetBlueprint* WidgetBlueprint,
UWidget* Widget,
FText& OutErrorMessage
)

 Removes a widget and all of its children from the blueprint's widget tree. WidgetBlueprintOperationUtils.h  

static bool RenameWidget ( UWidgetBlueprint* WidgetBlueprint,
UWidget* Widget,
const FString& NewDisplayName
)

 Renames a widget in the blueprint. Returns true on success. WidgetBlueprintOperationUtils.h  

static bool ReplaceWidgetsWithTemplateClass ( UWidgetBlueprint* BP,
TSet< UWidget* > Widgets,
TSharedPtr< FWidgetTemplateClass > TemplateClass,
FWidgetBlueprintEditorUtils::EReplaceWidgetNamingMethod NewWidgetNamingMethod
)

   WidgetBlueprintOperationUtils.h  

static bool ReplaceWidgetWithChild ( UWidgetBlueprint* WidgetBlueprint,
UWidget* WidgetToReplace,
FText& OutErrorMessage
)

 Replaces a single-child panel widget with its child, preserving named-slot host wiring and parent linkage. WidgetBlueprintOperationUtils.h  

static bool ReplaceWidgetWithNamedSlot ( UWidgetBlueprint* WidgetBlueprint,
UWidget* WidgetToReplace,
FName NamedSlot,
FWidgetBlueprintEditorUtils::EDeleteWidgetWarningType DeleteWarningType,
FText& OutErrorMessage
)

 Replaces a host widget with the content of one of its named slots, preserving parent linkage and root-widget wiring. WidgetBlueprintOperationUtils.h  

static bool ReplaceWidgetWithTemplate ( UWidgetBlueprint* WidgetBlueprint,
UWidget* WidgetToReplace,
TSubclassOf< UWidget > TemplateClass,
FText& OutErrorMessage
)

 Replaces a widget instance in the blueprint's widget tree with a new instance created from a different template widget class. WidgetBlueprintOperationUtils.h  

static void ToggleWidgetAsVariable ( UWidgetBlueprint* WidgetBlueprint,
UWidget* Widget,
bool bIsVariable,
bool bMarkBlueprintModified
)

 Sets the bIsVariable flag on a widget. WidgetBlueprintOperationUtils.h  

static bool VerifyWidgetRename ( UWidgetBlueprint* WidgetBlueprint,
UWidget* TemplateWidget,
const FText& NewName,
FText& OutErrorMessage
)

 Validates that a widget can be renamed to NewName. WidgetBlueprintOperationUtils.h  

static void WalkWidgetTree ( const UWidgetBlueprint* WidgetBlueprint,
const UWidget* StartWidget,
int32 MaxDepth,
TFunctionRef< void(const UWidget*Widget, int32Depth, FName SlotName)> Visitor
)

 Depth-first walk of a widget tree. WidgetBlueprintOperationUtils.h  

static TArray< UWidget * > WrapWidgets ( UWidgetBlueprint* BP,
TArray< UWidget* > Widgets,
UClass* WidgetClass
)

 Wraps selected widgets in a new parent widget of the specified class. WidgetBlueprintOperationUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page