ISlateEditableTextWidget.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Layout/Visibility.h"
#include "Widgets/SWidget.h"
#include "Framework/Application/IMenu.h"
#include "Widgets/Input/IVirtualKeyboardEntry.h"
 
#include "ISlateEditableTextWidget.generated.h"
 
struct FTextLocation;
 
enum class ECursorMoveMethod
{
    Cardinal,
    ScreenPosition
};
 
enum class ECursorMoveGranularity
{
    Character,
    Word
};
 
enum class ECursorAction
{
    MoveCursor,
    SelectText
};
 
enum class ETextLocation
{
    BeginningOfDocument,
    EndOfDocument,
    BeginningOfLine,
    EndOfLine,
    PreviousPage,
    NextPage,
};
 
UENUM(BlueprintType)
enum class EVirtualKeyboardTrigger : uint8
{
    OnFocusByPointer,
    OnAllFocusEvents,
};
 
UENUM(BlueprintType)
enum class EVirtualKeyboardDismissAction : uint8
{
    TextChangeOnDismiss,
    TextCommitOnAccept,
    TextCommitOnDismiss,
};
 
class FMoveCursor
{
public:
    static FMoveCursor Cardinal(ECursorMoveGranularity Granularity, FIntPoint Direction, ECursorAction Action);
 
    static FMoveCursor ViaScreenPointer(FVector2D LocalPosition, float GeometryScale, ECursorAction Action);
 
    ECursorMoveMethod GetMoveMethod() const;
 
    bool IsVerticalMovement() const;
 
    bool IsHorizontalMovement() const;
 
    ECursorAction GetAction() const;
 
    FIntPoint GetMoveDirection() const;
 
    FVector2D GetLocalPosition() const;
 
    ECursorMoveGranularity GetGranularity() const;
 
    float GetGeometryScale() const;
 
private:
    FMoveCursor(ECursorMoveGranularity InGranularity, ECursorMoveMethod InMethod, FVector2D InDirectionOrPosition, float InGeometryScale, ECursorAction InAction);
 
    ECursorMoveGranularity Granularity;
    ECursorMoveMethod Method;
    FVector2f DirectionOrPosition;
    ECursorAction Action;
    float GeometryScale;
};
 
class FActiveTextEditContextMenu
{
public:
    FActiveTextEditContextMenu()
        : bIsPendingSummon(false)
        , ActiveMenu()
    {
    }
 
    bool IsValid() const
    {
        return bIsPendingSummon || ActiveMenu.IsValid();
    }
 
    void Reset()
    {
        bIsPendingSummon = false;
        ActiveMenu.Reset();
    }
 
    void PrepareToSummon()
    {
        bIsPendingSummon = true;
        ActiveMenu.Reset();
    }
 
    void SummonSucceeded(const TSharedRef<IMenu>& InMenu)
    {
        bIsPendingSummon = false;
        ActiveMenu = InMenu;
    }
 
    void SummonFailed()
    {
        bIsPendingSummon = false;
        ActiveMenu.Reset();
    }
 
    void Dismiss()
    {
        if (ActiveMenu.IsValid())
        {
            auto ActiveMenuPin = ActiveMenu.Pin();
            ActiveMenuPin->Dismiss();
        }
        Reset();
    }
 
private:
    bool bIsPendingSummon;
 
    TWeakPtr<IMenu> ActiveMenu;
};
 
class ISlateEditableTextWidget
{
public:
    virtual bool IsTextReadOnly() const = 0;
 
    virtual bool IsTextPassword() const = 0;
 
    virtual bool IsMultiLineTextEdit() const = 0;
 
    virtual bool ShouldJumpCursorToEndWhenFocused() const = 0;
 
    virtual bool ShouldSelectAllTextWhenFocused() const = 0;
 
    virtual bool ShouldClearTextSelectionOnFocusLoss() const = 0;
 
    virtual bool ShouldRevertTextOnEscape() const = 0;
 
    virtual bool ShouldClearKeyboardFocusOnCommit() const = 0;
 
    virtual bool ShouldSelectAllTextOnCommit() const = 0;
 
    virtual bool ShouldSelectWordOnMouseDoubleClick() const = 0;
 
    virtual bool CanInsertCarriageReturn() const = 0;
 
    virtual bool CanTypeCharacter(const TCHAR InChar) const = 0;
 
    virtual bool IsIntegratedKeyboardEnabled() const = 0;
 
    virtual void EnsureActiveTick() = 0;
 
    virtual EKeyboardType GetVirtualKeyboardType() const = 0;
 
    virtual FVirtualKeyboardOptions GetVirtualKeyboardOptions() const = 0;
 
    virtual EVirtualKeyboardTrigger GetVirtualKeyboardTrigger() const = 0;
 
    virtual EVirtualKeyboardDismissAction GetVirtualKeyboardDismissAction() const = 0;
 
    virtual TSharedRef<SWidget> GetSlateWidget() = 0;
 
    virtual TSharedPtr<SWidget> GetSlateWidgetPtr() = 0;
 
    virtual TSharedPtr<SWidget> BuildContextMenuContent() const = 0;
    
    virtual void OnBeginTextEdit(const FText& InText) = 0;
 
    virtual void OnTextChanged(const FText& InText) = 0;
 
    virtual void OnTextCommitted(const FText& InText, const ETextCommit::Type InTextAction) = 0;
 
    virtual void OnCursorMoved(const FTextLocation& InLocation) = 0;
 
    virtual float UpdateAndClampHorizontalScrollBar(const float InViewOffset, const float InViewFraction, const EVisibility InVisiblityOverride) = 0;
 
    virtual float UpdateAndClampVerticalScrollBar(const float InViewOffset, const float InViewFraction, const EVisibility InVisiblityOverride) = 0;
};