Class that handles input text event notifications by priority.
More...
#include <InputTextEventListener.h>
Inherits InputTextNotificationBus::Handler.
|
|
static AZ::s32 | GetPriorityFirst () |
|
static AZ::s32 | GetPriorityDebug () |
|
static AZ::s32 | GetPriorityDebugUI () |
|
static AZ::s32 | GetPriorityUI () |
|
static AZ::s32 | GetPriorityDefault () |
|
static AZ::s32 | GetPriorityLast () |
|
Class that handles input text event notifications by priority.
◆ 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 |
◆ 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