FInputChord

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

Choose your operating system:

Windows

macOS

Linux

References

Module

Slate

Header

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

Include

#include "Framework/Commands/InputChord.h"

Syntax

struct FInputChord

Remarks

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

Variables

Name Description

Public variable

uint32: 1

 

bAlt

Whether the alt key is part of the chord.

Public variable

uint32: 1

 

bCmd

Whether the command key is part of the chord.

Public variable

uint32: 1

 

bCtrl

Whether the control key is part of the chord.

Public variable

uint32: 1

 

bShift

Whether the shift key is part of the chord.

Public variable

FKey

 

Key

The Key is the core of the chord.

Constructors

Name Description

Public function

FInputChord()

Public function

FInputChord

(
    const FKey InKey
)

Public function

FInputChord

(
    const FInputChord& Other
)

Copy constructor.

Public function

FInputChord

(
    const EModifierKey::Type InModifier...,
    const FKey InKey
)

Creates and initializes a new instance.

Public function

FInputChord

(
    const FKey InKey,
    const EModifierKey::Type InModifier...
)

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

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

ERelationshi...

 

GetRelationship

(
    const FInputChord& OtherChord
)

Returns the relationship between this chord and another.

Public function Const

bool

 

HasAnyModifierKeys()

Checks whether this chord requires an modifier keys to be pressed.

Public function Const

bool

 

IsValidChord()

Determines if this chord is valid.

Public function Const

bool

 

NeedsAlt()

Public function Const

bool

 

NeedsCommand()

Public function Const

bool

 

NeedsControl()

Public function Const

bool

 

NeedsShift()

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

Name Description

Public function Const

bool

 

operator!=

(
    const FInputChord& Other
)

Compares this input chord with another for inequality.

Public function Const

bool

 

operator==

(
    const FInputChord& Other
)

Compares this input chord with another for equality.

Enums

Name

Description

Public enum

ERelationshipType

The ways two chords can be related to each other.