AzFramework::InputDeviceVirtualKeyboard::Implementation Class Reference

Base class for platform specific implementations of virtual keyboard input devices. More...

#include <InputDeviceVirtualKeyboard.h>

Public Member Functions
	AZ_CLASS_ALLOCATOR (Implementation, AZ::SystemAllocator)
	Implementation (InputDeviceVirtualKeyboard &inputDevice)
	AZ_DISABLE_COPY_MOVE (Implementation)
virtual	~Implementation ()
	Destructor.
virtual bool	IsConnected () const =0
virtual bool	HasTextEntryStarted () const =0
virtual void	TextEntryStart (const VirtualKeyboardOptions &options)=0
virtual void	TextEntryStop ()=0
	Hide the virtual keyboard, disabling text input (pair with StartTextInput)
virtual void	TickInputDevice ()=0
	Tick/update the input device to broadcast all input events since the last frame.
void	QueueRawCommandEvent (const InputChannelId &inputChannelId)
void	QueueRawTextEvent (const AZStd::string &textUTF8)

Static Public Member Functions
static Implementation *	Create (InputDeviceVirtualKeyboard &inputDevice)

Protected Member Functions
void	ProcessRawEventQueues ()
void	ResetInputChannelStates ()
	Reset the state of all this input device's associated input channels.

Detailed Description

Base class for platform specific implementations of virtual keyboard input devices.

Constructor & Destructor Documentation

Implementation()

AzFramework::InputDeviceVirtualKeyboard::Implementation::Implementation

(

InputDeviceVirtualKeyboard &

inputDevice

)

Constructor

Parameters

[in]

inputDevice

Reference to the input device being implemented

Member Function Documentation

Create()

static Implementation * AzFramework::InputDeviceVirtualKeyboard::Implementation::Create ( InputDeviceVirtualKeyboard &  inputDevice )

static

Default factory create function

Parameters

[in]

inputDevice

Reference to the input device being implemented

HasTextEntryStarted()

virtual bool AzFramework::InputDeviceVirtualKeyboard::Implementation::HasTextEntryStarted ( ) const

pure virtual

Query whether the virtual keyboard is being displayed/text input enabled

Returns

True if the virtual keyboard is being displayed, false otherwise

IsConnected()

virtual bool AzFramework::InputDeviceVirtualKeyboard::Implementation::IsConnected ( ) const

pure virtual

Query the connected state of the input device

Returns

True if the input device is currently connected, false otherwise

ProcessRawEventQueues()

void AzFramework::InputDeviceVirtualKeyboard::Implementation::ProcessRawEventQueues ( )

protected

Process raw input events that have been queued since the last call to this function. This function is not thread safe, and so should only be called from the main thread.

QueueRawCommandEvent()

void AzFramework::InputDeviceVirtualKeyboard::Implementation::QueueRawCommandEvent

(

const InputChannelId &

inputChannelId

)

Queue raw command event to be processed in the next call to ProcessRawEventQueues. This function is not thread safe and so should only be called from the main thread.

Parameters

[in]

inputChannelId

The input channel id

QueueRawTextEvent()

void AzFramework::InputDeviceVirtualKeyboard::Implementation::QueueRawTextEvent

(

const AZStd::string &

textUTF8

)

Queue raw text events to be processed in the next call to ProcessRawEventQueues. This function is not thread safe and so should only be called from the main thread.

Parameters

[in]

textUTF8

The text to queue (encoded using UTF-8)

TextEntryStart()

virtual void AzFramework::InputDeviceVirtualKeyboard::Implementation::TextEntryStart ( const VirtualKeyboardOptions &  options )

pure virtual

Display the virtual keyboard, enabling text input (pair with StopTextInput)

Parameters

[in]

options

Used to specify the appearance/behavior of the virtual keyboard

---

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

• Code/Framework/AzFramework/AzFramework/Input/Devices/VirtualKeyboard/InputDeviceVirtualKeyboard.h