Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > ApplicationCore > GenericPlatform > ITextInputMethodContext

Light Theme

Dark Theme

ITextInputMethodContext

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

Windows

MacOS

Linux

Inheritance Hierarchy

ITextInputMethodContext

FSlateEditableTextLayout::FTextInputMethodContext

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
	~ITextInputMethodContext()

Functions

	Name	Description
void	BeginComposition()	Begins composition.
void	EndComposition()	Ends composition. May or may not mean the composition was committed.
int32	GetCharacterIndexFromPoint ( const FVector2D& InPoint )	Gets the index of the code point at the point on the screen.
void	GetScreenBounds ( FVector2D& OutPosition, FVector2D& OutSize )	Measures the screen-space bounds of the display area available for text.
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.
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.
void	GetTextInRange ( const uint32 InBeginIndex, const uint32 InLength, FString& OutString )	Gets the code points in a range of indices.
uint32	GetTextLength()	Returns the number of code points in the text.
TSharedPtr< ...	GetWindow()	Returns the window in which the text is displayed.
bool	IsComposing()	Returns whether or not this context is currently composing.
bool	IsReadOnly()	Returns whether or not this text is read-only.
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.
void	SetTextInRange ( const uint32 InBeginIndex, const uint32 InLength, const FString& InString )	Sets the code points in a range of indices.
void	UpdateCompositionRange ( const int32 InBeginIndex, const uint32 InLength )	Updates the range of code point indices being composed.

Enums

	Name	Description
	ECaretPosition

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss