summaryrefslogtreecommitdiff
path: root/atspi/atspi-table.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-table.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-table.c')
-rw-r--r--atspi/atspi-table.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/atspi/atspi-table.c b/atspi/atspi-table.c
index b17e2f1c..54db9603 100644
--- a/atspi/atspi-table.c
+++ b/atspi/atspi-table.c
@@ -285,6 +285,8 @@ atspi_table_get_column_description (AtspiTable *obj,
* Gets the number of rows spanned by the table cell at the specific row
* and column. (some tables can have cells which span multiple rows
* and/or columns).
+ * The returned values are meaningful only if the Table has both
+ * STATE_VISIBLE and STATE_SHOWING.
*
* Returns: a #gint indicating the number of rows spanned by the specified cell.
**/
@@ -313,6 +315,8 @@ atspi_table_get_row_extent_at (AtspiTable *obj,
* Gets the number of columns spanned by the table cell at the specific
* row and column (some tables can have cells which span multiple
* rows and/or columns).
+ * The returned values are meaningful only if the Table has both
+ * STATE_VISIBLE and STATE_SHOWING.
*
* Returns: a #gint indicating the number of columns spanned by the specified cell.
**/
@@ -646,6 +650,8 @@ atspi_table_remove_column_selection (AtspiTable *obj,
* extents, and whether the cell is currently selected. If
* the child at index is not a cell (for instance, if it is
* a summary, caption, etc.), #FALSE is returned.
+ * The returned values are meaningful only if the Table has both
+ * STATE_VISIBLE and STATE_SHOWING.
*
* Example:
* If the #AtspiTable child at index '6' extends across columns 5 and 6 of