1. Epic GamesDeveloper
  3. FUICommandInfo

FUICommandInfo

API > API/Runtime > API/Runtime/Slate

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

Syntax

class FUICommandInfo

Constructors

Name Remarks Include Path Unreal Specifiers

FUICommandInfo ( const FName InBindingContext
)

 Creates and initializes a new instance. Framework/Commands/UICommandInfo.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveChords TArray< TSharedRef< FInputChord > > Input commands that executes this action Framework/Commands/UICommandInfo.h  
BindingContext FName The context in which this command is active Framework/Commands/UICommandInfo.h  
Bundle FName The bundle to group this command into. The bundle must have been added to the BindingContext first. Framework/Commands/UICommandInfo.h  
bUseLongDisplayName bool True if should we use long names for when getting text for input chords Framework/Commands/UICommandInfo.h  
CommandName FName Name of the command Framework/Commands/UICommandInfo.h  
DefaultChords TArray< FInputChord > The default input chords for this command (can be invalid) Framework/Commands/UICommandInfo.h  
Description FText Localized help text for this command Framework/Commands/UICommandInfo.h  
Icon FSlateIcon Brush name for icon to use in tool bars and menu items to represent this command Framework/Commands/UICommandInfo.h  
Label FText Default display name of the command Framework/Commands/UICommandInfo.h  
UIStyle FName Brush name for icon to use in tool bars and menu items to represent this command in its toggled on (checked) state Framework/Commands/UICommandInfo.h  
UserInterfaceType EUserInterfaceActionType The type of user interface to associated with this action Framework/Commands/UICommandInfo.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TSharedRef< const FInputChord > GetActiveChord ( const EMultipleKeyBindingIndex InChordIndex
) const

   Framework/Commands/UICommandInfo.h  

FName GetBindingContext()

   Framework/Commands/UICommandInfo.h  

FName GetBundle()

   Framework/Commands/UICommandInfo.h  

FName GetCommandName()

   Framework/Commands/UICommandInfo.h  

const FInputChord & GetDefaultChord ( const EMultipleKeyBindingIndex InChordIndex
) const

   Framework/Commands/UICommandInfo.h  

const FText & GetDescription()

   Framework/Commands/UICommandInfo.h  

const TSharedRef< const FInputChord > GetFirstValidChord()

   Framework/Commands/UICommandInfo.h  

const FSlateIcon & GetIcon()

   Framework/Commands/UICommandInfo.h  

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

const FText & GetLabel()

   Framework/Commands/UICommandInfo.h  

bool GetUseLongDisplayName()

   Framework/Commands/UICommandInfo.h  

EUserInterfaceActionType GetUserInterfaceType()

   Framework/Commands/UICommandInfo.h  

const bool HasActiveChord ( const FInputChord InChord
) const

   Framework/Commands/UICommandInfo.h  

const bool HasDefaultChord ( const FInputChord InChord
) const

   Framework/Commands/UICommandInfo.h  

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

 Makes a tooltip for this command. Framework/Commands/UICommandInfo.h  

void RemoveActiveChord ( const EMultipleKeyBindingIndex InChordIndex
)

 Removes the active chord from this command Framework/Commands/UICommandInfo.h  

void SetActiveChord ( const FInputChord& NewChord,
const EMultipleKeyBindingIndex InChordIndex
)

 Sets the new active chord for this command Framework/Commands/UICommandInfo.h  

void SetUseLongDisplayName ( const bool bInUseLongDisplayName
)

 Sets if we should use a long display name or not Framework/Commands/UICommandInfo.h  

Static

Name Remarks Include Path Unreal Specifiers

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

static void UnregisterCommandInfo ( const TSharedRef< class FBindingContext >& InContext,
const TSharedRef< FUICommandInfo >& InCommand
)

 Utility function to unregister an FUICommandInfo Framework/Commands/UICommandInfo.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page