You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
ccbeef74dc
#preflight 6245cae0c667881bf4f89ee4 #rb Lauren.Barnes [CL 19573724 by benjamin fox in ue5-main branch]
732 lines
33 KiB
C++
732 lines
33 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "Framework/MultiBox/MultiBoxExtender.h"
|
|
#include "Framework/SlateDelegates.h"
|
|
#include "CoreMinimal.h"
|
|
#include "Misc/Attribute.h"
|
|
#include "Layout/Visibility.h"
|
|
#include "Widgets/SWidget.h"
|
|
#include "Styling/CoreStyle.h"
|
|
#include "Framework/SlateDelegates.h"
|
|
#include "Textures/SlateIcon.h"
|
|
#include "Framework/Commands/UICommandInfo.h"
|
|
#include "Framework/Commands/UICommandList.h"
|
|
#include "Framework/MultiBox/MultiBoxDefs.h"
|
|
#include "Framework/MultiBox/MultiBoxExtender.h"
|
|
#include "Framework/MultiBox/MultiBox.h"
|
|
|
|
class FUICommandInfo;
|
|
class FUICommandList;
|
|
struct FSlateIcon;
|
|
struct FUIAction;
|
|
|
|
/** Delegate used by multi-box to call a user function to populate a new menu. Used for spawning sub-menus and pull-down menus. */
|
|
DECLARE_DELEGATE_OneParam( FNewMenuDelegate, class FMenuBuilder& );
|
|
|
|
|
|
/**
|
|
* MultiBox builder
|
|
*/
|
|
class SLATE_API FMultiBoxBuilder
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param InType Type of MultiBox
|
|
* @param bInShouldCloseWindowAfterMenuSelection Sets whether or not the window that contains this multibox should be destroyed after the user clicks on a menu item in this box
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget. This can be modified after the MultiBox is created by calling the PushCommandList() and PopCommandList() methods.
|
|
* @param InTutorialHighlightName Optional name to identify this widget and highlight during tutorials
|
|
*/
|
|
FMultiBoxBuilder( const EMultiBoxType InType, FMultiBoxCustomization InCustomization, const bool bInShouldCloseWindowAfterMenuSelection, const TSharedPtr< const FUICommandList >& InCommandList, TSharedPtr<FExtender> InExtender = TSharedPtr<FExtender>(), FName InTutorialHighlightName = NAME_None, FName InMenuName = NAME_None );
|
|
|
|
virtual ~FMultiBoxBuilder() {}
|
|
|
|
/**
|
|
* Adds an editable text entry
|
|
*
|
|
* @param InLabel The label to display in the menu
|
|
* @param InToolTip The tool tip to display when the menu entry is hovered over
|
|
* @param InIcon The icon to display to the left of the label
|
|
* @param InTextAttribute The text string we're editing (often, a delegate will be bound to the attribute)
|
|
* @param InOnTextCommitted Called when the user commits their change to the editable text control
|
|
* @param InOnTextChanged Called when the text is changed interactively
|
|
* @param bInReadOnly Whether or not the text block is read only
|
|
*/
|
|
void AddEditableText( const FText& InLabel, const FText& InToolTip, const FSlateIcon& InIcon, const TAttribute< FText >& InTextAttribute, const FOnTextCommitted& InOnTextCommitted = FOnTextCommitted(), const FOnTextChanged& InOnTextChanged = FOnTextChanged(), bool bInReadOnly = false );
|
|
|
|
/**
|
|
* Adds an editable text entry with a VerifyTextChanged delegate
|
|
*
|
|
* @param InLabel The label to display in the menu
|
|
* @param InToolTip The tool tip to display when the menu entry is hovered over
|
|
* @param InIcon The icon to display to the left of the label
|
|
* @param InTextAttribute The text string we're editing (often, a delegate will be bound to the attribute)
|
|
* @param InOnVerifyTextChanged Called to verify when the text is changed interactively
|
|
* @param InOnTextCommitted Called when the user commits their change to the editable text control
|
|
* @param InOnTextChanged Called when the text is changed interactively
|
|
* @param bInReadOnly Whether or not the text block is read only
|
|
*/
|
|
void AddVerifiedEditableText(const FText& InLabel, const FText& InToolTip, const FSlateIcon& InIcon, const TAttribute< FText >& InTextAttribute, const FOnVerifyTextChanged& InOnVerifyTextChanged, const FOnTextCommitted& InOnTextCommitted = FOnTextCommitted(), const FOnTextChanged& InOnTextChanged = FOnTextChanged(), bool bInReadOnly = false);
|
|
|
|
/**
|
|
* Creates a widget for this MultiBox
|
|
*
|
|
* @return New widget object
|
|
*/
|
|
virtual TSharedRef< class SWidget > MakeWidget( FMultiBox::FOnMakeMultiBoxBuilderOverride* InMakeMultiBoxBuilderOverride = nullptr, uint32 MaxHeight = INT_MAX);
|
|
|
|
|
|
/**
|
|
* Get the multi-box being built.
|
|
*
|
|
* @return The multi-box being built.
|
|
*/
|
|
TSharedRef< class FMultiBox > GetMultiBox();
|
|
|
|
|
|
/**
|
|
* Pushes a new command list onto the stack. This command list will be used for all subsequently-added multiblocks, until the command-list is popped.
|
|
*
|
|
* @param CommandList The new command list to use
|
|
*/
|
|
void PushCommandList( const TSharedRef< const FUICommandList > CommandList );
|
|
|
|
|
|
/**
|
|
* Pops the current command list.
|
|
*/
|
|
void PopCommandList();
|
|
|
|
/**
|
|
* @return The top command list
|
|
*/
|
|
TSharedPtr<const FUICommandList> GetTopCommandList();
|
|
|
|
/**
|
|
* Pushes a new extender onto the stack. This extender will be used for all subsequently-added multiblocks, until the extender is popped.
|
|
*
|
|
* @param InExtender The new extender to use
|
|
*/
|
|
void PushExtender( TSharedRef< FExtender > InExtender );
|
|
|
|
|
|
/**
|
|
* Pops the current extender.
|
|
*/
|
|
void PopExtender();
|
|
|
|
/** @return The style set used by the multibox widgets */
|
|
const ISlateStyle* GetStyleSet() const;
|
|
|
|
/** @return The style name used by the multibox widgets */
|
|
const FName& GetStyleName() const;
|
|
|
|
/** Sets the style to use on the multibox widgets */
|
|
void SetStyle( const ISlateStyle* InStyleSet, const FName& InStyleName );
|
|
|
|
/** @return The customization settings for the box being built */
|
|
FMultiBoxCustomization GetCustomization() const;
|
|
|
|
/** Sets extender support */
|
|
void SetExtendersEnabled(bool bEnabled) { bExtendersEnabled = bEnabled; }
|
|
|
|
/** @return True if extenders are enabled */
|
|
bool ExtendersEnabled() const { return bExtendersEnabled; }
|
|
|
|
protected:
|
|
/** Applies any potential extension hooks at the current place */
|
|
virtual void ApplyHook(FName InExtensionHook, EExtensionHook::Position HookPosition) = 0;
|
|
|
|
/** Applies the beginning of a section, including the header and relevant separator */
|
|
virtual void ApplySectionBeginning() {}
|
|
|
|
protected:
|
|
|
|
/** The MultiBox we're building up */
|
|
TSharedRef< class FMultiBox > MultiBox;
|
|
|
|
/** A stack of command lists which map command infos to delegates that should be called. New multi blocks will always use
|
|
the command-list at the top of the stack at the time they are added. */
|
|
TArray< TSharedPtr< const FUICommandList > > CommandListStack;
|
|
|
|
/** The extender stack holding all the possible extensions for this menu builder */
|
|
TArray< TSharedPtr<class FExtender> > ExtenderStack;
|
|
|
|
/** Name to identify this widget and highlight during tutorials */
|
|
FName TutorialHighlightName;
|
|
|
|
/** Name of the menu */
|
|
FName MenuName;
|
|
|
|
/** If extenders are enabled */
|
|
bool bExtendersEnabled;
|
|
};
|
|
|
|
/** Helper struct that holds FMenuEntry params for construction */
|
|
struct FMenuEntryParams : public FMultiBlock::FMultiBlockParams
|
|
{
|
|
/** Optional overridden text label for this menu entry. If not set, then the action's label will be used instead. */
|
|
TAttribute<FText> LabelOverride;
|
|
|
|
/** Optional overridden tool tip for this menu entry. If not set, then the action's tool tip will be used instead. */
|
|
TAttribute<FText> ToolTipOverride;
|
|
|
|
/** Optional overridden input binding text for this menu entry. If not set, then the UI action's binding will be used if available. */
|
|
TAttribute<FText> InputBindingOverride;
|
|
|
|
/** Optional overridden icon for this tool bar button. IF not set, then the action's icon will be used instead. */
|
|
FSlateIcon IconOverride;
|
|
|
|
/** Optional menu entry builder associated with this entry for building sub-menus and pull down menus */
|
|
FNewMenuDelegate EntryBuilder;
|
|
|
|
/** Delegate that returns an entire menu */
|
|
FOnGetContent MenuBuilder;
|
|
|
|
/** Widget to be added to the menu */
|
|
TSharedPtr<SWidget> EntryWidget;
|
|
|
|
/** True if this menu entry opens a sub-menu */
|
|
bool bIsSubMenu = false;
|
|
|
|
/** True if the search algorithm should walk down this menu sub menus. Usually true, unless the menu has circular/infinite expansion (happens in some menus generated on the fly by reflection). */
|
|
bool bIsRecursivelySearchable = true;;
|
|
|
|
/** True if this menu entry opens a sub-menu by clicking on it only */
|
|
bool bOpenSubMenuOnClick = false;
|
|
|
|
/** In the case where a command is not bound, the user interface action type to use. If a command is bound, we
|
|
simply use the action type associated with that command. */
|
|
EUserInterfaceActionType UserInterfaceActionType;
|
|
|
|
/** True if the menu should close itself and all its children or the entire open menu stack */
|
|
bool bCloseSelfOnly = false;
|
|
|
|
/** An extender that this menu entry should pass down to its children, so they get extended properly */
|
|
TSharedPtr<FExtender> Extender;
|
|
|
|
/** For submenus, whether the menu should be closed after something is selected */
|
|
bool bShouldCloseWindowAfterMenuSelection = true;
|
|
|
|
/** Display name for tutorials */
|
|
FName TutorialHighlightName;
|
|
};
|
|
|
|
/**
|
|
* Base menu builder
|
|
*/
|
|
class SLATE_API FBaseMenuBuilder : public FMultiBoxBuilder
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param InType Type of MultiBox
|
|
* @param bInShouldCloseWindowAfterMenuSelection Sets whether or not the window that contains this multibox should be destroyed after the user clicks on a menu item in this box
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
|
|
* @param bInCloseSelfOnly True if clicking on a menu entry closes itself only and its children but not the entire stack
|
|
* @param InTutorialHighlightName Optional name to identify this widget and highlight during tutorials
|
|
*/
|
|
FBaseMenuBuilder( const EMultiBoxType InType, const bool bInShouldCloseWindowAfterMenuSelection, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, TSharedPtr<FExtender> InExtender = TSharedPtr<FExtender>(), const ISlateStyle* InStyleSet = &FCoreStyle::Get(), FName InTutorialHighlightName = NAME_None, FName InMenuName = NAME_None );
|
|
|
|
/**
|
|
* Adds a menu entry
|
|
*
|
|
* @param InCommand The command associated with this menu entry
|
|
* @param InExtensionHook The section hook. Can be NAME_None
|
|
* @param InLabelOverride Optional label override. If omitted, then the action's label will be used instead.
|
|
* @param InToolTipOverride Optional tool tip override. If omitted, then the action's label will be used instead.
|
|
* @param InIconOverride Optional name of the slate brush to use for the tool bar image. If omitted, then the command's icon will be used instead.
|
|
* @param InTutorialHighlightName Optional name to identify this widget and highlight during tutorials
|
|
*/
|
|
void AddMenuEntry( const TSharedPtr< const FUICommandInfo > InCommand, FName InExtensionHook = NAME_None, const TAttribute<FText>& InLabelOverride = TAttribute<FText>(), const TAttribute<FText>& InToolTipOverride = TAttribute<FText>(), const FSlateIcon& InIconOverride = FSlateIcon(), FName InTutorialHighlightName = NAME_None );
|
|
|
|
/**
|
|
* Adds a menu entry without the use of a command
|
|
*
|
|
* @param InLabel Label to show in the menu entry
|
|
* @param InToolTip Tool tip used when hovering over the menu entry
|
|
* @param InIcon The icon to use
|
|
* @param UIAction Actions to execute on this menu item.
|
|
* @param InExtensionHook The section hook. Can be NAME_None
|
|
* @param UserInterfaceActionType Type of interface action
|
|
* @param InTutorialHighlightName Optional name to identify this widget and highlight during tutorials
|
|
*/
|
|
void AddMenuEntry( const TAttribute<FText>& InLabel, const TAttribute<FText>& InToolTip, const FSlateIcon& InIcon, const FUIAction& UIAction, FName InExtensionHook = NAME_None, const EUserInterfaceActionType UserInterfaceActionType = EUserInterfaceActionType::Button, FName InTutorialHighlightName = NAME_None );
|
|
|
|
/**
|
|
* Adds a menu entry with a custom widget
|
|
*
|
|
* @param UIAction Actions to execute on this menu item.
|
|
* @param Contents Custom widget to display
|
|
* @param InExtensionHook The section hook. Can be NAME_None
|
|
* @param InToolTip Tool tip used when hovering over the menu entry
|
|
* @param UserInterfaceActionType Type of interface action
|
|
* @param InTutorialHighlightName Optional name to identify this widget and highlight during tutorials
|
|
*/
|
|
void AddMenuEntry( const FUIAction& UIAction, const TSharedRef< SWidget > Contents, const FName& InExtensionHook = NAME_None, const TAttribute<FText>& InToolTip = TAttribute<FText>(), const EUserInterfaceActionType UserInterfaceActionType = EUserInterfaceActionType::Button, FName InTutorialHighlightName = NAME_None );
|
|
|
|
/** Adds a menu entry with given param struct */
|
|
void AddMenuEntry( const FMenuEntryParams& InMenuEntryParams );
|
|
|
|
protected:
|
|
/** True if clicking on a menu entry closes itself only and its children and not the entire stack */
|
|
bool bCloseSelfOnly;
|
|
};
|
|
|
|
|
|
/**
|
|
* Vertical menu builder
|
|
*/
|
|
class SLATE_API FMenuBuilder : public FBaseMenuBuilder
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param bInShouldCloseWindowAfterMenuSelection Sets whether or not the window that contains this multibox should be destroyed after the user clicks on a menu item in this box
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
|
|
* @param bInCloseSelfOnly True if clicking on a menu entry closes itself only and its children but not the entire stack
|
|
* @param bInSearchable True if the menu is searchable
|
|
* @param bInRecursivelySearchable True if search algorithm should go down the sub-menus when searching. If false, the search will not scan the sub-menus. Recursive search is usually disabled on
|
|
* menus that are automatically generated in a way that the menu can expand indefinitely in a circular fashion. For example, the Blueprint API binding reflected on
|
|
* function return type can do that. Think about a function like "A* A::GetParent()". If a root menu expands "A" functions and expands on the function return types, then
|
|
* selecting "GetParent()" will expand another "A" menu. Without simulation, the reflection API don't know when the recursion finishes, nor does the recursive search algorithm.
|
|
*/
|
|
FMenuBuilder( const bool bInShouldCloseWindowAfterMenuSelection, TSharedPtr< const FUICommandList > InCommandList, TSharedPtr<FExtender> InExtender = TSharedPtr<FExtender>(), const bool bCloseSelfOnly = false, const ISlateStyle* InStyleSet = &FCoreStyle::Get(), bool bInSearchable = true, FName InMenuName = NAME_None, bool bInRecursivelySearchable = true)
|
|
: FBaseMenuBuilder( EMultiBoxType::Menu, bInShouldCloseWindowAfterMenuSelection, InCommandList, bCloseSelfOnly, InExtender, InStyleSet, NAME_None, InMenuName )
|
|
, bSectionNeedsToBeApplied(false)
|
|
, bSearchable(bInSearchable)
|
|
, bRecursivelySearchable(bInRecursivelySearchable)
|
|
, bIsEditing(false)
|
|
{
|
|
if(bSearchable)
|
|
{
|
|
AddSearchWidget();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a widget for this MultiBox
|
|
*
|
|
* @return New widget object
|
|
*/
|
|
virtual TSharedRef< class SWidget > MakeWidget( FMultiBox::FOnMakeMultiBoxBuilderOverride* InMakeMultiBoxBuilderOverride = nullptr, uint32 MaxHeight = 1000) override;
|
|
|
|
/**
|
|
* Adds a separator
|
|
*/
|
|
void AddMenuSeparator(FName InExtensionHook = NAME_None);
|
|
void AddSeparator(FName InExtensionHook = NAME_None);
|
|
|
|
/**
|
|
* Starts a section on to the extender section hook stack
|
|
*
|
|
* @param InExtensionHook The section hook. Can be NAME_None
|
|
* @param InHeadingText The heading text to use. If none, only a separator is used
|
|
*/
|
|
void BeginSection( FName InExtensionHook, const TAttribute< FText >& InHeadingText = TAttribute<FText>() );
|
|
|
|
/**
|
|
* Ends the current section
|
|
*/
|
|
void EndSection();
|
|
|
|
|
|
/**
|
|
* Adds a sub-menu which is a menu within a menu
|
|
*
|
|
* @param InMenuLabel The text that should be shown for the menu
|
|
* @param InToolTip The tooltip that should be shown when the menu is hovered over
|
|
* @param InSubMenu Sub-Menu object which creates menu entries for the sub-menu
|
|
* @param InUIAction Actions to execute on this menu item.
|
|
* @param InExtensionHook The section hook. Can be NAME_None
|
|
* @param InUserInterfaceActionType Type of interface action
|
|
* @param bInOpenSubMenuOnClick Sub-menu will open only if the sub-menu entry is clicked
|
|
* @param InIcon The icon to use
|
|
* @param bInShouldCloseWindowAfterMenuSelection Whether the submenu should close after an item is selected
|
|
*/
|
|
void AddSubMenu( const TAttribute<FText>& InMenuLabel, const TAttribute<FText>& InToolTip, const FNewMenuDelegate& InSubMenu, const FUIAction& InUIAction, FName InExtensionHook, const EUserInterfaceActionType InUserInterfaceActionType, const bool bInOpenSubMenuOnClick = false, const FSlateIcon& InIcon = FSlateIcon(), const bool bInShouldCloseWindowAfterMenuSelection = true );
|
|
|
|
void AddSubMenu( const TAttribute<FText>& InMenuLabel, const TAttribute<FText>& InToolTip, const FNewMenuDelegate& InSubMenu, const bool bInOpenSubMenuOnClick = false, const FSlateIcon& InIcon = FSlateIcon(), const bool bInShouldCloseWindowAfterMenuSelection = true, FName InExtensionHook = NAME_None );
|
|
|
|
void AddSubMenu( const TSharedRef< SWidget > Contents, const FNewMenuDelegate& InSubMenu, const bool bInOpenSubMenuOnClick = false, const bool bInShouldCloseWindowAfterMenuSelection = true );
|
|
|
|
void AddSubMenu( const FUIAction& UIAction, const TSharedRef< SWidget > Contents, const FNewMenuDelegate& InSubMenu, const bool bInShouldCloseWindowAfterMenuSelection = true );
|
|
|
|
/**
|
|
* Adds any widget to the menu
|
|
*
|
|
* @param InWidget The widget that should be shown in the menu
|
|
* @param InLabel Optional label text to be added to the left of the content
|
|
* @param bNoIndent If true, removes the padding from the left of the widget that lines it up with other menu items (default == false)
|
|
* @param bSearchable If true, widget will be searchable (default == true)
|
|
*/
|
|
void AddWidget( TSharedRef<SWidget> InWidget, const FText& Label, bool bNoIndent = false, bool bSearchable = true );
|
|
|
|
/**
|
|
* Adds the widget the multibox will use for searching
|
|
*/
|
|
void AddSearchWidget();
|
|
|
|
void SetIsEditing(bool bInIsEditing) { bIsEditing = bInIsEditing; }
|
|
|
|
protected:
|
|
/** FMultiBoxBuilder interface */
|
|
virtual void ApplyHook(FName InExtensionHook, EExtensionHook::Position HookPosition) override;
|
|
virtual void ApplySectionBeginning() override;
|
|
|
|
public:
|
|
// These classes need access to the AddWrapperSubMenu() methods
|
|
//friend class FWidgetBlock;
|
|
//friend class FToolBarComboButtonBlock;
|
|
|
|
/**
|
|
* Adds a sub-menu which is a menu within a menu
|
|
*
|
|
* @param InMenuLabel The text that should be shown for the menu
|
|
* @param InToolTip The tooltip that should be shown when the menu is hovered over
|
|
* @param InSubMenu Sub-Menu object which creates the sub-menu
|
|
*/
|
|
void AddWrapperSubMenu( const FText& InMenuLabel, const FText& InToolTip, const FOnGetContent& InSubMenu, const FSlateIcon& InIcon );
|
|
|
|
void AddWrapperSubMenu( const FText& InMenuLabel, const FText& InToolTip, const FOnGetContent& InSubMenu, const FSlateIcon& InIcon, const FUIAction& UIAction );
|
|
|
|
/**
|
|
* Adds a sub-menu which is a menu within a menu
|
|
*
|
|
* @param InMenuLabel The text that should be shown for the menu
|
|
* @param InToolTip The tooltip that should be shown when the menu is hovered over
|
|
* @param InSubMenu Sub-Menu object
|
|
*/
|
|
void AddWrapperSubMenu( const FText& InMenuLabel, const FText& InToolTip, const TSharedPtr<SWidget>& InSubMenu, const FSlateIcon& InIcon );
|
|
|
|
private:
|
|
/** Current extension hook name for sections to determine where sections begin and end */
|
|
FName CurrentSectionExtensionHook;
|
|
|
|
/** Any pending section's heading text */
|
|
FText CurrentSectionHeadingText;
|
|
|
|
/** True if there is a pending section that needs to be applied */
|
|
bool bSectionNeedsToBeApplied;
|
|
|
|
/** Whether this menu is searchable */
|
|
bool bSearchable;
|
|
|
|
/** Whether the search algorithm should walk down this menu sub-menu(s) (if the menu is searchable in first place). */
|
|
bool bRecursivelySearchable;
|
|
|
|
/** Whether menu is currently being edited */
|
|
bool bIsEditing;
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
* Menu bar builder
|
|
*/
|
|
class SLATE_API FMenuBarBuilder : public FBaseMenuBuilder
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
|
|
*/
|
|
FMenuBarBuilder( TSharedPtr< const FUICommandList > InCommandList, TSharedPtr<FExtender> InExtender = TSharedPtr<FExtender>(), const ISlateStyle* InStyleSet = &FCoreStyle::Get(), FName InMenuName = NAME_None)
|
|
: FBaseMenuBuilder( EMultiBoxType::MenuBar, false, InCommandList, false, InExtender, InStyleSet, NAME_None, InMenuName )
|
|
{
|
|
MultiBox->SetStyle(InStyleSet, "WindowMenuBar");
|
|
}
|
|
|
|
|
|
/**
|
|
* Adds a pull down menu
|
|
*
|
|
* @param InMenuLabel The text that should be shown for the menu
|
|
* @param InToolTip The tooltip that should be shown when the menu is hovered over
|
|
* @param InPullDownMenu Pull down menu object for the menu to add.
|
|
*/
|
|
void AddPullDownMenu( const TAttribute<FText>& InMenuLabel, const TAttribute<FText>& InToolTip, const FNewMenuDelegate& InPullDownMenu, FName InExtensionHook = NAME_None, FName InTutorialHighlightName = NAME_None);
|
|
|
|
/**
|
|
* Adds a pull down menu
|
|
*
|
|
* @param InMenuLabel The text that should be shown for the menu
|
|
* @param InToolTip The tooltip that should be shown when the menu is hovered over
|
|
* @param InMenuContentGenerator Delegate that generates a widget for this pulldown menu's content. Called when the menu is summoned.
|
|
*/
|
|
void AddPullDownMenu(const TAttribute<FText>& InMenuLabel, const TAttribute<FText>& InToolTip, const FOnGetContent& InMenuContentGenerator, FName InExtensionHook = NAME_None, FName InTutorialHighlightName = NAME_None);
|
|
|
|
protected:
|
|
/** FMultiBoxBuilder interface */
|
|
virtual void ApplyHook(FName InExtensionHook, EExtensionHook::Position HookPosition) override;
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
* Tool bar builder
|
|
*/
|
|
class SLATE_API FToolBarBuilder : public FMultiBoxBuilder
|
|
{
|
|
friend class UToolMenus;
|
|
public:
|
|
|
|
UE_DEPRECATED(4.26, "FToolBarBuilder constructor that takes in an EOrientation is deprecated. Use one of the specific per-type FToolbarBuilder overrides instead.")
|
|
FToolBarBuilder(TSharedPtr< const FUICommandList > InCommandList, FMultiBoxCustomization InCustomization, TSharedPtr<FExtender> InExtender, EOrientation Orientation, const bool InForceSmallIcons = false, const bool bUniform = false)
|
|
: FMultiBoxBuilder(bUniform ? EMultiBoxType::UniformToolBar : (Orientation == Orient_Horizontal) ? EMultiBoxType::ToolBar : EMultiBoxType::VerticalToolBar, InCustomization, false, InCommandList, InExtender)
|
|
, bSectionNeedsToBeApplied(false)
|
|
, bIsFocusable(true)
|
|
, bForceSmallIcons(InForceSmallIcons)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
|
|
*/
|
|
FToolBarBuilder(TSharedPtr<const FUICommandList> InCommandList, FMultiBoxCustomization InCustomization, TSharedPtr<FExtender> InExtender = nullptr, const bool InForceSmallIcons = false)
|
|
: FMultiBoxBuilder(EMultiBoxType::ToolBar, InCustomization, false, InCommandList, InExtender)
|
|
, bSectionNeedsToBeApplied(false)
|
|
, bIsFocusable(true)
|
|
, bForceSmallIcons(InForceSmallIcons)
|
|
{
|
|
MultiBox->bIsFocusable = bIsFocusable;
|
|
}
|
|
|
|
void SetLabelVisibility( EVisibility InLabelVisibility ) { LabelVisibility = InLabelVisibility ; }
|
|
|
|
void SetIsFocusable(bool bInIsFocusable);
|
|
|
|
/**
|
|
* Adds a tool bar button
|
|
*
|
|
* @param InCommand The command associated with this tool bar button
|
|
* @param InLabelOverride Optional label override. If omitted, then the action's label will be used instead.
|
|
* @param InToolTipOverride Optional tool tip override. If omitted, then the action's label will be used instead.
|
|
* @param InIconOverride Optional name of the slate brush to use for the tool bar image. If omitted, then the action's icon will be used instead.
|
|
* @param InTutorialHighlightName Name to identify this widget and highlight during tutorials
|
|
* @param CustomMenuDelegate Optional custom menu delegate for cases where the toolbar is compressed into a menu
|
|
*/
|
|
void AddToolBarButton(const TSharedPtr< const FUICommandInfo > InCommand, FName InExtensionHook = NAME_None, const TAttribute<FText>& InLabelOverride = TAttribute<FText>(), const TAttribute<FText>& InToolTipOverride = TAttribute<FText>(), const TAttribute<FSlateIcon>& InIconOverride = TAttribute<FSlateIcon>(), FName InTutorialHighlightName = NAME_None, FNewMenuDelegate InCustomMenuDelegate = FNewMenuDelegate());
|
|
|
|
/**
|
|
* Adds a tool bar button
|
|
*
|
|
* @param UIAction Actions to execute on this menu item.
|
|
* @param InLabel Label to show in the menu entry
|
|
* @param InToolTip Tool tip used when hovering over the menu entry
|
|
* @param InIcon The icon to use
|
|
* @param UserInterfaceActionType Type of interface action
|
|
* @param InTutorialHighlightName Name to identify this widget and highlight during tutorials
|
|
*/
|
|
void AddToolBarButton(const FUIAction& InAction, FName InExtensionHook = NAME_None, const TAttribute<FText>& InLabelOverride = TAttribute<FText>(), const TAttribute<FText>& InToolTipOverride = TAttribute<FText>(), const TAttribute<FSlateIcon>& InIconOverride = TAttribute<FSlateIcon>(), const EUserInterfaceActionType UserInterfaceActionType = EUserInterfaceActionType::Button, FName InTutorialHighlightName = NAME_None );
|
|
|
|
/**
|
|
* Adds a combo button
|
|
*
|
|
* @param InAction UI action that sets the enabled state for this combo button
|
|
* @param InMenuContentGenerator Delegate that generates a widget for this combo button's menu content. Called when the menu is summoned.
|
|
* @param InLabelOverride Optional label override. If omitted, then the action's label will be used instead.
|
|
* @param InToolTipOverride Optional tool tip override. If omitted, then the action's label will be used instead.
|
|
* @param InIconOverride Optional icon to use for the tool bar image. If omitted, then the action's icon will be used instead.
|
|
* @param bInSimpleComboBox If true, the icon and label won't be displayed
|
|
* @param InTutorialHighlightName Name to identify this widget and highlight during tutorials
|
|
*/
|
|
void AddComboButton( const FUIAction& InAction, const FOnGetContent& InMenuContentGenerator, const TAttribute<FText>& InLabelOverride = TAttribute<FText>(), const TAttribute<FText>& InToolTipOverride = TAttribute<FText>(), const TAttribute<FSlateIcon>& InIconOverride = TAttribute<FSlateIcon>(), bool bInSimpleComboBox = false, FName InTutorialHighlightName = NAME_None );
|
|
|
|
/**
|
|
* Adds a tool bar stack button
|
|
*
|
|
* @param InCommand The command associated with this tool bar button
|
|
* @param InTutorialHighlightName Name to identify this widget and highlight during tutorials
|
|
*/
|
|
void AddToolbarStackButton(const TSharedPtr< const FUICommandInfo > InCommand, FName InTutorialHighlightName = NAME_None);
|
|
|
|
/**
|
|
* Adds any widget to the toolbar
|
|
*
|
|
* @param InWidget The widget that should be shown in the toolbar
|
|
* @param InLabel Optional Label.
|
|
* @param InTutorialHighlightName Name to identify this widget and highlight during tutorials
|
|
* @param bSearchable If true, widget will be searchable (default == true)
|
|
*/
|
|
void AddToolBarWidget(TSharedRef<SWidget> InWidget, const TAttribute<FText>& InLabel = TAttribute<FText>(), FName InTutorialHighlightName = NAME_None, bool bSearchable = true);
|
|
|
|
|
|
/**
|
|
* Adds any widget to the toolbar
|
|
*
|
|
* @param InWidget The widget that should be shown in the toolbar
|
|
* @param InTutorialHighlightName Name to identify this widget and highlight during tutorials
|
|
* @param bSearchable If true, widget will be searchable (default == true)
|
|
* @param Alignment Horizontal alignment for the widget inside the toolbar
|
|
* @param CustomMenuDelegate Optional custom menu delegate for cases where the toolbar is compressed into a menu
|
|
*/
|
|
void AddWidget(TSharedRef<SWidget> InWidget, FName InTutorialHighlightName = NAME_None, bool bSearchable = true, EHorizontalAlignment Alignment = HAlign_Fill, FNewMenuDelegate InCustomMenuDelegate = FNewMenuDelegate());
|
|
|
|
/**
|
|
* Adds a toolbar separator
|
|
*/
|
|
void AddSeparator(FName InExtensionHook = NAME_None);
|
|
|
|
/**
|
|
* Starts a section on to the extender section hook stack
|
|
*
|
|
* @param InExtensionHook The section hook. Can be NAME_None
|
|
*/
|
|
void BeginSection( FName InExtensionHook );
|
|
|
|
/**
|
|
* Ends the current section
|
|
*/
|
|
void EndSection();
|
|
|
|
/**
|
|
* Starts a new Group block, must be used in conjunction with EndBlockGroup
|
|
*/
|
|
void BeginBlockGroup();
|
|
|
|
/**
|
|
* End a group block, must be used in conjunction with BeginBlockGroup.
|
|
*/
|
|
void EndBlockGroup();
|
|
|
|
/**
|
|
* Overrides the style being used by this toolbar with a different one for the
|
|
* The override will be used for any added blocks until EndStyleOverride is called
|
|
*/
|
|
void BeginStyleOverride(FName StyleOverrideName);
|
|
void EndStyleOverride();
|
|
protected:
|
|
|
|
FToolBarBuilder(EMultiBoxType InType, TSharedPtr<const FUICommandList> InCommandList, FMultiBoxCustomization InCustomization, TSharedPtr<FExtender> InExtender = TSharedPtr<FExtender>(), const bool InForceSmallIcons = false)
|
|
: FMultiBoxBuilder(InType, InCustomization, false, InCommandList, InExtender)
|
|
, bSectionNeedsToBeApplied(false)
|
|
, bIsFocusable(false)
|
|
, bForceSmallIcons(InForceSmallIcons)
|
|
{
|
|
}
|
|
|
|
|
|
/** FMultiBoxBuilder interface */
|
|
virtual void ApplyHook(FName InExtensionHook, EExtensionHook::Position HookPosition) override;
|
|
virtual void ApplySectionBeginning() override;
|
|
|
|
private:
|
|
/** Current extension hook name for sections to determine where sections begin and end */
|
|
FName CurrentSectionExtensionHook;
|
|
|
|
FName CurrentStyleOverride;
|
|
|
|
TOptional< EVisibility > LabelVisibility;
|
|
|
|
/** True if there is a pending section that needs to be applied */
|
|
bool bSectionNeedsToBeApplied;
|
|
|
|
/** Whether the buttons created can receive keyboard focus */
|
|
bool bIsFocusable;
|
|
|
|
/** Whether this toolbar should always use small icons, regardless of the current settings */
|
|
bool bForceSmallIcons;
|
|
};
|
|
|
|
|
|
class SLATE_API FVerticalToolBarBuilder : public FToolBarBuilder
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
|
|
*/
|
|
FVerticalToolBarBuilder(TSharedPtr<const FUICommandList> InCommandList, FMultiBoxCustomization InCustomization, TSharedPtr<FExtender> InExtender = nullptr, const bool InForceSmallIcons = false)
|
|
: FToolBarBuilder(EMultiBoxType::VerticalToolBar, InCommandList, InCustomization, InExtender, InForceSmallIcons)
|
|
{
|
|
}
|
|
};
|
|
|
|
class SLATE_API FUniformToolBarBuilder : public FToolBarBuilder
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
|
|
*/
|
|
FUniformToolBarBuilder(TSharedPtr<const FUICommandList> InCommandList, FMultiBoxCustomization InCustomization, TSharedPtr<FExtender> InExtender = nullptr, const bool InForceSmallIcons = false)
|
|
: FToolBarBuilder(EMultiBoxType::UniformToolBar, InCommandList, InCustomization, InExtender, InForceSmallIcons)
|
|
{
|
|
}
|
|
};
|
|
|
|
class SLATE_API FSlimHorizontalToolBarBuilder : public FToolBarBuilder
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
|
|
*/
|
|
FSlimHorizontalToolBarBuilder(TSharedPtr<const FUICommandList> InCommandList, FMultiBoxCustomization InCustomization, TSharedPtr<FExtender> InExtender = nullptr, const bool InForceSmallIcons = false)
|
|
: FToolBarBuilder(EMultiBoxType::SlimHorizontalToolBar, InCommandList, InCustomization, InExtender, InForceSmallIcons)
|
|
{
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Button grid builder
|
|
*/
|
|
class SLATE_API FButtonRowBuilder : public FMultiBoxBuilder
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param InCommandList The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
|
|
*/
|
|
FButtonRowBuilder(TSharedPtr< const FUICommandList > InCommandList, TSharedPtr<FExtender> InExtender = TSharedPtr<FExtender>())
|
|
: FMultiBoxBuilder(EMultiBoxType::ButtonRow, FMultiBoxCustomization::None, false, InCommandList, InExtender)
|
|
{
|
|
}
|
|
|
|
|
|
/**
|
|
* Adds a button to a row
|
|
*
|
|
* @param InCommand The command associated with this tool bar button
|
|
* @param InLabelOverride Optional label override. If omitted, then the action's label will be used instead.
|
|
* @param InToolTipOverride Optional tool tip override. If omitted, then the action's label will be used instead.
|
|
* @param InIconOverride Optional icon to use for the tool bar image. If omitted, then the action's icon will be used instead.
|
|
*/
|
|
void AddButton(const TSharedPtr< const FUICommandInfo > InCommand, const TAttribute<FText>& InLabelOverride = TAttribute<FText>(), const TAttribute<FText>& InToolTipOverride = TAttribute<FText>(), const FSlateIcon& InIconOverride = FSlateIcon());
|
|
|
|
/**
|
|
* Adds a button to a row
|
|
*
|
|
* @param InLabel The button label to display
|
|
* @param InToolTipOverride The tooltip for the button
|
|
* @param UIAction Action to execute when the button is clicked or when state should be checked
|
|
* @param InIcon The icon for the button
|
|
* @param UserInterfaceActionType The style of button to display
|
|
*/
|
|
void AddButton(const FText& InLabel, const FText& InToolTip, const FUIAction& UIAction, const FSlateIcon& InIcon = FSlateIcon(), const EUserInterfaceActionType UserInterfaceActionType = EUserInterfaceActionType::Button);
|
|
|
|
protected:
|
|
/** FMultiBoxBuilder interface */
|
|
virtual void ApplyHook(FName InExtensionHook, EExtensionHook::Position HookPosition) override {}
|
|
};
|