<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::Table Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1Table.html">Accessibility::Table</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>Accessibility::Table Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::Table" -->
<p><code>import "<a class="el" href="Accessibility__Table_8idl_source.html">Accessibility_Table.idl</a>";</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a233e9585ad68f5cc7a7db1a04647a647">getAccessibleAt</a> (in long row, in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a70574b9c3ed128091e0ad934611399b8">getIndexAt</a> (in long row, in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a1a35643c89a1a2cc111a8933c771fc51">getRowAtIndex</a> (in long index)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#ac0a47c85e268e255f7b75f1bab8a53c7">getColumnAtIndex</a> (in long index)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#ae69095e053f1519ab6ae8e22a8b59c61">getRowDescription</a> (in long row)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a9c4e991fb4f9ce1c71ad200576218bd3">getColumnDescription</a> (in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#af5bdfebe6af9b00cdac0f57a62b70ff3">getRowExtentAt</a> (in long row, in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a5a7f4255e2f52f0999d50fc623329e37">getColumnExtentAt</a> (in long row, in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a0403cad12bf23f062eabe6724d157a81">getRowHeader</a> (in long row)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a64c03c8c0773c1dfddd3c191795748fe">getColumnHeader</a> (in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAccessibility.html#a798c179bf9ab97f1cd92e1f382dbf235">LongSeq</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#acaad063a9509780ea3cd5eacc0648d93">getSelectedRows</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAccessibility.html#a798c179bf9ab97f1cd92e1f382dbf235">LongSeq</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#ab331586f10b07ad34ca0872e6e0c537b">getSelectedColumns</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a247a2857a87fa431bb9790d9bf93f8f6">isRowSelected</a> (in long row)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a80c58dd3bbcc21bbbde1f1a4eb67f7dd">isColumnSelected</a> (in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a22f4760acfe218bdc0a5b3aab35d2cac">isSelected</a> (in long row, in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a152bc4935cae14623d298919fcf56649">addRowSelection</a> (in long row)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a999dda61a0b5fe4c4ad8199e75a2c442">addColumnSelection</a> (in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#abeee26d23ce79d44034c8d72f1a8a696">removeRowSelection</a> (in long row)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a7447ef04a504644e78cd8172a62a1440">removeColumnSelection</a> (in long column)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#ab6d3ee818f8393062951d8a5ba7a60b9">getRowColumnExtentsAtIndex</a> (in long index, out long row, out long col, out long row_extents, out long col_extents, out boolean is_selected)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a94db131868a3b4bfeb32372afbfd4da5">nRows</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a9269e77b16d3309929232df6b2e5b912">nColumns</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#af683410dcd7cf056d77952420072ae7e">caption</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a800192d3dd29b4f019beaead4684c34a">summary</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#a93ef6de686a5bcf6677282712ca43292">nSelectedRows</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Table.html#af668cf922ffac6a68fd76e8e22c41ba0">nSelectedColumns</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An interface used by containers whose contained data is arranged in a "tabular" (i.e. row-column) fashion. Tables may resemble a two-dimensional grid, as in a spreadsheet, or may feature objects which span multiple rows and/or columns, but whose bounds are aligned on a row/column matrix. Thus, the <a class="el" href="interfaceAccessibility_1_1Table.html">Table</a> interface may be used to represent "spreadsheets" as well as "frames".</p>
<p>Objects within tables are children of the <a class="el" href="interfaceAccessibility_1_1Table.html">Table</a> instance, and they may be referenced either via a child index or via a row/column pair. Their role may be ROLE_TABLE_CELL, but table 'cells' may have other roles as well. These 'cells' may implement other interfaces, such as <a class="el" href="interfaceAccessibility_1_1Text.html">Text</a>, <a class="el" href="interfaceAccessibility_1_1Action.html">Action</a>, <a class="el" href="interfaceAccessibility_1_1Image.html">Image</a>, and <a class="el" href="interfaceAccessibility_1_1Component.html">Component</a>, and should do so as appropriate to their onscreen representation and/or behavior. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a999dda61a0b5fe4c4ad8199e75a2c442"></a><!-- doxytag: member="Accessibility::Table::addColumnSelection" ref="a999dda61a0b5fe4c4ad8199e75a2c442" args="(in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Table::addColumnSelection </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Select the specified column, adding it to the current column selection, if the table's selection model permits it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>column</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Possible reasons for addColumnSelection to return <code>False</code> include: <ul>
<li>The table does not support <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> </li>
<li>The table column includes cells which do not have STATE_SELECTABLE </li>
<li>The table does not support selection by column </li>
<li>The table does not support selection of multiple columns, and one column is already selected. </li>
<li>The table does not support non-contiguous selections (i.e. does not include STATE_MULTISELECTABLE), and the specified column would result in selection of non-contiguous columns. </li>
<li>The table does not support user-instigated selection.</li>
</ul>
</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified column was successfully selected, <code>False</code> if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a152bc4935cae14623d298919fcf56649"></a><!-- doxytag: member="Accessibility::Table::addRowSelection" ref="a152bc4935cae14623d298919fcf56649" args="(in long row)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Table::addRowSelection </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Select the specified row, adding it to the current row selection, if the table's selection model permits it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Possible reasons for addRowSelection to return <code>False</code> include: <ul>
<li>The table does not support <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> </li>
<li>The table row includes cells which do not have STATE_SELECTABLE </li>
<li>The table does not support selection by row </li>
<li>The table does not support selection of multiple rows, and one row is already selected. </li>
<li>The table does not support non-contiguous selections (i.e. does not include STATE_MULTISELECTABLE), and the specified row would result in selection of non-contiguous rows. </li>
<li>The table does not support user-instigated selection.</li>
</ul>
</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified row was successfully selected, <code>False</code> if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a233e9585ad68f5cc7a7db1a04647a647"></a><!-- doxytag: member="Accessibility::Table::getAccessibleAt" ref="a233e9585ad68f5cc7a7db1a04647a647" args="(in long row, in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> Accessibility::Table::getAccessibleAt </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the table cell at the specified row and column indices. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>To get the accessible object at a particular (x, y) screen coordinate, use Accessible::getAccessibleAtPoint ().</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row,:</em> </td><td>the specified table row, zero-indexed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>column,:</em> </td><td>the specified table column, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> object representing the specified table cell. </dd></dl>
</div>
</div>
<a class="anchor" id="ac0a47c85e268e255f7b75f1bab8a53c7"></a><!-- doxytag: member="Accessibility::Table::getColumnAtIndex" ref="ac0a47c85e268e255f7b75f1bab8a53c7" args="(in long index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Accessibility::Table::getColumnAtIndex </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the table column index occupied by the child at a particular 1-D child index.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index,:</em> </td><td>the specified child index, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Table.html#a70574b9c3ed128091e0ad934611399b8">getIndexAt()</a>, <a class="el" href="interfaceAccessibility_1_1Table.html#a1a35643c89a1a2cc111a8933c771fc51">getRowAtIndex()</a></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a long integer indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) <code>index</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a9c4e991fb4f9ce1c71ad200576218bd3"></a><!-- doxytag: member="Accessibility::Table::getColumnDescription" ref="a9c4e991fb4f9ce1c71ad200576218bd3" args="(in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Table::getColumnDescription </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a text description of a particular table column. This differs from AccessibleTable_getColumnHeader, which returns an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>column,:</em> </td><td>the specified table column, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a UTF-8 string describing the specified table column, if available. </dd></dl>
</div>
</div>
<a class="anchor" id="a5a7f4255e2f52f0999d50fc623329e37"></a><!-- doxytag: member="Accessibility::Table::getColumnExtentAt" ref="a5a7f4255e2f52f0999d50fc623329e37" args="(in long row, in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Accessibility::Table::getColumnExtentAt </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get 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).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row,:</em> </td><td>the specified table row, zero-indexed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>column,:</em> </td><td>the specified table column, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a long integer indicating the number of columns spanned by the specified cell. </dd></dl>
</div>
</div>
<a class="anchor" id="a64c03c8c0773c1dfddd3c191795748fe"></a><!-- doxytag: member="Accessibility::Table::getColumnHeader" ref="a64c03c8c0773c1dfddd3c191795748fe" args="(in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> Accessibility::Table::getColumnHeader </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the header associated with a table column, if available, as an instance of <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>. This differs from getColumnDescription, which returns a string.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>column,:</em> </td><td>the specified table column, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> representatin of the specified table column, if available. </dd></dl>
</div>
</div>
<a class="anchor" id="a70574b9c3ed128091e0ad934611399b8"></a><!-- doxytag: member="Accessibility::Table::getIndexAt" ref="a70574b9c3ed128091e0ad934611399b8" args="(in long row, in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Accessibility::Table::getIndexAt </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the 1-D child index corresponding to the specified 2-D row and column indices. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>To get the accessible object at a particular (x, y) screen coordinate, use Accessible::getAccessibleAtPoint.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row,:</em> </td><td>the specified table row, zero-indexed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>column,:</em> </td><td>the specified table column, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Table.html#a1a35643c89a1a2cc111a8933c771fc51">getRowAtIndex</a>, <a class="el" href="interfaceAccessibility_1_1Table.html#ac0a47c85e268e255f7b75f1bab8a53c7">getColumnAtIndex</a></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a long integer which serves as the index of a specified cell in the table, in a form usable by <a class="el" href="interfaceAccessibility_1_1Accessible.html#a448e709e5dc7065b6a0cd5cbc5a4e649">Accessible::getChildAtIndex</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a1a35643c89a1a2cc111a8933c771fc51"></a><!-- doxytag: member="Accessibility::Table::getRowAtIndex" ref="a1a35643c89a1a2cc111a8933c771fc51" args="(in long index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Accessibility::Table::getRowAtIndex </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the table row index occupied by the child at a particular 1-D child index.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index,:</em> </td><td>the specified child index, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Table.html#a70574b9c3ed128091e0ad934611399b8">getIndexAt()</a>, <a class="el" href="interfaceAccessibility_1_1Table.html#ac0a47c85e268e255f7b75f1bab8a53c7">getColumnAtIndex()</a></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a long integer indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) <code>index</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ab6d3ee818f8393062951d8a5ba7a60b9"></a><!-- doxytag: member="Accessibility::Table::getRowColumnExtentsAtIndex" ref="ab6d3ee818f8393062951d8a5ba7a60b9" args="(in long index, out long row, out long col, out long row_extents, out long col_extents, out boolean is_selected)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Table::getRowColumnExtentsAtIndex </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out long </td>
<td class="paramname"> <em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out long </td>
<td class="paramname"> <em>col</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out long </td>
<td class="paramname"> <em>row_extents</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out long </td>
<td class="paramname"> <em>col_extents</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out boolean </td>
<td class="paramname"> <em>is_selected</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given a child index, determine the row and column indices and extents, and whether the cell is currently selected. If the child at <code>index</code> is not a cell (for instance, if it is a summary, caption, etc.), <code>False</code> is returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>the index of the <a class="el" href="interfaceAccessibility_1_1Table.html">Table</a> child whose row/column extents are requested. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>row</em> </td><td>back-filled with the first table row associated with the cell with child index <code>index</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>col</em> </td><td>back-filled with the first table column associated with the cell with child index <code>index</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>row_extents</em> </td><td>back-filled with the number of table rows across which child <code>i</code> extends. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>col_extents</em> </td><td>back-filled with the number of table columns across which child <code>i</code> extends. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>is_selected</em> </td><td>a boolean which is back-filled with <code>True</code> if the child at index <code>i</code> corresponds to a selected table cell, <code>False</code> otherwise.</td></tr>
</table>
</dd>
</dl>
<p>Example: If the <a class="el" href="interfaceAccessibility_1_1Table.html">Table</a> child at index '6' extends across columns 5 and 6 of row 2 of a <a class="el" href="interfaceAccessibility_1_1Table.html">Table</a> instance, and is currently selected, then </p>
<div class="fragment"><pre class="fragment"> retval = <a class="code" href="interfaceAccessibility_1_1Table.html#ab6d3ee818f8393062951d8a5ba7a60b9">table::getRowColumnExtentsAtIndex</a> (6, row, col,
row_extents,
col_extents,
is_selected);
</pre></div><p> will return True, and after the call <code>row</code>, <code>col</code>, <code>row_extents</code>, <code>col_extents</code>, and <code>is_selected</code> will contain <code>2</code>, <code>5</code>, <code>1</code>, <code>2</code>, and <code>True</code>, respectively.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the index is associated with a valid table cell, <code>False</code> if the index does not correspond to a cell. If <code>False</code> is returned, the values of the out parameters are undefined.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>AT-SPI 1.7.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae69095e053f1519ab6ae8e22a8b59c61"></a><!-- doxytag: member="Accessibility::Table::getRowDescription" ref="ae69095e053f1519ab6ae8e22a8b59c61" args="(in long row)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Table::getRowDescription </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a text description of a particular table row. This differs from AccessibleTable_getRowHeader, which returns an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row,:</em> </td><td>the specified table row, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a UTF-8 string describing the specified table row, if available. </dd></dl>
</div>
</div>
<a class="anchor" id="af5bdfebe6af9b00cdac0f57a62b70ff3"></a><!-- doxytag: member="Accessibility::Table::getRowExtentAt" ref="af5bdfebe6af9b00cdac0f57a62b70ff3" args="(in long row, in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Accessibility::Table::getRowExtentAt </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get 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).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row,:</em> </td><td>the specified table row, zero-indexed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>column,:</em> </td><td>the specified table column, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a long integer indicating the number of rows spanned by the specified cell. </dd></dl>
</div>
</div>
<a class="anchor" id="a0403cad12bf23f062eabe6724d157a81"></a><!-- doxytag: member="Accessibility::Table::getRowHeader" ref="a0403cad12bf23f062eabe6724d157a81" args="(in long row)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> Accessibility::Table::getRowHeader </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the header associated with a table row, if available. This differs from getRowDescription, which returns a string.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row,:</em> </td><td>the specified table row, zero-indexed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> representatin of the specified table row, if available. </dd></dl>
</div>
</div>
<a class="anchor" id="ab331586f10b07ad34ca0872e6e0c537b"></a><!-- doxytag: member="Accessibility::Table::getSelectedColumns" ref="ab331586f10b07ad34ca0872e6e0c537b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#a798c179bf9ab97f1cd92e1f382dbf235">LongSeq</a> Accessibility::Table::getSelectedColumns </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtain the indices of all columns which are currently selected. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Not all tables support column selection.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a sequence of integers comprising the indices of columns currently selected. </dd></dl>
</div>
</div>
<a class="anchor" id="acaad063a9509780ea3cd5eacc0648d93"></a><!-- doxytag: member="Accessibility::Table::getSelectedRows" ref="acaad063a9509780ea3cd5eacc0648d93" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#a798c179bf9ab97f1cd92e1f382dbf235">LongSeq</a> Accessibility::Table::getSelectedRows </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtain the indices of all rows which are currently selected. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Not all tables support row selection.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a sequence of integers comprising the indices of rows currently selected. </dd></dl>
</div>
</div>
<a class="anchor" id="a80c58dd3bbcc21bbbde1f1a4eb67f7dd"></a><!-- doxytag: member="Accessibility::Table::isColumnSelected" ref="a80c58dd3bbcc21bbbde1f1a4eb67f7dd" args="(in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Table::isColumnSelected </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine whether a table column is selected. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Not all tables support column selection.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>column,:</em> </td><td>the column being queried.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified column is currently selected, <code>False</code> if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a247a2857a87fa431bb9790d9bf93f8f6"></a><!-- doxytag: member="Accessibility::Table::isRowSelected" ref="a247a2857a87fa431bb9790d9bf93f8f6" args="(in long row)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Table::isRowSelected </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine whether a table row is selected. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Not all tables support row selection.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row,:</em> </td><td>the row being queried.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified row is currently selected, <code>False</code> if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a22f4760acfe218bdc0a5b3aab35d2cac"></a><!-- doxytag: member="Accessibility::Table::isSelected" ref="a22f4760acfe218bdc0a5b3aab35d2cac" args="(in long row, in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Table::isSelected </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine whether the cell at a specific row and column is selected. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row</em> </td><td>a row occupied by the cell whose state is being queried. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>column</em> </td><td>a column occupied by the cell whose state is being queried.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified cell is currently selected, <code>False</code> if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a7447ef04a504644e78cd8172a62a1440"></a><!-- doxytag: member="Accessibility::Table::removeColumnSelection" ref="a7447ef04a504644e78cd8172a62a1440" args="(in long column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Table::removeColumnSelection </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>column</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the specified column from current column selection, if the table's selection model permits it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>column</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Possible reasons for removeColumnSelection to return <code>False</code> include: <ul>
<li>The table does not support user-instigated modification of selection state </li>
<li>The table has no selected columns or does not support deselection by column.</li>
</ul>
</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified column was successfully de-selected, <code>False</code> if not. </dd></dl>
</div>
</div>
<a class="anchor" id="abeee26d23ce79d44034c8d72f1a8a696"></a><!-- doxytag: member="Accessibility::Table::removeRowSelection" ref="abeee26d23ce79d44034c8d72f1a8a696" args="(in long row)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Table::removeRowSelection </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>row</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the specified row from current row selection, if the table's selection model permits it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>row</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Possible reasons for removeRowSelection to return <code>False</code> include: <ul>
<li>The table does not support user-instigated <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> </li>
<li>The table has no selected rows or does not support deselection by row</li>
</ul>
</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified row was successfully de-selected, <code>False</code> if not. </dd></dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="af683410dcd7cf056d77952420072ae7e"></a><!-- doxytag: member="Accessibility::Table::caption" ref="af683410dcd7cf056d77952420072ae7e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> <a class="el" href="interfaceAccessibility_1_1Table.html#af683410dcd7cf056d77952420072ae7e">Accessibility::Table::caption</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> which represents of a caption for a <a class="el" href="interfaceAccessibility_1_1Table.html">Table</a>. </p>
</div>
</div>
<a class="anchor" id="a9269e77b16d3309929232df6b2e5b912"></a><!-- doxytag: member="Accessibility::Table::nColumns" ref="a9269e77b16d3309929232df6b2e5b912" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Table.html#a9269e77b16d3309929232df6b2e5b912">Accessibility::Table::nColumns</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The total number of columns in this table (including empty columns), exclusive of columns which are programmatically hidden. Columns which are scrolled out of view or clipped by the current viewport are included. </p>
</div>
</div>
<a class="anchor" id="a94db131868a3b4bfeb32372afbfd4da5"></a><!-- doxytag: member="Accessibility::Table::nRows" ref="a94db131868a3b4bfeb32372afbfd4da5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Table.html#a94db131868a3b4bfeb32372afbfd4da5">Accessibility::Table::nRows</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The total number of rows in this table (including empty rows), exclusive of any rows which are programmatically hidden. Rows which are merely scrolled out of view are included. </p>
</div>
</div>
<a class="anchor" id="af668cf922ffac6a68fd76e8e22c41ba0"></a><!-- doxytag: member="Accessibility::Table::nSelectedColumns" ref="af668cf922ffac6a68fd76e8e22c41ba0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Table.html#af668cf922ffac6a68fd76e8e22c41ba0">Accessibility::Table::nSelectedColumns</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The number of columns currently selected. A selected column is one in which all included cells are selected. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Not all tables support column selection. </dd></dl>
</div>
</div>
<a class="anchor" id="a93ef6de686a5bcf6677282712ca43292"></a><!-- doxytag: member="Accessibility::Table::nSelectedRows" ref="a93ef6de686a5bcf6677282712ca43292" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Table.html#a93ef6de686a5bcf6677282712ca43292">Accessibility::Table::nSelectedRows</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The number of rows currently selected. A selected row is one in which all included cells are selected. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Not all tables support row selection. </dd></dl>
</div>
</div>
<a class="anchor" id="a800192d3dd29b4f019beaead4684c34a"></a><!-- doxytag: member="Accessibility::Table::summary" ref="a800192d3dd29b4f019beaead4684c34a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> <a class="el" href="interfaceAccessibility_1_1Table.html#a800192d3dd29b4f019beaead4684c34a">Accessibility::Table::summary</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An accessible object which summarizes the contents of a <a class="el" href="interfaceAccessibility_1_1Table.html">Table</a>. This object is frequently itself a <a class="el" href="interfaceAccessibility_1_1Table.html">Table</a> instance, albeit a simplified one. </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Table_8idl_source.html">Accessibility_Table.idl</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
