Navigation
API > API/Plugins > API/Plugins/ScreenReader
The abstract base class all screen readers must derive from. The screen reader sets up and tears down the screen reader framework with Activate() and Deactivate() respectively. When active, the screen reader will intercept all application messages, perform necessary input pre-processing and dispatch the accessible events and inputs to all registered screen reader users. Users of derived classes must activate the screen reader to ensure the accessible inputs and accessible events are dispatched properly. Derived classes must implement the pure virtual OnAccessibleEventRaised function to handle accessible events.
| Name | FScreenReaderBase |
| Type | class |
| Header File | /Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/GenericPlatform/ScreenReaderBase.h |
| Include Path | #include "GenericPlatform/ScreenReaderBase.h" |
Syntax
class FScreenReaderBase
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| GenericPlatform/ScreenReaderBase.h | |||
FScreenReaderBase
(
const TSharedRef< GenericApplication >& InPlatformApplication |
GenericPlatform/ScreenReaderBase.h | ||
FScreenReaderBase
(
const FScreenReaderBase& Other |
We disallow copying. | GenericPlatform/ScreenReaderBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FScreenReaderBase() |
GenericPlatform/ScreenReaderBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bActive | bool | True if the screen reader is active. Else false. | GenericPlatform/ScreenReaderBase.h | |
| PlatformApplication | TWeakPtr< GenericApplication > | The platform application. | GenericPlatform/ScreenReaderBase.h | |
| ScreenReaderApplicationMessageHandler | TSharedRef< FScreenReaderApplicationMessageHandlerBase > | The screen reader's application message handler. | GenericPlatform/ScreenReaderBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Activate () |
Activates the screen reader and sets up the screen reader framework if the screen reader is inactive. | GenericPlatform/ScreenReaderBase.h | |
void Deactivate () |
Deactivates the screen reader and tears down the screen reading framework if the screen reader is active. | GenericPlatform/ScreenReaderBase.h | |
TSharedPtr< FScreenReaderUser > GetUser
(
int32 InUserId |
Returns a screen reader user associated with the passed in Id if the Id is registered. | GenericPlatform/ScreenReaderBase.h | |
TSharedRef< FScreenReaderUser > GetUserChecked
(
int32 InUserId |
Returns the screen reader user associated with the passed in Id. | GenericPlatform/ScreenReaderBase.h | |
bool IsActive() |
Returns true if the screen reader is active. Else false. | GenericPlatform/ScreenReaderBase.h | |
bool IsUserRegistered
(
int32 InUserId |
Returns true if the passed in user Id is already registered. Else returns false. | GenericPlatform/ScreenReaderBase.h | |
bool RegisterUser
(
int32 InUserId |
Registers a provided user Id to the screen reader framework and allows the user to receive and respond to accessible events and accessible input. | GenericPlatform/ScreenReaderBase.h | |
void SetScreenReaderApplicationMessageHandler
(
const TSharedRef< FScreenReaderApplicationMessageHandlerBase >& InScreenReaderApplicationMessageHan... |
GenericPlatform/ScreenReaderBase.h | ||
void UnregisterAllUsers () |
Unregisteres all screen reader users. | GenericPlatform/ScreenReaderBase.h | |
bool UnregisterUser
(
int32 InUserId |
Unregisters a provided user Id from the screen reader framework and deactivates the user. | GenericPlatform/ScreenReaderBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TWeakPtr< GenericApplication > GetPlatformApplicationWeak () |
Returns the weak pointer to the platform application. | GenericPlatform/ScreenReaderBase.h | |
void OnAccessibleEventRaised
(
const FAccessibleEventArgs& Args |
The handler for all accessible events raised from FGenericAccessibleMessageHandler. | GenericPlatform/ScreenReaderBase.h | |
virtual void OnActivate () |
Called at the end of Activate(). | GenericPlatform/ScreenReaderBase.h | |
virtual void OnDeactivate () |
Called at the start of Deactivate(). | GenericPlatform/ScreenReaderBase.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FScreenReaderBase & operator=
(
const FScreenReaderBase& Other |
GenericPlatform/ScreenReaderBase.h |