Navigation
API > API/Runtime > API/Runtime/ApplicationCore > API/Runtime/ApplicationCore/GenericPlatform > API/Runtime/ApplicationCore/GenericPlatform/Accessibility
Inheritance Hierarchy
- FGenericAccessibleUser
- FScreenReaderUser
References
| Module | ApplicationCore |
| Header | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
| Include | #include "GenericPlatform/Accessibility/GenericAccessibleInterfaces.h" |
Syntax
class FGenericAccessibleUser
Remarks
An accessible user is an input source that can interact with the application and needs to provide accessibility services such as a screen reader. This base class provides the basic information all accessible users need to implement to ensure accessibility services function properly. Users should subclass this class to provide additional functionality for their custom accessible users. All accessible users must be registered with an FGenericAccessibleUserRegistry for the users to be retrieved and interacted with.
Constructors
| Type | Name | Description | |
|---|---|---|---|
FGenericAccessibleUser
(
const FAccessibleUserIndex InUserIndex |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Clear the accessible focused widget. | ||
| TSharedPtr< IAccessibleWidget > | Returns the accessible widget the accessible user is currently focused on. | ||
| FAccessibleUserIndex | GetIndex () |
Returns the unique index that identifies this accessible user. | |
| void | OnRegistered () |
Called by FGenericAccessibleUserRegistry::RegisterUser. | |
| void | Called by FGenericAccessibleUserRegistry::UnregisterUser. | ||
| bool | SetFocusedAccessibleWidget
(
const TSharedRef< IAccessibleWidget >& InWidget |
Sets which accessible widget the accessible user is currently focused on. |