UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SSearchBox.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6#include "Misc/Attribute.h"
7#include "Layout/Visibility.h"
9#include "Input/Reply.h"
11#include "Styling/SlateTypes.h"
12#include "Styling/CoreStyle.h"
14
15#define LOCTEXT_NAMESPACE "Slate"
16
18
21{
22
23public:
30
39
41
56
59
60
61 SLATE_ATTRIBUTE( FText, HintText )
62
63
65
66
68
69
71
72
74
75
77
78
80
81
83
84
85 SLATE_ATTRIBUTE( bool, SelectAllTextWhenFocused )
86
87
88 SLATE_ATTRIBUTE( float, MinDesiredWidth )
89
90
91 SLATE_ATTRIBUTE( bool, DelayChangeNotificationsWhileTyping )
92
93
94 SLATE_ATTRIBUTE( float, DelayChangeNotificationsWhileTypingSeconds )
95
96
97 SLATE_EVENT(FOnKeyDown, OnKeyDownHandler)
98
99
102
103 SLATE_API void Construct( const FArguments& InArgs );
104
107
110
111private:
112
114 void HandleTextChanged(const FText& NewText);
115
117 void HandleTextCommitted(const FText& NewText, ETextCommit::Type CommitType);
118
119private:
120
122 EActiveTimerReturnType TriggerOnTextChanged( double InCurrentTime, float InDeltaTime, FText NewText );
123
125 FText GetSearchResultText() const;
126
128 EVisibility GetSearchResultNavigationButtonVisibility() const;
129
131 EVisibility GetXVisibility() const;
132
134 EVisibility GetSearchResultDataVisibility() const;
135
137 EVisibility GetIsSearchingThrobberVisibility() const;
138
140 EVisibility GetSearchGlassVisibility() const;
141
142 FReply OnClickedSearch(SSearchBox::SearchDirection Direction);
143
145 FReply OnClearSearch();
146
148 FSlateFontInfo GetWidgetFont() const;
149
150private:
152 TWeakPtr<FActiveTimerHandle> ActiveTimerHandle;
153
155 FOnSearch OnSearchDelegate;
156
158 FOnTextChanged OnTextChangedDelegate;
159
161 FOnTextCommitted OnTextCommittedDelegate;
162
164 TAttribute< bool > DelayChangeNotificationsWhileTyping;
165
167 TAttribute< float > DelayChangeNotificationsWhileTypingSeconds;
168
170 FSlateFontInfo ActiveFont, InactiveFont;
171
173 TAttribute<TOptional<FSearchResultData>> SearchResultData;
174
176 TAttribute<bool> bIsSearching;
177};
178
179
180#undef LOCTEXT_NAMESPACE
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
#define SLATE_STYLE_ARGUMENT(ArgType, ArgName)
Definition DeclarativeSyntaxSupport.h:280
#define SLATE_ATTRIBUTE(AttrType, AttrName)
Definition DeclarativeSyntaxSupport.h:192
#define SLATE_EVENT(DelegateName, EventName)
Definition DeclarativeSyntaxSupport.h:458
#define SLATE_END_ARGS()
Definition DeclarativeSyntaxSupport.h:116
return true
Definition ExternalRpcRegistry.cpp:601
#define LOCTEXT(InKey, InTextLiteral)
Definition Internationalization.h:295
EActiveTimerReturnType
Definition SlateEnums.h:329
Definition ActiveTimerHandle.h:12
Definition CoreStyle.h:15
Definition Reply.h:24
Definition TextLayout.h:150
Definition Text.h:385
Definition SEditableTextBox.h:29
FOnVerifyTextChanged OnVerifyTextChanged
Definition SEditableTextBox.h:475
FOnTextChanged OnTextChanged
Definition SEditableTextBox.h:469
FOnTextCommitted OnTextCommitted
Definition SEditableTextBox.h:472
const FEditableTextBoxStyle * Style
Definition SEditableTextBox.h:433
Definition SSearchBox.h:21
SearchDirection
Definition SSearchBox.h:26
@ Previous
Definition SSearchBox.h:27
@ Next
Definition SSearchBox.h:28
SLATE_API FTextSelection GetSelection() const
Definition SSearchBox.cpp:303
SLATE_API void Construct(const FArguments &InArgs)
Definition SSearchBox.cpp:11
DECLARE_DELEGATE_OneParam(FOnSearch, SSearchBox::SearchDirection)
SLATE_BEGIN_ARGS(SSearchBox)
Definition SSearchBox.h:42
Definition Attribute.h:17
Definition SharedPointer.h:1295
Definition SlateEnums.h:289
@ false
Definition radaudio_common.h:23
Definition Visibility.h:12
Definition SlateTypes.h:1264
Definition SlateFontInfo.h:147
Definition TextLayout.h:100
Definition SSearchBox.h:33
int32 NumSearchResults
Definition SSearchBox.h:35
int32 CurrentSearchResultIndex
Definition SSearchBox.h:37
Definition Optional.h:131