From 2e4f6055866f94a252445d2d885b4122cf9f51cf Mon Sep 17 00:00:00 2001
From: Michael Weghorn <m.weghorn@posteo.de>
Date: Tue, 11 Jun 2024 16:45:43 +0200
Subject: [PATCH] Accessible.xml: Mention other use cases for AccessibleId

Adust the doc for `AccessibleId` to mention that this can
also be used for reliable identification by ATs, not just
for automated testing.

This is also in line with the existing documentation for
`atk_object_set_accessible_id` (s. atk/atkobject.c) which
mentions:

> Such an ID will be available for
> instance to identify a given well-known accessible object for tailored screen
> reading, or for automatic regression testing.

One example use case could be reliable identification
of LibreOffice's spellcheck dialog by the Orca screen
reader, see [1].

[1] https://bugs.documentfoundation.org/show_bug.cgi?id=155447
---
 xml/Accessible.xml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/xml/Accessible.xml b/xml/Accessible.xml
index e2ec0903..86bff18a 100644
--- a/xml/Accessible.xml
+++ b/xml/Accessible.xml
@@ -69,11 +69,11 @@
     <!--
         AccessibleId: application-specific identifier for the current object.
 
-        You can use this to give a special id to an object to use in tests, for example,
-        "my_widget".  Note that there is no way to directly find an object by its id; your
-        test program may have to recursively get the children to find a specific id.  This
-        is because accessible objects can be created dynamically, and they do not always
-        correspond to a static view of an application's data.
+        This can be used to give a special id to an object for reliable identification by
+        ATs or for use in tests, for example, "my_widget".  Note that there is no way to
+        directly find an object by its id; ATs may have to recursively get the children to
+        find a specific id.  This is because accessible objects can be created dynamically,
+        and they do not always correspond to a static view of an application's data.
     -->
     <property name="AccessibleId" type="s" access="read"/>
 
-- 
GitLab