1. Epic GamesDeveloper
  3. FToolMenuEntry

FToolMenuEntry

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

API > API/Developer > API/Developer/ToolMenus

References

   
Module ToolMenus
Header /Engine/Source/Developer/ToolMenus/Public/ToolMenuEntry.h
Include #include "ToolMenuEntry.h"

Syntax

USTRUCT (BlueprintType )  
struct FToolMenuEntry

Remarks

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.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShouldCloseWindowAfterMenuSelection  
Public variable TAttribute< FSlateIcon > Icon  
Public variable TAttribute< FText > InputBindingLabel  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FToolMenuInsert InsertPosition  
Public variable TAttribute< FText > Label  
Public variable FNewToolMenuCustomWidget MakeCustomWidget Optional delegate that returns a widget to use as this menu entry
Public variable FNewToolMenuWidget MakeWidget  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName Name  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FToolMenuOwner Owner  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UToolMenuEntryScript > ScriptObject  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName StyleNameOverride  
Public variable FToolMenuEntrySubMenuData SubMenuData  
Public variable FToolMenuEntryToolBarData ToolBarData  
Public variable TAttribute< FText > ToolTip  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName TutorialHighlightName  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EMultiBlockType Type  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EUserInterfaceActionType UserInterfaceActionType  
Public variable FToolMenuEntryWidgetData WidgetData  

Constructors

  Type Name Description
Public function    
Public function    
Public function    
Public function  

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

  

Functions

  Type Name Description
Public function void

AddKeybindFromCommand ( const TSharedPtr< const FUICommandInfo >& InCommand
)

  
Public function void

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

  
Public function Const bool

CommandAcceptsInput ( const FKeyEvent& InKeyEvent
)

  
Public function Const const FUIAction *

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

  
Public function 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
)

  
Public function Static FToolMenuEntry

InitDynamicEntry ( const FName InName,
const FNewToolMenuSectionDelegate& InConstruct
)

  
Public function 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
)

  
Public function 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
)

  
Public function 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
)

  
Public function Static FToolMenuEntry

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

  
Public function 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
)

  
Public function Static FToolMenuEntry

InitSeparator ( const FName InName
)

  
Public function 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
)

  
Public function Static FToolMenuEntry

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

  
Public function 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
)

  
Public function 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
)

  
Public function 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
)

  
Public function Static FToolMenuEntry

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

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void

SetCommandList ( const TSharedPtr< const FUICommandList >& InCommandList
)

  
Public function void

SetShowInToolbarTopLevel ( TAttribute< bool > InTopLevel
)

 Show this menu entry in the top-level toolbar section of a toolbar.
Public function bool  

Operators

  Type Name Description
Public function FToolMenuEntry &  
Public function FToolMenuEntry &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page