Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
AzFramework::InputTextEntryRequests Class Reference

EBus interface used to send text entry requests to connected input devices. More...

#include <InputTextEntryRequestBus.h>

Inherits AZ::EBusTraits.

Classes

struct  VirtualKeyboardOptions
 

Public Types

using BusIdType = InputDeviceId
 EBus Trait: requests can be addressed to a specific InputDeviceId.
 

Public Member Functions

virtual bool HasTextEntryStarted () const
 
virtual void TextEntryStart (const VirtualKeyboardOptions &)
 
virtual void TextEntryStop ()
 
virtual ~InputTextEntryRequests ()=default
 Default destructor.
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 EBus Trait: requests should be handled by only one input device connected to each id.
 

Detailed Description

EBus interface used to send text entry requests to connected input devices.

Member Function Documentation

◆ HasTextEntryStarted()

virtual bool AzFramework::InputTextEntryRequests::HasTextEntryStarted ( ) const
inlinevirtual

Query whether text entry has already been started

Called using either:

  • EBus<>::Broadcast (any input device can respond to the request)
  • EBus<>::Event(id) (the given device can respond to the request)
Returns
True if text entry has already been started, false otherwise

◆ TextEntryStart()

virtual void AzFramework::InputTextEntryRequests::TextEntryStart ( const VirtualKeyboardOptions &  )
inlinevirtual

Inform input devices that text input is expected to start (pair with StopTextInput)

Called using either:

  • EBus<>::Broadcast (any input device can respond to the request)
  • EBus<>::Event(id) (the given device can respond to the request)
Parameters
[in]optionsUsed to specify the appearance/behavior of any virtual keyboard shown

◆ TextEntryStop()

virtual void AzFramework::InputTextEntryRequests::TextEntryStop ( )
inlinevirtual

Inform input devices that text input is expected to stop (pair with StartTextInput)

Called using either:

  • EBus<>::Broadcast (any input device can respond to the request)
  • EBus<>::Event(id) (the given device can respond to the request)

Member Data Documentation

◆ AddressPolicy

const AZ::EBusAddressPolicy AzFramework::InputTextEntryRequests::AddressPolicy = AZ::EBusAddressPolicy::ById
static

EBus Trait: requests can be addressed to a specific InputDeviceId using EBus<>::Event, which should be handled by only one device that has connected to the bus using that id. Input requests can also be sent using EBus<>::Broadcast, in which case they'll be sent to all input devices that have connected to the input event bus regardless of their id.

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