1. Epic GamesDeveloper
  3. FScreenReaderApplicationMessageHandlerBase

FScreenReaderApplicationMessageHandlerBase

The base class all screen reader application message handlers should derive from.

API > API/Plugins > API/Plugins/ScreenReader

The base class all screen reader application message handlers should derive from. By default, this is just a proxy for the underlying target message handler. The screen reader application message handler will intercept all application messages and may perform processing on the events before consuming the event or passing it to the underlying target message handler. Child classes should override the virtual event handlers from FGenericAccessibleMessageHandler to perform input processing for thier needs. For example: A mobile screen reader application message handler can subclass this class and intercept touch inputs to perform gesture detection to provide alternative navigation schemes for users. A desktop screen reader application message handler can subclass this class and intercept mouse movement events to speak widgets that the user mouses over.

   
Name FScreenReaderApplicationMessageHandlerBase
Type class
Header File /Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h
Include Path #include "GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h"

Syntax

class FScreenReaderApplicationMessageHandlerBase : public FGenericApplicationMessageHandler

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FScreenReaderApplicationMessageHandlerBase ( const TSharedRef< FGenericApplicationMessageHandler >& InTargetMessageHandler,
FScreenReaderBase& InOwningScreenReader
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  
  GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FScreenReaderApplicationMessageHandlerBase()

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bProcessKeyInput bool True if the screen reader application message handler should process key inputs. Else false. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  
bProcessMouseInput bool True if the screen reader application message handler should process mouse input. Else false. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  
TargetMessageHandler TSharedRef< FGenericApplicationMessageHandler > The underlying message handler that application messages will bubble down to if the screen reader applicaiton message handler does not consume or handle the app.application messages. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool BeginReshapingWindow ( const TSharedRef< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void FinishedReshapingWindow ( const TSharedRef< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual FWindowSizeLimits GetSizeLimitsForWindow ( const TSharedRef< FGenericWindow >& Window
) const

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

TSharedRef< FGenericApplicationMessageHandler > GetTargetMessageHandler()

 Returns the underlying message handler that application messages bubble down to if the screen reader application message handler does not handle the event. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual EWindowZone::Type GetWindowZoneForPoint ( const TSharedRef< FGenericWindow >& Window,
const int32 X,
const int32 Y
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void HandleDPIScaleChanged ( const TSharedRef< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnApplicationActivationChanged ( const bool IsActive
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void OnBeginGesture()

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnControllerAnalog ( FGamepadKeyNames::Type KeyName,
FPlatformUserId PlatformUserId,
FInputDeviceId InputDeviceId,
float AnalogValue
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnControllerButtonPressed ( FGamepadKeyNames::Type KeyName,
FPlatformUserId PlatformUserId,
FInputDeviceId InputDeviceId,
bool IsRepeat
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnControllerButtonReleased ( FGamepadKeyNames::Type KeyName,
FPlatformUserId PlatformUserId,
FInputDeviceId InputDeviceId,
bool IsRepeat
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnConvertibleLaptopModeChanged()

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnCursorSet()

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual EDropEffect::Type OnDragDrop ( const TSharedPtr< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual EDropEffect::Type OnDragEnterExternal ( const TSharedRef< FGenericWindow >& Window,
const FString& Text,
const TArray< FString >& Files
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual EDropEffect::Type OnDragEnterFiles ( const TSharedRef< FGenericWindow >& Window,
const TArray< FString >& Files
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual EDropEffect::Type OnDragEnterText ( const TSharedRef< FGenericWindow >& Window,
const FString& Text
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void OnDragLeave ( const TSharedPtr< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual EDropEffect::Type OnDragOver ( const TSharedPtr< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void OnEndGesture()

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnKeyChar ( const TCHAR Character,
const bool IsRepeat
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnKeyDown ( const int32 KeyCode,
const uint32 CharacterCode,
const bool IsRepeat
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnKeyUp ( const int32 KeyCode,
const uint32 CharacterCode,
const bool IsRepeat
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMotionDetected ( const FVector& Tilt,
const FVector& RotationRate,
const FVector& Gravity,
const FVector& Acceleration,
int32 ControllerId
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseDoubleClick ( const TSharedPtr< FGenericWindow >& Window,
const EMouseButtons::Type Button,
const FVector2D CursorPos
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseDoubleClick ( const TSharedPtr< FGenericWindow >& Window,
const EMouseButtons::Type Button
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseDown ( const TSharedPtr< FGenericWindow >& Window,
const EMouseButtons::Type Button,
const FVector2D CursorPos
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseDown ( const TSharedPtr< FGenericWindow >& Window,
const EMouseButtons::Type Button
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseMove()

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseUp ( const EMouseButtons::Type Button,
const FVector2D CursorPos
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseUp ( const EMouseButtons::Type Button
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseWheel ( const float Delta,
const FVector2D CursorPos
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnMouseWheel ( const float Delta
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void OnMovedWindow ( const TSharedRef< FGenericWindow >& Window,
const int32 X,
const int32 Y
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void OnOSPaint ( const TSharedRef< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnRawMouseMove ( const int32 X,
const int32 Y
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void OnResizingWindow ( const TSharedRef< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnSizeChanged ( const TSharedRef< FGenericWindow >& Window,
const int32 Width,
const int32 Height,
bool bWasMinimized
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnTouchEnded ( const FVector2D& Location,
int32 TouchIndex,
int32 ControllerId
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnTouchFirstMove ( const FVector2D& Location,
float Force,
int32 TouchIndex,
int32 ControllerId
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnTouchForceChanged ( const FVector2D& Location,
float Force,
int32 TouchIndex,
int32 ControllerId
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnTouchGesture ( EGestureEvent GestureType,
const FVector2D& Delta,
float WheelDelta,
bool bIsDirectionInvertedFromDevice
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnTouchMoved ( const FVector2D& Location,
float Force,
int32 TouchIndex,
int32 ControllerId
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnTouchStarted ( const TSharedPtr< FGenericWindow >& Window,
const FVector2D& Location,
float Force,
int32 TouchIndex,
int32 ControllerId
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnWindowAction ( const TSharedRef< FGenericWindow >& Window,
const EWindowAction::Type InActionType
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool OnWindowActivationChanged ( const TSharedRef< FGenericWindow >& Window,
const EWindowActivation ActivationType
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void OnWindowClose ( const TSharedRef< FGenericWindow >& Window
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

void SetProcessKeyInput ( bool bInProcessKeyInput
)

 Sets whether key inputs should be intercepted and processed. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

void SetProcessMouseInput ( bool bInProcessMouseInput
)

 Sets whether mouse events should be intercepted and processed. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

bool ShouldProcessKeyInput()

 Retursn true if the key inputs should be intercepted and processed. Else returns false. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

bool ShouldProcessMouseInput()

 Returns true if mouse events should be processed. Else returns false. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual bool ShouldProcessUserInputMessages ( const TSharedPtr< FGenericWindow >& PlatformWindow
) const

 FGenericApplicationMessageHandler By default all the following functions just forward the call to the underlying message handler. GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

virtual void ShouldSimulateGesture ( EGestureEvent Gesture,
bool bEnable
)

   GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page