UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Public Member Functions | List of all members
SSearchBox Class Reference

#include <SSearchBox.h>

+ Inheritance diagram for SSearchBox:

Classes

struct  FSearchResultData
 

Public Types

enum  SearchDirection { Previous , Next }
 

Public Member Functions

 DECLARE_DELEGATE_OneParam (FOnSearch, SSearchBox::SearchDirection)
 
 SLATE_BEGIN_ARGS (SSearchBox)
 
SLATE_API void Construct (const FArguments &InArgs)
 
SLATE_API FTextSelection GetSelection () const
 
SLATE_API void SelectText (const FTextLocation &InSelectionStart, const FTextLocation &InCursorLocation)
 
- Public Member Functions inherited from SEditableTextBox
 SLATE_BEGIN_ARGS (SEditableTextBox)
 
SLATE_API SEditableTextBox ()
 
virtual SLATE_API ~SEditableTextBox ()
 
SLATE_API void Construct (const FArguments &InArgs)
 
FText GetText () const
 
SLATE_API void SetStyle (const FEditableTextBoxStyle *InStyle)
 
SLATE_API void SetTextBlockStyle (const FTextBlockStyle *InTextStyle)
 
SLATE_API void SetText (const TAttribute< FText > &InNewText)
 
FText GetHintText () const
 
SLATE_API void SetHintText (const TAttribute< FText > &InHintText)
 
SLATE_API void SetSearchText (const TAttribute< FText > &InSearchText)
 
SLATE_API FText GetSearchText () const
 
SLATE_API void SetIsReadOnly (TAttribute< bool > InIsReadOnly)
 
bool IsReadOnly () const
 
SLATE_API void SetIsPassword (TAttribute< bool > InIsPassword)
 
bool IsPassword () const
 
SLATE_API void SetAllowContextMenu (TAttribute< bool > InAllowContextMenu)
 
SLATE_API void SetVirtualKeyboardDismissAction (TAttribute< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction)
 
SLATE_API void SetFont (const TAttribute< FSlateFontInfo > &InFont)
 
SLATE_API void SetTextBoxForegroundColor (const TAttribute< FSlateColor > &InForegroundColor)
 
SLATE_API void SetTextBoxBackgroundColor (const TAttribute< FSlateColor > &InBackgroundColor)
 
SLATE_API void SetReadOnlyForegroundColor (const TAttribute< FSlateColor > &InReadOnlyForegroundColor)
 
SLATE_API void SetFocusedForegroundColor (const TAttribute< FSlateColor > &InFocusedForegroundColor)
 
SLATE_API void SetMaximumLength (const TAttribute< int32 > &InMaximumLength)
 
SLATE_API void SetMinimumDesiredWidth (const TAttribute< float > &InMinimumDesiredWidth)
 
SLATE_API void SetIsCaretMovedWhenGainFocus (const TAttribute< bool > &InIsCaretMovedWhenGainFocus)
 
SLATE_API void SetSelectAllTextWhenFocused (const TAttribute< bool > &InSelectAllTextWhenFocused)
 
SLATE_API void SetRevertTextOnEscape (const TAttribute< bool > &InRevertTextOnEscape)
 
SLATE_API void SetClearKeyboardFocusOnCommit (const TAttribute< bool > &InClearKeyboardFocusOnCommit)
 
SLATE_API void SetSelectAllTextOnCommit (const TAttribute< bool > &InSelectAllTextOnCommit)
 
SLATE_API void SetSelectWordOnMouseDoubleClick (const TAttribute< bool > &InSelectWordOnMouseDoubleClick)
 
SLATE_API void SetJustification (const TAttribute< ETextJustify::Type > &InJustification)
 
SLATE_API void SetError (const FText &InError)
 
SLATE_API void SetError (const FString &InError)
 
SLATE_API void SetOnKeyCharHandler (FOnKeyChar InOnKeyCharHandler)
 
SLATE_API void SetOnKeyDownHandler (FOnKeyDown InOnKeyDownHandler)
 
SLATE_API void SetTextShapingMethod (const TOptional< ETextShapingMethod > &InTextShapingMethod)
 
SLATE_API void SetTextFlowDirection (const TOptional< ETextFlowDirection > &InTextFlowDirection)
 
