1. Epic GamesDeveloper
  3. FToolMenuEntry

FToolMenuEntry

Represents entries in menus such as buttons, checkboxes, and sub-menus.

API > API/Developer > API/Developer/ToolMenus

Represents entries in menus such as buttons, checkboxes, and sub-menus.

Many entries are created for you via the methods of FToolMenuSection, such as FToolMenuSection::AddMenuEntry.

   
Name FToolMenuEntry
Type struct
Header File /Engine/Source/Developer/ToolMenus/Public/ToolMenuEntry.h
Include Path #include "ToolMenuEntry.h"

Syntax

USTRUCT (BlueprintType )  
struct FToolMenuEntry

Constructors

Name Remarks Include Path Unreal Specifiers

FToolMenuEntry ( const FToolMenuOwner InOwner,
const FName InName,
EMultiBlockType InType
)

   ToolMenuEntry.h  
  ToolMenuEntry.h  
  ToolMenuEntry.h  
  ToolMenuEntry.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bShouldCloseWindowAfterMenuSelection bool   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
Icon TAttribute< FSlateIcon >   ToolMenuEntry.h  
InputBindingLabel TAttribute< FText >   ToolMenuEntry.h  
InsertPosition FToolMenuInsert   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
Label TAttribute< FText >   ToolMenuEntry.h  
MakeCustomWidget FNewToolMenuCustomWidget Optional delegate that returns a widget to use as this menu entry ToolMenuEntry.h  
MakeWidget FNewToolMenuWidget   ToolMenuEntry.h  
Name FName   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
Owner FToolMenuOwner   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
ScriptObject TObjectPtr< UToolMenuEntryScript >   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
StyleNameOverride FName   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
SubMenuData FToolMenuEntrySubMenuData   ToolMenuEntry.h  
ToolBarData FToolMenuEntryToolBarData   ToolMenuEntry.h  
ToolTip TAttribute< FText >   ToolMenuEntry.h  
TutorialHighlightName FName   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
Type EMultiBlockType   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
UserInterfaceActionType EUserInterfaceActionType   ToolMenuEntry.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
Visibility FToolMenuVisibilityChoice   ToolMenuEntry.h  
WidgetData FToolMenuEntryWidgetData   ToolMenuEntry.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Action FToolUIActionChoice   ToolMenuEntry.h  
bAddedDuringRegister bool   ToolMenuEntry.h  
bCommandIsKeybindOnly bool   ToolMenuEntry.h  
Command TSharedPtr< const FUICommandInfo >   ToolMenuEntry.h  
CommandList TSharedPtr< const FUICommandList >   ToolMenuEntry.h  
Construct FNewToolMenuSectionDelegate   ToolMenuEntry.h  
ConstructLegacy FNewToolMenuDelegateLegacy   ToolMenuEntry.h  
ShowInToolbarTopLevel TAttribute< bool >   ToolMenuEntry.h  
StringExecuteAction FToolMenuStringCommand   ToolMenuEntry.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddKeybindFromCommand ( const TSharedPtr< const FUICommandInfo >& InCommand
)

   ToolMenuEntry.h  

void AddOptionsDropdown ( FUIAction InAction,
const FOnGetContent InMenuContentGenerator,
const TAttribute< FText >& InToolTip
)

   ToolMenuEntry.h  

bool CommandAcceptsInput ( const FKeyEvent& InKeyEvent
) const

   ToolMenuEntry.h  

const FUIAction * GetActionForCommand ( const FToolMenuContext& InContext,
TSharedPtr< const FUICommandList >& OutCommandList
) const

   ToolMenuEntry.h  

ECheckBoxState GetCheckState ( const FToolMenuContext& InContext
) const

 Get the checked state of this entry by calling underlying commands and delegates. ToolMenuEntry.h  

bool IsCommandKeybindOnly()

   ToolMenuEntry.h  

bool IsConstructLegacy()

   ToolMenuEntry.h  

bool IsSubMenu()

   ToolMenuEntry.h  

void SetCommandList ( const TSharedPtr< const FUICommandList >& InCommandList
)

   ToolMenuEntry.h  

void SetShowInToolbarTopLevel ( TAttribute< bool > InTopLevel
)

 Show this menu entry in the top-level toolbar section of a toolbar. ToolMenuEntry.h  

