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

SKeySelector

Widget for selecting an input key

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SKeySelector

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

	Name	Description
FSlateFontInfo	CategoryFont	Font used for category tree entries
TAttribute< TOp...	CurrentKey	The key attribute that we're modifying with this widget, or an empty optional if the key contains multiple values
TArray< FKeyTre...	FilteredKeyTreeRoot	Array containing a filtered list, according to the text in the searchbox
TSharedPtr< SSe...	FilterTextBox
TSharedPtr< SCo...	KeyComboButton	Combo Button that shows current key and icon
FSlateFontInfo	KeyFont	Font used for key tree entries
TArray< FKeyTre...	KeyTreeRoot	Array containing the unfiltered list of all values this key could possibly have
TSharedPtr< SKe...	KeyTreeView
TSharedPtr< SWi...	MenuContent	Reference to the menu content that's displayed when the key button is clicked on
FOnKeyChanged	OnKeyChanged	Delegate that is called every time the key changes.
FText	SearchText
TAttribute< FOp...	TreeViewHeight	Desired height of the tree view widget
TAttribute< FOp...	TreeViewWidth	Desired width of the tree view widget

Functions

	Name	Description
void	Construct ( const FArguments& InArgs )
TSharedRef< ...	GenerateKeyTreeRow ( FKeyTreeItem InItem, const TSharedRef< STableViewBase > ... )	Treeview support functions
bool	GetChildrenMatchingSearch ( const TArray< FString >& SearchTok..., const TArray< FKeyTreeItem >& Unfi..., TArray< FKeyTreeItem >& OutFiltere... )	Helper to generate the filtered list of keys, based on the search string matching
const FSlate...	GetIconFromKey ( FKey Key )	Determine the best icon to represent the given key.
void	GetKeyChildren ( FKeyTreeItem InItem, TArray< FKeyTreeItem >& OutChildre... )
FText	GetKeyDescription()	Gets a succinct description for the key being manipulated
const FSlate...	GetKeyIconImage()	Gets the icon for the key being manipulated
FText	GetKeyTooltip()	Gets a tooltip for the selected key
TSharedRef< ...	GetMenuContent()	Gets the Menu Content, setting it up if necessary
void	GetSearchTokens ( const FString& SearchString, TArray< FString >& OutTokens )
void	OnFilterTextChanged ( const FText& NewText )	Key searching support
void	OnFilterTextCommitted ( const FText& NewText, ETextCommit::Type CommitInfo )
void	OnKeySelectionChanged ( FKeyTreeItem Selection, ESelectInfo::Type SelectInfo )

Classes

	Name	Description
	FArguments

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss