FUICommandInfo

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Commands/UICommandInfo.h

Include

#include "Framework/Commands/UICommandInfo.h"

Syntax

class FUICommandInfo

Constructors

Name Description

Public function

FUICommandInfo

(
    const FName InBindingContext
)

Creates and initializes a new instance.

Functions

Name Description

Public function Const

const TShare...

 

GetActiveChord

(
    const EMultipleKeyBindingIndex InCh...
)

Public function Const

FName

 

GetBindingContext()

Public function Const

FName

 

GetBundle()

Public function Const

FName

 

GetCommandName()

Public function Const

const FInput...

 

GetDefaultChord

(
    const EMultipleKeyBindingIndex InCh...
)

Public function Const

const FText ...

 

GetDescription()

Public function Const

const TShare...

 

GetFirstValidChord()

Public function Const

const FSlate...

 

GetIcon()

Public function Const

const FText

 

GetInputText()

Returns the friendly, localized string name of the first valid chord in the key bindings list that is required to perform the command

Public function Const

const FText ...

 

GetLabel()

Public function Const

bool

 

GetUseLongDisplayName()

Public function Const

EUserInterfa...

 

GetUserInterfaceType()

Public function Const

const bool

 

HasActiveChord

(
    const FInputChord InChord
)

Public function Const

const bool

 

HasDefaultChord

(
    const FInputChord InChord
)

Public function Static

void

 

MakeCommandInfo

(
    const TSharedRef< class FBindingCon...,
    TSharedPtr< FUICommandInfo >& OutC...,
    const FName InCommandName,
    const FText& InCommandLabel,
    const FText& InCommandDesc,
    const FSlateIcon& InIcon,
    const EUserInterfaceActionType InUs...,
    const FInputChord& InDefaultChord,
    const FInputChord& InAlternateDefa...,
    const FName InBundle
)

Utility function to make an FUICommandInfo

Public function Const

TSharedRef< ...

 

MakeTooltip

(
    const TAttribute< FText >& InText,
    const TAttribute< EVisibility >& I...
)

Makes a tooltip for this command.

Public function

void

 

RemoveActiveChord

(
    const EMultipleKeyBindingIndex InCh...
)

Removes the active chord from this command

Public function

void

 

SetActiveChord

(
    const FInputChord& NewChord,
    const EMultipleKeyBindingIndex InCh...
)

Sets the new active chord for this command

Public function

void

 

SetUseLongDisplayName

(
    const bool bInUseLongDisplayName
)

Sets if we should use a long display name or not

Public function Static

void

 

UnregisterCommandInfo

(
    const TSharedRef< class FBindingCon...,
    const TSharedRef< FUICommandInfo > ...
)

Utility function to unregister an FUICommandInfo
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel