Navigation
API > API/Plugins > API/Plugins/ScreenReader
An interface that controls how a screen reader user navigates around the accessible widget hierarchy and what accessible widgets can be navigated to from a source widget. Clients can provide custom implementations to provide different navigation behaviors for screen reader users at runtime. A sample implementation is FDefaultScreenReaderNavigationPolicy.
| Name | IScreenReaderNavigationPolicy |
| Type | class |
| Header File | /Engine/Plugins/Experimental/ScreenReader/Source/ScreenReader/Public/Navigation/ScreenReaderNavigationPolicy.h |
| Include Path | #include "Navigation/ScreenReaderNavigationPolicy.h" |
Syntax
class IScreenReaderNavigationPolicy
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IScreenReaderNavigationPolicy() |
Navigation/ScreenReaderNavigationPolicy.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IAccessibleWidget > GetFirstAncestorFrom
(
const TSharedRef< IAccessibleWidget >& Source |
Returns the first ancestor from the source widget that satisfies the navigation policy. | Navigation/ScreenReaderNavigationPolicy.h | |
TSharedPtr< IAccessibleWidget > GetFirstChildFrom
(
const TSharedRef< IAccessibleWidget >& Source |
Returns the first child from the source widget that satisfies the navigation policy. | Navigation/ScreenReaderNavigationPolicy.h | |
TSharedPtr< IAccessibleWidget > GetNextSiblingFrom
(
const TSharedRef< IAccessibleWidget >& Source |
Returns the first instance of a next sibling from the source widget that satisfies the navigation policy. | Navigation/ScreenReaderNavigationPolicy.h | |
TSharedPtr< IAccessibleWidget > GetNextWidgetInHierarchyFrom
(
const TSharedRef< IAccessibleWidget >& Source |
Returns the first instance of a logical next widget from the source widget that satisfies the navigation policy. | Navigation/ScreenReaderNavigationPolicy.h | |
TSharedPtr< IAccessibleWidget > GetPreviousSiblingFrom
(
const TSharedRef< IAccessibleWidget >& Source |
Returns the first instance of a previous sibling from the source widget that satisfies the navigation policy. | Navigation/ScreenReaderNavigationPolicy.h | |
TSharedPtr< IAccessibleWidget > GetPreviousWidgetInHierarchyFrom
(
const TSharedRef< IAccessibleWidget >& Source |
Returns the first instance of a logical previous widget from the source widget that satisfies the navigation policy. | Navigation/ScreenReaderNavigationPolicy.h |
See Also
-
FDefaultScreenReaderNavigaitonPolicy