FMenuEntryBlock Class Reference

#include <SMenuEntryBlock.h>

Inheritance diagram for FMenuEntryBlock:

Public Member Functions
	FMenuEntryBlock (const FName &InExtensionHook, const TSharedPtr< const FUICommandInfo > InCommand, TSharedPtr< const FUICommandList > InCommandList, const TAttribute< FText > &InLabelOverride=TAttribute< FText >(), const TAttribute< FText > &InToolTipOverride=TAttribute< FText >(), const FSlateIcon &InIconOverride=FSlateIcon(), bool bInCloseSelfOnly=false, bool bInShouldCloseWindowAfterMenuSelection=true)
	FMenuEntryBlock (const FName &InExtensionHook, const TAttribute< FText > &InLabel, const TAttribute< FText > &InToolTip, const FNewMenuDelegate &InEntryBuilder, TSharedPtr< FExtender > InExtender, bool bInSubMenu, bool bInSubMenuOnClick, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, const FSlateIcon &InIcon=FSlateIcon(), bool bInShouldCloseWindowAfterMenuSelection=true)
	FMenuEntryBlock (const FName &InExtensionHook, const TAttribute< FText > &InLabel, const TAttribute< FText > &InToolTip, const FOnGetContent &InMenuBuilder, TSharedPtr< FExtender > InExtender, bool bInSubMenu, bool bInSubMenuOnClick, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, const FSlateIcon &InIcon=FSlateIcon(), bool bInShouldCloseWindowAfterMenuSelection=true)
	FMenuEntryBlock (const FName &InExtensionHook, const TAttribute< FText > &InLabel, const TAttribute< FText > &InToolTip, const TSharedPtr< SWidget > &InEntryWidget, TSharedPtr< FExtender > InExtender, bool bInSubMenu, bool bInSubMenuOnClick, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, const FSlateIcon &InIcon=FSlateIcon(), bool bInShouldCloseWindowAfterMenuSelection=true)
	FMenuEntryBlock (const FName &InExtensionHook, const TAttribute< FText > &InLabel, const TAttribute< FText > &InToolTip, const FNewMenuDelegate &InEntryBuilder, TSharedPtr< FExtender > InExtender, bool bInSubMenu, bool bInSubMenuOnClick, const FSlateIcon &InIcon, const FUIAction &InUIAction, const EUserInterfaceActionType InUserInterfaceActionType, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection=true, TSharedPtr< const FUICommandList > InCommandList=nullptr, const TAttribute< FText > &InInputBindingOverride=TAttribute< FText >())
	FMenuEntryBlock (const FName &InExtensionHook, const TAttribute< FText > &InLabel, const TAttribute< FText > &InToolTip, const FSlateIcon &InIcon, const FUIAction &InUIAction, const EUserInterfaceActionType InUserInterfaceActionType, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection=true, const TAttribute< FText > &InInputBindingOverride=TAttribute< FText >())
	FMenuEntryBlock (const FName &InExtensionHook, const FUIAction &UIAction, const TSharedRef< SWidget > Contents, const TAttribute< FText > &InToolTip, const EUserInterfaceActionType InUserInterfaceActionType, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection=true)
	FMenuEntryBlock (const FName &InExtensionHook, const TSharedRef< SWidget > Contents, const FNewMenuDelegate &InEntryBuilder, TSharedPtr< FExtender > InExtender, bool bInSubMenu, bool bInSubMenuOnClick, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection=true)
	FMenuEntryBlock (const FName &InExtensionHook, const FUIAction &UIAction, const TSharedRef< SWidget > Contents, const FNewMenuDelegate &InEntryBuilder, TSharedPtr< FExtender > InExtender, bool bInSubMenu, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection=true)
	FMenuEntryBlock (const FName &InExtensionHook, const FUIAction &UIAction, const TAttribute< FText > &InLabel, const TAttribute< FText > &InToolTip, const FOnGetContent &InMenuBuilder, TSharedPtr< FExtender > InExtender, bool bInSubMenu, bool bInSubMenuOnClick, bool bInCloseSelfOnly, const FSlateIcon &InIcon=FSlateIcon(), bool bInShouldCloseWindowAfterMenuSelection=true)
	FMenuEntryBlock (const FMenuEntryParams &InMenuEntryParams)