SLATE_API void SetOverflowPolicy (TOptional< ETextOverflowPolicy > InOverflowPolicy)
 
SLATE_API bool AnyTextSelected () const
 
SLATE_API void SelectAllText ()
 
SLATE_API void ClearSelection ()
 
SLATE_API FText GetSelectedText () const
 
SLATE_API void GoTo (const FTextLocation &NewLocation)
 
void GoTo (const ETextLocation NewLocation)
 
SLATE_API void ScrollTo (const FTextLocation &NewLocation)
 
void ScrollTo (const ETextLocation NewLocation)
 
SLATE_API void BeginSearch (const FText &InSearchText, const ESearchCase::Type InSearchCase=ESearchCase::IgnoreCase, const bool InReverse=false)
 
SLATE_API void AdvanceSearch (const bool InReverse=false)
 
SLATE_API void EnableTextInputMethodContext ()
 
SLATE_API bool HasError () const
 
virtual SLATE_API bool SupportsKeyboardFocus () const override
 
virtual SLATE_API bool HasKeyboardFocus () const override
 
virtual SLATE_API FReply OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent) override
 
virtual SLATE_API FReply OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override
 
- Public Member Functions inherited from SBorder
 SLATE_BEGIN_ARGS (SBorder)
 
FArguments & Padding (float Uniform)
 
FArguments & Padding (float Horizontal, float Vertical)
 
FArguments & Padding (float Left, float Top, float Right, float Bottom)
 
SLATE_API SBorder ()
 
virtual SLATE_API ~SBorder ()
 
SLATE_API void Construct (const FArguments &InArgs)
 
virtual SLATE_API void SetContent (TSharedRef< SWidget > InContent)
 
SLATE_API const TSharedRef< SWidget > & GetContent () const
 
SLATE_API void ClearContent ()
 
SLATE_API void SetBorderBackgroundColor (TAttribute< FSlateColor > InColorAndOpacity)
 
FSlateColor GetBorderBackgroundColor () const
 
SLATE_API void SetDesiredSizeScale (TAttribute< FVector2D > InDesiredSizeScale)
 
SLATE_API void SetHAlign (EHorizontalAlignment HAlign)
 
SLATE_API void SetVAlign (EVerticalAlignment VAlign)
 
SLATE_API void SetPadding (TAttribute< FMargin > InPadding)
 
SLATE_API void SetShowEffectWhenDisabled (TAttribute< bool > InShowEffectWhenDisabled)
 
SLATE_API void SetBorderImage (TAttribute< const FSlateBrush * > InBorderImage)
 
const FSlateBrush * GetBorderImage () const
 
virtual SLATE_API int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
- Public Member Functions inherited from SCompoundWidget
const FVector2D GetContentScale () const
 
void SetContentScale (TAttribute< FVector2D > InContentScale)
 
FLinearColor GetColorAndOpacity () const
 
void SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)
 
void SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)
 
virtual SLATECORE_API FChildren * GetChildren () override
 
virtual SLATECORE_API void OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override
 
virtual SLATECORE_API FSlateColor GetForegroundColor () const override
 
virtual SLATECORE_API void SetVisibility (TAttribute< EVisibility > InVisibility) override final
 
- Public Member Functions inherited from SWidget
SLATECORE_API int32 Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
 
virtual SLATECORE_API void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)
 
virtual SLATECORE_API void OnFocusLost (const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API FReply OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)
 
virtual SLATECORE_API FReply OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)
 
virtual SLATECORE_API FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseLeave (const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const
 
virtual SLATECORE_API TOptional< TSharedRef< SWidget > > OnMapCursor (const FCursorReply &CursorReply) const
 
virtual SLATECORE_API FReply OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)
 
virtual SLATECORE_API bool OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)
 
virtual SLATECORE_API TSharedPtr< FPopupLayer > OnVisualizePopup (const TSharedRef< SWidget > &PopupContent)
 
virtual SLATECORE_API FReply OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API void OnDragLeave (const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)
 
virtual SLATECORE_API FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)
 
virtual SLATECORE_API TOptional< bool > OnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual SLATECORE_API FPopupMethodReply OnQueryPopupMethod () const
 
