diff options
author | Federico Mena Quintero <federico@gnome.org> | 2022-07-05 15:30:42 -0500 |
---|---|---|
committer | Federico Mena Quintero <federico@gnome.org> | 2022-07-05 15:42:17 -0500 |
commit | 76447d97fc6449835a2e3c105f900d6bbf3a4ca1 (patch) | |
tree | 401ae8cf298575385c0983a538a5d97ac9537c6b | |
parent | dc05184d7ff97bde7b1bea6e68588b24f44f7689 (diff) | |
download | at-spi2-core-76447d97fc6449835a2e3c105f900d6bbf3a4ca1.tar.gz |
Accessible.xml: document the GetChildAtIndex method
-rw-r--r-- | xml/Accessible.xml | 14 |
1 files changed, 14 insertions, 0 deletions
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)"/> |