summaryrefslogtreecommitdiff
path: root/xml
diff options
context:
space:
mode:
authorFederico Mena Quintero <federico@gnome.org>2022-10-17 11:16:06 -0500
committerFederico Mena Quintero <federico@gnome.org>2022-10-17 17:43:21 -0500
commit20f1394b96466cf05c92bc72b28e5ab7f20f3108 (patch)
treed2825d5cc655b4120d72d79e225adb9b214d9354 /xml
parent47738b06ab8d8e31bd805effb28eb27f5227458f (diff)
downloadat-spi2-core-20f1394b96466cf05c92bc72b28e5ab7f20f3108.tar.gz
Component.xml: document the Contains method
Diffstat (limited to 'xml')
-rw-r--r--xml/Component.xml21
1 files changed, 20 insertions, 1 deletions
diff --git a/xml/Component.xml b/xml/Component.xml
index f93e63d6..29c50a1b 100644
--- a/xml/Component.xml
+++ b/xml/Component.xml
@@ -1,7 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
-<node>
+<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
+ <!--
+ org.a11y.atspi.Component:
+ @short_description: Interface for GUI components like widgets or other visible elements.
+ -->
<interface name="org.a11y.atspi.Component">
+ <!--
+ Contains:
+ @x: X coordinate of point.
+ @y: Y coordinate of point.
+ @coord_type: Whether the coordinates are relative to the screen or to the
+ component's top level window; see the description.
+
+ Queries whether a point (x, y) is inside the 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.
+ -->
<method name="Contains">
<arg direction="in" name="x" type="i"/>
<arg direction="in" name="y" type="i"/>