FScreenReaderApplicationMessageHandlerBase

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FGenericApplicationMessageHandler

FScreenReaderApplicationMessageHandlerBase

References

Module

ScreenReader

Header

/Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h

Include

#include "GenericPlatform/ScreenReaderApplicationMessageHandlerBase.h"

Syntax

class FScreenReaderApplicationMessageHandlerBase : public FGenericApplicationMessageHandler

Remarks

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.

Variables

Name Description

Protected variable

FScreenReaderBa...

 

OwningScreenReader

The screen reader that owns this screen reader application message handler.

Constructors

Destructors

Functions

Name Description

Public function Const

TSharedRef< ...

 

GetTargetMessageHandler()

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

Public function

void

 

SetProcessKeyInput

(
    bool bInProcessKeyInput
)

Sets whether key inputs should be intercepted and processed.

Public function

void

 

SetProcessMouseInput

(
    bool bInProcessMouseInput
)

Sets whether mouse events should be intercepted and processed.

Public function Const

bool

 

ShouldProcessKeyInput()

Retursn true if the key inputs should be intercepted and processed. Else returns false.

Public function Const

bool

 

ShouldProcessMouseInput()

Returns true if mouse events should be processed. Else returns false.

Overridden from FGenericApplicationMessageHandler

Name Description

Public function Virtual

bool

 

BeginReshapingWindow

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

void

 

FinishedReshapingWindow

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual Const

FWindowSizeL...

 

GetSizeLimitsForWindow

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

EWindowZone:...

 

GetWindowZoneForPoint

(
    const TSharedRef< FGenericWindow > ...,
    const int32 X,
    const int32 Y
)

Public function Virtual

void

 

HandleDPIScaleChanged

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

bool

 

OnApplicationActivationChanged

(
    const bool IsActive
)

Public function Virtual

void

 

OnBeginGesture()

Public function Virtual

bool

 

OnControllerAnalog

(
    FGamepadKeyNames::Type KeyName,
    int32 ControllerId,
    float AnalogValue
)

Deprecate these when engine code has been converted to handle platform user id.

Public function Virtual

bool

 

OnControllerButtonPressed

(
    FGamepadKeyNames::Type KeyName,
    int32 ControllerId,
    bool IsRepeat
)

Public function Virtual

bool

 

OnControllerButtonReleased

(
    FGamepadKeyNames::Type KeyName,
    int32 ControllerId,
    bool IsRepeat
)

Public function Virtual

bool

 

OnConvertibleLaptopModeChanged()

Public function Virtual

bool

 

OnCursorSet()

Public function Virtual

EDropEffect:...

 

OnDragDrop

(
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

EDropEffect:...

 

OnDragEnterExternal

(
    const TSharedRef< FGenericWindow > ...,
    const FString& Text,
    const TArray< FString >& Files
)

Public function Virtual

EDropEffect:...

 

OnDragEnterFiles

(
    const TSharedRef< FGenericWindow > ...,
    const TArray< FString >& Files
)

Public function Virtual

EDropEffect:...

 

OnDragEnterText

(
    const TSharedRef< FGenericWindow > ...,
    const FString& Text
)

Public function Virtual

void

 

OnDragLeave

(
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

EDropEffect:...

 

OnDragOver

(
    const TSharedPtr< FGenericWindow > ...
)

Public function Virtual

void

 

OnEndGesture()

Public function Virtual

bool

 

OnKeyChar

(
    const TCHAR Character,
    const bool IsRepeat
)

Public function Virtual

bool

 

OnKeyDown

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

Public function Virtual

bool

 

OnKeyUp

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

Public function Virtual

bool

 

OnMotionDetected

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

Public function Virtual

bool

 

OnMouseDoubleClick

(
    const TSharedPtr< FGenericWindow > ...,
    const EMouseButtons::Type Button,
    const FVector2D CursorPos
)

Public function Virtual

bool

 

OnMouseDoubleClick

(
    const TSharedPtr< FGenericWindow > ...,
    const EMouseButtons::Type Button
)

Public function Virtual

bool

 

OnMouseDown

(
    const TSharedPtr< FGenericWindow > ...,
    const EMouseButtons::Type Button,
    const FVector2D CursorPos
)

Public function Virtual

bool

 

OnMouseDown

(
    const TSharedPtr< FGenericWindow > ...,
    const EMouseButtons::Type Button
)

Public function Virtual

bool

 

OnMouseMove()

Public function Virtual

bool

 

OnMouseUp

(
    const EMouseButtons::Type Button,
    const FVector2D CursorPos
)

Public function Virtual

bool

 

OnMouseUp

(
    const EMouseButtons::Type Button
)

Public function Virtual

bool

 

OnMouseWheel

(
    const float Delta,
    const FVector2D CursorPos
)

Public function Virtual

bool

 

OnMouseWheel

(
    const float Delta
)

Public function Virtual

void

 

OnMovedWindow

(
    const TSharedRef< FGenericWindow > ...,
    const int32 X,
    const int32 Y
)

Public function Virtual

void

 

OnOSPaint

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

bool

 

OnRawMouseMove

(
    const int32 X,
    const int32 Y
)

Public function Virtual

void

 

OnResizingWindow

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual

bool

 

OnSizeChanged

(
    const TSharedRef< FGenericWindow > ...,
    const int32 Width,
    const int32 Height,
    bool bWasMinimized
)

Public function Virtual

bool

 

OnTouchEnded

(
    const FVector2D& Location,
    int32 TouchIndex,
    int32 ControllerId
)

Public function Virtual

bool

 

OnTouchFirstMove

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

Public function Virtual

bool

 

OnTouchForceChanged

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

Public function Virtual

bool

 

OnTouchGesture

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

Public function Virtual

bool

 

OnTouchMoved

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

Public function Virtual

bool

 

OnTouchStarted

(
    const TSharedPtr< FGenericWindow > ...,
    const FVector2D& Location,
    float Force,
    int32 TouchIndex,
    int32 ControllerId
)

Public function Virtual

bool

 

OnWindowAction

(
    const TSharedRef< FGenericWindow > ...,
    const EWindowAction::Type InActionT...
)

Public function Virtual

bool

 

OnWindowActivationChanged

(
    const TSharedRef< FGenericWindow > ...,
    const EWindowActivation ActivationT...
)

Public function Virtual

void

 

OnWindowClose

(
    const TSharedRef< FGenericWindow > ...
)

Public function Virtual Const

bool

 

ShouldProcessUserInputMessages

(
    const TSharedPtr< FGenericWindow > ...
)

FGenericApplicationMessageHandlerBy default all the following functions just forward the call to the underlying message handler.

Public function Virtual

void

 

ShouldSimulateGesture

(
    EGestureEvent Gesture,
    bool bEnable
)