bool TryExecuteToolUIAction ( const FToolMenuContext& InContext
)

   ToolMenuEntry.h  

Static

Name Remarks Include Path Unreal Specifiers

static FToolMenuEntry InitComboButton ( const FName InName,
const FToolUIActionChoice& InAction,
const FNewToolMenuChoice& InMenuContentGenerator,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
bool bInSimpleComboBox,
FName InTutorialHighlightName
)

   ToolMenuEntry.h  

static FToolMenuEntry InitDynamicEntry ( const FName InName,
const FNewToolMenuSectionDelegate& InConstruct
)

   ToolMenuEntry.h  

static FToolMenuEntry InitMenuEntry ( const TSharedPtr< const FUICommandInfo >& InCommand,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
const FName InTutorialHighlightName,
const TOptional< FName > InNameOverride
)

   ToolMenuEntry.h  

static FToolMenuEntry InitMenuEntry ( const FName InName,
const FToolUIActionChoice& InAction,
const TSharedRef< SWidget >& Widget
)

   ToolMenuEntry.h  

static FToolMenuEntry InitMenuEntry ( const FName InName,
const TAttribute< FText >& InLabel,
const TAttribute< FText >& InToolTip,
const TAttribute< FSlateIcon >& InIcon,
const FToolUIActionChoice& InAction,
const EUserInterfaceActionType UserInterfaceActionType,
const FName InTutorialHighlightName
)

   ToolMenuEntry.h  

static FToolMenuEntry InitMenuEntry ( const FName InNameOverride,
const TSharedPtr< const FUICommandInfo >& InCommand,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
const FName InTutorialHighlightName
)

   ToolMenuEntry.h  

static FToolMenuEntry InitMenuEntryWithCommandList ( const TSharedPtr< const FUICommandInfo >& InCommand,
const TSharedPtr< const FUICommandList >& InCommandList,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
const FName InTutorialHighlightName,
const TOptional< FName > InNameOverride
)

   ToolMenuEntry.h  

static FToolMenuEntry InitSeparator ( const FName InName
)

   ToolMenuEntry.h  

static FToolMenuEntry InitSubMenu ( const FName InName,
const TAttribute< FText >& InLabel,
const TAttribute< FText >& InToolTip,
const FNewToolMenuChoice& InMakeMenu,
const FToolUIActionChoice& InAction,
const EUserInterfaceActionType InUserInterfaceActionType,
bool bInOpenSubMenuOnClick,
const TAttribute< FSlateIcon >& InIcon,
const bool bShouldCloseWindowAfterMenuSelection
)

   ToolMenuEntry.h  

static FToolMenuEntry InitSubMenu ( const FName InName,
const TAttribute< FText >& InLabel,
const TAttribute< FText >& InToolTip,
const FNewToolMenuChoice& InMakeMenu,
bool bInOpenSubMenuOnClick,
const TAttribute< FSlateIcon >& InIcon,
const bool bShouldCloseWindowAfterMenuSelection,
const FName InTutorialHighlightName
)

   ToolMenuEntry.h  

static FToolMenuEntry InitSubMenu ( const FName InName,
const FToolUIActionChoice& InAction,
const TSharedRef< SWidget >& InWidget,
const FNewToolMenuChoice& InMakeMenu,
bool bShouldCloseWindowAfterMenuSelection
)

   ToolMenuEntry.h  

static FToolMenuEntry InitToolBarButton ( const FName InName,
const FToolUIActionChoice& InAction,
const TAttribute< FText >& InLabel,
const TAttribute< FText >& InToolTip,
const TAttribute< FSlateIcon >& InIcon,
const EUserInterfaceActionType UserInterfaceActionType,
FName InTutorialHighlightName
)

   ToolMenuEntry.h  

static FToolMenuEntry InitToolBarButton ( const TSharedPtr< const FUICommandInfo >& InCommand,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
FName InTutorialHighlightName,
const TOptional< FName > InNameOverride
)

   ToolMenuEntry.h  

static FToolMenuEntry InitWidget ( const FName InName,
const TSharedRef< SWidget >& InWidget,
const FText& Label,
bool bNoIndent,
bool bSearchable,
bool bNoPadding,
const FText& InToolTipText
)

   ToolMenuEntry.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ToolMenuEntry.h  
  ToolMenuEntry.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page