virtual SLATECORE_API TOptional< FVirtualPointerPosition > TranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const
 
virtual SLATECORE_API void OnFinishedPointerInput ()
 
virtual SLATECORE_API void OnFinishedKeyInput ()
 
virtual SLATECORE_API FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)
 
virtual SLATECORE_API EWindowZone::Type GetWindowZoneOverride () const
 
bool NeedsPrepass () const
 
SLATECORE_API void SlatePrepass ()
 
SLATECORE_API void SlatePrepass (float InLayoutScaleMultiplier)
 
void SetCanTick (bool bInCanTick)
 
bool GetCanTick () const
 
bool HasRegisteredSlateAttribute () const
 
bool IsAttributesUpdatesEnabled () const
 
const FSlateWidgetPersistentState & GetPersistentState () const
 
const FWidgetProxyHandle GetProxyHandle () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetDesiredSize () const
 
SLATECORE_API void AssignParentWidget (TSharedPtr< SWidget > InParent)
 
SLATECORE_API bool ConditionallyDetatchParentWidget (SWidget *InExpectedParent)
 
virtual bool ValidatePathToChild (SWidget *InChild)
 
bool IsParentValid () const
 
TSharedPtr< SWidget > GetParentWidget () const
 
TSharedPtr< SWidget > Advanced_GetPaintParentWidget () const
 
SLATECORE_API FSlateRect CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const
 
bool HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
virtual SLATECORE_API float GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const
 
SLATECORE_API void ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const
 
virtual FChildren * GetAllChildren ()
 
SLATECORE_API TOptional< EFocusCause > HasUserFocus (int32 UserIndex) const
 
SLATECORE_API TOptional< EFocusCause > HasAnyUserFocus () const
 
SLATECORE_API bool HasUserFocusedDescendants (int32 UserIndex) const
 
SLATECORE_API bool HasFocusedDescendants () const
 
SLATECORE_API bool HasAnyUserFocusOrFocusedDescendants () const
 
SLATECORE_API bool HasMouseCapture () const
 
SLATECORE_API bool HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const
 
virtual SLATECORE_API void OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
 
void SetEnabled (TAttribute< bool > InEnabledState)
 
bool IsEnabled () const
 
virtual bool IsInteractable () const
 
virtual SLATECORE_API TSharedPtr< IToolTip > GetToolTip ()
 
virtual SLATECORE_API void OnToolTipClosing ()
 
SLATECORE_API void EnableToolTipForceField (const bool bEnableForceField)
 
bool HasToolTipForceField () const
 
bool IsHovered () const
 
SLATECORE_API bool IsDirectlyHovered () const
 
EVisibility GetVisibility () const
 
bool IsVolatile () const
 
bool IsVolatileIndirectly () const
 
void ForceVolatile (bool bForce)
 
bool ShouldInvalidatePrepassDueToVolatility ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 
void CacheVolatility ()
 
void MarkPrepassAsDirty ()
 
float GetRenderOpacity () const
 
void SetRenderOpacity (float InRenderOpacity)
 
void SetTag (FName InTag)
 
const TOptional< FSlateRenderTransform > & GetRenderTransform () const
 
TOptional< FSlateRenderTransform > GetRenderTransformWithRespectToFlowDirection () const
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivotWithRespectToFlowDirection () const
 
void SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivot () const
 
void SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)
 
SLATECORE_API void SetClipping (EWidgetClipping InClipping)
 
EWidgetClipping GetClipping () const
 
SLATECORE_API void SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)
 
EWidgetPixelSnapping GetPixelSnapping () const
 
void SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)
 
FMargin GetCullingBoundsExtension () const
 
void SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)
 
EFlowDirectionPreference GetFlowDirectionPreference () const
 
SLATECORE_API void SetToolTipText (const TAttribute< FText > &ToolTipText)
 
SLATECORE_API void SetToolTipText (const FText &InToolTipText)
 
SLATECORE_API void SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)
 
SLATECORE_API void SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)
 
template<typename MetaDataType >
TSharedPtr< MetaDataType > GetMetaData () const
 
template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > > GetAllMetaData () const
 
template<typename MetaDataType >
void AddMetadata (const TSharedRef< MetaDataType > &AddMe)
 
