Language:
Discover
By Skill Level
By Category

SKeySelector

Choose your OS:

Inheritance Hierarchy

Syntax

class SKeySelector : public SCompoundWidget

Remarks

Widget for selecting an input key

Variables

Name Description

Protected variable

FSlateFontInfo

 

CategoryFont

Font used for category tree entries

Protected variable

TAttribute < TOp ...

 

CurrentKey

The key attribute that we're modifying with this widget, or an empty optional if the key contains multiple values

Protected variable

TArray < FKeyTre ...

 

FilteredKeyTreeRoot

Array containing a filtered list, according to the text in the searchbox

Protected variable

TSharedPtr < SSe ...

 

FilterTextBox

Protected variable

TSharedPtr < SCo ...

 

KeyComboButton

Combo Button that shows current key and icon

Protected variable

FSlateFontInfo

 

KeyFont

Font used for key tree entries

Protected variable

TArray < FKeyTre ...

 

KeyTreeRoot

Array containing the unfiltered list of all values this key could possibly have

Protected variable

TSharedPtr < SKe ...

 

KeyTreeView

Protected variable

TSharedPtr < SWi ...

 

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 < FOp ...

 

TreeViewHeight

Desired height of the tree view widget

Protected variable

TAttribute < FOp ...

 

TreeViewWidth

Desired width of the tree view widget

Functions

Name Description

Public function

void

 

Construct

(
    const FArguments & InArgs
)

Protected function Virtual

TSharedRef < ...

 

GenerateKeyTreeRow

(
    FKeyTreeItem InItem,
    const TSharedRef < STableViewBase > ...
)

Treeview support functions

Protected function

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

Protected function

const FSlate ...

 

GetIconFromKey

(
    FKey Key
)

Determine the best icon to represent the given key.

Protected function

void

 

GetKeyChildren

(
    FKeyTreeItem InItem,
    TArray < FKeyTreeItem >& OutChildre...
)

Protected function

FText

 

GetKeyDescription()

Gets a succinct description for the key being manipulated

Protected function

const FSlate ...

 

GetKeyIconImage()

Gets the icon for the key being manipulated

Protected function Virtual

TSharedRef < ...

 

GetMenuContent()

Gets the Menu Content, setting it up if necessary

Protected function

void

 

GetSearchTokens

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

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
)

Classes

Name

Description

Public struct

FArguments

References

Module

UnrealEd

Header

Editor/UnrealEd/Public/SKeySelector.h