1. Epic GamesDeveloper
  3. FScreenReaderApplicationMessageHandlerBase

FScreenReaderApplicationMessageHandlerBase

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

API > API/Plugins > API/Plugins/ScreenReader > API/Plugins/ScreenReader/GenericPlatform

Inheritance Hierarchy

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

  Type Name Description
Protected variable FScreenReaderBase & OwningScreenReader The screen reader that owns this screen reader application message handler.

Constructors

  Type Name Description
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const TSharedRef< FGenericApplicationMessageHandler > 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 Retursn true if the key inputs should be intercepted and processed. Else returns false.
Public function Const bool Returns true if mouse events should be processed. Else returns false.

Overridden from FGenericApplicationMessageHandler

  Type Name Description
Public function Virtual bool  
Public function Virtual void  
Public function Virtual Const FWindowSizeLimits  
Public function Virtual EWindowZone::Type

GetWindowZoneForPoint ( const TSharedRef< FGenericWindow >& Window,
const int32 X,
const int32 Y
)

  
Public function Virtual void  
Public function Virtual bool

OnApplicationActivationChanged ( const bool IsActive
)

  
Public function Virtual void  
Public function Virtual bool

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

  
Public function Virtual bool

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

  
Public function Virtual bool

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

  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual EDropEffect::Type

OnDragDrop ( const TSharedPtr< FGenericWindow >& Window
)

  
Public function Virtual EDropEffect::Type

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

  
Public function Virtual EDropEffect::Type

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

  
Public function Virtual EDropEffect::Type

OnDragEnterText ( const TSharedRef< FGenericWindow >& Window,
const FString& Text
)

  
Public function Virtual void

OnDragLeave ( const TSharedPtr< FGenericWindow >& Window
)

  
Public function Virtual EDropEffect::Type

OnDragOver ( const TSharedPtr< FGenericWindow >& Window
)

  
Public function Virtual void  
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 >& Window,
const EMouseButtons::Type Button,
const FVector2D CursorPos
)

  
Public function Virtual bool  
Public function Virtual bool

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

  
Public function Virtual bool

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

  
Public function Virtual bool  
Public function Virtual bool

OnMouseUp ( const EMouseButtons::Type Button
)

  
Public function Virtual bool

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

  
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 >& Window,
const int32 X,
const int32 Y
)

  
Public function Virtual void

OnOSPaint ( const TSharedRef< FGenericWindow >& Window
)

  
Public function Virtual bool

OnRawMouseMove ( const int32 X,
const int32 Y
)

  
Public function Virtual void  
Public function Virtual bool

OnSizeChanged ( const TSharedRef< FGenericWindow >& Window,
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 >& Window,
const FVector2D& Location,
float Force,
int32 TouchIndex,
int32 ControllerId
)

  
Public function Virtual bool

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

  
Public function Virtual bool

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

  
Public function Virtual void

OnWindowClose ( const TSharedRef< FGenericWindow >& Window
)

  
Public function Virtual Const bool FGenericApplicationMessageHandlerBy default all the following functions just forward the call to the underlying message handler.
Public function Virtual void

ShouldSimulateGesture ( EGestureEvent Gesture,
bool bEnable
)

  

Deprecated Functions

  Type Name Description
Public function Virtual bool

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

 This version of OnControllerAnalog is deprecated, please use the version that takes an FPlatformUserId instead
Public function Virtual bool

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

 This version of OnControllerButtonPressed is deprecated, please use the version that takes an FPlatformUserId instead
Public function Virtual bool

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

 This version of OnControllerButtonReleased is deprecated, please use the version that takes an FPlatformUserId instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page