virtual void	CreateMenuEntry (class FMenuBuilder &MenuBuilder) const override
virtual bool	HasIcon () const override
void	SetCheckBoxStyle (FName InCheckBoxStyle)
bool	IsSubMenu () const
void	SetRecursivelySearchable (bool bInRecursivelySearchable)
bool	IsRecursivelySearchable () const
Public Member Functions inherited from FMultiBlock
	FMultiBlock (const TSharedPtr< const FUICommandInfo > InCommand, TSharedPtr< const FUICommandList > InCommandList, FName InExtensionHook=NAME_None, EMultiBlockType InType=EMultiBlockType::None, bool bInIsPartOfHeading=false)
	FMultiBlock (const FUIAction &InAction, FName InExtensionHook=NAME_None, EMultiBlockType InType=EMultiBlockType::None, bool bInIsPartOfHeading=false, TSharedPtr< const FUICommandList > InCommandList=nullptr)
	FMultiBlock (const FMultiBlockParams &InMultiBlockParams)
virtual	~FMultiBlock ()
TSharedPtr< const FUICommandList >	GetActionList () const
TSharedPtr< const FUICommandInfo >	GetAction () const
const FUIAction &	GetDirectActions () const
virtual bool	IsGroupStartBlock () const
virtual bool	IsGroupEndBlock () const
void	SetTutorialHighlightName (FName InTutorialName)
FName	GetTutorialHighlightName () const
void	SetStyleNameOverride (FName InStyleNameOverride)
FName	GetStyleNameOverride () const
SLATE_API TSharedRef< class IMultiBlockBaseWidget >	MakeWidget (TSharedRef< class SMultiBoxWidget > InOwnerMultiBoxWidget, EMultiBlockLocation::Type InLocation, bool bSectionContainsIcons, TSharedPtr< SWidget > OptionsBlockWidget) const
const EMultiBlockType	GetType () const
bool	IsSeparator () const
bool	IsPartOfHeading () const
SLATE_API void	SetSearchable (bool bSearchable)
SLATE_API bool	GetSearchable () const
FName	GetExtensionHook () const
TAttribute< EVisibility >	GetVisibilityOverride () const
void	SetVisibilityOverride (TAttribute< EVisibility > InVisibilityOverride)
const TAttribute< FMenuEntryResizeParams > &	GetResizeParams () const
void	SetResizeParams (const TAttribute< FMenuEntryResizeParams > &InResizeParams)
Public Member Functions inherited from TSharedFromThis< FMultiBlock >
TSharedRef< FMultiBlock, Mode >	AsShared ()
TSharedRef< FMultiBlock const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FMultiBlock, Mode >	AsWeak ()
TWeakPtr< FMultiBlock const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Friends
class	SMenuEntryBlock
class	FSlateMacMenu

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FMultiBlock >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FMultiBlock >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Menu entry MultiBlock

Constructor & Destructor Documentation

FMenuEntryBlock() [1/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const TSharedPtr< const FUICommandInfo >	InCommand,
		TSharedPtr< const FUICommandList >	InCommandList,
		const TAttribute< FText > &	InLabelOverride = TAttribute<FText>(),
		const TAttribute< FText > &	InToolTipOverride = TAttribute<FText>(),
		const FSlateIcon &	InIconOverride = FSlateIcon(),
		bool	bInCloseSelfOnly = false,
		bool	bInShouldCloseWindowAfterMenuSelection = true
	)

Constructor

Parameters

InCommand	The command associated with this menu entry
InCommandList	The list of commands that are mapped to delegates so that we know what to execute when this menu entry is activated
InLabelOverride	Optional label override. If omitted, then the action's label will be used instead.
InToolTipOverride	Optional tool tip override. If omitted, then the action's label will be used instead.
InIconOverride	Optional icon to use for the tool bar image. If omitted, then the action's icon will be used instead.
bInShouldCloseWindowAfterMenuSelection	In the case of a submenu, whether it should close after an item is selected
bInInvertLabelOnHover	Whether to invert the label text's color on hover

FMenuEntryBlock() [2/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const TAttribute< FText > &	InLabel,
		const TAttribute< FText > &	InToolTip,
		const FNewMenuDelegate &	InEntryBuilder,
		TSharedPtr< FExtender >	InExtender,
		bool	bInSubMenu,
		bool	bInSubMenuOnClick,
		TSharedPtr< const FUICommandList >	InCommandList,
		bool	bInCloseSelfOnly,
		const FSlateIcon &	InIcon = FSlateIcon(),
		bool	bInShouldCloseWindowAfterMenuSelection = true
	)

