diff options
| author | Mike Gorse <mgorse@suse.com> | 2023-01-06 19:09:24 +0000 |
|---|---|---|
| committer | Mike Gorse <mgorse@suse.com> | 2023-01-06 19:09:24 +0000 |
| commit | aeb957706db3f0ee2282fb92b3297e8be86aa2a7 (patch) | |
| tree | fcf48ceb608726bffd9cc72f3007be237863ba0e | |
| parent | 6ed601aed555a092a88be954017547e0ea4abcc6 (diff) | |
| parent | f1e2f1046377c83b67fa8065efcc66d95d88b864 (diff) | |
| download | at-spi2-core-aeb957706db3f0ee2282fb92b3297e8be86aa2a7.tar.gz | |
Merge branch 'fix_Component_ScrollToPoint_xml' into 'main'
Fix XML documentation for Component's ScrollToPoint method
See merge request GNOME/at-spi2-core!122
| -rw-r--r-- | xml/Component.xml | 12 |
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"/> |