Component.xml: document the GetExtents method

1 files changed, 16 insertions, 0 deletions

diff --git a/xml/Component.xml b/xml/Component.xml
index 3d7e2e47..ec4f0904 100644
--- a/xml/Component.xml
+++ b/xml/Component.xml
@@ -56,6 +56,22 @@
       <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiObjectReference"/>
     </method>
 
+    <!--
+        GetExtents:
+        @coord_type: Whether the coordinates are relative to the screen or to the
+        component's top level window; see the description.
+
+        Queries the pixel extents of a component.
+
+        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: a tuple (x, y, width, height) corresponding to the rectangle for the
+        component's extents.
+    -->
     <method name="GetExtents">
       <arg direction="in" name="coord_type" type="u"/>
       <arg direction="out" type="(iiii)"/>