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

> Unreal Engine API Reference > Runtime > Slate > Widgets > Input > SSearchBox > FArguments

Light Theme

Dark Theme

FArguments

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateBaseNamedArgs

TSlateBaseNamedArgs

SSearchBox::FArguments

References

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

Syntax

struct FArguments : public TSlateBaseNamedArgs< SSearchBox >

Constructors

	Name	Description
	FArguments()

Functions

	Name	Description
WidgetArgsTy...	DelayChangeNotificationsWhileTyping ( const TAttribute< bool >& InAttrib... )	Whether the SearchBox should delay notifying listeners of text changed events until the user is done typing
WidgetArgsTy...	DelayChangeNotificationsWhileTypingSeconds ( const TAttribute< float >& InAttri... )	If we're delaying change notifications how many seconds should we wait?
WidgetArgsTy...	HintText ( const TAttribute< FText >& InAttri... )	The text displayed in the SearchBox when no text has been entered
WidgetArgsTy...	InitialText ( const TAttribute< FText >& InAttri... )	The text displayed in the SearchBox when it's created
WidgetArgsTy...	IsSearching ( const TAttribute< bool >& InAttrib... )	Whether or not an external search is currently running.
WidgetArgsTy...	MinDesiredWidth ( const TAttribute< float >& InAttri... )	Minimum width that a text block should be
WidgetArgsTy...	OnKeyDownHandler ( const FOnKeyDown& InDelegate )	Callback delegate to have first chance handling of the OnKeyDown event
WidgetArgsTy...	OnSearch ( const FOnSearch& InDelegate )	This will add a next and previous button to your search box
WidgetArgsTy...	OnTextChanged ( const FOnTextChanged& InDelegate )	Invoked whenever the text changes
WidgetArgsTy...	OnTextCommitted ( const FOnTextCommitted& InDelegate )	Invoked whenever the text is committed (e.g. user presses enter)
WidgetArgsTy...	SearchResultData ( const TAttribute< TOptional< FSearc... )	Optional search result data to be shown in the search bar.
WidgetArgsTy...	SelectAllTextWhenFocused ( const TAttribute< bool >& InAttrib... )	Whether to select all text when the user clicks to give focus on the widget
WidgetArgsTy...	Style ( const FSearchBoxStyle* InArg )	Style used to draw this search box

Typedefs

Name	Description
WidgetArgsType

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

Take our survey

Dismiss