Constructor

Parameters

InLabel	The label to display in the menu
InToolTip	The tool tip to display when the menu entry is hovered over
InEntryBuilder	Menu builder object for the menu to add.
InExtender	The menu extender class to pass down to child menus
bInSubMenu	True if this menu entry spawns a sub-menu instead of activating a command
bInSubMenuOnClick	True if this menu entry spawns a sub-menu only by clicking on it
InCommandList	The list of commands bound to delegates that should be executed for menu entries
InIcon	The icon to display to the left of the label
bInShouldCloseWindowAfterMenuSelection	In the case of a submenu, whether it should close after an item is selected
bInInvertLabelOnHover	Whether to invert the label text's color on hover

FMenuEntryBlock() [3/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const TAttribute< FText > &	InLabel,
		const TAttribute< FText > &	InToolTip,
		const FOnGetContent &	InMenuBuilder,
		TSharedPtr< FExtender >	InExtender,
		bool	bInSubMenu,
		bool	bInSubMenuOnClick,
		TSharedPtr< const FUICommandList >	InCommandList,
		bool	bInCloseSelfOnly,
		const FSlateIcon &	InIcon = FSlateIcon(),
		bool	bInShouldCloseWindowAfterMenuSelection = true
	)

Constructor

Parameters

InLabel	The label to display in the menu
InToolTip	The tool tip to display when the menu entry is hovered over
InMenuBuilder	Menu widget object to add.
InExtender	The menu extender class to pass down to child menus
bInSubMenu	True if this menu entry spawns a sub-menu instead of activating a command
bInSubMenuOnClick	True if this menu entry spawns a sub-menu only by clicking on it
InCommandList	The list of commands bound to delegates that should be executed for menu entries
InIcon	The icon to display to the left of the label
bInShouldCloseWindowAfterMenuSelection	In the case of a submenu, whether it should close after an item is selected
bInInvertLabelOnHover	Whether to invert the label text's color on hover

FMenuEntryBlock() [4/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const TAttribute< FText > &	InLabel,
		const TAttribute< FText > &	InToolTip,
		const TSharedPtr< SWidget > &	InEntryWidget,
		TSharedPtr< FExtender >	InExtender,
		bool	bInSubMenu,
		bool	bInSubMenuOnClick,
		TSharedPtr< const FUICommandList >	InCommandList,
		bool	bInCloseSelfOnly,
		const FSlateIcon &	InIcon = FSlateIcon(),
		bool	bInShouldCloseWindowAfterMenuSelection = true
	)

Constructor

Parameters

InLabel	The label to display in the menu
InToolTip	The tool tip to display when the menu entry is hovered over
InEntryWidget	Menu widget object to add.
InExtender	The menu extender class to pass down to child menus
bInSubMenu	True if this menu entry spawns a sub-menu instead of activating a command
bInSubMenuOnClick	True if this menu entry spawns a sub-menu only by clicking on it
InCommandList	The list of commands bound to delegates that should be executed for menu entries
InIcon	The icon to display to the left of the label
bInShouldCloseWindowAfterMenuSelection	In the case of a submenu, whether it should close after an item is selected
bInInvertLabelOnHover	Whether to invert the label text's color on hover

FMenuEntryBlock() [5/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const TAttribute< FText > &	InLabel,
		const TAttribute< FText > &	InToolTip,
		const FNewMenuDelegate &	InEntryBuilder,
		TSharedPtr< FExtender >	InExtender,
		bool	bInSubMenu,
		bool	bInSubMenuOnClick,
		const FSlateIcon &	InIcon,
		const FUIAction &	InUIAction,
		const EUserInterfaceActionType	InUserInterfaceActionType,
		bool	bInCloseSelfOnly,
		bool	bInShouldCloseWindowAfterMenuSelection = true,
		TSharedPtr< const FUICommandList >	InCommandList = nullptr,
		const TAttribute< FText > &	InInputBindingOverride = TAttribute<FText>()
	)

Constructor for use with dynamic menu entries that do not have commands

Parameters

