Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > ApplicationCore > GenericPlatform > Accessibility > FGenericAccessibleMessageHandler

Light Theme

Dark Theme

FGenericAccessibleMessageHandler

Platform and application-agnostic messaging system for accessible events.

Windows

MacOS

Linux

References

Module	ApplicationCore
Header	/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/Accessibility/GenericAccessibleInterfaces.h
Include	#include "GenericPlatform/Accessibility/GenericAccessibleInterfaces.h"

Syntax

class FGenericAccessibleMessageHandler

Remarks

Platform and application-agnostic messaging system for accessible events. The message handler lives in GenericApplication and any subclass that wishes to support accessibility should subclass this and use GenericAppliation::SetAccessibleMessageHandler to enable functionality.

GetAccessibleWindow() is tne entry point to all accessible widgets. Once the window is retrieved, it can be queried for children in various ways. RaiseEvent() allows messages to bubble back up to the native OS through anything bound to the AccessibleEventDelegate.

Callers can use ApplicationIsAccessible() to see if accessibility is supported or not. Alternatively, calling GetAccessibleWindow and seeing if the result is valid should provide the same information.

Variables

		Name	Description
	bool	bApplicationIsAccessible	Subclasses should override this to indicate that they support accessibility.
		FVariant	If this was a property changed event, the 'after' value.

Constructors

	Name	Description
	FGenericAccessibleMessageHandler()

Destructors

	Name	Description
	~FGenericAccessibleMessageHandler()

Functions

	Name	Description
bool	ApplicationIsAccessible()	Subclasses should return true to indicate that they support accessibility.
TSharedPtr< ...	GetAccessibleWidgetFromId ( AccessibleWidgetId Id )	Retrieves an accessible widget that matches the given identifier.
TSharedPtr< ...	GetAccessibleWindow ( const TSharedRef< FGenericWindow > ... )	Creates or retrieves an accessible object for a native OS window.
AccessibleWi...	GetAccessibleWindowId ( const TSharedRef< FGenericWindow > ... )	Creates or retrieves the identifier for an accessible object for a native OS window.
bool	IsActive()	Checks if accessibility is enabled in the application.
void	MakeAccessibleAnnouncement ( const FString& AnnouncementString )	Request a string to be announced to the user.
void	OnActivate()	Triggered when bIsActive changes from false to true.
void	OnDeactivate()	Triggered when bIsActive changes from true to false.
void	RaiseEvent ( TSharedRef< IAccessibleWidget > Wid..., EAccessibleEvent Event, FVariant OldValue, FVariant NewValue )	Push an event from an accessible widget back to the platform layer.
void	RunInThread ( const TFunction< void()>& Function, bool bWaitForCompletion, ENamedThreads::Type Thread )	Request a function to be run in a particular thread.
void	SetAccessibleEventDelegate ( const FAccessibleEvent& Delegate )	Assign a function to be called whenever an accessible event is raised.
void	SetActive ( bool bActive )	Notify the application to start or stop processing accessible messages from the platform layer.

Typedefs

Name	Description
FAccessibleEvent	A widget raised an event to pass to the native OS implementation.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss