1. Epic GamesDeveloper
  3. SKeySelector

SKeySelector

Widget for selecting an input key

Unreal Engine C++ API Reference > Editor > UnrealEd

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/SKeySelector.h
Include #include "SKeySelector.h"

Syntax

class SKeySelector : public SCompoundWidget

Remarks

Widget for selecting an input key

Variables

  Type Name Description
Protected variable bool bEnabledFromKeyStructCustomization  
Protected variable bool bListenForNextInput  
Protected variable FSlateFontInfo CategoryFont Font used for category tree entries
Protected variable TAttribute< TOptional< FKey > > CurrentKey The key attribute that we're modifying with this widget, or an empty optional if the key contains multiple values
Protected variable FText DisabledSelectorToolTip Tooltip to display on the selector when the selector is disabled
Protected variable TArray< FKeyTreeItem > FilteredKeyTreeRoot Array containing a filtered list, according to the text in the searchbox
Protected variable TSharedPtr< SSearchBox > FilterTextBox  
Protected variable TSharedPtr< SComboButton > KeyComboButton Combo Button that shows current key and icon
Protected variable FSlateFontInfo KeyFont Font used for key tree entries
Protected variable TArray< FKeyTreeItem > KeyTreeRoot Array containing the unfiltered list of all values this key could possibly have
Protected variable TSharedPtr< SKeyTreeView > KeyTreeView  
Protected variable TSharedPtr< SWidget > MenuContent Reference to the menu content that's displayed when the key button is clicked on
Protected variable FOnKeyChanged OnKeyChanged Delegate that is called every time the key changes.
Protected variable FText SearchText  
Protected variable TAttribute< FOptionalSize > TreeViewHeight Desired height of the tree view widget
Protected variable TAttribute< FOptionalSize > TreeViewWidth Desired width of the tree view widget

Functions

  Type Name Description
Public function void

Construct ( const FArguments& InArgs
)

  
Protected function Virtual TSharedRef< ITableRow >

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

 Treeview support functions
Protected function 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
Public function Const FText Gets tooltip on the KeySelector when it is disabled
Protected function Const const FSlateBrush * Determine the best icon to represent the given key.
Protected function void

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

  
Protected function Const FText Gets a succinct description for the key being manipulated
Protected function Const FText Gets a description tooltip for the key being manipulated
Protected function Const FSlateColor Toggles the icon's color when in listen mode
Protected function Const const FSlateBrush * Gets the icon for the key being manipulated
Protected function Const FText Gets a tooltip for the selected key
Protected function Virtual TSharedRef< SWidget > Gets the Menu Content, setting it up if necessary
Protected function Const void

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

  
Public function Const bool Gets bEnabledFromKeyStructCustomization bool
Protected function FReply Start listening for the next key press
Protected function void

OnFilterTextChanged ( const FText& NewText
)

 Key searching support
Protected function void

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

  
Protected function void

OnKeySelectionChanged ( FKeyTreeItem Selection,
ESelectInfo::Type SelectInfo
)

  
Protected function FReply

ProcessHeardInput ( FKey KeyHeard
)

 Assigns the heard input as the current key
Public function void

SetDisabledKeySelectorToolTip ( const FText& InToolTip
)

 Sets tooltip on the KeySelector when it is disabled
Public function void Sets bool to produce tooltip notifying this key selector it was disabled from KeyStructCustomization

Overridden from SWidget

  Type Name Description
Protected function Virtual FReply

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

 Called when an analog value changes on a button that supports analog
Protected function Virtual FReply

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

 Input listeners
Protected function Virtual FReply

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

 MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
Protected function Virtual FReply

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

 The system calls this method to notify the widget that a mouse moved within it.
Protected function Virtual FReply

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

 Called when the mouse wheel is spun. This event is bubbled.
Protected function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page