InLabel	The label to display in the menu
InToolTip	The tool tip to display when the menu entry is hovered over
InIcon	The icon to display to the left of the label
InUIAction	UI action to take when this menu item is clicked as well as to determine if the menu entry can be executed or appears "checked"
InUserInterfaceActionType	Type of interface action
bInShouldCloseWindowAfterMenuSelection	In the case of a submenu, whether it should close after an item is selected
bInInvertLabelOnHover	Whether to invert the label text's color on hover
InCommandList	The list of commands bound to delegates that should be executed for menu entries
InInputBindingOverride	Optional overridden input binding text for this menu entry

FMenuEntryBlock() [6/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const TAttribute< FText > &	InLabel,
		const TAttribute< FText > &	InToolTip,
		const FSlateIcon &	InIcon,
		const FUIAction &	InUIAction,
		const EUserInterfaceActionType	InUserInterfaceActionType,
		bool	bInCloseSelfOnly,
		bool	bInShouldCloseWindowAfterMenuSelection = true,
		const TAttribute< FText > &	InInputBindingOverride = TAttribute<FText>()
	)

FMenuEntryBlock() [7/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const FUIAction &	UIAction,
		const TSharedRef< SWidget >	Contents,
		const TAttribute< FText > &	InToolTip,
		const EUserInterfaceActionType	InUserInterfaceActionType,
		bool	bInCloseSelfOnly,
		bool	bInShouldCloseWindowAfterMenuSelection = true
	)

FMenuEntryBlock() [8/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const TSharedRef< SWidget >	Contents,
		const FNewMenuDelegate &	InEntryBuilder,
		TSharedPtr< FExtender >	InExtender,
		bool	bInSubMenu,
		bool	bInSubMenuOnClick,
		TSharedPtr< const FUICommandList >	InCommandList,
		bool	bInCloseSelfOnly,
		bool	bInShouldCloseWindowAfterMenuSelection = true
	)

FMenuEntryBlock() [9/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const FUIAction &	UIAction,
		const TSharedRef< SWidget >	Contents,
		const FNewMenuDelegate &	InEntryBuilder,
		TSharedPtr< FExtender >	InExtender,
		bool	bInSubMenu,
		TSharedPtr< const FUICommandList >	InCommandList,
		bool	bInCloseSelfOnly,
		bool	bInShouldCloseWindowAfterMenuSelection = true
	)

FMenuEntryBlock() [10/11]

FMenuEntryBlock::FMenuEntryBlock	(	const FName &	InExtensionHook,
		const FUIAction &	UIAction,
		const TAttribute< FText > &	InLabel,
		const TAttribute< FText > &	InToolTip,
		const FOnGetContent &	InMenuBuilder,
		TSharedPtr< FExtender >	InExtender,
		bool	bInSubMenu,
		bool	bInSubMenuOnClick,
		bool	bInCloseSelfOnly,
		const FSlateIcon &	InIcon = FSlateIcon(),
		bool	bInShouldCloseWindowAfterMenuSelection = true
	)

FMenuEntryBlock() [11/11]

FMenuEntryBlock::FMenuEntryBlock

(

const FMenuEntryParams &

InMenuEntryParams

)

Construct a menu entry given param struct

Member Function Documentation

CreateMenuEntry()

void FMenuEntryBlock::CreateMenuEntry ( class FMenuBuilder &  MenuBuilder ) const

overridevirtual

FMultiBlock interface

Reimplemented from FMultiBlock.

HasIcon()

bool FMenuEntryBlock::HasIcon ( ) const

overridevirtual

Reimplemented from FMultiBlock.

IsRecursivelySearchable()

bool FMenuEntryBlock::IsRecursivelySearchable ( ) const

inline

Returns whether the menu search algorithm should walk down this menu sub-menus.

IsSubMenu()

bool FMenuEntryBlock::IsSubMenu ( ) const

inline

Returns whether this menu entry block opens a sub-menu.

SetCheckBoxStyle()

void FMenuEntryBlock::SetCheckBoxStyle

(

FName

InCheckBoxStyle

)

the override for the checkbox style

SetRecursivelySearchable()

void FMenuEntryBlock::SetRecursivelySearchable ( bool  bInRecursivelySearchable )

inline

Sets whether the menu search algorithm should walk down this menu sub-menus.

Friends And Related Symbol Documentation

FSlateMacMenu

friend class FSlateMacMenu

friend

SMenuEntryBlock

friend class SMenuEntryBlock

friend

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Slate/Private/Framework/MultiBox/SMenuEntryBlock.h
• Engine/Source/Runtime/Slate/Private/Framework/MultiBox/SMenuEntryBlock.cpp