summaryrefslogtreecommitdiff
path: root/atspi/atspi-text.c
diff options
context:
space:
mode:
authorMike Gorse <mgorse@alum.wpi.edu>2019-03-03 13:27:40 -0600
committerMike Gorse <mgorse@alum.wpi.edu>2019-03-03 13:27:40 -0600
commit1b3d49e57f9d6a77723f857165234cc7dea427fc (patch)
tree47573955e1ff125413730b5222aed890d446cf41 /atspi/atspi-text.c
parent6c8e1a3c1b8afb2f90de0ddd54f55bb626192b16 (diff)
downloadat-spi2-core-1b3d49e57f9d6a77723f857165234cc7dea427fc.tar.gz
Update libatspi documentation to indicate that extents are only meaningful
when an object has both STATE_VISIBLE and STATE_SHOWING. Corresponds to merge request GNOME/at-spi2-core!8
Diffstat (limited to 'atspi/atspi-text.c')
-rw-r--r--atspi/atspi-text.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/atspi/atspi-text.c b/atspi/atspi-text.c
index 009d07bf..a360f56c 100644
--- a/atspi/atspi-text.c
+++ b/atspi/atspi-text.c
@@ -618,6 +618,8 @@ atspi_text_get_character_at_offset (AtspiText *obj,
*
* Gets a bounding box containing the glyph representing
* the character at a particular text offset.
+ * The returned values are meaningful only if the Text has both
+ * STATE_VISIBLE and STATE_SHOWING.
*
* Returns: An #AtspiRect specifying the position and size of the character.
*
@@ -690,6 +692,8 @@ atspi_text_get_offset_at_point (AtspiText *obj,
* for the returned values.
*
* Gets the bounding box for text within a range in an #AtspiText object.
+ * The returned values are meaningful only if the Text has both
+ * STATE_VISIBLE and STATE_SHOWING.
*
* Returns: An #AtspiRect giving the position and size of the specified range
* of text.