1. Epic GamesDeveloper
  3. SKeySelector

SKeySelector

Widget for selecting an input key

API > API/Editor > API/Editor/UnrealEd

Widget for selecting an input key

   
Name SKeySelector
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/SKeySelector.h
Include Path #include "SKeySelector.h"

Syntax

class SKeySelector : public SCompoundWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs
)

   SKeySelector.h  

FText GetDisabledKeySelectorToolTip()

 Gets tooltip on the KeySelector when it is disabled SKeySelector.h  

bool GetSetEnabledFromKeyStructCustomization()

 Gets bEnabledFromKeyStructCustomization bool SKeySelector.h  

void SetDisabledKeySelectorToolTip ( const FText& InToolTip
)

 Sets tooltip on the KeySelector when it is disabled SKeySelector.h  

void SetEnabledFromKeyStructCustomization ( bool bIsEnabled
)

 Sets bool to produce tooltip notifying this key selector it was disabled from KeyStructCustomization SKeySelector.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool CanChangeKey()

 Returns true if this key selector can actually change the that it's assigned to or not SKeySelector.h  

virtual TSharedRef< ITableRow > GenerateKeyTreeRow ( FKeyTreeItem InItem,
const TSharedRef< STableViewBase >& OwnerTree
)

 Treeview support functions SKeySelector.h  

bool GetChildrenMatchingSearch ( const TArray< FString >& SearchTokens,
const TArray< FKeyTreeItem >& UnfilteredList,
TArray< FKeyTreeItem >& OutFilteredList
)

 Helper to generate the filtered list of keys, based on the search string matching SKeySelector.h  

const FSlateBrush * GetIconFromKey ( FKey Key
) const

 Determine the best icon to represent the given key. SKeySelector.h  

void GetKeyChildren ( FKeyTreeItem InItem,
TArray< FKeyTreeItem >& OutChildren
)

   SKeySelector.h  

FText GetKeyDescription()

 Gets a succinct description for the key being manipulated SKeySelector.h  

FText GetKeyDescriptionToolTip()

 Gets a description tooltip for the key being manipulated SKeySelector.h  

FSlateColor GetKeyIconColor()

 Toggles the icon's color when in listen mode SKeySelector.h  

const FSlateBrush * GetKeyIconImage()

 Gets the icon for the key being manipulated SKeySelector.h  

FText GetKeyTooltip()

 Gets a tooltip for the selected key SKeySelector.h  

virtual TSharedRef< SWidget > GetMenuContent()

 Gets the Menu Content, setting it up if necessary SKeySelector.h  

void GetSearchTokens ( const FString& SearchString,
TArray< FString >& OutTokens
) const

   SKeySelector.h  

FReply ListenForInput()

 Start listening for the next key press SKeySelector.h  

void OnFilterTextChanged ( const FText& NewText
)

 Key searching support SKeySelector.h  

void OnFilterTextCommitted ( const FText& NewText,
ETextCommit::Type CommitInfo
)

   SKeySelector.h  

void OnKeySelectionChanged ( FKeyTreeItem Selection,
ESelectInfo::Type SelectInfo
)

   SKeySelector.h  

FReply ProcessHeardInput ( FKey KeyHeard
)

 Assigns the heard input as the current key SKeySelector.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnAnalogValueChanged ( const FGeometry& MyGeometry,
const FAnalogInputEvent& InAnalogInputEvent
)

   SKeySelector.h  

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

 Input listeners SKeySelector.h  

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

   SKeySelector.h  

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

   SKeySelector.h  

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

   SKeySelector.h  

virtual bool SupportsKeyboardFocus()

   SKeySelector.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page