IVirtualKeyboardEntry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Types/SlateEnums.h"
 
#include "IVirtualKeyboardEntry.generated.h"
 
// @todo - hook up keyboard types
enum EKeyboardType
{
    Keyboard_Default,
    Keyboard_Number,
    Keyboard_Web,
    Keyboard_Email,
    Keyboard_Password,
    Keyboard_AlphaNumeric,
};
 
enum class ETextEntryType : uint8
{
    TextEntryCanceled,
    TextEntryAccepted,
    TextEntryUpdated
};
 
USTRUCT()
struct FVirtualKeyboardOptions
{
public:
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Autocorrect)
    bool bEnableAutocorrect;
 
    // TODO: Add additional VKB features, such as autocapitalization and autocomplete
 
    FVirtualKeyboardOptions()
        : bEnableAutocorrect(false)
    {
    }
};
 
DECLARE_DELEGATE(FOnSelectionChangedDelegateVK);
 
class IVirtualKeyboardEntry
{
 
public:
    virtual ~IVirtualKeyboardEntry() {}
 
    virtual void SetTextFromVirtualKeyboard(const FText& InNewText, ETextEntryType TextEntryType) = 0;
 
    virtual void SetSelectionFromVirtualKeyboard(int InSelStart, int SelEnd) = 0;
    
    virtual FText GetText() const = 0;
 
    virtual bool GetSelection(int& OutSelStart, int& OutSelEnd) = 0;
 
    FOnSelectionChangedDelegateVK OnSelectionChanged;
 
    virtual FText GetHintText() const = 0;
 
    virtual EKeyboardType GetVirtualKeyboardType() const = 0;
 
    virtual FVirtualKeyboardOptions GetVirtualKeyboardOptions() const = 0;
 
    virtual bool IsMultilineEntry() const = 0;
    
    virtual bool IsIntegratedKeyboardEnabled() const { return false; }
};