1. Epic GamesDeveloper
  3. SInputKeySelector

SInputKeySelector

A widget for selecting keys or input chords.

API > API/Runtime > API/Runtime/Slate

A widget for selecting keys or input chords.

   
Name SInputKeySelector
Type class
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Input/SInputKeySelector.h
Include Path #include "Widgets/Input/SInputKeySelector.h"

Syntax

class SInputKeySelector : public SCompoundWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
FOnIsSelectingKeyChanged TBaseDelegate_NoParams< void >   Widgets/Input/SInputKeySelector.h
FOnKeySelected TBaseDelegate_OneParam< void, const FInputChord & >   Widgets/Input/SInputKeySelector.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAllowGamepadKeys bool When true gamepad keys are recorded on the selected key chord, otherwise they are ignored. Widgets/Input/SInputKeySelector.h  
bAllowModifierKeys bool When true modifier keys are recorded on the selected key chord, otherwise they are ignored. Widgets/Input/SInputKeySelector.h  
bEscapeCancelsSelection bool When true, pressing escape will cancel the key selection, when false, pressing escape will select the escape key. Widgets/Input/SInputKeySelector.h  
bIsFocusable bool Can this button be focused? Widgets/Input/SInputKeySelector.h  
bIsSelectingKey bool True when key selection mode is active. Widgets/Input/SInputKeySelector.h  
Button TSharedPtr< SButton > The button which starts the key selection mode. Widgets/Input/SInputKeySelector.h  
EscapeKeys TArray< FKey > When EscapeCancelsSelection is true, escape on specific keys that are unbind able by the user. Widgets/Input/SInputKeySelector.h  
KeySelectionText FText The text to display when selecting keys. Widgets/Input/SInputKeySelector.h  
Margin TAttribute< FMargin > The margin around the text used to display the currently selected key. Widgets/Input/SInputKeySelector.h  
NoKeySpecifiedText FText The text to display while no key text is available or not selecting a key. Widgets/Input/SInputKeySelector.h  
OnIsSelectingKeyChanged FOnIsSelectingKeyChanged Delegate which is run when key selection mode starts and stops. Widgets/Input/SInputKeySelector.h  
OnKeySelected FOnKeySelected Delegate which is run any time a new key is selected. Widgets/Input/SInputKeySelector.h  
SelectedKey TAttribute< FInputChord > The currently selected key chord. Widgets/Input/SInputKeySelector.h  
TextBlock TSharedPtr< STextBlock > The text which is rendered on the button. Widgets/Input/SInputKeySelector.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs
)

   Widgets/Input/SInputKeySelector.h  

bool GetIsSelectingKey()

 Returns true whenever key selection mode is active, otherwise returns false. Widgets/Input/SInputKeySelector.h  

FInputChord GetSelectedKey()

 Gets the currently selected key chord. Widgets/Input/SInputKeySelector.h  

void SetAllowGamepadKeys ( const bool bInAllowGamepadKeys
)

 When true gamepad keys are captured in the selected key chord, otherwise they are ignored. Widgets/Input/SInputKeySelector.h  

void SetAllowModifierKeys ( const bool bInAllowModifierKeys
)

 When true modifier keys are captured in the selected key chord, otherwise they are ignored. Widgets/Input/SInputKeySelector.h  

void SetButtonStyle ( const FButtonStyle* ButtonStyle
)

 Sets the style of the button which is used enter key selection mode. Widgets/Input/SInputKeySelector.h  

void SetEscapeKeys ( TArray< FKey > InEscapeKeys
)

 Sets the escape keys to check against. Widgets/Input/SInputKeySelector.h  

void SetKeySelectionText ( FText InKeySelectionText
)

 Sets the text which is displayed when selecting a key. Widgets/Input/SInputKeySelector.h  

void SetMargin ( TAttribute< FMargin > InMargin
)

 Sets the margin around the text used to display the currently selected key Widgets/Input/SInputKeySelector.h  

void SetNoKeySpecifiedText ( FText InNoKeySpecifiedText
)

 Sets the text to display when no key text is available or not selecting a key. Widgets/Input/SInputKeySelector.h  

void SetSelectedKey ( TAttribute< FInputChord > InSelectedKey
)

 Sets the currently selected key chord. Widgets/Input/SInputKeySelector.h  

void SetTextBlockVisibility ( EVisibility InVisibility
)

 Sets the visibility of the text block. Widgets/Input/SInputKeySelector.h  

void SetTextStyle ( const FTextBlockStyle* InTextStyle
)

 Sets the style of the text on the button which is used enter key selection mode. Widgets/Input/SInputKeySelector.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual void OnFocusLost ( const FFocusEvent& InFocusEvent
)

   Widgets/Input/SInputKeySelector.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Widgets/Input/SInputKeySelector.h  

virtual FReply OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Widgets/Input/SInputKeySelector.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Widgets/Input/SInputKeySelector.h  

virtual FNavigationReply OnNavigation ( const FGeometry& MyGeometry,
const FNavigationEvent& InNavigationEvent
)

   Widgets/Input/SInputKeySelector.h  

virtual FReply OnPreviewKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Widgets/Input/SInputKeySelector.h  

virtual FReply OnPreviewMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Widgets/Input/SInputKeySelector.h  

virtual bool SupportsKeyboardFocus()

   Widgets/Input/SInputKeySelector.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page