Language:
Discover
By Skill Level
By Category

FUICommandList

Choose your OS:

Inheritance Hierarchy

Syntax

class FUICommandList : public TSharedFromThis< FUICommandList >

Destructors

Name Description

Public function Virtual

~FUICommandList()

Virtual destructor

Functions

Name Description

Public function

void

 

Append

(
    const TSharedRef < FUICommandList > ...
)

Append commands in InCommandsToAppend to this command list.

Public function

bool

 

CanExecuteAction

(
    const TSharedRef < const FUICommandI ...
)

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

Protected function

bool

 

ConditionalProcessCommandBindings

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

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

Public function Virtual

bool

 

ExecuteAction

(
    const TSharedRef < const FUICommandI ...
)

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

Protected function

void

 

GatherContextsForList

(
    TSet < FName >& OutAllContexts
)

Returns all contexts associated with this list.

Protected function

void

 

GatherContextsForListRecursively

(
    TSet < FName >& OutAllContexts,
    TSet < TSharedRef < const FUICommandL ...
)

Returns all contexts associated with this list.

Public function

const FUIAct ...

 

GetActionForCommand

(
    TSharedPtr < const FUICommandInfo > ...
)

Attempts to find an action for the specified command in the current UICommandList.

Protected function

const FUIAct ...

 

GetActionForCommandRecursively

(
    const TSharedRef < const FUICommandI ...,
    bool bIncludeChildren,
    bool bIncludeParents,
    TSet < TSharedRef < const FUICommandL ...
)

Attempts to find an action for the specified command in the current UICommandList.

Public function

ECheckBoxSta ...

 

GetCheckState

(
    const TSharedRef < const FUICommandI ...
)

Calls the GetCheckState delegate to see if the visualization of this command in a multibox should appear checked

Public function

EVisibility

 

GetVisibility

(
    const TSharedRef < const FUICommandI ...
)

Calls the IsVisible delegate associated with the provided command info to see if the command should be visible in a toolbar

Public function

bool

 

IsActionMapped

(
    const TSharedPtr < const FUICommandI ...
)

Checks if an action is already mapped

True if an action is already mapped or false otherwise

Public function

void

 

MapAction

(
    const TSharedPtr < const FUICommandI ...,
    FExecuteAction ExecuteAction,
    FCanExecuteAction CanExecuteAction,
    FGetActionCheckState GetActionCheck...,
    FIsActionButtonVisible IsVisibleDel...,
    EUIActionRepeatMode RepeatMode
)

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

Public function

void

 

MapAction

(
    const TSharedPtr < const FUICommandI ...,
    FExecuteAction ExecuteAction,
    FCanExecuteAction CanExecuteAction,
    FIsActionChecked IsCheckedDelegate,
    FIsActionButtonVisible IsVisibleDel...,
    EUIActionRepeatMode RepeatMode
)

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

Public function Virtual

void

 

MapAction

(
    const TSharedPtr < const FUICommandI ...,
    const FUIAction & InUIAction
)

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

Public function

void

 

MapAction

(
    const TSharedPtr < const FUICommandI ...,
    FExecuteAction ExecuteAction,
    EUIActionRepeatMode RepeatMode
)

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

Public function

void

 

MapAction

(
    const TSharedPtr < const FUICommandI ...,
    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

Public function

void

 

MapAction

(
    const TSharedPtr < const FUICommandI ...,
    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

Public function

void

 

MapAction

(
    const TSharedPtr < const FUICommandI ...,
    FExecuteAction ExecuteAction,
    FCanExecuteAction CanExecuteAction,
    FGetActionCheckState GetActionCheck...,
    EUIActionRepeatMode RepeatMode
)

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

Public function

bool

 

ProcessCommandBindings

(
    const FKeyEvent & InKeyEvent
)

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

Public function

bool

 

ProcessCommandBindings

(
    const FKey Key,
    const FModifierKeysState & Modifier...,
    const bool bRepeat
)

Processes any UI commands which are activated by the specified key, modifier keys state and input event

Public function

bool

 

ProcessCommandBindings

(
    const FPointerEvent & InMouseEvent
)

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

Public function

void

 

SetCanProduceActionForCommand

(
    const FCanProduceActionForCommand &...
)

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

Public function

bool

 

TryExecuteAction

(
    const TSharedRef < const FUICommandI ...
)

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

Public function

void

 

UnmapAction

(
    const TSharedPtr < const FUICommandI ...
)

Unmaps a command info that was previously mapped

Typedefs

Name

Description

FCanProduceActionForCommand

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

FUIBindingMap

References

Module

Slate

Header

Runtime/Slate/Public/Framework/Commands/UICommandList.h