1. Epic GamesDeveloper
  3. FInputChord

FInputChord

An Input Chord is a key and the modifier keys that are to be held with it.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Commands

References

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

Syntax

USTRUCT (BlueprintType )  
struct FInputChord

Remarks

An Input Chord is a key and the modifier keys that are to be held with it.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bAlt Whether the alt key is part of the chord.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bCmd Whether the command key is part of the chord.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bCtrl Whether the control key is part of the chord.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bShift Whether the shift key is part of the chord.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FKey Key The Key is the core of the chord.

Constructors

  Type Name Description
Public function    
Public function  

FInputChord ( const FKey InKey
)

  
Public function  

FInputChord ( const FInputChord& Other
)

 Copy constructor.
Public function  

FInputChord ( FInputChord&& Other
)

 Move constructor.
Public function  

FInputChord ( const EModifierKey::Type InModifierKeys,
const FKey InKey
)

 Creates and initializes a new instance.
Public function  

FInputChord ( const FKey InKey,
const EModifierKey::Type InModifierKeys
)

 Creates and initializes a new instance.
Public function  

FInputChord ( const FKey InKey,
const bool bInShift,
const bool bInCtrl,
const bool bInAlt,
const bool bInCmd
)

  

Functions

  Type Name Description
Public function Const FText

GetInputText ( const bool bLongDisplayName
)

 Gets a localized string that represents the chord.
Public function Const FText

GetKeyText ( const bool bLongDisplayName
)

 Gets the key represented as a localized string.
Public function Const FText

GetModifierText ( TOptional< FText > ModifierAppender
)

 Gets the localized string for the modifier portion of the coord.
Public function Const ERelationshipType

GetRelationship ( const FInputChord& OtherChord
)

 Returns the relationship between this chord and another.
Public function Const bool Checks whether this chord requires an modifier keys to be pressed.
Public function Const bool Determines if this chord is valid.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void

Set ( const FInputChord& InTemplate
)

 Sets this chord to a new key and modifier state based on the provided template Should not be called directly.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FInputChord& Other
)

 Compares this input chord with another for inequality.
Public function FInputChord &

operator= ( const FInputChord& Other
)

 Copy assignment operator.
Public function FInputChord &

operator= ( FInputChord&& Other
)

 Move assignment operator.
Public function Const bool

operator== ( const FInputChord& Other
)

 Compares this input chord with another for equality.

Enums

  Type Name Description
Public enum ERelationshipType The ways two chords can be related to each other.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page