1. Epic GamesDeveloper
  3. FUICommandList

FUICommandList

API > API/Runtime > API/Runtime/Slate

   
Name FUICommandList
Type class
Header File /Engine/Source/Runtime/Slate/Public/Framework/Commands/UICommandList.h
Include Path #include "Framework/Commands/UICommandList.h"

Syntax

class FUICommandList : public TSharedFromThis< FUICommandList >

Inheritance Hierarchy

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FUICommandList()

 Virtual destructor Framework/Commands/UICommandList.h  

Typedefs

Name Type Remarks Include Path
FCanProduceActionForCommand TBaseDelegate_OneParam< bool, const TSharedRef< const FUICommandInfo > & > Determines if this UICommandList is capable of producing an action for the supplied command Framework/Commands/UICommandList.h
FUIBindingMap TMap< const TSharedPtr< const FUICommandInfo >, FUIAction >   Framework/Commands/UICommandList.h
FUIContextMap TMap< const TSharedPtr< const FUICommandInfo >, FUIActionContext >   Framework/Commands/UICommandList.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CanProduceActionForCommand FCanProduceActionForCommand Determines if this UICommandList is capable of producing an action for the supplied command Framework/Commands/UICommandList.h  
ChildUICommandLists TArray< TWeakPtr< FUICommandList > >   Framework/Commands/UICommandList.h  
ContextsInList TSet< FName > Known contexts in this list. Framework/Commands/UICommandList.h  
ParentUICommandLists TArray< TWeakPtr< FUICommandList > > The list of parent and children UICommandLists Framework/Commands/UICommandList.h  
UICommandBindingMap FUIBindingMap Mapping of command to action Framework/Commands/UICommandList.h  
UICommandContextMap FUIContextMap Mapping of command to action context, used for special cases and thus much more sparse Framework/Commands/UICommandList.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Append ( const TSharedRef< FUICommandList >& InCommandsToAppend
)

 Append commands in InCommandsToAppend to this command list. Framework/Commands/UICommandList.h  

bool CanExecuteAction ( const TSharedRef< const FUICommandInfo > InUICommandInfo
) const

 Calls the CanExecuteAction associated with the provided command info to see if ExecuteAction can be called Framework/Commands/UICommandList.h  

virtual bool ExecuteAction ( const TSharedRef< const FUICommandInfo > InUICommandInfo
) const

 Executes the action associated with the provided command info Note: It is assumed at this point that CanExecuteAction was already checked Framework/Commands/UICommandList.h  

const FUIAction * GetActionForCommand ( TSharedPtr< const FUICommandInfo > Command
) const

 Attempts to find an action for the specified command in the current UICommandList. Framework/Commands/UICommandList.h  

ECheckBoxState GetCheckState ( const TSharedRef< const FUICommandInfo > InUICommandInfo
) const

 Calls the GetCheckState delegate to see if the visualization of this command in a multibox should appear checked Framework/Commands/UICommandList.h  

const FUIActionContext * GetContextForCommand ( TSharedPtr< const FUICommandInfo > Command
) const

 Attempts to find an context for the specified command in the current UICommandList. Framework/Commands/UICommandList.h  

EVisibility GetVisibility ( const TSharedRef< const FUICommandInfo > InUICommandInfo
) const

 Calls the IsVisible delegate associated with the provided command info to see if the command should be visible in a toolbar Framework/Commands/UICommandList.h  

bool IsActionMapped ( const TSharedPtr< const FUICommandInfo > InUICommandInfo
) const

 Checks if an action is already mapped Framework/Commands/UICommandList.h  

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 Framework/Commands/UICommandList.h  

void MapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo,
FExecuteAction ExecuteAction,
EUIActionRepeatMode RepeatMode
)

 Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input Framework/Commands/UICommandList.h  

virtual void MapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo,
const FUIAction& InUIAction,
const FUIActionContext& InUIActionContext
)

 Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input Additionally, add a container of context objects to also associate with this command Framework/Commands/UICommandList.h  

void MapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo,
FExecuteAction ExecuteAction,
FCanExecuteAction CanExecuteAction,
EUIActionRepeatMode RepeatMode
)

 Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input Framework/Commands/UICommandList.h  

void MapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo,
FExecuteAction ExecuteAction,
FCanExecuteAction CanExecuteAction,
FIsActionChecked IsCheckedDelegate,
EUIActionRepeatMode RepeatMode
)

 Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input Framework/Commands/UICommandList.h  

void MapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo,
FExecuteAction ExecuteAction,
FCanExecuteAction CanExecuteAction,
FGetActionCheckState GetActionCheckState,
EUIActionRepeatMode RepeatMode
)

 Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input Framework/Commands/UICommandList.h  

void MapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo,
FExecuteAction ExecuteAction,
FCanExecuteAction CanExecuteAction,
FIsActionChecked IsCheckedDelegate,
FIsActionButtonVisible IsVisibleDelegate,
EUIActionRepeatMode RepeatMode
)

 Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input Framework/Commands/UICommandList.h  

void MapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo,
FExecuteAction ExecuteAction,
FCanExecuteAction CanExecuteAction,
FGetActionCheckState GetActionCheckState,
FIsActionButtonVisible IsVisibleDelegate,
EUIActionRepeatMode RepeatMode
)

 Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input Framework/Commands/UICommandList.h  

bool ProcessCommandBindings ( const FKeyEvent& InKeyEvent
) const

 Processes any UI commands which are activated by the specified key event Framework/Commands/UICommandList.h  

bool ProcessCommandBindings ( const FPointerEvent& InMouseEvent
) const

 Processes any UI commands which are activated by the specified mouse event Framework/Commands/UICommandList.h  

bool ProcessCommandBindings ( const FKey Key,
const FModifierKeysState& ModifierKeysState,
const bool bRepeat
) const

 Processes any UI commands which are activated by the specified key, modifier keys state and input event Framework/Commands/UICommandList.h  

void SetCanProduceActionForCommand ( const FCanProduceActionForCommand& NewCanProduceActionForCommand
)

 Sets the delegate that determines if this UICommandList is capable of producing an action for the supplied command Framework/Commands/UICommandList.h  

bool TryExecuteAction ( const TSharedRef< const FUICommandInfo > InUICommandInfo
) const

 Attempts to execute the action associated with the provided command info Note: This will check if the action can be executed before finally executing the action Framework/Commands/UICommandList.h  

void UnmapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo
)

 Unmaps a command info that was previously mapped Framework/Commands/UICommandList.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool ConditionalProcessCommandBindings ( const FKey Key,
bool bCtrl,
bool bAlt,
bool bShift,
bool bCmd,
bool bRepeat
) const

 Helper function to execute delegate or exec command associated with a command (if valid) Framework/Commands/UICommandList.h  

void GatherContextsForList ( TSet< FName >& OutAllContexts
) const

 Returns all contexts associated with this list. Framework/Commands/UICommandList.h  

void GatherContextsForListRecursively ( TSet< FName >& OutAllContexts,
TSet< TSharedRef< const FUICommandList > >& InOutVisitedLists
) const

 Returns all contexts associated with this list. Framework/Commands/UICommandList.h  

const FUIAction * GetActionForCommandRecursively ( const TSharedRef< const FUICommandInfo >& Command,
bool bIncludeChildren,
bool bIncludeParents,
TSet< TSharedRef< const FUICommandList > >& InOutVisitedLists
) const

 Attempts to find an action for the specified command in the current UICommandList. Framework/Commands/UICommandList.h  

const FUIActionContext * GetContextForCommandRecursively ( const TSharedRef< const FUICommandInfo >& Command,
bool bIncludeChildren,
bool bIncludeParents,
TSet< TSharedRef< const FUICommandList > >& InOutVisitedLists
) const

 Attempts to find an context for the specified command in the current UICommandList. Framework/Commands/UICommandList.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page