.. index:: pair: class; EE::UI::AccessibilityWidgetResolver
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver:

class EE::UI::AccessibilityWidgetResolver
=========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Resolves standard widget semantics directly from the live widget instance. :ref:`More...<details-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <accessibilitywidgetresolver.hpp>
	
	class AccessibilityWidgetResolver {
	public:
		// methods
	
		static :ref:`AccessibilityRole<doxid-namespace_e_e_1_1_u_i_1af9ed821869c9a05c6b2343fdc3fb0bb3>` :target:`getRole<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1adeedf29fda1c5363fb856736a650c3f1>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`Uint8<doxid-namespace_e_e_1aa226754e64fe26f32b5526c7cd36fa75>` :target:`getHeadingLevel<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a85cdcf9d6a23aafd1123bef0b4c5f1c3>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static void :ref:`onHTMLTextChanged<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a940d520e021b17db5ded821f9fa576a9>`(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, std::optional<:ref:`AccessibilityRole<doxid-namespace_e_e_1_1_u_i_1af9ed821869c9a05c6b2343fdc3fb0bb3>`> previousRole = std::nullopt);
		static const char* :ref:`getRoleName<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1ae99d205f92fbce45cbc76e5dbee1a69b>`(:ref:`AccessibilityRole<doxid-namespace_e_e_1_1_u_i_1af9ed821869c9a05c6b2343fdc3fb0bb3>` role);
		static bool :ref:`isLeafRole<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a849fdb48bb11b26788f52b5bb129fe1c>`(:ref:`AccessibilityRole<doxid-namespace_e_e_1_1_u_i_1af9ed821869c9a05c6b2343fdc3fb0bb3>` role);
		static :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* :ref:`getLeafOwner<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1ad35450cbc561c58b9c46cb326cb2647b>`(const :ref:`Scene::Node<doxid-class_e_e_1_1_scene_1_1_node>`* node);
		static bool :ref:`isHiddenFromAccessibility<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a7d302a15619eb9d17be8783a660988db>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`String<doxid-class_e_e_1_1_string>` :target:`getName<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a8f66facdcb5aa3b693d3867e01d5a710>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`String<doxid-class_e_e_1_1_string>` :target:`getDescription<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a492c00912278751977fbf30b639f0804>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`String<doxid-class_e_e_1_1_string>` :target:`getValue<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a4c9e0d3a725f4d0de912c80cb8aa1cea>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`AccessibilityShortcut<doxid-struct_e_e_1_1_u_i_1_1_accessibility_shortcut>` :ref:`getShortcut<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1afabb884ebc969593a771c9aa8ca43e4b>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`AccessibilityRangeInfo<doxid-struct_e_e_1_1_u_i_1_1_accessibility_range_info>` :target:`getRange<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a43ffffa73d71b189625b5ce6895dd956>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`AccessibilityTextInfo<doxid-struct_e_e_1_1_u_i_1_1_accessibility_text_info>` :target:`getText<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a88fb094517a3e507316212a8a58c5ded>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`AccessibilityTextInfo<doxid-struct_e_e_1_1_u_i_1_1_accessibility_text_info>` :ref:`getText<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a6df4b1890a63bbc202456ab6f8987f45>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, bool includeOffsets);
		static const :ref:`Doc::TextDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_document>`* :ref:`getTextDocument<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1ae098efec94756bce516186aaf99459fe>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` :ref:`getTextLength<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1af28f2e304d87c35cb07154044246e875>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`String<doxid-class_e_e_1_1_string>` :target:`getTextRange<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a2a2dd61db9a0aa134715ac9e276d3919>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` start, :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` end);
		static bool :ref:`getTextLineBounds<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a878d70f7b87078866beef6660b5b9a1b>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` offset, :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& start, :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& end);
		static :ref:`AccessibilityTextRevision<doxid-struct_e_e_1_1_u_i_1_1_accessibility_text_revision>` :target:`getTextRevision<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a169c0eba51774e115302d9ef31102177>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` :ref:`getTextOffset<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a8ba8ebf4e01f22a33ac00427394b35a3>`(const :ref:`Doc::TextDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_document>`& document, const :ref:`Doc::TextPosition<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_position>`& position);
		static :ref:`AccessibilityState<doxid-namespace_e_e_1_1_u_i_1ae8a4dddb4848807dfdfc02d9b8237804>` :target:`getState<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a7fe5fc7605428f233767f014023bd771>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`AccessibilityActions<doxid-namespace_e_e_1_1_u_i_1abf28e6e99bb89119333e70a0151a8964>` :target:`getActions<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a4fc8d522cd13901147e2ea2bd1c7fcfe>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget);
		static :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* :ref:`getOwningModelView<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a147c327d108595408d4cec033161872a>`(const :ref:`Scene::Node<doxid-class_e_e_1_1_scene_1_1_node>`* node);
		static :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* :ref:`getFocusOwner<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a52fd48e6033efa2729daffa67707d608>`(:ref:`Scene::Node<doxid-class_e_e_1_1_scene_1_1_node>`* focused, const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* sceneRoot);
		static :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* :ref:`getEventTarget<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a02dc4a6ec6fa1a7ef522267b44c103fc>`(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, :ref:`AccessibilityEvent<doxid-namespace_e_e_1_1_u_i_1a6e149b98265ee3870d7cd6ce7d313c56>` event);
		static bool :target:`performAction<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a4955d1e08e4ccea1a6ae7753f5843b1d>`(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, const :ref:`AccessibilityActionRequest<doxid-struct_e_e_1_1_u_i_1_1_accessibility_action_request>`& request);
		static std::vector<:ref:`AccessibilityIssue<doxid-struct_e_e_1_1_u_i_1_1_accessibility_issue>`> :ref:`audit<doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a5e98db30b3b21145ed9ad77cdbe56006>`(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* root);
	};
.. _details-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Resolves standard widget semantics directly from the live widget instance.

Methods
-------

.. index:: pair: function; onHTMLTextChanged
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a940d520e021b17db5ded821f9fa576a9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static void onHTMLTextChanged(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, std::optional<:ref:`AccessibilityRole<doxid-namespace_e_e_1_1_u_i_1af9ed821869c9a05c6b2343fdc3fb0bb3>`> previousRole = std::nullopt)

Updates queried HTML text and named ancestors. Called only after the activity gate.

.. index:: pair: function; getRoleName
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1ae99d205f92fbce45cbc76e5dbee1a69b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static const char* getRoleName(:ref:`AccessibilityRole<doxid-namespace_e_e_1_1_u_i_1af9ed821869c9a05c6b2343fdc3fb0bb3>` role)

A readable role name for tools and logs, for example "CheckBox".

.. index:: pair: function; isLeafRole
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a849fdb48bb11b26788f52b5bb129fe1c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static bool isLeafRole(:ref:`AccessibilityRole<doxid-namespace_e_e_1_1_u_i_1af9ed821869c9a05c6b2343fdc3fb0bb3>` role)

Controls whose content is fully described by their own name, value and state. Their implementation children (a button's text view, a menu item's shortcut label) are not exposed.

.. index:: pair: function; getLeafOwner
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1ad35450cbc561c58b9c46cb326cb2647b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* getLeafOwner(const :ref:`Scene::Node<doxid-class_e_e_1_1_scene_1_1_node>`* node)

The outermost leaf control containing the node, or nullptr when no ancestor is a leaf.

.. index:: pair: function; isHiddenFromAccessibility
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a7d302a15619eb9d17be8783a660988db:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static bool isHiddenFromAccessibility(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget)

Whether the widget or any ancestor is hidden from accessibility (aria-hidden).

.. index:: pair: function; getShortcut
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1afabb884ebc969593a771c9aa8ca43e4b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`AccessibilityShortcut<doxid-struct_e_e_1_1_u_i_1_1_accessibility_shortcut>` getShortcut(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget)

The keyboard shortcut of a menu item; empty for every other widget.

.. index:: pair: function; getText
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a6df4b1890a63bbc202456ab6f8987f45:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`AccessibilityTextInfo<doxid-struct_e_e_1_1_u_i_1_1_accessibility_text_info>` getText(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, bool includeOffsets)

Metadata-only queries avoid scanning document lines to calculate offsets.

.. index:: pair: function; getTextDocument
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1ae098efec94756bce516186aaf99459fe:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static const :ref:`Doc::TextDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_document>`* getTextDocument(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget)

The document behind a text element; nullptr for other widgets and for password inputs, whose text is never exposed.

.. index:: pair: function; getTextLength
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1af28f2e304d87c35cb07154044246e875:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` getTextLength(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget)

Ranged text access, in code points. None of these copy more than the requested range.

.. index:: pair: function; getTextLineBounds
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a878d70f7b87078866beef6660b5b9a1b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static bool getTextLineBounds(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` offset, :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& start, :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& end)

The line containing ``offset`` : [start, end), end past its newline.

.. index:: pair: function; getTextOffset
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a8ba8ebf4e01f22a33ac00427394b35a3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>` getTextOffset(const :ref:`Doc::TextDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_document>`& document, const :ref:`Doc::TextPosition<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_position>`& position)

Standalone code-point offset calculation, without retaining a document cache (O(lines)). Native widget queries use their manager's optional incremental index instead.

.. index:: pair: function; getOwningModelView
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a147c327d108595408d4cec033161872a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* getOwningModelView(const :ref:`Scene::Node<doxid-class_e_e_1_1_scene_1_1_node>`* node)

Returns the model view whose virtual nodes represent this widget, or nullptr when the widget is exposed directly: outside every model view, or inside its active cell editor.

.. index:: pair: function; getFocusOwner
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a52fd48e6033efa2729daffa67707d608:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* getFocusOwner(:ref:`Scene::Node<doxid-class_e_e_1_1_scene_1_1_node>`* focused, const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* sceneRoot)

Projects the keyboard focus node onto the accessibility element that exposes it. Hidden implementation children (for example a spin box's input) resolve to their semantic owner.

.. index:: pair: function; getEventTarget
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a02dc4a6ec6fa1a7ef522267b44c103fc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* getEventTarget(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* widget, :ref:`AccessibilityEvent<doxid-namespace_e_e_1_1_u_i_1a6e149b98265ee3870d7cd6ce7d313c56>` event)

Routes internal control state changes to their semantic owner.

.. index:: pair: function; audit
.. _doxid-class_e_e_1_1_u_i_1_1_accessibility_widget_resolver_1a5e98db30b3b21145ed9ad77cdbe56006:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static std::vector<:ref:`AccessibilityIssue<doxid-struct_e_e_1_1_u_i_1_1_accessibility_issue>`> audit(const :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`* root)

Lists common authoring problems in a widget tree: controls without an accessible name and aria-labelledby / aria-describedby ids that resolve to nothing. Hidden and invisible subtrees are skipped, as are the implementation children of model views.