[at-spi2-core: 2/19] Accessible.xml: document the Name property




commit ae711a75b46ac03d1c3f30f567a0a5c336312ffa
Author: Federico Mena Quintero <federico gnome org>
Date:   Tue Jul 5 13:49:10 2022 -0500

    Accessible.xml: document the Name property

 xml/Accessible.xml | 13 +++++++++++++
 1 file changed, 13 insertions(+)
---
diff --git a/xml/Accessible.xml b/xml/Accessible.xml
index 63e8b09f..c5ad2f11 100644
--- a/xml/Accessible.xml
+++ b/xml/Accessible.xml
@@ -6,6 +6,19 @@
   -->
   <interface name="org.a11y.atspi.Accessible">
 
+    <!--
+        Name: Human-readable, localized, short name for the object.
+
+        Normally you need to set this for objects which do not have a labelled-by
+        relation.  Consider a widget to select RGB colors by setting three sliders.  The
+        names for the sliders would be "Red", "Green", "Blue", respectively, or
+        translations to application's locale.  The names would be unnecessary if each
+        slider had a labelled-by relation to corresponding labels visible in the user
+        interface.
+
+        In general, something is missing from your application if an object that can be
+        interacted with has no Name or a labelled-by relation.
+    -->
     <property name="Name" type="s" access="read"/>
 
     <property name="Description" type="s" access="read"/>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]