ITextInputMethodContext

Editable texts should implement this class and maintain an object of this type after registering it.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ApplicationCore

Header

/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/ITextInputMethodSystem.h

Include

#include "GenericPlatform/ITextInputMethodSystem.h"

Syntax

class ITextInputMethodContext

Remarks

Editable texts should implement this class and maintain an object of this type after registering it. Methods of this class are called by the system to query contextual information about the state of the editable text. This information is used by the text input method system to provide appropriate processed input. Methods of this class are also called by the system to provide processed text input.

Destructors

Name Description

Public function Virtual

~ITextInputMethodContext()

Functions

Name Description

Public function

void

 

BeginComposition()

Begins composition.

Public function

void

 

EndComposition()

Ends composition. May or may not mean the composition was committed.

Public function

int32

 

GetCharacterIndexFromPoint

(
    const FVector2D& InPoint
)

Gets the index of the code point at the point on the screen.

Public function

void

 

GetScreenBounds

(
    FVector2D& OutPosition,
    FVector2D& OutSize
)

Measures the screen-space bounds of the display area available for text.

Public function

void

 

GetSelectionRange

(
    uint32& OutBeginIndex,
    uint32& OutLength,
    ECaretPosition& OutCaretPosition
)

Gets the range of code point indices that are selected and which end of the selection the caret is at.

Public function

bool

 

GetTextBounds

(
    const uint32 InBeginIndex,
    const uint32 InLength,
    FVector2D& OutPosition,
    FVector2D& OutSize
)

Measures the screen-space bounds of the text in the specified range of code points.

Public function

void

 

GetTextInRange

(
    const uint32 InBeginIndex,
    const uint32 InLength,
    FString& OutString
)

Gets the code points in a range of indices.

Public function

uint32

 

GetTextLength()

Returns the number of code points in the text.

Public function

TSharedPtr< ...

 

GetWindow()

Returns the window in which the text is displayed.

Public function

bool

 

IsComposing()

Returns whether or not this context is currently composing.

Public function

bool

 

IsReadOnly()

Returns whether or not this text is read-only.

Public function

void

 

SetSelectionRange

(
    const uint32 InBeginIndex,
    const uint32 InLength,
    const ECaretPosition InCaretPositio...
)

Sets the range of code point indices that are selected and which end of the selection the caret is at.

Public function

void

 

SetTextInRange

(
    const uint32 InBeginIndex,
    const uint32 InLength,
    const FString& InString
)

Sets the code points in a range of indices.

Public function

void

 

UpdateCompositionRange

(
    const int32 InBeginIndex,
    const uint32 InLength
)

Updates the range of code point indices being composed.

Enums

Name

Description

Public enum

ECaretPosition