template<typename MetaDataType >
int32 RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)
 
SLATECORE_API void SetOnMouseButtonDown (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseButtonUp (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseMove (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseDoubleClick (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)
 
virtual SLATECORE_API FString ToString () const
 
SLATECORE_API FString GetTypeAsString () const
 
SLATECORE_API FName GetType () const
 
virtual SLATECORE_API FString GetReadableLocation () const
 
SLATECORE_API FName GetCreatedInLocation () const
 
virtual SLATECORE_API FName GetTag () const
 
virtual SLATECORE_API FSlateColor GetDisabledForegroundColor () const
 
SLATECORE_API const FGeometry & GetCachedGeometry () const
 
SLATECORE_API const FGeometry & GetTickSpaceGeometry () const
 
SLATECORE_API const FGeometry & GetPaintSpaceGeometry () const
 
const TOptional< FSlateClippingState > & GetCurrentClippingState () const
 
virtual bool Advanced_IsWindow () const
 
virtual bool Advanced_IsInvalidationRoot () const
 
virtual const FSlateInvalidationRoot * Advanced_AsInvalidationRoot () const
 
SLATECORE_API TSharedRef< FActiveTimerHandle > RegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)
 
SLATECORE_API void UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)
 
bool HasActiveTimers () const
 
- Public Member Functions inherited from FSlateControlledConstruction
 FSlateControlledConstruction ()=default
 
virtual ~FSlateControlledConstruction ()=default
 
virtual const FSlateWidgetClassData & GetWidgetClass () const =0
 
void operator delete (void *mem)
 
- Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode > AsShared ()
 
TSharedRef< SWidget const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< SWidget, Mode > AsWeak ()
 
TWeakPtr< SWidget const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Additional Inherited Members

- Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData & StaticWidgetClass ()
 
- Protected Member Functions inherited from SEditableTextBox
SLATE_API void OnEditableTextChanged (const FText &InText)
 
SLATE_API void OnEditableTextCommitted (const FText &InText, ETextCommit::Type InCommitType)
 
- Protected Member Functions inherited from SBorder
virtual SLATE_API FVector2D ComputeDesiredSize (float) const override
 
bool GetShowDisabledEffect () const
 
FVector2D GetDesiredSizeScale () const
 
TSlateAttributeRef< const FSlateBrush * > GetBorderImageAttribute () const
 
TSlateAttributeRef< FSlateColor > GetBorderBackgroundColorAttribute () const
 
TSlateAttributeRef< FVector2D > GetDesiredSizeScaleAttribute () const
 
TSlateAttributeRef< bool > GetShowDisabledEffectAttribute () const
 
- Protected Member Functions inherited from SCompoundWidget
TSlateAttributeRef< FVector2D > GetContentScaleAttribute () const
 
TSlateAttributeRef< FLinearColor > GetColorAndOpacityAttribute () const
 
TSlateAttributeRef< FSlateColor > GetForegroundColorAttribute () const
 
SLATECORE_API SCompoundWidget ()
 
virtual SLATECORE_API ~SCompoundWidget ()
 
- Protected Member Functions inherited from SWidget
void SetVolatilePrepass (bool bVolatile)
 
virtual bool CustomPrepass (float LayoutScaleMultiplier)
 
virtual SLATECORE_API void CacheDesiredSize (float InLayoutScaleMultiplier)
 
void SetHover (TAttribute< bool > InHovered)
 
bool IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const
 
SLATECORE_API void InvalidateChildRemovedFromTree (SWidget &Child)
 
bool Advanced_InvalidateVolatility ()
 
EFlowDirection ComputeFlowDirection () const
 
SLATECORE_API void SetDebugInfo (const ANSICHAR *InType, const ANSICHAR *InFile, int32 OnLine, size_t InAllocSize)
 
virtual SLATECORE_API TOptional< EMouseCursor::Type > GetCursor () const
 
SLATECORE_API SWidget ()
 
SLATECORE_API void SWidgetConstruct (const FSlateBaseNamedArgs &Args)
 
bool IsConstructed () const
 
SLATECORE_API bool FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API void FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API FGeometry FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const
 
bool ShouldBeEnabled (bool InParentEnabled) const
 
virtual SLATECORE_API const FSlateBrush * GetFocusBrush () const
 
virtual bool ComputeVolatility () const
 
virtual SLATECORE_API void OnClippingChanged ()
 
float GetPrepassLayoutScaleMultiplier () const
 
SLATECORE_API void Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)
 
