1. Epic GamesDeveloper
  3. FUICommandList_Pinnable

FUICommandList_Pinnable

Extended version of [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) that allows:

API > API/Editor > API/Editor/PinnedCommandList

Inheritance Hierarchy

References

   
Module PinnedCommandList
Header /Engine/Source/Editor/PinnedCommandList/Public/UICommandList_Pinnable.h
Include #include "UICommandList_Pinnable.h"

Syntax

class FUICommandList_Pinnable : public FUICommandList

Remarks

Extended version of FUICommandList that allows:

  • Hooks into action dispatch, to allow commands to be forwarded for pinning
  • Indexing when mapping to provide a sort key
  • Optional grouping of actions

Variables

  Type Name Description
Protected variable TMap< FName, FName > CommandGroupMap Map providing a group for each command that was mapped via this command list
Protected variable TMap< FName, int32 > CommandIndexMap Map providing an index for each command that was mapped via this command list
Protected variable int32 CurrentActionIndex Index used to provide a sort key for actions when mapped
Protected variable FName CurrentGroupName Current group name
Protected variable FOnCustomWidgetInteraction OnCustomWidgetInteractionDelegate Delegate called when a custom widget is interacted with
Protected variable FOnExecuteAction OnExecuteActionDelegate Delegate called when an action is executed

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

BeginGroup ( FName InGroupName
)

 Start a group scope.
Public function void End a group scope.
Public function Const FName

GetMappedCommandGroup ( FName InCommandName
)

 Get the group this command was mapped into.
Public function Const int32

GetMappedCommandIndex ( FName InCommandName
)

 Get the index this command was mapped to.
Public function FOnCustomWidgetInteraction & Delegate called when an custom widget is interacted with
Public function FOnExecuteAction & Delegate called when an action is executed
Public function Const void

WidgetInteraction ( FName InCustomWidgetIdentifier
)

 Mark that a custom widget was interacted with

Overridden from FUICommandList

  Type Name Description
Public function Virtual Const bool

ExecuteAction ( const TSharedRef< const FUICommandInfo > InUICommandInfo
)

 FUICommandList interface
Public function Virtual void

MapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo,
const FUIAction& InUIAction
)

 Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input

Typedefs

Name Description
FOnCustomWidgetInteraction Delegate called when a custom widget is interacted with
FOnExecuteAction Delegate called when an action is executed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page