Navigation
API > API/Developer > API/Developer/ToolWidgets > API/Developer/ToolWidgets/SCustomDialog
| Name | FArguments |
| Type | struct |
| Header File | /Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h |
| Include Path | #include "Dialog/SCustomDialog.h" |
Syntax
struct FArguments : public TSlateBaseNamedArgs< SCustomDialog >
Inheritance Hierarchy
- FSlateBaseNamedArgs → TSlateBaseNamedArgs → SCustomDialog::FArguments
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArguments() |
Dialog/SCustomDialog.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| WidgetArgsType | FArguments | Dialog/SCustomDialog.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| _DialogContent | TSharedPtr< SWidget > | Content for the dialog (deprecated - use Content instead) | Dialog/SCustomDialog.h | |
| _VAlignButtonBox | EVerticalAlignment | Dialog/SCustomDialog.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
WidgetArgsType & AutoCloseOnButtonPress
(
bool InArg |
Whether to automatically close this window when any auto-generated button is pressed (default: true) | Dialog/SCustomDialog.h | |
NamedSlotProperty< FArguments > BeforeButtons() |
Custom widget placed before the auto-generated buttons | Dialog/SCustomDialog.h | |
WidgetArgsType & ButtonAreaPadding
(
const TAttribute< FMargin >& InAttribute |
Padding to apply around the layout holding the buttons (default: {20,16,0,0}) | Dialog/SCustomDialog.h | |
| The buttons that this dialog should have. One or more buttons must be added. | Dialog/SCustomDialog.h | ||
WidgetArgsType & ClientSize
(
FVector2D InArg |
What the initial size of the window should be. If left at Zero, the window will be AutoSized. | Dialog/SCustomDialog.h | |
NamedSlotProperty< FArguments > Content() |
The content to display above the button; icon is optionally created to the left of it. | Dialog/SCustomDialog.h | |
WidgetArgsType & ContentAreaPadding
(
const TAttribute< FMargin >& InAttribute |
Padding to apply to DialogContent - you can use it to move away from the icon (default: {0,0,0,0}) | Dialog/SCustomDialog.h | |
WidgetArgsType & DialogContent
(
TSharedPtr< SWidget > InArg |
Dialog/SCustomDialog.h | ||
WidgetArgsType & GetWidgetToFocusOnActivate
(
FGetFocusWidget InArg |
Function to call when activating to get the widget to focus, for use when the widget needed is dynamic | Dialog/SCustomDialog.h | |
WidgetArgsType & HAlignButtonBox
(
EHorizontalAlignment InArg |
HAlign to use for Button Box slot (default: HAlign_Fill) | Dialog/SCustomDialog.h | |
WidgetArgsType & HAlignContent
(
EHorizontalAlignment InArg |
HAlign to use for Content slot (default: HAlign_Left) | Dialog/SCustomDialog.h | |
WidgetArgsType & HAlignIcon
(
EHorizontalAlignment InArg |
Alignment of icon (default: HAlign_Left) | Dialog/SCustomDialog.h | |
WidgetArgsType & Icon
(
const TAttribute< const FSlateBrush* >& InAttribute |
Optional icon to display (default: empty, translucent) | Dialog/SCustomDialog.h | |
FArguments & IconBrush
(
FName InIconBrush |
Optional icon to display in the dialog (default: none) | Dialog/SCustomDialog.h | |
WidgetArgsType & IconDesiredSizeOverride
(
const TAttribute< TOptional< FVector2D > >& InAttribute |
When specified, ignore the brushes size and report the DesiredSizeOverride as the desired image size (default: use icon size) | Dialog/SCustomDialog.h | |
WidgetArgsType & OnCancelHotkeyPressed
(
FSimpleDelegate InArg |
Function to call when the Cancel hotkey (Escape) is pressed | Dialog/SCustomDialog.h | |
WidgetArgsType & OnClosed
(
const FSimpleDelegate& InDelegate |
Event triggered when the dialog is closed, either because one of the buttons is pressed, or the windows is closed. | Dialog/SCustomDialog.h | |
WidgetArgsType & OnConfirmHotkeyPressed
(
FSimpleDelegate InArg |
Function to call when the Confirm hotkey (Enter) is pressed | Dialog/SCustomDialog.h | |
WidgetArgsType & RootPadding
(
const TAttribute< FMargin >& InAttribute |
Padding to apply to the widget embedded in the window, i.e. to all widgets contained in the window (default: {4,4,4,4} ) | Dialog/SCustomDialog.h | |
WidgetArgsType & ScrollBoxMaxHeight
(
float InArg |
Max height for the scroll box (default: 300) | Dialog/SCustomDialog.h | |
WidgetArgsType & Title
(
FText InArg |
Title to display for the dialog. | Dialog/SCustomDialog.h | |
WidgetArgsType & UseScrollBox
(
bool InArg |
Should this dialog use a scroll box for over-sized content? (default: true) | Dialog/SCustomDialog.h | |
WidgetArgsType & VAlignButtonBox
(
EVerticalAlignment InArg |
Dialog/SCustomDialog.h | ||
WidgetArgsType & VAlignContent
(
EVerticalAlignment InArg |
VAlign to use for Content slot (default: VAlign_Center) | Dialog/SCustomDialog.h | |
WidgetArgsType & VAlignIcon
(
EVerticalAlignment InArg |
Alignment of icon (default: VAlign_Center) | Dialog/SCustomDialog.h | |
WidgetArgsType & WindowArguments
(
SWindow::FArguments InArg |
Provides default values for SWindow::FArguments not overriden by SCustomDialog. | Dialog/SCustomDialog.h |