summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Gorse <mgorse@suse.com>2023-03-28 04:16:21 -0500
committerMike Gorse <mgorse@suse.com>2023-03-28 04:16:21 -0500
commite2ca4072142c0cd9c4acce5b6a511e5d8d3de0c5 (patch)
treeaf5091cfb16f0ba08ce02ceefa3f39b60f51d3da
parente9f3abdcdd1224c64fa3f0b2c3e23bfc4aff3ebf (diff)
downloadat-spi2-core-e2ca4072142c0cd9c4acce5b6a511e5d8d3de0c5.tar.gz
xml: document that GetIndexInParent can return -1
GetIndexInParent might return -1 for a top-level object or where an index is not available. For instance, atk defaults to returning -1 if the object's class does not provide a get_index_in_parent function. This puts the xml documentation in line with the atk and libatspi documentation.
-rw-r--r--xml/Accessible.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/xml/Accessible.xml b/xml/Accessible.xml
index 5619930e..2ada7005 100644
--- a/xml/Accessible.xml
+++ b/xml/Accessible.xml
@@ -113,7 +113,8 @@
GetIndexInParent:
Returns the 0-based index at which the object would be returned by calling
- GetChildren on its parent.
+ GetChildren on its parent, or -1 if the object has no containing
+ parent or on exception.
-->
<method name="GetIndexInParent">
<arg direction="out" type="i"/>