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
FScrollyZoomy::OnMouseMove
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Should be called when a mouse move event occurs. IfFReply::Handledis returned, that should be passed as the result of the calling function.
Slate
[FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MyWidget, [IScrollableZoomable](API\Runtime\Slate\Framework\Layout\IScrollableZoomable) & ScrollableZoomable, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
FScrollyZoomy::OnMouseWheel
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Should be called by your widget when the mouse wheel is used IfFReply::Handledis returned, that should be passed as the result of the calling function.
Slate
[FReply](API\Runtime\SlateCore\Input\FReply) OnMouseWheel ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent, [IScrollableZoomable](API\Runtime\Slate\Framework\Layout\IScrollableZoomable) & ScrollableZoomable )
[]
FScrollyZoomy::PaintSoftwareCursorIfNeeded
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Call this from your widget's OnPaint to paint a software cursor, if needed New layer Identifier.
Slate
int32 PaintSoftwareCursorIfNeeded ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId ) const
[]
FScrollyZoomy::Tick
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Should be called every frame to update simulation state.
Slate
void Tick ( const float DeltaTime, [IScrollableZoomable](API\Runtime\Slate\Framework\Layout\IScrollableZoomable) & ScrollableZoomable )
[]
FScrollyZoomy::FScrollyZoomy
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Create and initialize a new instance.
Slate
FScrollyZoomy ( const bool InUseInertialScrolling )
[]
FScrollyZoomy
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Derived your widget class fromIScrollableZoomable, then embed an instance ofFScrollyZoomyas a widget member variable, and call this class's event handlers from your own widget's event handler callbacks.
Slate
class FScrollyZoomy
[]
IScrollableWidget::GetScrollDistance
/Engine/Source/Runtime/Slate/Public/Framework/Layout/IScrollableWidget.h
Gets the distance that user has scrolled into the control in normalized coordinates (0 - 1)
Slate
FVector2D GetScrollDistance()
[]
IScrollableWidget::GetScrollDistanceRemaining
/Engine/Source/Runtime/Slate/Public/Framework/Layout/IScrollableWidget.h
Gets the distance that user has left to scroll in the control before reaching the end in normalized coordinates (0 - 1)
Slate
FVector2D GetScrollDistanceRemaining()
[]
IScrollableWidget::GetScrollWidget
/Engine/Source/Runtime/Slate/Public/Framework/Layout/IScrollableWidget.h
Returns the typedSWidgetthat implements this interface
Slate
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetScrollWidget()
[]
IScrollableWidget::~IScrollableWidget
/Engine/Source/Runtime/Slate/Public/Framework/Layout/IScrollableWidget.h
Slate
virtual ~IScrollableWidget()
[]
IScrollableWidget
/Engine/Source/Runtime/Slate/Public/Framework/Layout/IScrollableWidget.h
An interface to allow Slate Widgets to expose scrollable functionality.
Slate
class IScrollableWidget
[]
IScrollableZoomable::ScrollBy
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Override this to scroll your widget's content. True if anything was scrolled.
Slate
bool ScrollBy ( const FVector2D & Offset )
[]
IScrollableZoomable::ZoomBy
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Override this to zoom your widget's content. True if anything was zoomed.
Slate
bool ZoomBy ( const float Amount )
[]
IScrollableZoomable
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Interface for widgets that can be used withFScrollyZoomy.
Slate
class IScrollableZoomable
[]
FDriverIdMetaData::GetTypeId
/Engine/Source/Runtime/Slate/Public/Framework/MetaData/DriverIdMetaData.h
Slate
static const [FName](API\Runtime\Core\UObject\FName) & GetTypeId()
[]
FDriverIdMetaData::IsOfTypeImpl
/Engine/Source/Runtime/Slate/Public/Framework/MetaData/DriverIdMetaData.h
Checks whether this drag and drop operation can cast safely to the specified type.
Slate
virtual bool IsOfTypeImpl ( const [FName](API\Runtime\Core\UObject\FName) & Type ) const
[]
FDriverIdMetaData::FDriverIdMetaData
/Engine/Source/Runtime/Slate/Public/Framework/MetaData/DriverIdMetaData.h
Slate
FDriverIdMetaData ( [FName](API\Runtime\Core\UObject\FName) InId )
[]
FDriverIdMetaData
/Engine/Source/Runtime/Slate/Public/Framework/MetaData/DriverIdMetaData.h
Slate
class FDriverIdMetaData : public [ISlateMetaData](API\Runtime\SlateCore\Types\ISlateMetaData)
[ { "type": "FName", "name": "Id", "description": "" } ]
FDriverMetaData::Id
/Engine/Source/Runtime/Slate/Public/Framework/MetaData/DriverMetaData.h
the automation driver specific metadata type for specifying an Id for a widget
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ISlateMetaData](API\Runtime\SlateCore\Types\ISlateMetaData) > Id ( [FName](API\Runtime\Core\UObject\FName) Tag )
[]
FDriverMetaData
/Engine/Source/Runtime/Slate/Public/Framework/MetaData/DriverMetaData.h
A static helper class which is used to easily construct various types of AutomationDriver specific SlateMetaData.
Slate
class FDriverMetaData
[]
EExtensionHook::Position
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Where in relation to an extension hook should you apply your extension
Slate
namespace EExtensionHook { enum Position { Before, After, First, } }
[]
EMultiBlockLocation::ToName
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxDefs.h
Returns the passed in style with the addition of the location information
Slate
namespace EMultiBlockLocation { static [FName](API\Runtime\Core\UObject\FName) EMultiBlockLocation::ToName ( [FName](API\Runtime\Core\UObject\FName) StyleName, [Type](API\Runtime\Slate\Framework\MultiBox\EMultiBlockLocation__Type) InLocation ) }
[]
EMultiBlockLocation::Type
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxDefs.h
Block location information
Slate
namespace EMultiBlockLocation { enum Type { None = -1, Start, Middle, End, } }
[]
FBaseMenuBuilder::AddMenuEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a menu entry with given param struct
Slate
void AddMenuEntry ( const [FMenuEntryParams](API\Runtime\Slate\Framework\MultiBox\FMenuEntryParams) & InMenuEntryParams )
[]
FBaseMenuBuilder::AddMenuEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a menu entry
Slate
void AddMenuEntry ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > InCommand, [FName](API\Runtime\Core\UObject\FName) InExtensionHook, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIconOverride, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )
[]
FBaseMenuBuilder::AddMenuEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a menu entry with a custom widget
Slate
void AddMenuEntry ( const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) & UIAction, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > Contents, const [FName](API\Runtime\Core\UObject\FName) & InExtensionHook, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const EUserInterfaceActionType UserInterfaceActionType, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )
[]
FBaseMenuBuilder::AddMenuEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a menu entry without the use of a command
Slate
void AddMenuEntry ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) & UIAction, [FName](API\Runtime\Core\UObject\FName) InExtensionHook, const EUserInterfaceActionType UserInterfaceActionType, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )
[]
FBaseMenuBuilder::FBaseMenuBuilder
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Constructor
Slate
FBaseMenuBuilder ( const EMultiBoxType InType, const bool bInShouldCloseWindowAfterMenuSelection, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > InCommandList, bool bInCloseSelfOnly, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > InExtender, const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) * InStyleSet, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName, [FName](API\Runtime\Core\UObject\FName) InMenuName )
[]
FBaseMenuBuilder
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Base menu builder
Slate
class FBaseMenuBuilder : public [FMultiBoxBuilder](API\Runtime\Slate\Framework\MultiBox\FMultiBoxBuilder)
[ { "type": "bool", "name": "bCloseSelfOnly", "description": "True if clicking on a menu entry closes itself only and its children and not the entire stack" } ]
FButtonArgs::FButtonArgs
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/SToolBarButtonBlock.h
Slate
FButtonArgs()
[]
FButtonArgs
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/SToolBarButtonBlock.h
Slate
struct FButtonArgs : public [TSharedFromThis< FButtonArgs >](API\Runtime\Core\Templates\TSharedFromThis)
[ { "type": "FUIAction", "name": "Action", "description": "" }, { "type": "FName", "name": "BorderBrushName", "description": "" }, { "type": "TSharedPtr< con...", "name": "Command", "description": "" }, { "type": "TSharedPtr< con...", "name": "CommandList", "description": "" }, { "type": "FNewMenuDelegat...", "name": "CustomMenuDelegate", "description": "" }, { "type": "FName", "name": "ExtensionHook", "description": "" }, { "type": "TAttribute<FSl...", "name": "IconOverride", "description": "" }, { "type": "TAttribute<FTe...", "name": "LabelOverride", "description": "" }, { "type": "FOnGetContent", "name": "OnGetMenuContent", "description": "" }, { "type": "TAttribute<FTe...", "name": "ToolTipOverride", "description": "" }, { "type": "FName", "name": "TutorialHighlightName", "description": "" }, { "type": "EUserInterfaceA...", "name": "UserInterfaceActionType", "description": "" } ]
FButtonRowBuilder::AddButton
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a button to a row
Slate
void AddButton ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > InCommand, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InLabelOverride, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipOverride, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIconOverride )
[]
FButtonRowBuilder::AddButton
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a button to a row
Slate
void AddButton ( const [FText](API\Runtime\Core\Internationalization\FText) & InLabel, const [FText](API\Runtime\Core\Internationalization\FText) & InToolTip, const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) & UIAction, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const EUserInterfaceActionType UserInterfaceActionType )
[]
FButtonRowBuilder::ApplyHook
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
FMultiBoxBuilderinterface
Slate
virtual void ApplyHook ( [FName](API\Runtime\Core\UObject\FName) InExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition )
[]
FButtonRowBuilder::FButtonRowBuilder
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Constructor
Slate
FButtonRowBuilder ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > InCommandList, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > InExtender )
[]
FCustomizedToolMenu::AddEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
[FCustomizedToolMenuEntry](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenuEntry) * AddEntry ( const [FName](API\Runtime\Core\UObject\FName) InEntryName )
[]
FButtonRowBuilder
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Button grid builder
Slate
class FButtonRowBuilder : public [FMultiBoxBuilder](API\Runtime\Slate\Framework\MultiBox\FMultiBoxBuilder)
[]
FCustomizedToolMenu::FindEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
[FCustomizedToolMenuEntry](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenuEntry) * FindEntry ( const [FName](API\Runtime\Core\UObject\FName) InEntryName )
[]
FCustomizedToolMenu::AddSection
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
[FCustomizedToolMenuSection](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenuSection) * AddSection ( const [FName](API\Runtime\Core\UObject\FName) InSectionName )
[]
FCustomizedToolMenu::FindSection
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
[FCustomizedToolMenuSection](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenuSection) * FindSection ( const [FName](API\Runtime\Core\UObject\FName) InSectionName )
[]
FCustomizedToolMenu::FindEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
const [FCustomizedToolMenuEntry](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenuEntry) * FindEntry ( const [FName](API\Runtime\Core\UObject\FName) InEntryName ) const
[]
FCustomizedToolMenu::FindSection
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
const [FCustomizedToolMenuSection](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenuSection) * FindSection ( const [FName](API\Runtime\Core\UObject\FName) InSectionName ) const
[]
FCustomizedToolMenu::GetEntrySectionName
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
[FName](API\Runtime\Core\UObject\FName) GetEntrySectionName ( const [FName](API\Runtime\Core\UObject\FName) InEntryName ) const
[]
FCustomizedToolMenu::GetSectionVisiblity
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
ECustomizedToolMenuVisibility GetSectionVisiblity ( const [FName](API\Runtime\Core\UObject\FName) InSectionName ) const
[]
FCustomizedToolMenu::GetEntryVisiblity
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
ECustomizedToolMenuVisibility GetEntryVisiblity ( const [FName](API\Runtime\Core\UObject\FName) InSectionName ) const
[]
FCustomizedToolMenu::IsEntryHidden
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
bool IsEntryHidden ( const [FName](API\Runtime\Core\UObject\FName) InEntryName ) const
[]
FCustomizedToolMenu::SetSuppressExtenders
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
void SetSuppressExtenders ( const [FName](API\Runtime\Core\UObject\FName) InOwnerName, const bool bInSuppress )
[]
FCustomizedToolMenu::IsSuppressExtenders
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
bool IsSuppressExtenders() const
[]
FCustomizedToolMenu::IsSectionHidden
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
bool IsSectionHidden ( const [FName](API\Runtime\Core\UObject\FName) InSectionName ) const
[]
FCustomizedToolMenuEntry::FCustomizedToolMenuEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
FCustomizedToolMenuEntry()
[]
FCustomizedToolMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
struct FCustomizedToolMenu
[ { "type": "TMap<FName,FC...", "name": "Entries", "description": "" }, { "type": "TMap<FName,FC...", "name": "EntryOrder", "description": "" }, { "type": "FNamePermission...", "name": "MenuPermissions", "description": "" }, { "type": "FName", "name": "Name", "description": "" }, { "type": "TArray<FName>", "name": "SectionOrder", "description": "" }, { "type": "TMap<FName,FC...", "name": "Sections", "description": "" }, { "type": "TArray<FName>", "name": "SuppressExtenders", "description": "" } ]
FCustomizedToolMenuEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
struct FCustomizedToolMenuEntry
[ { "type": "ECustomizedTool...", "name": "Visibility", "description": "" } ]
FCustomizedToolMenuHierarchy::GenerateFlattened
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
[FCustomizedToolMenu](API\Runtime\Slate\Framework\MultiBox\FCustomizedToolMenu) GenerateFlattened() const
[]
FCustomizedToolMenuHierarchy::GetEntrySectionName
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
[FName](API\Runtime\Core\UObject\FName) GetEntrySectionName ( const [FName](API\Runtime\Core\UObject\FName) InEntryName ) const
[]
FCustomizedToolMenuHierarchy::IsEntryHidden
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
bool IsEntryHidden ( const [FName](API\Runtime\Core\UObject\FName) InEntryName ) const
[]
FCustomizedToolMenuHierarchy::IsSectionHidden
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
bool IsSectionHidden ( const [FName](API\Runtime\Core\UObject\FName) InSectionName ) const
[]
FCustomizedToolMenuHierarchy::IsSuppressExtenders
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
bool IsSuppressExtenders() const
[]
FCustomizedToolMenuHierarchy
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
struct FCustomizedToolMenuHierarchy
[ { "type": "TArray< constF...", "name": "Hierarchy", "description": "" }, { "type": "TArray< constF...", "name": "RuntimeHierarchy", "description": "" } ]
FCustomizedToolMenuNameArray
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
struct FCustomizedToolMenuNameArray
[ { "type": "TArray<FName>", "name": "Names", "description": "" } ]
FCustomizedToolMenuSection::FCustomizedToolMenuSection
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
FCustomizedToolMenuSection()
[]
FCustomizedToolMenuSection
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/ToolMenuBase.h
Slate
struct FCustomizedToolMenuSection
[ { "type": "ECustomizedTool...", "name": "Visibility", "description": "" } ]
FExtender::AddMenuBarExtension
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Extends a menu bar at the specified extension point Pointer to the new extension object. You can use this later to remove the extension.
Slate
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const FExtensionBase > AddMenuBarExtension ( [FName](API\Runtime\Core\UObject\FName) ExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & CommandList, const FMenuBarExtensionDelegate & MenuBarExtensionDelegate )
[]
FExtender::AddToolBarExtension
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Extends a tool bar at the specified extension point Pointer to the new extension object. You can use this later to remove the extension.
Slate
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const FExtensionBase > AddToolBarExtension ( [FName](API\Runtime\Core\UObject\FName) ExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & CommandList, const FToolBarExtensionDelegate & ToolBarExtensionDelegate )
[]
FExtender::AddMenuExtension
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Extends a menu at the specified extension point Pointer to the new extension object. You can use this later to remove the extension.
Slate
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const FExtensionBase > AddMenuExtension ( [FName](API\Runtime\Core\UObject\FName) ExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > & CommandList, const FMenuExtensionDelegate & MenuExtensionDelegate )
[]
FExtender::Apply
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Applies any menu bar extensions at the specified extension point
Slate
void Apply ( [FName](API\Runtime\Core\UObject\FName) ExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition, [FMenuBarBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBarBuilder) & MenuBarBuilder ) const
[]
FExtender::Apply
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Applies any extensions at the specified extension point
Slate
void Apply ( [FName](API\Runtime\Core\UObject\FName) ExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition, [FToolBarBuilder](API\Runtime\Slate\Framework\MultiBox\FToolBarBuilder) & ToolBarBuilder ) const
[]
FExtender::Apply
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Applies any extensions at the specified extension point
Slate
void Apply ( [FName](API\Runtime\Core\UObject\FName) ExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition, [FMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBuilder) & MenuBuilder ) const
[]
FExtender::NumExtensions
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Returns the number of extensions in the extender
Slate
int32 NumExtensions() const
[]
FExtender::RemoveExtension
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Removes an existing extension.
Slate
void RemoveExtension ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const FExtensionBase > & Extension )
[]
FMenuBarBuilder::AddPullDownMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a pull down menu
Slate
void AddPullDownMenu ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InMenuLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const FNewMenuDelegate & InPullDownMenu, [FName](API\Runtime\Core\UObject\FName) InExtensionHook, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )
[]
FMenuBarBuilder::ApplyHook
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
FMultiBoxBuilderinterface
Slate
virtual void ApplyHook ( [FName](API\Runtime\Core\UObject\FName) InExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition )
[]
FMenuBarBuilder::AddPullDownMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a pull down menu
Slate
void AddPullDownMenu ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InMenuLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const FOnGetContent & InMenuContentGenerator, [FName](API\Runtime\Core\UObject\FName) InExtensionHook, [FName](API\Runtime\Core\UObject\FName) InTutorialHighlightName )
[]
FExtender::Combine
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Consolidates an array of FExtenders into a singleFExtenderA newFExtenderpointer that has all of the extensions of the input
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > Combine ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > > & Extenders )
[]
FMenuBarBuilder::FMenuBarBuilder
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Constructor
Slate
FMenuBarBuilder ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > InCommandList, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > InExtender, const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) * InStyleSet, [FName](API\Runtime\Core\UObject\FName) InMenuName )
[]
FMenuBarBuilder
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Menu bar builder
Slate
class FMenuBarBuilder : public [FBaseMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FBaseMenuBuilder)
[]
FMenuBuilder::AddMenuSeparator
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a separator
Slate
void AddMenuSeparator ( [FName](API\Runtime\Core\UObject\FName) InExtensionHook )
[]
FMenuBuilder::AddSearchWidget
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds the widget the multibox will use for searching
Slate
void AddSearchWidget()
[]
FMenuBuilder::AddSeparator
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Slate
void AddSeparator ( [FName](API\Runtime\Core\UObject\FName) InExtensionHook )
[]
FMenuBuilder::AddSubMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Slate
void AddSubMenu ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > Contents, const FNewMenuDelegate & InSubMenu, const bool bInOpenSubMenuOnClick, const bool bInShouldCloseWindowAfterMenuSelection )
[]
FMenuBuilder::AddSubMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Slate
void AddSubMenu ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InMenuLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const FNewMenuDelegate & InSubMenu, const bool bInOpenSubMenuOnClick, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const bool bInShouldCloseWindowAfterMenuSelection, [FName](API\Runtime\Core\UObject\FName) InExtensionHook )
[]
FExtender
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
Slate
class FExtender
[]
FMenuBuilder::AddSubMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a sub-menu which is a menu within a menu
Slate
void AddSubMenu ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InMenuLabel, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTip, const FNewMenuDelegate & InSubMenu, const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) & InUIAction, [FName](API\Runtime\Core\UObject\FName) InExtensionHook, const EUserInterfaceActionType InUserInterfaceActionType, const bool bInOpenSubMenuOnClick, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const bool bInShouldCloseWindowAfterMenuSelection )
[]
FMenuBuilder::AddSubMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Slate
void AddSubMenu ( const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) & UIAction, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > Contents, const FNewMenuDelegate & InSubMenu, const bool bInShouldCloseWindowAfterMenuSelection )
[]
FMenuBuilder::AddWidget
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds any widget to the menu
Slate
void AddWidget ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InWidget, const [FText](API\Runtime\Core\Internationalization\FText) & Label, bool bNoIndent, bool bSearchable, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InToolTipText )
[]
FMenuBuilder::AddWrapperSubMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
These classes need access to theAddWrapperSubMenu()methods friend class FWidgetBlock; friend classFToolBarComboButtonBlock; Adds a sub-menu which is a menu within a menu
Slate
void AddWrapperSubMenu ( const [FText](API\Runtime\Core\Internationalization\FText) & InMenuLabel, const [FText](API\Runtime\Core\Internationalization\FText) & InToolTip, const FOnGetContent & InSubMenu, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon )
[]
FMenuBuilder::AddWrapperSubMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Adds a sub-menu which is a menu within a menu
Slate
void AddWrapperSubMenu ( const [FText](API\Runtime\Core\Internationalization\FText) & InMenuLabel, const [FText](API\Runtime\Core\Internationalization\FText) & InToolTip, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & InSubMenu, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon )
[]
FMenuBuilder::AddWrapperSubMenu
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Slate
void AddWrapperSubMenu ( const [FText](API\Runtime\Core\Internationalization\FText) & InMenuLabel, const [FText](API\Runtime\Core\Internationalization\FText) & InToolTip, const FOnGetContent & InSubMenu, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const [FUIAction](API\Runtime\Slate\Framework\Commands\FUIAction) & UIAction )
[]
FMenuBuilder::BeginSection
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Starts a section on to the extender section hook stack
Slate
void BeginSection ( [FName](API\Runtime\Core\UObject\FName) InExtensionHook, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InHeadingText )
[]
FMenuBuilder::ApplySectionBeginning
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Applies the beginning of a section, including the header and relevant separator
Slate
virtual void ApplySectionBeginning()
[]
FMenuBuilder::EndSection
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Ends the current section
Slate
void EndSection()
[]
FMenuBuilder::MakeWidget
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Creates a widget for this MultiBox New widget object
Slate
virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MakeWidget ( [FMultiBox::FOnMakeMultiBoxBuilderOverride](API\Runtime\Slate\Framework\MultiBox\FMultiBox\FOnMakeMultiBoxBuilderOverride) * InMakeMultiBoxBuilderOverride, uint32 MaxHeight )
[]
FMenuBuilder::SetIsEditing
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Slate
void SetIsEditing ( bool bInIsEditing )
[]
FMenuBuilder::ApplyHook
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
FMultiBoxBuilderinterface
Slate
virtual void ApplyHook ( [FName](API\Runtime\Core\UObject\FName) InExtensionHook, [EExtensionHook::Position](API\Runtime\Slate\Framework\MultiBox\EExtensionHook__Position) HookPosition )
[]
FMenuBuilder::FMenuBuilder
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Constructor
Slate
FMenuBuilder ( const bool bInShouldCloseWindowAfterMenuSelection, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > InCommandList, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > InExtender, const bool bCloseSelfOnly, const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) * InStyleSet, bool bInSearchable, [FName](API\Runtime\Core\UObject\FName) InMenuName, bool bInRecursivelySearchable )
[]
FMenuBuilder
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Vertical menu builder
Slate
class FMenuBuilder : public [FBaseMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FBaseMenuBuilder)
[]
FMenuEntryParams
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Helper struct that holds FMenuEntry params for construction
Slate
struct FMenuEntryParams : public [FMultiBlock::FMultiBlockParams](API\Runtime\Slate\Framework\MultiBox\FMultiBlock\FMultiBlockParams)
[ { "type": "bool", "name": "bCloseSelfOnly", "description": "True if the menu should close itself and all its children or the entire open menu stack" }, { "type": "bool", "name": "bIsRecursivelySearchable", "description": "True if the search algorithm should walk down this menu sub menus." }, { "type": "bool", "name": "bIsSubMenu", "description": "True if this menu entry opens a sub-menu" }, { "type": "bool", "name": "bOpenSubMenuOnClick", "description": "True if this menu entry opens a sub-menu by clicking on it only" }, { "type": "bool", "name": "bShouldCloseWindowAfterMenuSelection", "description": "For submenus, whether the menu should be closed after something is selected" }, { "type": "FNewMenuDelegat...", "name": "EntryBuilder", "description": "Optional menu entry builder associated with this entry for building sub-menus and pull down menus" }, { "type": "TSharedPtr<SWi...", "name": "EntryWidget", "description": "Widget to be added to the menu" }, { "type": "TSharedPtr<FEx...", "name": "Extender", "description": "An extender that this menu entry should pass down to its children, so they get extended properly" }, { "type": "FSlateIcon", "name": "IconOverride", "description": "Optional overridden icon for this tool bar button." }, { "type": "TAttribute<FTe...", "name": "InputBindingOverride", "description": "Optional overridden input binding text for this menu entry." }, { "type": "TAttribute<FTe...", "name": "LabelOverride", "description": "Optional overridden text label for this menu entry." }, { "type": "FOnGetContent", "name": "MenuBuilder", "description": "Delegate that returns an entire menu" }, { "type": "TAttribute<FTe...", "name": "ToolTipOverride", "description": "Optional overridden tool tip for this menu entry." }, { "type": "FName", "name": "TutorialHighlightName", "description": "Display name for tutorials" }, { "type": "EUserInterfaceA...", "name": "UserInterfaceActionType", "description": "In the case where a command is not bound, the user interface action type to use." } ]
FMultiBlock::CreateMenuEntry
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBox.h
Creates a menu entry that is representative of this block
Slate
virtual void CreateMenuEntry ( class [FMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBuilder) & MenuBuilder ) const
[]
FMultiBlockParams
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBox.h
Slate
struct FMultiBlockParams
[ { "type": "constTSharedPt...", "name": "Action", "description": "The action associated with this block (can be null for some actions)" }, { "type": "constTSharedPt...", "name": "ActionList", "description": "The list of mappings from command info to delegates that should be called." }, { "type": "bool", "name": "bIsPartOfHeading", "description": "Whether this block is part of the heading blocks for a section" }, { "type": "FUIAction", "name": "DirectActions", "description": "Direct processing of actions." }, { "type": "FName", "name": "ExtensionHook", "description": "Optional extension hook which is used for debug display purposes, so users can see what hooks are where" }, { "type": "EMultiBlockType", "name": "Type", "description": "Type of MultiBlock" } ]
FMultiBlock::GetAction
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBox.h
Returns the action associated with this block The action for this block or null if one does not exist
Slate
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandInfo](API\Runtime\Slate\Framework\Commands\FUICommandInfo) > GetAction() const
[]
FMultiBlock::GetActionList
/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBox.h
Returns the action list associated with this block The action list or null if one does not exist for this block
Slate
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) > GetActionList() const
[]