ITextInputMethodSystem Class Reference

#include <ITextInputMethodSystem.h>

Inheritance diagram for ITextInputMethodSystem:

Public Member Functions
virtual	~ITextInputMethodSystem ()
virtual void	ApplyDefaults (const TSharedRef< FGenericWindow > &InWindow)=0
virtual TSharedPtr< ITextInputMethodChangeNotifier >	RegisterContext (const TSharedRef< ITextInputMethodContext > &Context)=0
virtual void	UnregisterContext (const TSharedRef< ITextInputMethodContext > &Context)=0
virtual void	ActivateContext (const TSharedRef< ITextInputMethodContext > &Context)=0
virtual void	DeactivateContext (const TSharedRef< ITextInputMethodContext > &Context)=0
virtual bool	IsActiveContext (const TSharedRef< ITextInputMethodContext > &Context) const =0

Detailed Description

Platform owners implement this class to interface with the platform's input method system.

Constructor & Destructor Documentation

~ITextInputMethodSystem()

virtual ITextInputMethodSystem::~ITextInputMethodSystem ( )

inlinevirtual

Member Function Documentation

ActivateContext()

virtual void ITextInputMethodSystem::ActivateContext ( const TSharedRef< ITextInputMethodContext > &  Context )

pure virtual

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

Parameters

Context

The context to be activated.

Implemented in FMacTextInputMethodSystem, and FWindowsTextInputMethodSystem.

ApplyDefaults()

virtual void ITextInputMethodSystem::ApplyDefaults ( const TSharedRef< FGenericWindow > &  InWindow )

pure virtual

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

Implemented in FMacTextInputMethodSystem, and FWindowsTextInputMethodSystem.

DeactivateContext()

virtual void ITextInputMethodSystem::DeactivateContext ( const TSharedRef< ITextInputMethodContext > &  Context )

pure virtual

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

Parameters

Context

The context to be activated.

Implemented in FMacTextInputMethodSystem, and FWindowsTextInputMethodSystem.

IsActiveContext()

virtual bool ITextInputMethodSystem::IsActiveContext ( const TSharedRef< ITextInputMethodContext > &  Context ) const

pure virtual

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

Parameters

Context

The context to be checked.

Returns

True if the context is active, false otherwise

Implemented in FMacTextInputMethodSystem, and FWindowsTextInputMethodSystem.

RegisterContext()

virtual TSharedPtr< ITextInputMethodChangeNotifier > ITextInputMethodSystem::RegisterContext ( const TSharedRef< ITextInputMethodContext > &  Context )

pure virtual

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

Context

The implemented context interface object to be registered.

Returns

An implemented notifier interface object

Implemented in FMacTextInputMethodSystem, and FWindowsTextInputMethodSystem.

UnregisterContext()

virtual void ITextInputMethodSystem::UnregisterContext ( const TSharedRef< ITextInputMethodContext > &  Context )

pure virtual

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

Parameters

Context

The implemented context interface object to be unregistered.

Implemented in FMacTextInputMethodSystem, and FWindowsTextInputMethodSystem.

---

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

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