#include <UICommandList.h>

Inheritance diagram for FUICommandList:

Public Member Functions
virtual	~FUICommandList ()

	DECLARE_DELEGATE_RetVal_OneParam (bool, FCanProduceActionForCommand, const TSharedRef< const FUICommandInfo > &)

SLATE_API void	MapAction (const TSharedPtr< const FUICommandInfo > InUICommandInfo, FExecuteAction ExecuteAction, EUIActionRepeatMode RepeatMode=EUIActionRepeatMode::RepeatDisabled)

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

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

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

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

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

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

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

SLATE_API void	Append (const TSharedRef< FUICommandList > &InCommandsToAppend)

SLATE_API void	UnmapAction (const TSharedPtr< const FUICommandInfo > InUICommandInfo)

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

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

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

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

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

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

SLATE_API bool	ProcessCommandBindings (const FKeyEvent &InKeyEvent) const

SLATE_API bool	ProcessCommandBindings (const FPointerEvent &InMouseEvent) const

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

void	SetCanProduceActionForCommand (const FCanProduceActionForCommand &NewCanProduceActionForCommand)

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

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

Public Member Functions inherited from TSharedFromThis< FUICommandList >
TSharedRef< FUICommandList, Mode >	AsShared ()

TSharedRef< FUICommandList const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< FUICommandList, Mode >	AsWeak ()

TWeakPtr< FUICommandList const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Protected Member Functions
SLATE_API bool	ConditionalProcessCommandBindings (const FKey Key, bool bCtrl, bool bAlt, bool bShift, bool bCmd, bool bRepeat) const

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

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

SLATE_API void	GatherContextsForList (TSet< FName > &OutAllContexts) const

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

Protected Member Functions inherited from TSharedFromThis< FUICommandList >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Friends
struct	RecursiveCommandDataGetter

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< FUICommandList >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Constructor & Destructor Documentation

◆ ~FUICommandList()

virtual FUICommandList::~FUICommandList ( )

inlinevirtual

Virtual destructor

Member Function Documentation

◆ Append()

void FUICommandList::Append ( const TSharedRef< FUICommandList > & InCommandsToAppend )

Append commands in InCommandsToAppend to this command list.

◆ CanExecuteAction()

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

Calls the CanExecuteAction associated with the provided command info to see if ExecuteAction can be called

Parameters

InUICommandInfo The command info execute

◆ ConditionalProcessCommandBindings()

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

protected

Helper function to execute delegate or exec command associated with a command (if valid)

Parameters

Key	The current key that is pressed
bCtrl	True if control is pressed
bAlt	True if alt is pressed
bShift	True if shift is pressed
bRepeat	True if command is repeating (held)

Returns: True if a command was executed, False otherwise

◆ DECLARE_DELEGATE_RetVal_OneParam()

FUICommandList::DECLARE_DELEGATE_RetVal_OneParam	(	bool	,
		FCanProduceActionForCommand	,
		const TSharedRef< const FUICommandInfo > &
	)

Determines if this UICommandList is capable of producing an action for the supplied command

◆ ExecuteAction()

bool FUICommandList::ExecuteAction ( const TSharedRef< const FUICommandInfo > InUICommandInfo ) const

virtual

Executes the action associated with the provided command info Note: It is assumed at this point that CanExecuteAction was already checked

Parameters

InUICommandInfo The command info execute

◆ GatherContextsForList()

void FUICommandList::GatherContextsForList ( TSet< FName > & OutAllContexts ) const

protected

Returns all contexts associated with this list. This is a wrapper for GatherContextsForListRecursively

◆ GatherContextsForListRecursively()

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

protected

Returns all contexts associated with this list.

◆ GetActionForCommand()

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

Attempts to find an action for the specified command in the current UICommandList. This is a wrapper for GetActionForCommandRecursively.

Parameters

Command The UI command for which you are discovering an action

◆ GetActionForCommandRecursively()

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

protected

Attempts to find an action for the specified command in the current UICommandList. If it is not found, the action for the specified command is discovered in the children recursively then the parents recursively.

Parameters

Command	The UI command for which you are discovering an action
bIncludeChildren	If true, children of this command list will be searched in the event that the action is not found
bIncludeParents	If true, parents of this command list will be searched in the event that the action is not found
OutVisitedLists	The set of visited lists during recursion. This is used to prevent cycles.

◆ GetCheckState()

ECheckBoxState FUICommandList::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

Parameters

InUICommandInfo The command info execute

◆ GetContextForCommand()

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

Attempts to find an context for the specified command in the current UICommandList. This is a wrapper for GetContextForCommandRecursively.

Parameters

Command The UI command for which you are discovering an action

◆ GetContextForCommandRecursively()

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

protected

Attempts to find an context for the specified command in the current UICommandList. If it is not found, the context for the specified command is discovered in the children recursively then the parents recursively.

Parameters

Command	The UI command for which you are discovering an action
bIncludeChildren	If true, children of this command list will be searched in the event that the action is not found
bIncludeParents	If true, parents of this command list will be searched in the event that the action is not found
OutVisitedLists	The set of visited lists during recursion. This is used to prevent cycles.

◆ GetVisibility()

EVisibility FUICommandList::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

Parameters

InUICommandInfo The command info execute

◆ IsActionMapped()

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

Checks if an action is already mapped

Returns: True if an action is already mapped or false otherwise

◆ MapAction() [1/8]

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

virtual

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

Parameters

InUICommandInfo	The command info to map
InUIAction	Action to map to this command

◆ MapAction() [2/8]

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

virtual

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

Parameters

InUICommandInfo	The command info to map
InUIAction	Action to map to this command
InUIActionContext	Action context to map to this command

◆ MapAction() [3/8]

void FUICommandList::MapAction	(	const TSharedPtr< const FUICommandInfo >	InUICommandInfo,
		FExecuteAction	ExecuteAction,
		EUIActionRepeatMode	RepeatMode = `EUIActionRepeatMode::RepeatDisabled`
	)

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

Parameters

InUICommandInfo	The command info to map
ExecuteAction	The delegate to call when the command should be executed
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

◆ MapAction() [4/8]

void FUICommandList::MapAction	(	const TSharedPtr< const FUICommandInfo >	InUICommandInfo,
		FExecuteAction	ExecuteAction,
		FCanExecuteAction	CanExecuteAction,
		EUIActionRepeatMode	RepeatMode = `EUIActionRepeatMode::RepeatDisabled`
	)

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

Parameters

InUICommandInfo	The command info to map
ExecuteAction	The delegate to call when the command should be executed
CanExecuteAction	The delegate to call to see if the command can be executed
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

◆ MapAction() [5/8]

void FUICommandList::MapAction	(	const TSharedPtr< const FUICommandInfo >	InUICommandInfo,
		FExecuteAction	ExecuteAction,
		FCanExecuteAction	CanExecuteAction,
		FGetActionCheckState	GetActionCheckState,
		EUIActionRepeatMode	RepeatMode = `EUIActionRepeatMode::RepeatDisabled`
	)

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

Parameters

InUICommandInfo	The command info to map
ExecuteAction	The delegate to call when the command should be executed
CanExecuteAction	The delegate to call to see if the command can be executed
GetActionCheckState	The delegate to call to see what the check state of the action should be when visualized in a multibox
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

◆ MapAction() [6/8]

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

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

Parameters

InUICommandInfo	The command info to map
ExecuteAction	The delegate to call when the command should be executed
CanExecuteAction	The delegate to call to see if the command can be executed
GetActionCheckState	The delegate to call to see what the check state of the action should be when visualized in a multibox
IsVisibleDelegate	The delegate to call to see if the command should appear or be hidden when visualized in a multibox
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

◆ MapAction() [7/8]

void FUICommandList::MapAction	(	const TSharedPtr< const FUICommandInfo >	InUICommandInfo,
		FExecuteAction	ExecuteAction,
		FCanExecuteAction	CanExecuteAction,
		FIsActionChecked	IsCheckedDelegate,
		EUIActionRepeatMode	RepeatMode = `EUIActionRepeatMode::RepeatDisabled`
	)

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

Parameters

InUICommandInfo	The command info to map
ExecuteAction	The delegate to call when the command should be executed
CanExecuteAction	The delegate to call to see if the command can be executed
IsCheckedDelegate	The delegate to call to see if the command should appear checked when visualized in a multibox
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

◆ MapAction() [8/8]

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

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

Parameters

InUICommandInfo	The command info to map
ExecuteAction	The delegate to call when the command should be executed
CanExecuteAction	The delegate to call to see if the command can be executed
IsCheckedDelegate	The delegate to call to see if the command should appear checked when visualized in a multibox
IsVisibleDelegate	The delegate to call to see if the command should appear or be hidden when visualized in a multibox
RepeatMode	Can this action can be repeated if the chord used to call it is held down?

◆ ProcessCommandBindings() [1/3]

bool FUICommandList::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

Parameters

Key	The current key that is pressed
ModifierKeysState	Pressed state of keys that are commonly used as modifiers
bRepeat	True if input is repeating (held)

Returns: true if an action was processed

◆ ProcessCommandBindings() [2/3]

bool FUICommandList::ProcessCommandBindings ( const FKeyEvent & InKeyEvent ) const

Processes any UI commands which are activated by the specified key event

Parameters

InKeyEvent The key event to check

Returns: true if an action was processed

◆ ProcessCommandBindings() [3/3]

bool FUICommandList::ProcessCommandBindings ( const FPointerEvent & InMouseEvent ) const

Processes any UI commands which are activated by the specified mouse event

Parameters

InKeyEvent The mouse event to check

Returns: true if an action was processed

◆ SetCanProduceActionForCommand()

void FUICommandList::SetCanProduceActionForCommand ( const FCanProduceActionForCommand & NewCanProduceActionForCommand )

inline

Sets the delegate that determines if this UICommandList is capable of producing an action for the supplied command

◆ TryExecuteAction()

bool FUICommandList::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

Parameters

InUICommandInfo The command info execute

◆ UnmapAction()

void FUICommandList::UnmapAction ( const TSharedPtr< const FUICommandInfo > InUICommandInfo )

Unmaps a command info that was previously mapped

Parameters

InUICommandInfo The command info to unmap

Friends And Related Symbol Documentation

◆ RecursiveCommandDataGetter

friend struct RecursiveCommandDataGetter

friend

Helper struct for list recursion

The documentation for this class was generated from the following files:

Engine/Source/Runtime/Slate/Public/Framework/Commands/UICommandList.h
Engine/Source/Runtime/Slate/Private/Framework/Commands/UICommandList.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~FUICommandList()

Member Function Documentation

◆ Append()

◆ CanExecuteAction()

◆ ConditionalProcessCommandBindings()

◆ DECLARE_DELEGATE_RetVal_OneParam()

◆ ExecuteAction()

◆ GatherContextsForList()

◆ GatherContextsForListRecursively()

◆ GetActionForCommand()

◆ GetActionForCommandRecursively()

◆ GetCheckState()

◆ GetContextForCommand()

◆ GetContextForCommandRecursively()

◆ GetVisibility()

◆ IsActionMapped()

◆ MapAction() [1/8]

◆ MapAction() [2/8]

◆ MapAction() [3/8]

◆ MapAction() [4/8]

◆ MapAction() [5/8]

◆ MapAction() [6/8]

◆ MapAction() [7/8]

◆ MapAction() [8/8]

◆ ProcessCommandBindings() [1/3]

◆ ProcessCommandBindings() [2/3]

◆ ProcessCommandBindings() [3/3]

◆ SetCanProduceActionForCommand()

◆ TryExecuteAction()

◆ UnmapAction()

Friends And Related Symbol Documentation

◆ RecursiveCommandDataGetter