SVirtualKeyboardEntry.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 "Styling/SlateColor.h"
#include "Fonts/SlateFontInfo.h"
#include "Input/Reply.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SLeafWidget.h"
#include "Styling/CoreStyle.h"
#include "Framework/SlateDelegates.h"
#include "Widgets/Input/IVirtualKeyboardEntry.h"
#include "Framework/Layout/SlateScrollHelper.h"
 
class FPaintArgs;
class FSlateWindowElementList;
 
class SVirtualKeyboardEntry : public SLeafWidget, public IVirtualKeyboardEntry
{
 
public:
 
    SLATE_BEGIN_ARGS( SVirtualKeyboardEntry )
        : _Text()
        , _HintText()
        , _Font( FCoreStyle::Get().GetFontStyle("NormalFont") )
        , _ColorAndOpacity( FSlateColor::UseForeground() )
        , _IsReadOnly( false )
        , _ClearKeyboardFocusOnCommit( true )
        , _MinDesiredWidth( 0.0f )
        , _KeyboardType ( EKeyboardType::Keyboard_Default )
        , _VirtualKeyboardOptions ( FVirtualKeyboardOptions() )
        , _EnableIntegratedKeyboard ( false )
        {}
 
        SLATE_ATTRIBUTE( FText, Text )
 
        
        SLATE_ATTRIBUTE( FText, HintText )
 
        
        SLATE_ATTRIBUTE( FSlateFontInfo, Font )
 
        
        SLATE_ATTRIBUTE( FSlateColor, ColorAndOpacity )
 
        
        SLATE_ATTRIBUTE( bool, IsReadOnly )
 
        
        SLATE_ATTRIBUTE( bool, ClearKeyboardFocusOnCommit )
 
        
        SLATE_EVENT( FOnTextChanged, OnTextChanged )
 
        
        SLATE_EVENT( FOnTextCommitted, OnTextCommitted )
 
        
        SLATE_ATTRIBUTE( float, MinDesiredWidth )
 
        
        SLATE_ATTRIBUTE( EKeyboardType, KeyboardType )
 
        
        SLATE_ARGUMENT( FVirtualKeyboardOptions, VirtualKeyboardOptions )
 
        
        SLATE_ARGUMENT( bool, EnableIntegratedKeyboard )
 
        SLATE_END_ARGS()
 
 
    
    SLATE_API SVirtualKeyboardEntry();
    
    SLATE_API void Construct( const FArguments& InArgs );
 
    SLATE_API void RestoreOriginalText();
 
    SLATE_API bool HasTextChangedFromOriginal() const;
 
    SLATE_API void SetText(const TAttribute< FText >& InNewText);
 
    SLATE_API void SetFont( const TAttribute< FSlateFontInfo >& InNewFont );
 
    SLATE_API bool GetIsReadOnly() const;
 
public:
    //~ Begin IVirtualKeyboardEntry Interface
    SLATE_API virtual void SetTextFromVirtualKeyboard(const FText& InNewText, ETextEntryType TextEntryType) override;
    SLATE_API virtual void SetSelectionFromVirtualKeyboard(int InSelStart, int InSelEnd) override;
 
    virtual bool GetSelection(int& OutSelStart, int& OutSelEnd) override
    {
        return false;
    }
 
    virtual FText GetText() const override
    {
        check(IsInGameThread());
 
        return Text.Get();
    }
 
    virtual FText GetHintText() const override
    {
        check(IsInGameThread());
 
        return HintText.Get();
    }
 
    virtual EKeyboardType GetVirtualKeyboardType() const override
    {
        check(IsInGameThread());
 
        return KeyboardType.Get();
    }
 
    virtual FVirtualKeyboardOptions GetVirtualKeyboardOptions() const override
    {
        check(IsInGameThread());
 
        return VirtualKeyboardOptions;
    }
 
    virtual bool IsMultilineEntry() const override
    {
        check(IsInGameThread());
 
        return false;
    }
 
    virtual bool IsIntegratedKeyboardEnabled() const override
    {
        check(IsInGameThread());
 
        return bEnableIntegratedKeyboard.Get();
    }
    //~ End IVirtualKeyboardEntry Interface
 
protected:
 
    //~ Begin SWidget Interface
    SLATE_API virtual void Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) override;
    SLATE_API virtual FVector2D ComputeDesiredSize(float) const override;
    SLATE_API virtual int32 OnPaint( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled ) const override;
    SLATE_API virtual bool SupportsKeyboardFocus() const override;
    SLATE_API virtual FReply OnFocusReceived( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual void OnFocusLost( const FFocusEvent& InFocusEvent ) override;
    //~ End SWidget Interface
 
private:
 
    SLATE_API FString GetStringToRender() const;
 
private:
 
    TAttribute< FText > Text;
 
    TAttribute< FText > HintText;
 
    TAttribute< FSlateFontInfo > Font;
 
    TAttribute<FSlateColor> ColorAndOpacity;
 
    TAttribute< bool > IsReadOnly;
 
    TAttribute< bool > ClearKeyboardFocusOnCommit;
 
    FOnTextChanged OnTextChanged;
 
    FOnTextCommitted OnTextCommitted;
 
    FText EditedText;
 
    FText OriginalText;
 
    FScrollHelper ScrollHelper;
 
    bool bWasFocusedByLastMouseDown;
 
    bool bIsChangingText;
 
    TAttribute<float> MinDesiredWidth;
 
    TAttribute<EKeyboardType> KeyboardType;
 
    TAttribute<bool> bEnableIntegratedKeyboard;
 
    FVirtualKeyboardOptions VirtualKeyboardOptions;
 
    bool bNeedsUpdate;
 
};