SSearchBox.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Layout/Visibility.h"
#include "Fonts/SlateFontInfo.h"
#include "Input/Reply.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Widgets/Input/SEditableTextBox.h"
 
#define LOCTEXT_NAMESPACE "Slate"
 
class FActiveTimerHandle;
 
class SSearchBox : public SEditableTextBox
{
 
public:
    enum SearchDirection
    {
        Previous,
        Next,
    };
 
    struct FSearchResultData
    {
        int32 NumSearchResults;
        int32 CurrentSearchResultIndex;
    };
 
    DECLARE_DELEGATE_OneParam(FOnSearch, SSearchBox::SearchDirection);
 
    SLATE_BEGIN_ARGS(SSearchBox)
        : _Style( &FCoreStyle::Get().GetWidgetStyle<FSearchBoxStyle>("SearchBox") )
        , _HintText( LOCTEXT("SearchHint", "Search") )
        , _InitialText()
        , _SearchResultData()
        , _IsSearching(false)
        , _OnTextChanged()
        , _OnTextCommitted()
        , _OnVerifyTextChanged()
        , _OnSearch()
        , _SelectAllTextWhenFocused( true )
        , _DelayChangeNotificationsWhileTyping( true )
        , _DelayChangeNotificationsWhileTypingSeconds(0.25f)
    { }
 
        SLATE_STYLE_ARGUMENT( FSearchBoxStyle, Style )
 
        
        SLATE_ATTRIBUTE( FText, HintText )
 
        
        SLATE_ATTRIBUTE( FText, InitialText )
 
        
        SLATE_ATTRIBUTE( TOptional<FSearchResultData>, SearchResultData )
 
        
        SLATE_ATTRIBUTE( bool, IsSearching )
 
        
        SLATE_EVENT( FOnTextChanged, OnTextChanged )
 
        
        SLATE_EVENT( FOnTextCommitted, OnTextCommitted )
 
        
        SLATE_EVENT( FOnVerifyTextChanged, OnVerifyTextChanged )
    
        
        SLATE_EVENT( FOnSearch, OnSearch )
 
        
        SLATE_ATTRIBUTE( bool, SelectAllTextWhenFocused )
        
        
        SLATE_ATTRIBUTE( float, MinDesiredWidth )
 
        
        SLATE_ATTRIBUTE( bool, DelayChangeNotificationsWhileTyping )
 
        
        SLATE_ATTRIBUTE( float, DelayChangeNotificationsWhileTypingSeconds )
 
        
        SLATE_EVENT(FOnKeyDown, OnKeyDownHandler)
 
        
        SLATE_EVENT(FOnClicked, OnSearchGlassClicked)
    SLATE_END_ARGS()
 
    SLATE_API void Construct( const FArguments& InArgs );
 
    SLATE_API FTextSelection GetSelection() const;
 
    SLATE_API void SelectText(const FTextLocation& InSelectionStart, const FTextLocation& InCursorLocation);
 
private:
 
    void HandleTextChanged(const FText& NewText);
 
    void HandleTextCommitted(const FText& NewText, ETextCommit::Type CommitType);
 
private:
 
    EActiveTimerReturnType TriggerOnTextChanged( double InCurrentTime, float InDeltaTime, FText NewText );
 
    FText GetSearchResultText() const;
 
    EVisibility GetSearchResultNavigationButtonVisibility() const;
 
    EVisibility GetXVisibility() const;
 
    EVisibility GetSearchResultDataVisibility() const;
 
    EVisibility GetIsSearchingThrobberVisibility() const;
 
    EVisibility GetSearchGlassVisibility() const;
 
    FReply OnClickedSearch(SSearchBox::SearchDirection Direction);
 
    FReply OnClearSearch();
 
    FSlateFontInfo GetWidgetFont() const;
 
private:
    TWeakPtr<FActiveTimerHandle> ActiveTimerHandle;
 
    FOnSearch OnSearchDelegate;
 
    FOnTextChanged OnTextChangedDelegate;
 
    FOnTextCommitted OnTextCommittedDelegate;
 
    TAttribute< bool > DelayChangeNotificationsWhileTyping;
 
    TAttribute< float > DelayChangeNotificationsWhileTypingSeconds;
 
    FSlateFontInfo ActiveFont, InactiveFont;
 
    TAttribute<TOptional<FSearchResultData>> SearchResultData;
 
    TAttribute<bool> bIsSearching;
};
 
 
#undef LOCTEXT_NAMESPACE