From 17d72d2da33467f1c22d9880f890435b176a42dd Mon Sep 17 00:00:00 2001
From: Federico Mena Quintero <federico@gnome.org>
Date: Mon, 17 Oct 2022 19:33:40 -0500
Subject: Component.xml: document the ScrollTo method

---
 xml/Component.xml | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

(limited to 'xml')

diff --git a/xml/Component.xml b/xml/Component.xml
index 364ff893..ceb89673 100644
--- a/xml/Component.xml
+++ b/xml/Component.xml
@@ -254,6 +254,38 @@
       <arg direction="out" type="b"/>
     </method>
 
+    <!--
+        ScrollTo:
+        @type: How to position the component within its parent; see the description.
+
+        Makes the component visible on the screen by scrolling all necessary parents.
+
+        The @type corresponds to AtkScrollType:
+
+        0 - TOP_LEFT: Scroll the object vertically and horizontally to bring
+        its top left corner to the top left corner of the window.
+
+        1 - BOTTOM_RIGHT: Scroll the object vertically and horizontally to
+        bring its bottom right corner to the bottom right corner of the window.
+
+        2 - TOP_EDGE: Scroll the object vertically to bring its top edge to
+        the top edge of the window.
+
+        3 - BOTTOM_EDGE: Scroll the object vertically to bring its bottom
+        edge to the bottom edge of the window.
+
+        4 - LEFT_EDGE: Scroll the object vertically and horizontally to bring
+        its left edge to the left edge of the window.
+
+        5 - RIGHT_EDGE: Scroll the object vertically and horizontally to
+        bring its right edge to the right edge of the window.
+
+        6 - ANYWHERE: Scroll the object vertically and horizontally so that
+        as much as possible of the object becomes visible. The exact placement is
+        determined by the application.
+
+        Returns: true if successful, or false otherwise.
+    -->
     <method name="ScrollTo">
       <arg direction="in" name="type" type="u"/>
       <arg direction="out" type="b"/>
-- 
cgit v1.2.1