diff options
| author | Samuel Thibault <samuel.thibault@ens-lyon.org> | 2019-07-03 14:41:32 +0200 |
|---|---|---|
| committer | Samuel Thibault <samuel.thibault@ens-lyon.org> | 2019-07-05 15:10:59 +0200 |
| commit | d6bec3fb749ab7afc205858bf7c980f995ab7bb6 (patch) | |
| tree | 519b751e3d7a51f4ac0dd2da8b29e70c89b0796e | |
| parent | 57af1951823d6e855e2e37bb345070913449653d (diff) | |
| download | atk-d6bec3fb749ab7afc205858bf7c980f995ab7bb6.tar.gz | |
Refine *_scroll_to_point documentation
These scroll the top-left of the accessible object.
Fixes #12
| -rw-r--r-- | atk/atkcomponent.c | 4 | ||||
| -rw-r--r-- | atk/atkcomponent.h | 7 | ||||
| -rw-r--r-- | atk/atktext.c | 6 | ||||
| -rw-r--r-- | atk/atktext.h | 2 |
4 files changed, 13 insertions, 6 deletions
diff --git a/atk/atkcomponent.c b/atk/atkcomponent.c index e4a9c63..d720481 100644 --- a/atk/atkcomponent.c +++ b/atk/atkcomponent.c @@ -597,8 +597,8 @@ atk_component_scroll_to (AtkComponent *component, * @x: x-position where to scroll to * @y: y-position where to scroll to * - * Makes an object visible on the screen at a given position by scrolling all - * necessary parents. + * Move the top-left of @component to a given position of the screen by + * scrolling all necessary parents. * * Returns: whether scrolling was successful. * diff --git a/atk/atkcomponent.h b/atk/atkcomponent.h index 72e9f7d..e764be7 100644 --- a/atk/atkcomponent.h +++ b/atk/atkcomponent.h @@ -203,6 +203,13 @@ struct _AtkComponentIface /* * Scrolls this object so it becomes visible on the screen. + * + * scroll_to lets the implementation compute an appropriate target + * position on the screen, with type used as a positioning hint. + * + * scroll_to_point lets the client specify a precise target position + * on the screen for the top-left of the object. + * * Since ATK 2.30 */ gboolean (*scroll_to) (AtkComponent *component, diff --git a/atk/atktext.c b/atk/atktext.c index 23034c7..d54a1fb 100644 --- a/atk/atktext.c +++ b/atk/atktext.c @@ -1365,7 +1365,7 @@ atk_text_rectangle_contain (AtkTextRectangle *clip, * @end_offset: end position, or -1 for the end of the string. * @type: specify where the object should be made visible. * - * Makes @text visible on the screen by scrolling all necessary parents. + * Makes a substring of @text visible on the screen by scrolling all necessary parents. * * Contrary to atk_text_set_position, this does not actually move * @text in its parent, this only makes the parents scroll so that the @@ -1402,8 +1402,8 @@ atk_text_scroll_substring_to (AtkText *text, * @x: x-position where to scroll to * @y: y-position where to scroll to * - * Makes an object visible on the screen at a given position by scrolling all - * necessary parents. + * Move the top-left of a substring of @text to a given position of the screen + * by scrolling all necessary parents. * * Since: 2.32 * diff --git a/atk/atktext.h b/atk/atktext.h index 32f0bf2..ca66a43 100644 --- a/atk/atktext.h +++ b/atk/atktext.h @@ -341,7 +341,7 @@ struct _AtkTextIface * position on the screen, with type used as a positioning hint. * * scroll_substring_to_point lets the client specify a precise target position - * on the screen. + * on the screen for the top-left of the substring. * * Since ATK 2.32 */ |