1. Epic GamesDeveloper
  3. FScreenReaderBase

FScreenReaderBase

The abstract base class all screen readers must derive from.

Unreal Engine C++ API Reference > Plugins > ScreenReader > GenericPlatform

References

   
Module ScreenReader
Header /Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/GenericPlatform/ScreenReaderBase.h
Include #include "GenericPlatform/ScreenReaderBase.h"

Syntax

class FScreenReaderBase

Remarks

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.

Constructors

  Type Name Description
Public function    
Public function  

FScreenReaderBase ( const TSharedRef< GenericApplication >& InPlatformApplication
)

  
Public function   We disallow copying.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Activates the screen reader and sets up the screen reader framework if the screen reader is inactive.
Public function void Deactivates the screen reader and tears down the screen reading framework if the screen reader is active.
Protected function Const TWeakPtr< GenericApplication > Returns the weak pointer to the platform application.
Public function Const TSharedPtr< FScreenReaderUser >

GetUser ( int32 InUserId
)

 Returns a screen reader user associated with the passed in Id if the Id is registered.
Public function Const TSharedRef< FScreenReaderUser >

GetUserChecked ( int32 InUserId
)

 Returns the screen reader user associated with the passed in Id.
Public function Const bool Returns true if the screen reader is active. Else false.
Public function Const bool

IsUserRegistered ( int32 InUserId
)

 Returns true if the passed in user Id is already registered. Else returns false.
Protected function void

OnAccessibleEventRaised ( const FAccessibleEventArgs& Args
)

 The handler for all accessible events raised from FGenericAccessibleMessageHandler.
Protected function Virtual void Called at the end of Activate().
Protected function Virtual void Called at the start of Deactivate().
Public function 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.
Public function void

SetScreenReaderApplicationMessageHandler ( const TSharedRef< FScreenReaderApplicationMessageHandlerBase >& InScreenReaderApplicationMessageHan...
)

  
Public function void Unregisteres all screen reader users.
Public function bool

UnregisterUser ( int32 InUserId
)

 Unregisters a provided user Id from the screen reader framework and deactivates the user.

Operators

  Type Name Description
Public function FScreenReaderBase &

operator= ( const FScreenReaderBase& Other
)

  

See Also

FScreenReaderUser

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page