FMenuEntryParams Struct Reference

#include <MultiBoxBuilder.h>

Inheritance diagram for FMenuEntryParams:

Public Member Functions
	FMenuEntryParams ()

Public Attributes
TAttribute< FText >	LabelOverride
TAttribute< FText >	ToolTipOverride
TAttribute< FText >	InputBindingOverride
TAttribute< EVisibility >	Visibility
FSlateIcon	IconOverride
FNewMenuDelegate	EntryBuilder
FOnGetContent	MenuBuilder
TSharedPtr< SWidget >	EntryWidget
bool	bIsSubMenu = false
bool	bIsRecursivelySearchable = true
bool	bOpenSubMenuOnClick = false
EUserInterfaceActionType	UserInterfaceActionType
bool	bCloseSelfOnly = false
TSharedPtr< FExtender >	Extender
bool	bShouldCloseWindowAfterMenuSelection = true
FName	TutorialHighlightName
Public Attributes inherited from FMultiBlock::FMultiBlockParams
FUIAction	DirectActions
const TSharedPtr< const FUICommandInfo >	Action
const TSharedPtr< const FUICommandList >	ActionList
FName	ExtensionHook
EMultiBlockType	Type = EMultiBlockType::None
bool	bIsPartOfHeading = false

Detailed Description

Helper struct that holds FMenuEntry params for construction

Constructor & Destructor Documentation

FMenuEntryParams()

FMenuEntryParams::FMenuEntryParams ( )

inline

Member Data Documentation

bCloseSelfOnly

bool FMenuEntryParams::bCloseSelfOnly = false

True if the menu should close itself and all its children or the entire open menu stack

bIsRecursivelySearchable

bool FMenuEntryParams::bIsRecursivelySearchable = true

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).

bIsSubMenu

bool FMenuEntryParams::bIsSubMenu = false

True if this menu entry opens a sub-menu

bOpenSubMenuOnClick

bool FMenuEntryParams::bOpenSubMenuOnClick = false

True if this menu entry opens a sub-menu by clicking on it only

bShouldCloseWindowAfterMenuSelection

bool FMenuEntryParams::bShouldCloseWindowAfterMenuSelection = true

For submenus, whether the menu should be closed after something is selected

EntryBuilder

FNewMenuDelegate FMenuEntryParams::EntryBuilder

Optional menu entry builder associated with this entry for building sub-menus and pull down menus

EntryWidget

TSharedPtr<SWidget> FMenuEntryParams::EntryWidget

Widget to be added to the menu

Extender

TSharedPtr<FExtender> FMenuEntryParams::Extender

An extender that this menu entry should pass down to its children, so they get extended properly

IconOverride

FSlateIcon FMenuEntryParams::IconOverride

Optional overridden icon for this tool bar button. IF not set, then the action's icon will be used instead.

InputBindingOverride

TAttribute<FText> FMenuEntryParams::InputBindingOverride

Optional overridden input binding text for this menu entry. If not set, then the UI action's binding will be used if available.

LabelOverride

TAttribute<FText> FMenuEntryParams::LabelOverride

Optional overridden text label for this menu entry. If not set, then the action's label will be used instead.

MenuBuilder

FOnGetContent FMenuEntryParams::MenuBuilder

Delegate that returns an entire menu

ToolTipOverride

TAttribute<FText> FMenuEntryParams::ToolTipOverride

Optional overridden tool tip for this menu entry. If not set, then the action's tool tip will be used instead.

TutorialHighlightName

FName FMenuEntryParams::TutorialHighlightName

Display name for tutorials

UserInterfaceActionType

EUserInterfaceActionType FMenuEntryParams::UserInterfaceActionType

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.

Visibility

TAttribute<EVisibility> FMenuEntryParams::Visibility

Set in case this entry needs to be dynamically hidden

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h