summaryrefslogtreecommitdiff
path: root/atspi/atspi-table-cell.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-cell.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-cell.c')
-rw-r--r--atspi/atspi-table-cell.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/atspi/atspi-table-cell.c b/atspi/atspi-table-cell.c
index 13203bf6..3a475655 100644
--- a/atspi/atspi-table-cell.c
+++ b/atspi/atspi-table-cell.c
@@ -58,6 +58,8 @@ get_object_array_and_unref (DBusMessage *reply)
* @obj: a GObject instance that implements AtspiTableCellIface
*
* Returns the number of columns occupied by this cell accessible.
+ * The returned values are meaningful only if the table cell has both
+ * STATE_VISIBLE and STATE_SHOWING.
*
* Returns: a gint representing the number of columns occupied by this cell,
* or 0 if the cell does not implement this method.
@@ -101,6 +103,8 @@ atspi_table_cell_get_column_header_cells (AtspiTableCell *obj, GError **error)
* @obj: a GObject instance that implements AtspiTableCellIface
*
* Returns the number of rows occupied by this cell accessible.
+ * The returned values are meaningful only if the table cell has both
+ * STATE_VISIBLE and STATE_SHOWING.
*
* Returns: a gint representing the number of rows occupied by this cell,
* or 0 if the cell does not implement this method.
@@ -206,6 +210,8 @@ atspi_table_cell_get_position (AtspiTableCell *obj,
* @column_span: (out): the number of columns occupied by this cell.
*
* Gets the row and column indexes and extents of this cell accessible.
+ * The returned values are meaningful only if the table cell has both
+ * STATE_VISIBLE and STATE_SHOWING.
*/
void
atspi_table_cell_get_row_column_span (AtspiTableCell *obj,