AzFramework::InputTextEventListener Class Reference

Class that handles input text event notifications by priority. More...

#include <InputTextEventListener.h>

Inherits InputTextNotificationBus::Handler.

Public Member Functions
	InputTextEventListener ()
	Constructor.
	InputTextEventListener (bool autoConnect)
	InputTextEventListener (AZ::s32 priority)
	InputTextEventListener (AZ::s32 priority, bool autoConnect)
	AZ_DEFAULT_COPY (InputTextEventListener)
	~InputTextEventListener () override=default
	Default destructor.
AZ::s32	GetPriority () const override
	AzFramework::InputTextNotifications::GetPriority
void	Connect ()
	Connect to the input notification bus to start receiving input notifications.
void	Disconnect ()
	Disconnect from the input notification bus to stop receiving input notifications.

Static Public Member Functions
static AZ::s32	GetPriorityFirst ()
static AZ::s32	GetPriorityDebug ()
static AZ::s32	GetPriorityDebugUI ()
static AZ::s32	GetPriorityUI ()
static AZ::s32	GetPriorityDefault ()
static AZ::s32	GetPriorityLast ()

Protected Member Functions
void	OnInputTextEvent (const AZStd::string &textUTF8, bool &o_hasBeenConsumed) final
	AzFramework::InputTextNotifications::OnInputTextEvent
virtual bool	OnInputTextEventFiltered (const AZStd::string &textUTF8)=0

Detailed Description

Class that handles input text event notifications by priority.

Constructor & Destructor Documentation

InputTextEventListener() [1/3]

AzFramework::InputTextEventListener::InputTextEventListener ( bool  autoConnect )

explicit

Constructor

Parameters

[in]

autoConnect

Whether to connect to the input notification bus on construction

InputTextEventListener() [2/3]

AzFramework::InputTextEventListener::InputTextEventListener ( AZ::s32  priority )

explicit

Constructor

Parameters

[in]

priority

The priority used to sort relative to other text event listeners

InputTextEventListener() [3/3]

AzFramework::InputTextEventListener::InputTextEventListener ( AZ::s32  priority, bool  autoConnect  )

explicit

Constructor

Parameters

[in]	priority	The priority used to sort relative to other text event listeners
[in]	autoConnect	Whether to connect to the input notification bus on construction

Member Function Documentation

GetPriorityFirst()

static AZ::s32 AzFramework::InputTextEventListener::GetPriorityFirst ( )

inlinestatic

Predefined text event listener priority, used to sort handlers from highest to lowest

OnInputTextEventFiltered()

virtual bool AzFramework::InputTextEventListener::OnInputTextEventFiltered ( const AZStd::string &  textUTF8 )

protectedpure virtual

Override to be notified when input text events are generated, but not those already been consumed by a higher priority listener, or those that do not pass this listener's filter.

Parameters

[in]

textUTF8

The text to process (encoded using UTF-8)

Returns

True if the text event has been consumed, false otherwise

---

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

• Code/Framework/AzFramework/AzFramework/Input/Events/InputTextEventListener.h