1. Epic GamesDeveloper
  3. IAccessibleWidget

IAccessibleWidget

Provides the core set of accessible data that is necessary in order for widget traversal and TTS to be implemented.

Unreal Engine C++ API Reference > Runtime > ApplicationCore > GenericPlatform > Accessibility

Inheritance Hierarchy

References

   
Module ApplicationCore
Header /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/Accessibility/GenericAccessibleInterfaces.h
Include #include "GenericPlatform/Accessibility/GenericAccessibleInterfaces.h"

Syntax

class IAccessibleWidget : public TSharedFromThis< IAccessibleWidget >

Remarks

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.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual IAccessibleActivatable * Attempt to cast this to an IAccessibleActivatable
Public function Virtual IAccessibleProperty * Attempt to cast this to an IAccessibleProperty
Public function Virtual IAccessibleTable *

AsTable ()

 Attempt to cast this to an IAccessibleTable
Public function Virtual IAccessibleTableRow * Attempt to cast this to an IAccessibleTableRow
Public function Virtual IAccessibleText *

AsText ()

 Attempt to cast this to an IAccessibleText
Public function Virtual IAccessibleWindow * Attempt to cast this to an IAccessibleWindow
Public function Const bool Whether the widget can currently support accessible focus.
Public function Const FBox2D Retrieving the bounding rect in absolute coordinates for this widget.
Public function TSharedPtr< IAccessibleWidget >

GetChildAt ( int32 Index
)

 Retrieves the accessible child widget at a certain index.
Public function Const FString The name of the underlying class that this accessible widget represents.
Public function Const FString Additional information a user may need in order to effectively interact or use the widget, such as a tooltip.
Public function Const AccessibleWidgetId

GetId ()

 Get an application-unique identifier for this widget.
Public function TSharedPtr< IAccessibleWidget > Retrieves the widget after this one in the parent's list of children.
Public function TSharedPtr< IAccessibleWidget > Retrieves the logical next widget in the accessible widget hierarchy from this widget.
Public function int32 How many accessible children this widget has.
Public function TSharedPtr< IAccessibleWidget > Get the accessible parent of this widget.
Public function TSharedPtr< IAccessibleWidget > Retrieves the widget before this one in the parent's list of children.
Public function TSharedPtr< IAccessibleWidget > Retrieves the logical previous widget in the accessible widget hierarchy from this current widget.
Public function Const FString The name of the widget to report to the platform layer.
Public function Const EAccessibleWidgetType What type of accessible widget the underlying widget should be treated as.
Public function Const TSharedPtr< IAccessibleWidget > Returns the window at the top of this widget's hierarchy.
Public function Const bool

HasUserFocus ( const FAccessibleUserIndex UserIndex
)

 Whether the widget has accessible focus or not by a particular user .
Public function Const bool Whether the widget is enabled and can be interacted with.
Public function Const bool Whether the widget is being rendered on screen or not.
Public function Const bool

IsValid ()

 Whether or not the underlying widget backing this interface still exists
Public function Static TSharedPtr< IAccessibleWidget >

SearchForAncestorFrom ( const TSharedRef< IAccessibleWidget >& Source,
PredicateType Predicate
)

 Returns the first instance of an ancestor from a source widget that satisfies a search criteria.
Public function Static TSharedPtr< IAccessibleWidget >

SearchForFirstChildFrom ( const TSharedRef< IAccessibleWidget >& Source,
PredicateType Predicate
)

 Returns the first instance of a child from a source widget that satisfies a search criteria.
Public function Static TSharedPtr< IAccessibleWidget >

SearchForNextSiblingFrom ( const TSharedRef< IAccessibleWidget >& Source,
PredicateType Predicate
)

 Returns the first instance of a next sibling from a source widget that satisfies a search criteria.
Public function Static TSharedPtr< IAccessibleWidget >

SearchForNextWidgetInHierarchyFrom ( const TSharedRef< IAccessibleWidget >& Source,
PredicateType Predicate
)

 Returns the first instance of a next widget in the accessible hierarchy from a source widget that satisfies a search criteria.
Public function Static TSharedPtr< IAccessibleWidget >

SearchForPreviousSiblingFrom ( const TSharedRef< IAccessibleWidget >& Source,
PredicateType Predicate
)

 Returns the first instance of a previous sibling from a source widget that satisfies a search criteria.
Public function Static TSharedPtr< IAccessibleWidget >

SearchForPreviousWidgetInHierarchyFrom ( const TSharedRef< IAccessibleWidget >& Source,
PredicateType Predicate
)

 Returns the first instance of a previous widget in the accessible hierarchy from a source widget that satisfies a search criteria.
Public function bool

SetUserFocus ( const FAccessibleUserIndex UserIndex
)

 Assign accessible focus to the widget. Also sets keyboard/gamepad focus if the widget supports it.
Public function Const bool Whether the widget can ever support accessible focus.
Public function Const bool Whether the widget can ever support keyboard/gamepad focus.
Public function Virtual Const FString Returns a string representation of this widget. Primarily used for debugging.

Constants

Name Description
InvalidAccessibleWidgetId  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page