Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UInputKeySelector

A widget for selecting a single key or a single key with a modifier.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UInputKeySelector

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/InputKeySelector.h
Include	#include "Components/InputKeySelector.h"

Syntax

class UInputKeySelector : public UWidget

Remarks

A widget for selecting a single key or a single key with a modifier.

Variables

	Name	Description
bool	bAllowGamepadKeys	When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored.
bool	bAllowModifierKeys	When true modifier keys such as control and alt are allowed in the input chord representing the selected key, if false modifier keys are ignored.
TArray< FKey >	EscapeKeys	When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored.
FText	KeySelectionText	Sets the text which is displayed while selecting keys.
FMargin	Margin	The amount of blank space around the text used to display the currently selected key.
FText	NoKeySpecifiedText	Sets the text to display when no key text is available or not selecting a key.
FOnIsSelectingK...	OnIsSelectingKeyChanged	Called whenever the key selection mode starts or stops.
FOnKeySelected	OnKeySelected	Called whenever a new key is selected by the user.
FInputChord	SelectedKey	The currently selected key chord.
FTextBlockStyle	TextStyle	The button style used at runtime
FButtonStyle	WidgetStyle	The button style used at runtime

Constructors

	Name	Description
	UInputKeySelector ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	GetIsSelectingKey()	Returns true if the widget is currently selecting a key, otherwise returns false.
void	SetAllowGamepadKeys ( bool bInAllowGamepadKeys )	Sets whether or not gamepad keys are allowed in the selected key.
void	SetAllowModifierKeys ( bool bInAllowModifierKeys )	Sets whether or not modifier keys are allowed in the selected key.
void	SetButtonStyle ( const FButtonStyle* ButtonStyl... )	Sets the style of the button used to start key selection mode.
void	SetEscapeKeys ( const TArray< FKey >& InKeys )	Sets escape keys.
void	SetKeySelectionText ( FText InKeySelectionText )	Sets the text which is displayed while selecting keys.
void	SetNoKeySpecifiedText ( FText InNoKeySpecifiedText )	Sets the text to display when no key text is available or not selecting a key.
void	SetSelectedKey ( const FInputChord& InSelectedKey )	Sets the currently selected key.
void	SetTextBlockVisibility ( const ESlateVisibility InVisibility )	Sets the visibility of the text block.

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FOnIsSelectingKeyChanged
	FOnKeySelected

Deprecated Variables

		Name	Description
	FLinearColor	ColorAndOpacity_DEPRECATED
	FSlateFontInfo	Font_DEPRECATED