1. Epic GamesDeveloper
  3. FUICommandInfo

FUICommandInfo

Unreal Engine C++ API Reference > Runtime > Slate > Framework > Commands

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/Commands/UICommandInfo.h
Include #include "Framework/Commands/UICommandInfo.h"

Syntax

class FUICommandInfo

Constructors

  Type Name Description
Public function  

FUICommandInfo ( const FName InBindingContext
)

 Creates and initializes a new instance.

Functions

  Type Name Description
Public function Const const TSharedRef< const FInputChord >

GetActiveChord ( const EMultipleKeyBindingIndex InChordIndex
)

  
Public function Const FName  
Public function Const FName  
Public function Const FName  
Public function Const const FInputChord &

GetDefaultChord ( const EMultipleKeyBindingIndex InChordIndex
)

  
Public function Const const FText &  
Public function Const const TSharedRef< const FInputChord >  
Public function Const const FSlateIcon &

GetIcon ()

  
Public function Const const FText 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 &  
Public function Const bool  
Public function Const EUserInterfaceActionType  
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 FBindingContext >& InContext,
TSharedPtr< FUICommandInfo >& OutCommand,
const FName InCommandName,
const FText& InCommandLabel,
const FText& InCommandDesc,
const FSlateIcon& InIcon,
const EUserInterfaceActionType InUserInterfaceType,
const FInputChord& InDefaultChord,
const FInputChord& InAlternateDefaultChord,
const FName InBundle
)

 Utility function to make an FUICommandInfo
Public function Const TSharedRef< class SToolTip >

MakeTooltip ( const TAttribute< FText >& InText,
const TAttribute< EVisibility >& InToolTipVisibility
)

 Makes a tooltip for this command.
Public function void Removes the active chord from this command
Public function void

SetActiveChord ( const FInputChord& NewChord,
const EMultipleKeyBindingIndex InChordIndex
)

 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 FBindingContext >& InContext,
const TSharedRef< FUICommandInfo >& InCommand
)

 Utility function to unregister an FUICommandInfo

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page