Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > ApplicationCore > GenericPlatform > Accessibility > IAccessibleWidget

Light Theme

Dark Theme

IAccessibleWidget

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

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

IAccessibleWidget

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

	Name	Description
	IAccessibleWidget()

Destructors

	Name	Description
	~IAccessibleWidget()

Functions

	Name	Description
IAccessibleA...	AsActivatable()	Attempt to cast this to an IAccessibleActivatable
IAccessibleP...	AsProperty()	Attempt to cast this to an IAccessibleProperty
IAccessibleT...	AsText()	Attempt to cast this to an IAccessibleText
IAccessibleW...	AsWindow()	Attempt to cast this to an IAccessibleWindow
FBox2D	GetBounds()	Retrieving the bounding rect in absolute coordinates for this widget.
TSharedPtr< ...	GetChildAt ( int32 Index )	Retrieves the accessible child widget at a certain index.
FString	GetClassName()	The name of the underlying class that this accessible widget represents.
FString	GetHelpText()	Additional information a user may need in order to effectively interact or use the widget, such as a tooltip.
AccessibleWi...	GetId()	Get an application-unique identifier for this widget.
TSharedPtr< ...	GetNextSibling()	Retrieves the widget after this one in the parent's list of children.
int32	GetNumberOfChildren()	How many accessible children this widget has.
TSharedPtr< ...	GetParent()	Get the accessible parent of this widget.
TSharedPtr< ...	GetPreviousSibling()	Retrieves the widget before this one in the parent's list of children.
FString	GetWidgetName()	The name of the widget to report to the platform layer.
EAccessibleW...	GetWidgetType()	What type of accessible widget the underlying widget should be treated as.
TSharedPtr< ...	GetWindow()	Returns the window at the top of this widget's hierarchy.
bool	HasFocus()	Whether the widget has keyboard focus or not.
bool	IsEnabled()	Whether the widget is enabled and can be interacted with.
bool	IsHidden()	Whether the widget is being rendered on screen or not.
bool	IsValid()	Whether or not the underlying widget backing this interface still exists
void	SetFocus()	Assign keyboard focus to this widget, if it supports it. If not, focus should not be affected.
bool	SupportsFocus()	Whether the widget supports keyboard focus or not.

Constants

Name	Description
InvalidAccessibleWidgetId

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss