summaryrefslogtreecommitdiff
path: root/xml
diff options
context:
space:
mode:
authorArnold Loubriat <arnold.loubriat@outlook.com>2022-12-27 00:21:11 +0000
committerArnold Loubriat <arnold.loubriat@outlook.com>2022-12-27 00:21:11 +0000
commitf1e2f1046377c83b67fa8065efcc66d95d88b864 (patch)
treefe5d737e5c5ef7a0e149a79661e77b88b7aa586f /xml
parent13655833cb3d041ff6da649d2f684d8c53797405 (diff)
downloadat-spi2-core-f1e2f1046377c83b67fa8065efcc66d95d88b864.tar.gz
Fix XML documentation for Component's ScrollToPoint method
Diffstat (limited to 'xml')
-rw-r--r--xml/Component.xml12
1 files changed, 9 insertions, 3 deletions
diff --git a/xml/Component.xml b/xml/Component.xml
index 20c9675b..2db6217c 100644
--- a/xml/Component.xml
+++ b/xml/Component.xml
@@ -293,18 +293,24 @@
<!--
ScrollToPoint:
- @type: How to position the component within its parent; see the description of the
- ScrollTo method for the possible values.
+ @coord_type: Whether the coordinates are relative to the screen or to the
+ component's top level window; see the description.
@x: X coordinate within the component to make visible.
@y: Y coordinate within the component to make visible.
Similar to the ScrollTo method, but makes a specific point from the component
visible in its parent.
+ The @coord_type values are as follows, and correspond to AtkCoordType:
+
+ 0 - Coordinates are relative to the screen.
+ 1 - Coordinates are relative to the component's toplevel window.
+ 2 - Coordinates are relative to the component's immediate parent.
+
Returns: true if successful, or false otherwise.
-->
<method name="ScrollToPoint">
- <arg direction="in" name="type" type="u"/>
+ <arg direction="in" name="coord_type" type="u"/>
<arg direction="in" name="x" type="i"/>
<arg direction="in" name="y" type="i"/>
<arg direction="out" type="b"/>