Commit d27c3e37 authored by Samuel Thibault's avatar Samuel Thibault
Browse files

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
parent 51433afc
......@@ -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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment