Navigation
Unreal Engine C++ API Reference > Runtime > ApplicationCore > GenericPlatform > Accessibility
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 the 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.
Callers should also use GetAccessibleUserRegistry() to register and interact with accessible users. Accessible users must be registered with the set accessible user registry for the rest of the application to be able to retrieve and interact with the accessible users.
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
bool | bApplicationIsAccessible | Subclasses should override this to indicate that they support accessibility. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
bool | Subclasses should return true to indicate that they support accessibility. | |
![]() |
FGenericAccessibleUserRegistry & | Retrieves the accessible user registry. | |
![]() ![]() |
const FGenericAccessibleUserRegistry & | Retrieves the accessible user registry. | |
![]() ![]() ![]() |
TSharedPtr< IAccessibleWidget > | GetAccessibleWidgetFromId
(
AccessibleWidgetId Id |
Retrieves an accessible widget that matches the given identifier. |
![]() ![]() ![]() |
TSharedPtr< IAccessibleWidget > | GetAccessibleWindow
(
const TSharedRef< FGenericWindow >& InWindow |
Creates or retrieves an accessible object for a native OS window. |
![]() ![]() ![]() |
AccessibleWidgetId | GetAccessibleWindowId
(
const TSharedRef< FGenericWindow >& InWindow |
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
(
const FAccessibleEventArgs& Args |
Push an event from an accessible widget back to the platform layer. |
![]() ![]() |
void | RunInThread
(
const TFunction< void()>& Function, |
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 | SetAccessibleUserRegistry
(
const TSharedRef< FGenericAccessibleUserRegistry >& InAccessibleUserRegistry |
Sets a new accessible user registry for the application. |
![]() |
void | SetActive
(
bool bActive |
Notify the application to start or stop processing accessible messages from the platform layer. |
![]() |
void | Unbinds the delegate called during accessible events if it is bound. |
Typedefs
Name | Description |
---|---|
FAccessibleEvent | A delegate accessible event handlers such as platform accessibility APIs can listen for accessibility events raised by widgets. |