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

SSuggestionTextBox

Implements an editable text box that can show auto-complete histories and suggestions lists.

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SSuggestionTextBox

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Input/SSuggestionTextBox.h
Include	#include "Widgets/Input/SSuggestionTextBox.h"

Syntax

class SSuggestionTextBox : public SCompoundWidget

Remarks

Implements an editable text box that can show auto-complete histories and suggestions lists.

Constructors

	Name	Description
	SSuggestionTextBox()	Default constructor.

Functions

	Name	Description
void	ClearSuggestions()	Clears the list of suggestions and hides the suggestions list.
void	Construct ( const FArguments& InArgs )	Construct this widget. Called by the SNew()Slate macro.
void	FocusTextBox()	Sets the keyboard focus to the text box.
FString	GetSelectedSuggestionString()	Gets the string value of the currently selected suggestion.
FText	GetText()	Returns the text string.
void	MarkActiveSuggestion()	Highlights the selected suggestion in the suggestion list.
void	SetError ( const FString& InError )	Sets an optional error string.
void	SetSuggestions ( TArray< FString >& SuggestionStrin..., bool InHistoryMode )	Sets the list of suggestions.
void	SetText ( const TAttribute< FText >& InNewTe... )	Sets the text string currently being edited

Overridden from SWidget

	Name	Description
void	OnFocusLost ( const FFocusEvent& InFocusEvent )	Called when this widget loses focus. This event does not bubble.
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.

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