template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 
TSlateAttributeRef< bool > GetEnabledStateAttribute () const
 
TSlateAttributeRef< bool > GetHoveredAttribute () const
 
TSlateAttributeRef< EVisibility > GetVisibilityAttribute () const
 
TSlateAttributeRef< TOptional< FSlateRenderTransform > > GetRenderTransformAttribute () const
 
TSlateAttributeRef< FVector2D > GetRenderTransformPivotAttribute () const
 
virtual SLATECORE_API ~SWidget ()
 
- Protected Member Functions inherited from TSharedFromThis< SWidget >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32 FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)
 
static SLATECORE_API int32 FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)
 
static TAttribute< EVisibility > AccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)
 
- Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- Protected Attributes inherited from SEditableTextBox
const FEditableTextBoxStyle * Style
 
TSharedPtr< SBox > PaddingBox
 
TSharedPtr< SEditableText > EditableText
 
TAttribute< FMargin > PaddingOverride
 
TAttribute< FSlateFontInfo > FontOverride
 
TAttribute< FSlateColor > ForegroundColorOverride
 
TAttribute< FSlateColor > BackgroundColorOverride
 
TAttribute< FSlateColor > ReadOnlyForegroundColorOverride
 
TAttribute< FSlateColor > FocusedForegroundColorOverride
 
TAttribute< int32 > MaximumLength
 
TSharedPtr< SHorizontalBox > Box
 
TSharedPtr< class IErrorReportingWidget > ErrorReporting
 
FOnTextChanged OnTextChanged
 
FOnTextCommitted OnTextCommitted
 
FOnVerifyTextChanged OnVerifyTextChanged
 
- Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot ChildSlot
 
- Protected Attributes inherited from SWidget
uint8 bCanSupportFocus: 1
 
uint8 bCanHaveChildren: 1
 
uint8 bClippingProxy: 1
 
uint8 bHasCustomPrepass: 1
 
uint8 bHasRelativeLayoutScale: 1
 
uint8 bVolatilityAlwaysInvalidatesPrepass: 1
 
EWidgetClipping Clipping
 
EWidgetPixelSnapping PixelSnappingMethod
 
FMargin CullingBoundsExtension
 
float RenderOpacity
 

Detailed Description

A text box that is used for searching. Meant to be as easy to use as possible with as few options as possible.

Member Enumeration Documentation

◆ SearchDirection

enum SSearchBox::SearchDirection

Which direction to go when searching

Enumerator
Previous 
Next 

Member Function Documentation

◆ Construct()

void SSearchBox::Construct ( const FArguments &  InArgs)

Style used to draw this search box The text displayed in the SearchBox when no text has been entered The text displayed in the SearchBox when it's created Optional search result data to be shown in the search bar. Whether or not an external search is currently running. Invoked whenever the text changes Invoked whenever the text is committed (e.g. user presses enter) Called whenever the text is changed programmatically or interactively by the user This will add a next and previous button to your search box Whether to select all text when the user clicks to give focus on the widget Minimum width that a text block should be Whether the SearchBox should delay notifying listeners of text changed events until the user is done typing If we're delaying change notifications how many seconds should we wait? Callback delegate to have first chance handling of the OnKeyDown event Optional callback to allow for special functionality to be invoked when the search glass button is clicked

◆ DECLARE_DELEGATE_OneParam()

SSearchBox::DECLARE_DELEGATE_OneParam ( FOnSearch  ,
SSearchBox::SearchDirection   
)

◆ GetSelection()

FTextSelection SSearchBox::GetSelection ( ) const

Get the current selection

◆ SelectText()

void SSearchBox::SelectText ( const FTextLocation &  InSelectionStart,
const FTextLocation &  InCursorLocation 
)

Select a block of text

◆ SLATE_BEGIN_ARGS()

SSearchBox::SLATE_BEGIN_ARGS ( SSearchBox  )
inline
The documentation for this class was generated from the following files: