summaryrefslogtreecommitdiff
path: root/idl
diff options
context:
space:
mode:
authorbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>2006-07-12 14:59:47 +0000
committerbillh <billh@e2bd861d-eb25-0410-b326-f6ed22b6b98c>2006-07-12 14:59:47 +0000
commit74ba76b61acb398d6f10065e3166b5e6f50a3bc0 (patch)
treeda895081cd88481636dbabcca87d91dd67fe1c30 /idl
parentb0b12f83d87d3561be05d956226d728f762135ef (diff)
downloadat-spi2-core-74ba76b61acb398d6f10065e3166b5e6f50a3bc0.tar.gz
Added new method to Accessibility::Table; see RFE #326536.
git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@835 e2bd861d-eb25-0410-b326-f6ed22b6b98c
Diffstat (limited to 'idl')
-rw-r--r--idl/Accessibility_Table.idl48
1 files changed, 46 insertions, 2 deletions
diff --git a/idl/Accessibility_Table.idl b/idl/Accessibility_Table.idl
index 0e2ee672..a995ba31 100644
--- a/idl/Accessibility_Table.idl
+++ b/idl/Accessibility_Table.idl
@@ -291,7 +291,52 @@ typedef sequence<long> LongSeq;
* \c False if not.
**/
boolean removeColumnSelection (in long column);
-
+ /**
+ * Given a child index, determine the row and column indices and
+ * extents, and whether the cell is currently selected. If
+ * the child at \c index is not a cell (for instance, if it is
+ * a summary, caption, etc.), \c False is returned.
+ *
+ * @param index the index of the Table child whose row/column
+ * extents are requested.
+ * @param row back-filled with the first table row associated with
+ * the cell with child index \c index.
+ * @param col back-filled with the first table column associated
+ * with the cell with child index \c index.
+ * @param row_extents back-filled with the number of table rows
+ * across which child \c i extends.
+ * @param col_extents back-filled with the number of table columns
+ * across which child \c i extends.
+ * @param is_selected a boolean which is back-filled with \c True
+ * if the child at index \c i corresponds to a selected table cell,
+ * \c False otherwise.
+ *
+ * Example:
+ * If the Table child at index '6' extends across columns 5 and 6 of
+ * row 2 of a Table instance, and is currently selected, then
+ * \code
+ * retval = table::getRowColumnExtentsAtIndex (6, row, col,
+ * row_extents,
+ * col_extents,
+ * is_selected);
+ * \endcode
+ * will return True, and after the call
+ * \c row, \c col, \c row_extents, \c col_extents,
+ * and \c is_selected will contain \c 2, \c 5, \c 1, \c 2, and
+ * \c True, respectively.
+ *
+ * @returns \c True if the index is associated with a valid table
+ * cell, \c False if the index does not correspond to a cell. If
+ * \c False is returned, the values of the out parameters are
+ * undefined.
+ *
+ * @since AT-SPI 1.7.0
+ **/
+ boolean getRowColumnExtentsAtIndex (in long index, out long row,
+ out long col,
+ out long row_extents,
+ out long col_extents,
+ out boolean is_selected);
/** \cond
* unImplemented:
*
@@ -304,7 +349,6 @@ typedef sequence<long> LongSeq;
void unImplemented5 ();
void unImplemented6 ();
void unImplemented7 ();
- void unImplemented8 ();
/** \endcond */
};
};