[atk: 1/3] Refine *_scroll_substring_to documentation
- From: Samuel Thibault <sthibaul src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [atk: 1/3] Refine *_scroll_substring_to documentation
- Date: Tue, 10 Sep 2019 10:45:56 +0000 (UTC)
commit d27c3e373eb136e57f31ec0c90ae7fc413ff8a66
Author: Samuel Thibault <samuel thibault ens-lyon org>
Date: Wed Jul 3 14:41:32 2019 +0200
Refine *_scroll_substring_to documentation
Avoid confusions between "position" on screen and "position" in the
text.
Remove reference to non-existing atk_text_set_position.
Fixes #12
atk/atktext.c | 12 ++++--------
1 file changed, 4 insertions(+), 8 deletions(-)
---
diff --git a/atk/atktext.c b/atk/atktext.c
index c15ea78..7b6d182 100644
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -1374,16 +1374,12 @@ atk_text_rectangle_contain (AtkTextRectangle *clip,
/**
* atk_text_scroll_substring_to:
* @text: an #AtkText
- * @start_offset: start position
- * @end_offset: end position, or -1 for the end of the string.
+ * @start_offset: start offset in the @text
+ * @end_offset: end offset in the @text, or -1 for the end of the text.
* @type: specify where the object should be made visible.
*
* 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
- * object shows up on the screen, given its current position within the parents.
- *
* Since: 2.32
*
* Returns: whether scrolling was successful.
@@ -1408,8 +1404,8 @@ atk_text_scroll_substring_to (AtkText *text,
/**
* atk_text_scroll_substring_to_point:
* @text: an #AtkText
- * @start_offset: start position
- * @end_offset: end position, or -1 for the end of the string.
+ * @start_offset: start offset in the @text
+ * @end_offset: end offset in the @text, or -1 for the end of the text.
* @coords: specify whether coordinates are relative to the screen or to the
* parent object.
* @x: x-position where to scroll to
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]