className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
UToolMenus::AssembleMenuHierarchy
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Bake final menu including calls to construction delegates, sorting, and customization
ToolMenus
void AssembleMenuHierarchy ( [UToolMenu](API\Developer\ToolMenus\UToolMenu) * GeneratedMenu, const [TArray](API\Runtime\Core\Containers\TArray)< [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > & Hierarchy )
[]
UToolMenus::AssignSetTimerForNextTickDelegate
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Sets delegate to setup timer for deferred one off ticks
ToolMenus
void AssignSetTimerForNextTickDelegate ( const FSimpleDelegate & InDelegate )
[]
UToolMenus::BeginDestroy
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.
ToolMenus
virtual void BeginDestroy()
[]
bHasShutDown
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
static bool bHasShutDown = false;
[]
UToolMenus::CleanupStaleWidgetsNextTick
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Release references to UObjects of widgets that have been deleted. Combines multiple requests in one frame together for improved performance.
ToolMenus
void CleanupStaleWidgetsNextTick ( bool bGarbageCollect )
[]
UToolMenus::CollectHierarchy
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Returns list of menus starting with root parent
ToolMenus
[TArray](API\Runtime\Core\Containers\TArray)< [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > CollectHierarchy ( const [FName](API\Runtime\Core\UObject\FName) Name )
[]
UToolMenus::CollectHierarchy
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
TArray< UToolMenu &42; > CollectHierarchy &40; const FName Name, const TMap< FName, FName > & UnregisteredParentNames &41;
[]
UToolMenus::CanSafelyRouteCall
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Returns true if safe to call into script
ToolMenus
static bool CanSafelyRouteCall()
[]
UToolMenus::CurrentOwner
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
For advanced use cases
ToolMenus
[FToolMenuOwner](API\Developer\ToolMenus\FToolMenuOwner) CurrentOwner() const
[]
UToolMenus::ExtendMenu
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Extends a menu without registering the menu or claiming ownership of it. Ok to call even if menu does not exist yet. ToolMenu Menu object
ToolMenus
[UToolMenu](API\Developer\ToolMenus\UToolMenu) * ExtendMenu ( const [FName](API\Runtime\Core\UObject\FName) Name )
[]
FEditMenuDelegate
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Delegate that opens a menu editor
ToolMenus
typedef TBaseDelegate_OneParam< void, class [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > FEditMenuDelegate
[]
FGenerateWidgetEvent
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
typedef TMulticastDelegate_TwoParams< void, const [FName](API\Runtime\Core\UObject\FName) InName, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) &InMenuContext > FGenerateWidgetEvent
[]
UToolMenus::FindContext
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Finds a context object of a given class if it exists
ToolMenus
static [UObject](API\Runtime\CoreUObject\UObject\UObject) * FindContext ( const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & InContext, [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass )
[]
UToolMenus::FindMenu
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Finds an existing menu that has been registered or extended. ToolMenu Menu object. Returns null if not found.
ToolMenus
[UToolMenu](API\Developer\ToolMenus\UToolMenu) * FindMenu ( const [FName](API\Runtime\Core\UObject\FName) Name )
[]
UToolMenus::FindMenuCustomization
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Find customization settings for a menu
ToolMenus
[FCustomizedToolMenu](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenu) * FindMenuCustomization ( const [FName](API\Runtime\Core\UObject\FName) InName )
[]
UToolMenus::FindMenuCustomizationIndex
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Find index of customization settings for a menu
ToolMenus
int32 FindMenuCustomizationIndex ( const [FName](API\Runtime\Core\UObject\FName) InName )
[]
UToolMenus::FindRuntimeMenuCustomization
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Find runtime customization settings for a menu
ToolMenus
[FCustomizedToolMenu](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenu) * FindRuntimeMenuCustomization ( const [FName](API\Runtime\Core\UObject\FName) InName )
[]
FShouldDisplayExtensionPoints
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Displaying extension points is for debugging menus
ToolMenus
typedef TBaseDelegate_NoParams< bool > FShouldDisplayExtensionPoints
[]
UToolMenus::GenerateMenu
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Create a finalized menu that combines all parents used to generate a widget. Advanced special use cases only.
ToolMenus
[UToolMenu](API\Developer\ToolMenus\UToolMenu) * GenerateMenu ( const [FName](API\Runtime\Core\UObject\FName) Name, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & InMenuContext )
[]
UToolMenus::GenerateMenuAsBuilder
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Create a finalized menu based on a custom crafted menu. Advanced special use cases only.
ToolMenus
[UToolMenu](API\Developer\ToolMenus\UToolMenu) * GenerateMenuAsBuilder ( const [UToolMenu](API\Developer\ToolMenus\UToolMenu) * InMenu, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & InMenuContext )
[]
UToolMenus::GenerateMenuOrSubMenuForEdit
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Generate either a menu or submenu ready for editing
ToolMenus
[UToolMenu](API\Developer\ToolMenus\UToolMenu) * GenerateMenuOrSubMenuForEdit ( const [UToolMenu](API\Developer\ToolMenus\UToolMenu) * InMenu )
[]
UToolMenus::GenerateSubMenu
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Generates sub menu by entry name in the given generated menu parent
ToolMenus
[UToolMenu](API\Developer\ToolMenus\UToolMenu) * GenerateSubMenu ( const [UToolMenu](API\Developer\ToolMenus\UToolMenu) * InGeneratedParent, const [FName](API\Runtime\Core\UObject\FName) InBlockName )
[]
UToolMenus::GenerateWidget
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Generate widget from a final collapsed menu. For advanced specialized use cases. Widget to display
ToolMenus
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidget ( [UToolMenu](API\Developer\ToolMenus\UToolMenu) * GeneratedMenu )
[]
UToolMenus::GenerateWidget
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Generate widget from a registered menu. Most common function used to generate new menu widgets. Widget to display
ToolMenus
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidget ( const [FName](API\Runtime\Core\UObject\FName) Name, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & InMenuContext )
[]
UToolMenus::GenerateWidget
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Generate widget from a hierarchy of menus. For advanced specialized use cases. Widget to display
ToolMenus
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GenerateWidget ( const [TArray](API\Runtime\Core\Containers\TArray)< [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > & Hierarchy, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & InMenuContext )
[]
UToolMenus::Get
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
static [UToolMenus](API\Developer\ToolMenus\UToolMenus) * Get()
[]
InternalStartupCallbackHandle
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
static [TOptional](API\Runtime\Core\IO\TOptional)< [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) > InternalStartupCallbackHandle;
[]
UToolMenus::GetEditMenusMode
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
When true, adds command to open edit menu dialog to each menu
ToolMenus
bool GetEditMenusMode() const
[]
UToolMenus::HandleNextTick
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Timer function used to consolidate multiple duplicate requests into a single frame.
ToolMenus
void HandleNextTick()
[]
UToolMenus::IsMenuRegistered
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Determines if a menu has already been registered. bool True if menu has already been registered.
ToolMenus
bool IsMenuRegistered ( const [FName](API\Runtime\Core\UObject\FName) Name ) const
[]
UToolMenus::IsToolMenuUIEnabled
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Returns true if slate initialized and editor GUI is being used. The application should have been initialized before this method is called. True if slate initialized and editor GUI is being used.
ToolMenus
static bool IsToolMenuUIEnabled()
[]
UToolMenus::RefreshAllWidgets
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Rebuilds all currently generated widgets next tick.
ToolMenus
void RefreshAllWidgets()
[]
UToolMenus::JoinMenuPaths
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Join two paths together
ToolMenus
static [FName](API\Runtime\Core\UObject\FName) JoinMenuPaths ( const [FName](API\Runtime\Core\UObject\FName) Base, const [FName](API\Runtime\Core\UObject\FName) Child )
[]
UToolMenus::RefreshMenuWidget
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Rebuilds all widgets generated from a specific menu.
ToolMenus
bool RefreshMenuWidget ( const [FName](API\Runtime\Core\UObject\FName) Name )
[]
UToolMenus::RefreshMenuWidget
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Re-creates widget that is active
ToolMenus
bool RefreshMenuWidget &40; const FName Name, FGeneratedToolMenuWidget & GeneratedMenuWidget &41;
[]
UToolMenus::RegisterMenu
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Registers a menu by name ToolMenu Menu object
ToolMenus
[UToolMenu](API\Developer\ToolMenus\UToolMenu) * RegisterMenu ( [FName](API\Runtime\Core\UObject\FName) Name, const [FName](API\Runtime\Core\UObject\FName) Parent, EMultiBoxType Type, bool bWarnIfAlreadyRegistered )
[]
UToolMenus::RegisterStringCommandHandler
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Registers a new type of string based command handler.
ToolMenus
void RegisterStringCommandHandler ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FToolMenuExecuteString](API\Developer\ToolMenus\FToolMenuExecuteString) & InDelegate )
[]
UToolMenus::RegisterStartupCallback
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Delays menu registration until safe and ready Will not trigger if Slate does not end up being enabled after loading Will not trigger when running commandlet, game, dedicated server or client only
ToolMenus
static [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterStartupCallback ( const FSimpleMulticastDelegate::FDelegate & InDelegate )
[]
UToolMenus::RemoveAllCustomizations
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Remove all menu customizations for all menus
ToolMenus
void RemoveAllCustomizations()
[]
UToolMenus::RemoveCustomization
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Remove customization for a menu
ToolMenus
void RemoveCustomization ( const [FName](API\Runtime\Core\UObject\FName) InName )
[]
UToolMenus::RemoveEntry
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Removes a menu entry from a given menu and section
ToolMenus
void RemoveEntry ( const [FName](API\Runtime\Core\UObject\FName) MenuName, const [FName](API\Runtime\Core\UObject\FName) Section, const [FName](API\Runtime\Core\UObject\FName) Name )
[]
UToolMenus::RemoveMenu
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Unregisters a menu by name
ToolMenus
void RemoveMenu ( const [FName](API\Runtime\Core\UObject\FName) MenuName )
[]
UToolMenus::RemoveSection
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Removes a section from a given menu
ToolMenus
void RemoveSection ( const [FName](API\Runtime\Core\UObject\FName) MenuName, const [FName](API\Runtime\Core\UObject\FName) Section )
[]
UToolMenus::RemoveSubstitutionDuringGenerate
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Remove substitute one menu for another during generate
ToolMenus
void RemoveSubstitutionDuringGenerate ( const [FName](API\Runtime\Core\UObject\FName) InMenu )
[]
UToolMenus::SaveCustomizations
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Save menu customizations to ini files
ToolMenus
void SaveCustomizations()
[]
UToolMenus::SetSectionLabel
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Sets a section's displayed label text.
ToolMenus
void SetSectionLabel ( const [FName](API\Runtime\Core\UObject\FName) MenuName, const [FName](API\Runtime\Core\UObject\FName) SectionName, const [FText](API\Runtime\Core\Internationalization\FText) Label )
[]
UToolMenus::SetEditMenusMode
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Enables adding command to open edit menu dialog to each menu
ToolMenus
void SetEditMenusMode ( bool bEnable )
[]
UToolMenus::SetSectionPosition
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Sets where to insert a section into a menu when generating relative to other section names.
ToolMenus
void SetSectionPosition ( const [FName](API\Runtime\Core\UObject\FName) MenuName, const [FName](API\Runtime\Core\UObject\FName) SectionName, const [FName](API\Runtime\Core\UObject\FName) OtherSectionName, const [EToolMenuInsertType](API\Developer\ToolMenus\EToolMenuInsertType) PositionType )
[]
Singleton
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
static [UToolMenus](API\Developer\ToolMenus\UToolMenus) * Singleton = nullptr;
[]
UToolMenus::SplitMenuPath
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Break apart a menu path into components
ToolMenus
static bool SplitMenuPath ( const [FName](API\Runtime\Core\UObject\FName) MenuPath, [FName](API\Runtime\Core\UObject\FName) & OutLeft, [FName](API\Runtime\Core\UObject\FName) & OutRight )
[]
StartupCallbacks
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
static FSimpleMulticastDelegate StartupCallbacks;
[]
UToolMenus::TryGet
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Try to getUToolMenuswithout forcing ToolMenus module to load.
ToolMenus
static [UToolMenus](API\Developer\ToolMenus\UToolMenus) * TryGet()
[]
UToolMenus::UnregisterOwner
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Unregister everything associated with the given owner without forcing ToolMenus module to load.
ToolMenus
static void UnregisterOwner ( [FToolMenuOwner](API\Developer\ToolMenus\FToolMenuOwner) Owner )
[]
UToolMenus::UnregisterOwnerByName
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Removes all entries that were registered under a specific owner name
ToolMenus
void UnregisterOwnerByName ( [FName](API\Runtime\Core\UObject\FName) InOwnerName )
[]
UToolMenus::UnregisterRuntimeMenuCustomizationOwner
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Unregister runtime customization settings for a specific owner name
ToolMenus
void UnregisterRuntimeMenuCustomizationOwner ( const [FName](API\Runtime\Core\UObject\FName) InOwnerName )
[]
UToolMenus::UnRegisterStartupCallback
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Unregister a startup callback delegate by pointer
ToolMenus
static void UnRegisterStartupCallback ( const void * UserPointer )
[]
UToolMenus::UnRegisterStartupCallback
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Unregister a startup callback delegate by handle
ToolMenus
static void UnRegisterStartupCallback ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle )
[]
UToolMenus::UnregisterStringCommandHandler
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
Removes a string based command handler.
ToolMenus
void UnregisterStringCommandHandler ( const [FName](API\Runtime\Core\UObject\FName) InName )
[]
UToolMenus::UToolMenus
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
UToolMenus()
[]
UToolMenus
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h
ToolMenus
class UToolMenus : public [UObject](API\Runtime\CoreUObject\UObject\UObject)
[ { "type": "FEditMenuDelega...", "name": "EditMenuDelegate", "description": "" }, { "type": "FSlateIcon", "name": "EditMenuIcon", "description": "Icon to display in menus for command to open menu editor" }, { "type": "FSlateIcon", "name": "EditToolbarIcon", "description": "Icon to display in toolbars for command to open menu editor" }, { "type": "FGenerateWidget...", "name": "OnPostGenerateWidget", "description": "Called after we generate a menu widget." }, { "type": "FGenerateWidget...", "name": "OnPreGenerateWidget", "description": "Called before we generate a menu widget." }, { "type": "FShouldDisplayE...", "name": "ShouldDisplayExtensionPoints", "description": "" } ]
UToolMenuSectionDynamic::ConstructSections
/Engine/Source/Developer/ToolMenus/Public/ToolMenuSection.h
ToolMenus
void ConstructSections ( [UToolMenu](API\Developer\ToolMenus\UToolMenu) * Menu, const [FToolMenuContext](API\Developer\ToolMenus\FToolMenuContext) & Context )
[]
UToolMenuSectionDynamic
/Engine/Source/Developer/ToolMenus/Public/ToolMenuSection.h
ToolMenus
class UToolMenuSectionDynamic : public [UObject](API\Runtime\CoreUObject\UObject\UObject)
[]
SCustomDialog::Construct
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
ToolWidgets
void Construct ( const [FArguments](API\Developer\ToolWidgets\Dialog\SCustomDialog\FArguments) & InArgs )
[]
SCustomDialog::FArguments::AutoCloseOnButtonPress
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Whether to automatically close this window when any button is pressed (default: true)
ToolWidgets
WidgetArgsType & AutoCloseOnButtonPress &40; bool InArg &41;
[]
SCustomDialog::FArguments::BeforeButtons
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Custom widget placed before the buttons
ToolWidgets
NamedSlotProperty< FArguments > BeforeButtons&40;&41;
[]
SCustomDialog::FArguments::ButtonAreaPadding
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Padding to apply around the layout holding the buttons (default: {20,0,0,0})
ToolWidgets
WidgetArgsType & ButtonAreaPadding &40; const TAttribute< FMargin > & InAttribute &41;
[]
SCustomDialog::FArguments::Buttons
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
The buttons that this dialog should have. One or more buttons must be added.
ToolWidgets
WidgetArgsType & Buttons &40; TArray< FButton > InArg &41;
[]
SCustomDialog::FArguments::Content
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
The content to display above the button; icon is optionally created to the left of it.
ToolWidgets
NamedSlotProperty< FArguments > Content&40;&41;
[]
SCustomDialog::FArguments::ContentAreaPadding
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Padding to apply to DialogContent - you can use it to move away from the icon (default: {0,0,0,0})
ToolWidgets
WidgetArgsType & ContentAreaPadding &40; const TAttribute< FMargin > & InAttribute &41;
[]
SCustomDialog::FArguments::DialogContent
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
ToolWidgets
WidgetArgsType & DialogContent &40; TSharedPtr< SWidget > InArg &41;
[]
SCustomDialog::FArguments::HAlignButtonBox
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
HAlign to use for Button Box slot (default: HAlign_Left)
ToolWidgets
WidgetArgsType & HAlignButtonBox &40; EHorizontalAlignment InArg &41;
[]
SCustomDialog::FArguments::HAlignContent
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
HAlign to use for Content slot (default: HAlign_Left)
ToolWidgets
WidgetArgsType & HAlignContent &40; EHorizontalAlignment InArg &41;
[]
SCustomDialog::FArguments::HAlignIcon
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Alignment of icon (default: HAlign_Left)
ToolWidgets
WidgetArgsType & HAlignIcon &40; EHorizontalAlignment InArg &41;
[]
SCustomDialog::FArguments::Icon
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Optional icon to display (default: empty, translucent)
ToolWidgets
WidgetArgsType & Icon &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;
[]
SCustomDialog::FArguments::IconBrush
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Optional icon to display in the dialog (default: none)
ToolWidgets
FArguments & IconBrush &40; FName InIconBrush &41;
[]
SCustomDialog::FArguments::IconDesiredSizeOverride
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
When specified, ignore the brushes size and report the DesiredSizeOverride as the desired image size (default: use icon size)
ToolWidgets
WidgetArgsType & IconDesiredSizeOverride &40; const TAttribute< TOptional< FVector2D > > & InAttribute &41;
[]
SCustomDialog::FArguments::RootPadding
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Padding to apply to the widget embedded in the window, i.e. to all widgets contained in the window (default: {4,4,4,4} )
ToolWidgets
WidgetArgsType & RootPadding &40; const TAttribute< FMargin > & InAttribute &41;
[]
SCustomDialog::FArguments::OnClosed
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Event triggered when the dialog is closed, either because one of the buttons is pressed, or the windows is closed.
ToolWidgets
WidgetArgsType & OnClosed &40; const FSimpleDelegate & InDelegate &41;
[]
SCustomDialog::FArguments::ScrollBoxMaxHeight
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Max height for the scroll box (default: 300)
ToolWidgets
WidgetArgsType & ScrollBoxMaxHeight &40; int32 InArg &41;
[]
SCustomDialog::FArguments::Title
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Title to display for the dialog.
ToolWidgets
WidgetArgsType & Title &40; FText InArg &41;
[]
SCustomDialog::FArguments::VAlignButtonBox
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
VAlign to use for Button Box slot (default: VAlign_Center)
ToolWidgets
WidgetArgsType & VAlignButtonBox &40; EVerticalAlignment InArg &41;
[]
SCustomDialog::FArguments::VAlignContent
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
VAlign to use for Content slot (default: VAlign_Center)
ToolWidgets
WidgetArgsType & VAlignContent &40; EVerticalAlignment InArg &41;
[]
SCustomDialog::FArguments::VAlignIcon
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Alignment of icon (default: VAlign_Center)
ToolWidgets
WidgetArgsType & VAlignIcon &40; EVerticalAlignment InArg &41;
[]
WidgetArgsType
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
ToolWidgets
typedef FArguments WidgetArgsType
[]
SCustomDialog::FArguments::WindowArguments
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Provides default values forSWindow::FArgumentsnot overriden bySCustomDialog.
ToolWidgets
WidgetArgsType & WindowArguments &40; SWindow::FArguments InArg &41;
[]
SCustomDialog::FArguments::FArguments
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
ToolWidgets
FArguments&40;&41;
[]
SCustomDialog::FArguments::UseScrollBox
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Should this dialog use a scroll box for over-sized content? (default: true)
ToolWidgets
WidgetArgsType & UseScrollBox &40; bool InArg &41;
[]
FArguments
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
ToolWidgets
struct FArguments : public [TSlateBaseNamedArgs< SCustomDialog >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[ { "type": "TSharedPtr<SWi...", "name": "_DialogContent", "description": "Content for the dialog (deprecated - use Content instead)" } ]
SCustomDialog::FButton::SetOnClicked
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Called when the button is clicked
ToolWidgets
FButton & SetOnClicked &40; FSimpleDelegate InOnClicked &41;
[]
SCustomDialog::FButton::SetFocus
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Whether to focus this button. Focus rules: 1: If a button hasSetFocus(), use the last one 2: If a button is marked primary, use the last one 3: Otherwise, ise the last button
ToolWidgets
FButton & SetFocus&40;&41;
[]
SCustomDialog::FButton::SetPrimary
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Primary buttons are highlighted
ToolWidgets
FButton & SetPrimary &40; bool bValue &41;
[]
FButton
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
ToolWidgets
struct FButton
[ { "type": "bool", "name": "bIsPrimary", "description": "" }, { "type": "bool", "name": "bShouldFocus", "description": "" }, { "type": "FText", "name": "ButtonText", "description": "" }, { "type": "FSimpleDelegate", "name": "OnClicked", "description": "" } ]
SCustomDialog::FButton::FButton
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
ToolWidgets
FButton &40; const FText & InButtonText, const FSimpleDelegate & InOnClicked &41;
[]
SCustomDialog::ShowModal
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Show a modal dialog. Will block until an input is received. Returns the index of the button that was pressed.
ToolWidgets
int32 ShowModal()
[]
SCustomDialog::Show
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Show the dialog. This method will return immediately.
ToolWidgets
void Show()
[]
SCustomDialog
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SCustomDialog.h
Note: If the content is only text, seeSMessageDialog.
ToolWidgets
class SCustomDialog : public [SWindow](API\Runtime\SlateCore\Widgets\SWindow)
[]
SMessageDialog::Construct
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
ToolWidgets
void Construct ( const [FArguments](API\Developer\ToolWidgets\Dialog\SMessageDialog\FArguments) & InArgs )
[]
SMessageDialog::FArguments::AutoCloseOnButtonPress
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Whether to automatically close this window when any button is pressed (default: true)
ToolWidgets
WidgetArgsType & AutoCloseOnButtonPress &40; bool InArg &41;
[]
SMessageDialog::FArguments::Buttons
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
The buttons that this dialog should have. One or more buttons must be added.
ToolWidgets
WidgetArgsType & Buttons &40; TArray< FButton > InArg &41;
[]
SMessageDialog::FArguments::Icon
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Optional icon to display in the dialog. (default: empty)
ToolWidgets
WidgetArgsType & Icon &40; const FSlateBrush &42; InArg &41;
[]