UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FWindowsTextInputMethodSystem Class Reference

#include <WindowsTextInputMethodSystem.h>

+ Inheritance diagram for FWindowsTextInputMethodSystem:

Public Member Functions

virtual ~FWindowsTextInputMethodSystem ()
 
bool Initialize ()
 
void Terminate ()
 
int32 ProcessMessage (HWND hwnd, uint32 msg, WPARAM wParam, LPARAM lParam)
 
virtual void ApplyDefaults (const TSharedRef< FGenericWindow > &InWindow) override
 
virtual TSharedPtr< ITextInputMethodChangeNotifierRegisterContext (const TSharedRef< ITextInputMethodContext > &Context) override
 
virtual void UnregisterContext (const TSharedRef< ITextInputMethodContext > &Context) override
 
virtual void ActivateContext (const TSharedRef< ITextInputMethodContext > &Context) override
 
virtual void DeactivateContext (const TSharedRef< ITextInputMethodContext > &Context) override
 
virtual bool IsActiveContext (const TSharedRef< ITextInputMethodContext > &Context) const override
 
- Public Member Functions inherited from ITextInputMethodSystem
virtual ~ITextInputMethodSystem ()
 

Friends

class FTSFActivationProxy
 

Constructor & Destructor Documentation

◆ ~FWindowsTextInputMethodSystem()

virtual FWindowsTextInputMethodSystem::~FWindowsTextInputMethodSystem ( )
inlinevirtual

Member Function Documentation

◆ ActivateContext()

void FWindowsTextInputMethodSystem::ActivateContext ( const TSharedRef< ITextInputMethodContext > &  Context)
overridevirtual

Activates the provided context. Editable text should call this method when keyboard focus is received.

Parameters
ContextThe context to be activated.

Implements ITextInputMethodSystem.

◆ ApplyDefaults()

void FWindowsTextInputMethodSystem::ApplyDefaults ( const TSharedRef< FGenericWindow > &  InWindow)
overridevirtual

Called when a window is first created to allow the text input system to apply any default settings

Implements ITextInputMethodSystem.

◆ DeactivateContext()

void FWindowsTextInputMethodSystem::DeactivateContext ( const TSharedRef< ITextInputMethodContext > &  Context)
overridevirtual

Deactivates the provided context. Editable text should call this method when keyboard focus is lost.

Parameters
ContextThe context to be activated.

Implements ITextInputMethodSystem.

◆ Initialize()

bool FWindowsTextInputMethodSystem::Initialize ( )

◆ IsActiveContext()

bool FWindowsTextInputMethodSystem::IsActiveContext ( const TSharedRef< ITextInputMethodContext > &  Context) const
overridevirtual

Test to see whether the provided context is the currently active context

Parameters
ContextThe context to be checked.
Returns
True if the context is active, false otherwise

Implements ITextInputMethodSystem.

◆ ProcessMessage()

int32 FWindowsTextInputMethodSystem::ProcessMessage ( HWND  hwnd,
uint32  msg,
WPARAM  wParam,
LPARAM  lParam 
)

◆ RegisterContext()

TSharedPtr< ITextInputMethodChangeNotifier > FWindowsTextInputMethodSystem::RegisterContext ( const TSharedRef< ITextInputMethodContext > &  Context)
overridevirtual

Registers an implemented context interface object with the system to receive callbacks and provides an implemented notifier interface object. Editable text should call this method after constructing an implemented context interface object.

Parameters
ContextThe implemented context interface object to be registered.
Returns
An implemented notifier interface object

Implements ITextInputMethodSystem.

◆ Terminate()

void FWindowsTextInputMethodSystem::Terminate ( )

◆ UnregisterContext()

void FWindowsTextInputMethodSystem::UnregisterContext ( const TSharedRef< ITextInputMethodContext > &  Context)
overridevirtual

Unregisters an implemented context interface object with the system. Editable text should call this method before destroying an implemented context interface object.

Parameters
ContextThe implemented context interface object to be unregistered.

Implements ITextInputMethodSystem.

Friends And Related Symbol Documentation

◆ FTSFActivationProxy


The documentation for this class was generated from the following files: