Navigation
API > API/Editor > API/Editor/UMGEditor
The Designer extension allows developers to provide additional widgets and custom painting to the designer surface for specific widgets. Allowing for a more customized and specific editors for the different widgets.
| Name | FDesignerExtension |
| Type | class |
| Header File | /Engine/Source/Editor/UMGEditor/Public/DesignerExtension.h |
| Include Path | #include "DesignerExtension.h" |
Syntax
class FDesignerExtension : public TSharedFromThis< FDesignerExtension >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FDesignerExtension
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDesignerExtension() |
Constructor | DesignerExtension.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FDesignerExtension() |
DesignerExtension.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ScopedTransaction | FScopedTransaction * | DesignerExtension.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanExtendSelection
(
const TArray< FWidgetReference >& Selection |
Returns true if the designer extension can extend the current selection. | DesignerExtension.h | |
virtual void ExtendSelection
(
const TArray< FWidgetReference >& Selection, |
Called every time a element the designer can extend is selected. | DesignerExtension.h | |
FName GetExtensionId() |
Gets the ID identifying this extension. | DesignerExtension.h | |
virtual void Initialize
(
IUMGDesigner* InDesigner, |
Initializes the designer extension, this is called the first time a designer extension is registered | DesignerExtension.h | |
virtual void Paint
(
const TSet< FWidgetReference >& Selection, |
Called to paint the extension. | DesignerExtension.h | |
virtual void PreviewContentChanged
(
TSharedRef< SWidget > NewContent |
Called every time the content of the designer changed. | DesignerExtension.h | |
virtual void PreviewContentCreated
(
UUserWidget* PreviewWidget |
Called every time the designer creates new preview. | DesignerExtension.h | |
virtual void Tick
(
const FGeometry& AllottedGeometry, |
Called each frames to tick the extension. | DesignerExtension.h | |
virtual void Uninitialize() |
Uninitializes the designer extension, this is called when the designer is removed. | DesignerExtension.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginTransaction
(
const FText& SessionName |
DesignerExtension.h | ||
void EndTransaction() |
DesignerExtension.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FDesignerExtension& Other |
DesignerExtension.h |