summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFederico Mena Quintero <federico@gnome.org>2022-10-17 18:53:29 -0500
committerFederico Mena Quintero <federico@gnome.org>2022-10-17 18:53:29 -0500
commiteed617846c227469d958d7ea708935a95c22f737 (patch)
tree0f245791c62351b39e4c5ff87930e31399375a55
parent3aba441fdc98c7e939a566f795dc4486325f91b0 (diff)
downloadat-spi2-core-eed617846c227469d958d7ea708935a95c22f737.tar.gz
Component.xml: document the SetPosition method
Same as the last commit, fix the docs for atspi_component_set_position().
-rw-r--r--atspi/atspi-component.c4
-rw-r--r--xml/Component.xml17
2 files changed, 19 insertions, 2 deletions
diff --git a/atspi/atspi-component.c b/atspi/atspi-component.c
index 726ea345..67ef5a1d 100644
--- a/atspi/atspi-component.c
+++ b/atspi/atspi-component.c
@@ -379,8 +379,8 @@ atspi_component_set_extents (AtspiComponent *obj,
/**
* atspi_component_set_position:
* @obj: a pointer to the #AtspiComponent to move.
- * @x: the new vertical position to which the component should be moved.
- * @y: the new horizontal position to which the component should be moved.
+ * @x: the new horizontal position to which the component should be moved.
+ * @y: the new vertical position to which the component should be moved.
* @ctype: the coordinate system in which the position is specified.
* (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
*
diff --git a/xml/Component.xml b/xml/Component.xml
index 240ba46c..922b1d48 100644
--- a/xml/Component.xml
+++ b/xml/Component.xml
@@ -215,6 +215,23 @@
<arg direction="out" type="b"/>
</method>
+ <!--
+ SetPosition:
+ @x: the new horizontal position to which the component should be moved.
+ @y: the new vertical position to which the component should be moved.
+ @coord_type: Whether the coordinates are relative to the screen or to the
+ component's top level window; see the description.
+
+ Moves the component to the specified position.
+
+ 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="SetPosition">
<arg direction="in" name="x" type="i"/>
<arg direction="in" name="y" type="i"/>