Navigation
API > API/Runtime > API/Runtime/ApplicationCore
The base class for an accessible user registry that all accessible users must register with. The registry controls the lifetime of all accessible users. All created accessible users must be registered with an accessible user registry. This should be the only means of retrieving and interacting with accessible users in other parts of the application. Users can subclass this class to provide additional functionality for their custom use cases.
| Name | FGenericAccessibleUserRegistry |
| Type | class |
| Header File | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
| Include Path | #include "GenericPlatform/Accessibility/GenericAccessibleInterfaces.h" |
Syntax
class FGenericAccessibleUserRegistry
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FGenericAccessibleUserRegistry() |
GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< TSharedRef< FGenericAccessibleUser > > GetAllUsers() |
Returns an array of all accessible users that are currently registered with the accessible registry. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
int32 GetNumberofUsers() |
Returns the number of accessible users registered with the accessible user registry. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
TSharedPtr< FGenericAccessibleUser > GetUser
(
const FAccessibleUserIndex UserIndex |
Returns the accessible user associated with the passed in user index. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool IsUserRegistered
(
const FAccessibleUserIndex UserIndex |
Returns true if the passed in user index is associated with a registered accessible user. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool RegisterUser
(
const TSharedRef< FGenericAccessibleUser >& User |
Registers an accessible user with the accessible registry. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
void UnregisterAllUsers () |
Unregisters all accessible users from the accessible registry. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool UnregisterUser
(
const FAccessibleUserIndex UserIndex |
Unregisters an accessible user from the accessible registry. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FAccessibleUserIndex GetPrimaryUserIndex () |
Returns the index of the primary accessible user. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |