1. Epic GamesDeveloper
  3. FWidgetBlueprintEditorUtils

FWidgetBlueprintEditorUtils

API > API/Editor > API/Editor/UMGEditor

References

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

Syntax

class FWidgetBlueprintEditorUtils

Functions

  Type Name Description
Public function Static bool

CanPasteWidgetsExtension ( TSet< FWidgetReference > SelectedWidgets
)

  
Public function Static EDesignPreviewSizeMode

ConvertThumbnailSizeModeToDesignerSizeMode ( EThumbnailPreviewSizeMode ThumbnailSizeMode,
UUserWidget* WidgetInstance
)

  
Public function Static void

CopyWidgets ( UWidgetBlueprint* BP,
TSet< FWidgetReference > Widgets
)

  
Public function Static UUserWidget *  
Public function Static void

CreateWidgetContextMenu ( FMenuBuilder& MenuBuilder,
TSharedRef< FWidgetBlueprintEditor > BlueprintEditor,
FVector2D TargetLocation
)

  
Public function Static void

CutWidgets ( TSharedRef< FWidgetBlueprintEditor > BlueprintEditor,
UWidgetBlueprint* BP,
TSet< FWidgetReference > Widgets
)

  
Public function Static void

DeleteWidgets ( TSharedRef< FWidgetBlueprintEditor > BlueprintEditor,
UWidgetBlueprint* BP,
TSet< FWidgetReference > Widgets,
bool bSilentDelete
)

  
Public function Static void

DestroyUserWidget ( UUserWidget* UserWidget
)

 Performs cleanup on the specified UserWidget.
Public function Static bool  
Public function Static TOptional< FWidgetThumbnailProperties >

DrawSWidgetInRenderTarget ( UUserWidget* WidgetInstance,
UTextureRenderTarget2D* RenderTarget2D
)

  
Public function Static TOptional< FWidgetThumbnailProperties >

DrawSWidgetInRenderTargetForThumbnail ( UUserWidget* WidgetInstance,
UTextureRenderTarget2D* RenderTarget2D,
FVector2D ThumbnailSize,
TOptional< FVector2D > ThumbnailCustomSize,
EThumbnailPreviewSizeMode ThumbnailSizeMode
)

  
Public function Static TOptional< FWidgetThumbnailProperties >

DrawSWidgetInRenderTargetForThumbnail ( UUserWidget* WidgetInstance,
FRenderTarget* RenderTarget2D,
FVector2D ThumbnailSize,
TOptional< FVector2D > ThumbnailCustomSize,
EThumbnailPreviewSizeMode ThumbnailSizeMode
)

  
Public function Static TArray< UWidget * >

DuplicateWidgets ( TSharedRef< FWidgetBlueprintEditor > BlueprintEditor,
UWidgetBlueprint* BP,
TSet< FWidgetReference > Widgets
)

  
Public function Static void

ExportPropertiesToText ( UObject* Object,
TMap< FName, FString >& ExportedProperties
)

 Exports the individual properties of an object to text and stores them in a map.
Public function Static void

ExportWidgetsToText ( TArray< UWidget* > WidgetsToExport,
FString& ExportedText
)

  
Public function Static void

FindAllAncestorNamedSlotHostWidgetsForContent ( TArray< FWidgetReference >& OutSlotHostWidgets,
UWidget* WidgetTemplate,
TSharedRef< FWidgetBlueprintEditor > BlueprintEditor
)

  
Public function Static UWidgetTree *

FindLatestWidgetTree ( UWidgetBlueprint* Blueprint,
UUserWidget* UserWidget
)

  
Public function Static TScriptInterface< INamedSlotInterface >

FindNamedSlotHostForContent ( UWidget* WidgetTemplate,
UWidgetTree* WidgetTree
)

  
Public function Static UWidget *

FindNamedSlotHostWidgetForContent ( UWidget* WidgetTemplate,
UWidgetTree* WidgetTree
)

  
Public function Static FText

GetPaletteCategory ( const FAssetData& WidgetAsset,
const TSubclassOf< UWidget > NativeClass
)

  
Public function Static FText

GetPaletteCategory ( const TSubclassOf< UWidget > Widget
)

  
Public function Static UWidgetEditingProjectSettings *

GetRelevantMutableSettings ( TWeakPtr< FWidgetBlueprintEditor > CurrentEditor
)

  
Public function Static const UWidgetEditingProjectSettings *

GetRelevantSettings ( TWeakPtr< FWidgetBlueprintEditor > CurrentEditor
)

  
Public function Static TTuple< float, FVector2D >

GetThumbnailImageScaleAndOffset ( FVector2D WidgetSize,
FVector2D ThumbnailSize
)

  
Public function Static UWidgetBlueprint *

GetWidgetBlueprintFromWidget ( const UWidget* Widget
)

  
Public function Static TTuple< FVector2D, FVector2D >

GetWidgetPreviewAreaAndSize ( UUserWidget* UserWidget,
FVector2D DesiredSize,
FVector2D PreviewSize,
EDesignPreviewSizeMode ThumbnailSizeMode,
TOptional< FVector2D > ThumbnailCustomSize
)

  
Public function Static float

GetWidgetPreviewDPIScale ( UUserWidget* UserWidget,
FVector2D PreviewSize
)

  
Public function Static FVector2D

GetWidgetPreviewUnScaledCustomSize ( FVector2D DesiredSize,
UUserWidget* UserWidget,
TOptional< FVector2D > ThumbnailCustomSize,
EThumbnailPreviewSizeMode ThumbnailSizeMode
)

  
Public function Static UWidget *

GetWidgetTemplateFromDragDrop ( UWidgetBlueprint* Blueprint,
UWidgetTree* RootWidgetTree,
TSharedPtr< FDragDropOperation >& DragDropOp
)

  
Public function Static void

ImportPropertiesFromText ( UObject* Object,
const TMap< FName, FString >& ExportedProperties
)

 Attempts to import any property in the map and apply it to a property with the same name on the object.
Public function Static void

ImportWidgetsFromText ( UWidgetBlueprint* BP,
const FString& TextToImport,
TSet< UWidget* >& ImportedWidgetSet,
TMap< FName, UWidgetSlotPair* >& PastedExtraSlotData
)

  
Public function Static bool

IsAnySelectedWidgetLocked ( TSet< FWidgetReference > SelectedWidgets
)

  
Public function Static bool

IsBindWidgetAnimProperty ( const FProperty* InProperty,
bool& bIsOptional
)

  
Public function Static bool

IsBindWidgetAnimProperty ( const FProperty* InProperty
)

  
Public function Static bool

IsBindWidgetProperty ( const FProperty* InProperty,
bool& bIsOptional
)

  
Public function Static bool

IsBindWidgetProperty ( const FProperty* InProperty
)

  
Public function Static TValueOrError< FUsableWidgetClassResult, void >

IsUsableWidgetClass ( const FAssetData& WidgetAsset
)

  
Public function Static bool

IsUsableWidgetClass ( const UClass* WidgetClass
)

  
Public function Static bool

IsUsableWidgetClass ( const UClass* WidgetClass,
TSharedRef< FWidgetBlueprintEditor > InCurrentActiveBlueprintEditor
)

  
Public function Static TValueOrError< FUsableWidgetClassResult, void >

IsUsableWidgetClass ( const FAssetData& WidgetAsset,
TSharedRef< FWidgetBlueprintEditor > InCurrentActiveBlueprintEditor
)

  
Public function Static TArray< UWidget * >

PasteWidgets ( TSharedRef< FWidgetBlueprintEditor > BlueprintEditor,
UWidgetBlueprint* BP,
FWidgetReference ParentWidget,
FName SlotName,
FVector2D PasteLocation
)

  
Public function Static bool

RemoveNamedSlotHostContent ( UWidget* WidgetTemplate,
TScriptInterface< INamedSlotInterface > NamedSlotHost
)

  
Public function Static bool

RenameWidget ( TSharedRef< class FWidgetBlueprintEditor > BlueprintEditor,
const FName& OldObjectName,
const FString& NewDisplayName
)

  
Public function Static void

ReplaceDesiredFocus ( TSharedRef< FWidgetBlueprintEditor > BlueprintEditor,
const FName& OldName,
const FName& NewName
)

  
Public function Static bool

ReplaceNamedSlotHostContent ( UWidget* WidgetTemplate,
TScriptInterface< INamedSlotInterface > NamedSlotHost,
UWidget* NewContentWidget
)

  
Public function Static void

SetDesiredFocus ( TSharedRef< FWidgetBlueprintEditor > BlueprintEditor,
const FName DesiredFocusWidgetName
)

  
Public function Static void

SetTextureAsAssetThumbnail ( UWidgetBlueprint* WidgetBlueprint,
UTexture2D* ThumbnailTexture
)

  
Public function Static bool

ShouldPreventDropOnTargetExtensions ( const UWidget* Target,
const TSharedPtr< FDragDropOperation >& DragDropOp,
FText& OutFailureText
)

  
Public function Static int32

UpdateHittestGrid ( FHittestGrid& HitTestGrid,
TSharedRef< SWindow > Window,
float Scale,
FVector2D DrawSize,
float DeltaTime
)

  
Public function Static bool

VerifyWidgetRename ( TSharedRef< class FWidgetBlueprintEditor > BlueprintEditor,
FWidgetReference Widget,
const FText& NewName,
FText& OutErrorMessage
)

  

Classes

  Type Name Description
Public struct FCreateWidgetFromBlueprintParams    
Public struct FUsableWidgetClassResult    
Public struct FWidgetThumbnailProperties    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page