[at-spi2-core: 8/19] Accessible.xml: document the GetChildAtIndex method




commit 76447d97fc6449835a2e3c105f900d6bbf3a4ca1
Author: Federico Mena Quintero <federico gnome org>
Date:   Tue Jul 5 15:30:42 2022 -0500

    Accessible.xml: document the GetChildAtIndex method

 xml/Accessible.xml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
---
diff --git a/xml/Accessible.xml b/xml/Accessible.xml
index 01a55664..1dc4e399 100644
--- a/xml/Accessible.xml
+++ b/xml/Accessible.xml
@@ -77,6 +77,20 @@
     -->
     <property name="AccessibleId" type="s" access="read"/>
 
+    <!--
+        GetChildAtIndex:
+        @index: 0-based index of the child to query.
+
+        Queries the Nth accessible child of the current object.  It is expected that this
+        will correspond to the order that the GetChildren method would return.
+
+        Returns: The (so) is a string for the application name, and an object path.
+
+        Notes: implementations vary in their behavior when the index is out of range.
+        GTK4 returns an error, while atk-adaptor returns the null object path
+        "/org/a11y/atspi/null".  To keep the type system gods happy, you should probably
+        return a DBus error in that case.
+    -->
     <method name="GetChildAtIndex">
       <arg direction="in" name="index" type="i"/>
       <arg direction="out" type="(so)"/>


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