Navigation
API > API/Runtime > API/Runtime/ApplicationCore
Provides the core set of accessible data that is necessary in order for widget traversal and TTS to be implemented. In order to support functionality beyond this, subclasses must implement the other accessible interfaces and then override the As*() functions.
| Name | IAccessibleWidget |
| Type | class |
| Header File | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
| Include Path | #include "GenericPlatform/Accessibility/GenericAccessibleInterfaces.h" |
Syntax
class IAccessibleWidget : public TSharedFromThis< IAccessibleWidget >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → IAccessibleWidget
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IAccessibleWidget() |
GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAccessibleWidget() |
GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| InvalidAccessibleWidgetId | const AccessibleWidgetId | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual IAccessibleActivatable * AsActivatable() |
Attempt to cast this to an IAccessibleActivatable | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
virtual IAccessibleProperty * AsProperty() |
Attempt to cast this to an IAccessibleProperty | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
virtual IAccessibleTable * AsTable() |
Attempt to cast this to an IAccessibleTable | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
virtual IAccessibleTableRow * AsTableRow() |
Attempt to cast this to an IAccessibleTableRow | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
virtual IAccessibleText * AsText() |
Attempt to cast this to an IAccessibleText | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
virtual IAccessibleWindow * AsWindow() |
Attempt to cast this to an IAccessibleWindow | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool CanCurrentlyAcceptAccessibleFocus() |
Whether the widget can currently support accessible focus. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
FBox2D GetBounds () |
Retrieving the bounding rect in absolute coordinates for this widget. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
TSharedPtr< IAccessibleWidget > GetChildAt
(
int32 Index |
Retrieves the accessible child widget at a certain index. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
FString GetClassName() |
The name of the underlying class that this accessible widget represents. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
FString GetHelpText() |
Additional information a user may need in order to effectively interact or use the widget, such as a tooltip. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
AccessibleWidgetId GetId () |
Get an application-unique identifier for this widget. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
| Retrieves the widget after this one in the parent's list of children. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
| Retrieves the logical next widget in the accessible widget hierarchy from this widget. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
int32 GetNumberOfChildren() |
How many accessible children this widget has. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
| Get the accessible parent of this widget. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
| Retrieves the widget before this one in the parent's list of children. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
| Retrieves the logical previous widget in the accessible widget hierarchy from this current widget. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
| The name of the widget to report to the platform layer. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
| What type of accessible widget the underlying widget should be treated as. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
| Returns the window at the top of this widget's hierarchy. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | ||
bool HasUserFocus
(
const FAccessibleUserIndex UserIndex |
Whether the widget has accessible focus or not by a particular user . | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool IsEnabled() |
Whether the widget is enabled and can be interacted with. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool IsHidden() |
Whether the widget is being rendered on screen or not. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool IsValid() |
Whether or not the underlying widget backing this interface still exists | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool SetUserFocus
(
const FAccessibleUserIndex UserIndex |
Assign accessible focus to the widget. Also sets keyboard/gamepad focus if the widget supports it. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool SupportsAccessibleFocus() |
Whether the widget can ever support accessible focus. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
bool SupportsFocus() |
Whether the widget can ever support keyboard/gamepad focus. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
virtual FString ToString() |
Returns a string representation of this widget. Primarily used for debugging. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< IAccessibleWidget > SearchForAncestorFrom
(
const TSharedRef< IAccessibleWidget >& Source, |
Returns the first instance of an ancestor from a source widget that satisfies a search criteria. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
static TSharedPtr< IAccessibleWidget > SearchForFirstChildFrom
(
const TSharedRef< IAccessibleWidget >& Source, |
Returns the first instance of a child from a source widget that satisfies a search criteria. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
static TSharedPtr< IAccessibleWidget > SearchForNextSiblingFrom
(
const TSharedRef< IAccessibleWidget >& Source, |
Returns the first instance of a next sibling from a source widget that satisfies a search criteria. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
static TSharedPtr< IAccessibleWidget > SearchForNextWidgetInHierarchyFrom
(
const TSharedRef< IAccessibleWidget >& Source, |
Returns the first instance of a next widget in the accessible hierarchy from a source widget that satisfies a search criteria. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
static TSharedPtr< IAccessibleWidget > SearchForPreviousSiblingFrom
(
const TSharedRef< IAccessibleWidget >& Source, |
Returns the first instance of a previous sibling from a source widget that satisfies a search criteria. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h | |
static TSharedPtr< IAccessibleWidget > SearchForPreviousWidgetInHierarchyFrom
(
const TSharedRef< IAccessibleWidget >& Source, |
Returns the first instance of a previous widget in the accessible hierarchy from a source widget that satisfies a search criteria. | GenericPlatform/Accessibility/GenericAccessibleInterfaces.h |