Navigation
API > API/Editor > API/Editor/Blutility
Base class for Editor Utility Widgets that are designed to be shown in modal or non-modal dialog windows. Subclass this in Blueprint to create custom dialog content.
Unlike regular Editor Utility Widgets (which live in dockable tabs), dialog widgets are shown in standalone windows with a standard button bar (OK, Cancel, Yes/No, etc.).
The caller receives this widget instance after the dialog closes, so you can expose UPROPERTY fields that the caller reads back to get user-entered data.
| Name | UEditorUtilityDialogWidget |
| Type | class |
| Header File | /Engine/Source/Editor/Blutility/Public/EditorUtilityDialogWidget.h |
| Include Path | #include "EditorUtilityDialogWidget.h" |
Syntax
UCLASS (MinimalAPI, Abstract, Blueprintable, Meta=(ShowWorldContextPin))
class UEditorUtilityDialogWidget : public UEditorUtilityWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UUserWidget → UEditorUtilityWidget → UEditorUtilityDialogWidget
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ButtonLayout | TEnumAsByte< EAppMsgType::Type > | Which standard buttons appear at the bottom of the dialog (Ok, OkCancel, YesNo, etc.). | EditorUtilityDialogWidget.h |
|
| DesiredDialogSize | FVector2D | Default window size in pixels (Width, Height). Set to (0, 0) to auto-size to content. | EditorUtilityDialogWidget.h |
|
| DialogTitle | FText | The title shown in the modal window's title bar. | EditorUtilityDialogWidget.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OwningDialog | TWeakPtr< SEditorUtilityDialog > | Weak reference to the Slate dialog window hosting this widget. Used by CloseDialog(). | EditorUtilityDialogWidget.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CloseDialog
(
EAppReturnType::Type Result |
Programmatically close this dialog with a specific result. | EditorUtilityDialogWidget.h |
|
void OnDialogButtonPressed
(
EAppReturnType::Type Result |
Called for ANY button press. Catch-all alternative to OnDialogConfirmed/OnDialogCancelled. | EditorUtilityDialogWidget.h |
|
void OnDialogCancelled() |
Called when the user presses Cancel, No, or closes via the X button. Fires before close. | EditorUtilityDialogWidget.h |
|
void OnDialogConfirmed() |
Called when the user presses a positive button (OK, Yes, etc.). Fires before close. | EditorUtilityDialogWidget.h |
|
void OnDialogOpened() |
Called after the widget is created, before the dialog becomes visible. Initialize state here. | EditorUtilityDialogWidget.h |
|
void SetOwningDialog
(
TSharedPtr< SEditorUtilityDialog > InDialog |
Set by the dialog system when the widget is hosted in an SEditorUtilityDialog. | EditorUtilityDialogWidget.h |