1. Epic GamesDeveloper
  3. FArguments

FArguments

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Input > API/Runtime/Slate/Widgets/Input/SSearchBox

Inheritance Hierarchy

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

  Type Name Description
Public function    

Functions

  Type Name Description
Public function WidgetArgsType &

DelayChangeNotificationsWhileTyping ( const TAttribute< bool >& InAttribute
)

 Whether the SearchBox should delay notifying listeners of text changed events until the user is done typing
Public function WidgetArgsType &

DelayChangeNotificationsWhileTypingSeconds ( const TAttribute< float >& InAttribute
)

 If we're delaying change notifications how many seconds should we wait?
Public function WidgetArgsType &

HintText ( const TAttribute< FText >& InAttribute
)

 The text displayed in the SearchBox when no text has been entered
Public function WidgetArgsType &

InitialText ( const TAttribute< FText >& InAttribute
)

 The text displayed in the SearchBox when it's created
Public function WidgetArgsType &

IsSearching ( const TAttribute< bool >& InAttribute
)

 Whether or not an external search is currently running.
Public function WidgetArgsType &

MinDesiredWidth ( const TAttribute< float >& InAttribute
)

 Minimum width that a text block should be
Public function WidgetArgsType &

OnKeyDownHandler ( const FOnKeyDown& InDelegate
)

 Callback delegate to have first chance handling of the OnKeyDown event
Public function WidgetArgsType &

OnSearch ( const FOnSearch& InDelegate
)

 This will add a next and previous button to your search box
Public function WidgetArgsType &

OnSearchGlassClicked ( const FOnClicked& InDelegate
)

 Optional callback to allow for special functionality to be invoked when the search glass button is clicked
Public function WidgetArgsType &

OnTextChanged ( const FOnTextChanged& InDelegate
)

 Invoked whenever the text changes
Public function WidgetArgsType &

OnTextCommitted ( const FOnTextCommitted& InDelegate
)

 Invoked whenever the text is committed (e.g. user presses enter)
Public function WidgetArgsType &

OnVerifyTextChanged ( const FOnVerifyTextChanged& InDelegate
)

 Called whenever the text is changed programmatically or interactively by the user
Public function WidgetArgsType & Optional search result data to be shown in the search bar.
Public function WidgetArgsType &

SelectAllTextWhenFocused ( const TAttribute< bool >& InAttribute
)

 Whether to select all text when the user clicks to give focus on the widget
Public function WidgetArgsType &

Style ( const FSearchBoxStyle* InArg
)

 Style used to draw this search box

Typedefs

Name Description
WidgetArgsType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page