Navigation
API > API/Runtime > API/Runtime/ApplicationCore
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.
| Name | FGenericAccessibleUser |
| Type | class |
| Header File | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
| Include Path | #include "GenericPlatform/Accessibility/GenericAccessibleInterfaces.h" |
Syntax
class FGenericAccessibleUser
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGenericAccessibleUser
(
const FAccessibleUserIndex InUserIndex |
GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FGenericAccessibleUser() |
GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FocusedAccessibleWidget | TWeakPtr< IAccessibleWidget > | The focused accessible widget widget associated with this user. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
| UserIndex | FAccessibleUserIndex | The unique index for this accessible user | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearFocusedAccessibleWidget() |
Clear the accessible focused widget. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
| Returns the accessible widget the accessible user is currently focused on. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
FAccessibleUserIndex GetIndex() |
Returns the unique index that identifies this accessible user. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool SetFocusedAccessibleWidget
(
const TSharedRef< IAccessibleWidget >& InWidget |
Sets which accessible widget the accessible user is currently focused on. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnRegistered () |
Called by FGenericAccessibleUserRegistry::RegisterUser. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
virtual void OnUnregistered () |
Called by FGenericAccessibleUserRegistry::UnregisterUser. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |