Navigation
API > API/Runtime > API/Runtime/ApplicationCore
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.
| Name | ITextInputMethodContext |
| Type | class |
| Header File | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/ITextInputMethodSystem.h |
| Include Path | #include "GenericPlatform/ITextInputMethodSystem.h" |
Syntax
class ITextInputMethodContext
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ITextInputMethodContext() |
GenericPlatform/ITextInputMethodSystem.h |
Enums
Public
| Name | Remarks |
|---|---|
| ECaretPosition |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginComposition() |
Begins composition. | GenericPlatform/ITextInputMethodSystem.h | |
void EndComposition() |
Ends composition. May or may not mean the composition was committed. | GenericPlatform/ITextInputMethodSystem.h | |
int32 GetCharacterIndexFromPoint
(
const FVector2D& InPoint |
Gets the index of the code point at the point on the screen. | GenericPlatform/ITextInputMethodSystem.h | |
void GetScreenBounds
(
FVector2D& OutPosition, |
Measures the screen-space bounds of the display area available for text. | GenericPlatform/ITextInputMethodSystem.h | |
void GetSelectionRange
(
uint32& OutBeginIndex, |
Gets the range of code point indices that are selected and which end of the selection the caret is at. | GenericPlatform/ITextInputMethodSystem.h | |
bool GetTextBounds
(
const uint32 InBeginIndex, |
Measures the screen-space bounds of the text in the specified range of code points. | GenericPlatform/ITextInputMethodSystem.h | |
void GetTextInRange
(
const uint32 InBeginIndex, |
Gets the code points in a range of indices. | GenericPlatform/ITextInputMethodSystem.h | |
uint32 GetTextLength() |
Returns the number of code points in the text. | GenericPlatform/ITextInputMethodSystem.h | |
TSharedPtr< FGenericWindow > GetWindow() |
Returns the window in which the text is displayed. | GenericPlatform/ITextInputMethodSystem.h | |
bool IsComposing () |
Returns whether or not this context is currently composing. | GenericPlatform/ITextInputMethodSystem.h | |
bool IsReadOnly() |
Returns whether or not this text is read-only. | GenericPlatform/ITextInputMethodSystem.h | |
void SetSelectionRange
(
const uint32 InBeginIndex, |
Sets the range of code point indices that are selected and which end of the selection the caret is at. | GenericPlatform/ITextInputMethodSystem.h | |
void SetTextInRange
(
const uint32 InBeginIndex, |
Sets the code points in a range of indices. | GenericPlatform/ITextInputMethodSystem.h | |
void UpdateCompositionRange
(
const int32 InBeginIndex, |
Updates the range of code point indices being composed. | GenericPlatform/ITextInputMethodSystem.h |