1 <?xml version="1.0" encoding="UTF-8"?>
2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
8 <interface name="org.freedesktop.atspi.Table">
9 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
10 <p>An interface used by containers whose contained data is arranged in
11 a "tabular" (i.e.\ row-column) fashion. Tables may resemble a two-dimensional
12 grid, as in a spreadsheet, or may feature objects which span multiple rows and/or
13 columns, but whose bounds are aligned on a row/column matrix. Thus, the Table
14 interface may be used to represent "spreadsheets" as well as "frames". </p>
16 <p>Objects within tables are children of the Table instance, and they may be referenced
17 either via a child index or via a row/column pair.
18 Their role may be ROLE_TABLE_CELL, but table 'cells' may have other roles as well.
19 These 'cells' may implement other interfaces, such as Text, Action, Image,
20 and Component, and should do so as appropriate to their onscreen representation
23 <tp:property name="nRows" type="i" access="read">
24 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
25 <p>The total number of rows in this table (including empty rows),
26 exclusive of any rows which are programmatically hidden.
27 Rows which are merely scrolled out of view are included.</p>
30 <tp:property name="nColumns" type="i" access="read">
31 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
32 <p>The total number of columns in this table (including empty columns),
33 exclusive of columns which are programmatically hidden.
34 Columns which are scrolled out of view or clipped by the current
35 viewport are included. </p>
38 <tp:property name="caption" type="o" access="read">
40 An Accessible which represents of a caption for a Table.
43 <tp:property name="summary" type="o" access="read">
44 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
45 <p>An accessible object which summarizes the contents of a Table.
46 This object is frequently itself a Table instance, albeit a simplified one.</p>
49 <tp:property name="nSelectedRows" type="i" access="read">
50 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
51 <p>The number of rows currently selected.
52 A selected row is one in which all included cells are selected.
53 @note Not all tables support row selection.</p>
56 <tp:property name="nSelectedColumns" type="i" access="read">
57 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
58 <p>The number of columns currently selected.
59 A selected column is one in which all included cells are selected.
60 @note Not all tables support column selection.</p>
63 <method name="getAccessibleAt">
64 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
65 <p>Get the table cell at the specified row and column indices.
66 @note To get the accessible object at a particular (x, y) screen coordinate,
67 use Accessible::getAccessibleAtPoint (). </p>
69 <arg direction="in" name="row" type="i">
71 the specified table row, zero-indexed.
74 <arg direction="in" name="column" type="i">
76 the specified table column, zero-indexed.
79 <arg direction="out" type="o" tp:type="Accessible">
81 an Accessible object representing the specified table cell.
85 <method name="getIndexAt">
86 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
87 <p>Get the 1-D child index corresponding to the specified 2-D row and column indices.
88 @note To get the accessible object at a particular (x, y) screen coordinate,
89 use Accessible::getAccessibleAtPoint. </p>
91 <arg direction="in" name="row" type="i">
93 the specified table row, zero-indexed.
96 <arg direction="in" name="column" type="i">
98 the specified table column, zero-indexed.@see getRowAtIndex, getColumnAtIndex
101 <arg direction="out" type="i">
103 a long integer which serves as the index of a specified cell in thetable, in a form usable by Accessible::getChildAtIndex.
107 <method name="getRowAtIndex">
108 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
109 <p>Get the table row index occupied by the child at a particular 1-D child index. </p>
111 <arg direction="in" name="index" type="i">
113 the specified child index, zero-indexed.@see getIndexAt(), getColumnAtIndex()
116 <arg direction="out" type="i">
118 a long integer indicating the first row spanned by the child of atable, at the specified 1-D (zero-offset) \c index.
122 <method name="getColumnAtIndex">
123 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
124 <p>Get the table column index occupied by the child at a particular 1-D child index. </p>
126 <arg direction="in" name="index" type="i">
128 the specified child index, zero-indexed.@see getIndexAt(), getRowAtIndex()
131 <arg direction="out" type="i">
133 a long integer indicating the first column spanned by the child of atable, at the specified 1-D (zero-offset) \c index.
137 <method name="getRowDescription">
138 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
139 <p>Get a text description of a particular table row. This differs from
140 AccessibleTable_getRowHeader, which returns an Accessible.</p>
142 <arg direction="in" name="row" type="i">
144 the specified table row, zero-indexed.
147 <arg direction="out" type="s">
149 a UTF-8 string describing the specified table row, if available.
153 <method name="getColumnDescription">
154 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
155 <p>Get a text description of a particular table column. This differs from
156 AccessibleTable_getColumnHeader, which returns an Accessible.</p>
158 <arg direction="in" name="column" type="i">
160 the specified table column, zero-indexed.
163 <arg direction="out" type="s">
165 a UTF-8 string describing the specified table column, if available.
169 <method name="getRowExtentAt">
170 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
171 <p>Get the number of rows spanned by the table cell at the specific row and column.
172 (some tables can have cells which span multiple rows and/or columns). </p>
174 <arg direction="in" name="row" type="i">
176 the specified table row, zero-indexed.
179 <arg direction="in" name="column" type="i">
181 the specified table column, zero-indexed.
184 <arg direction="out" type="i">
186 a long integer indicating the number of rows spanned by the specified cell.
190 <method name="getColumnExtentAt">
191 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
192 <p>Get the number of columns spanned by the table cell at the specific row and column.
193 (some tables can have cells which span multiple rows and/or columns). </p>
195 <arg direction="in" name="row" type="i">
197 the specified table row, zero-indexed.
200 <arg direction="in" name="column" type="i">
202 the specified table column, zero-indexed.
205 <arg direction="out" type="i">
207 a long integer indicating the number of columns spanned by the specified cell.
211 <method name="getRowHeader">
212 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
213 <p>Get the header associated with a table row, if available. This differs from
214 getRowDescription, which returns a string. </p>
216 <arg direction="in" name="row" type="i">
218 the specified table row, zero-indexed.
221 <arg direction="out" type="o" tp:type="Accessible">
223 an Accessible representatin of the specified table row, if available.
227 <method name="getColumnHeader">
228 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
229 <p>Get the header associated with a table column, if available, as an
230 instance of Accessible. This differs from
231 getColumnDescription, which returns a string. </p>
233 <arg direction="in" name="column" type="i">
235 the specified table column, zero-indexed.
238 <arg direction="out" type="o" tp:type="Accessible">
240 an Accessible representatin of the specified table column, if available.
244 <method name="getSelectedRows">
245 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
246 <p>Obtain the indices of all rows which are currently selected.
247 @note Not all tables support row selection. </p>
249 <arg direction="out" type="ai" tp:type="LongSeq">
251 a sequence of integers comprising the indices of rows currently selected.
255 <method name="getSelectedColumns">
256 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
257 <p>Obtain the indices of all columns which are currently selected.
258 @note Not all tables support column selection. </p>
260 <arg direction="out" type="ai" tp:type="LongSeq">
262 a sequence of integers comprising the indices of columns currently selected.
266 <method name="isRowSelected">
267 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
268 <p>Determine whether a table row is selected.
269 @note Not all tables support row selection. </p>
271 <arg direction="in" name="row" type="i">
273 the row being queried.
276 <arg direction="out" type="b" tp:type="boolean">
278 \c True if the specified row is currently selected, \c False if not.
282 <method name="isColumnSelected">
283 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
284 <p>Determine whether a table column is selected.
285 @note Not all tables support column selection. </p>
287 <arg direction="in" name="column" type="i">
289 the column being queried.
292 <arg direction="out" type="b" tp:type="boolean">
294 \c True if the specified column is currently selected, \c False if not.
298 <method name="isSelected">
299 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
300 <p>Determine whether the cell at a specific row and column is selected.
301 @param row a row occupied by the cell whose state is being queried.
302 @param column a column occupied by the cell whose state is being queried. </p>
304 <arg direction="in" name="row" type="i"/>
305 <arg direction="in" name="column" type="i"/>
306 <arg direction="out" type="b" tp:type="boolean">
308 \c True if the specified cell is currently selected, \c False if not.
312 <method name="addRowSelection">
313 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
314 <p>Select the specified row, adding it to the current row selection,
315 if the table's selection model permits it. </p>
318 @note Possible reasons for addRowSelection to return \c False
320 \li The table does not support Selection
321 \li The table row includes cells which do not have STATE_SELECTABLE
322 \li The table does not support selection by row
323 \li The table does not support selection of multiple rows, and
324 one row is already selected.
325 \li The table does not support non-contiguous selections (i.e.
326 does not include STATE_MULTISELECTABLE), and the specified row
327 would result in selection of non-contiguous rows.
328 \li The table does not support user-instigated selection. </p>
330 <arg direction="in" name="row" type="i"/>
331 <arg direction="out" type="b" tp:type="boolean">
333 \c True if the specified row was successfully selected, \c False if not.
337 <method name="addColumnSelection">
338 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
339 <p>Select the specified column, adding it to the current column selection,
340 if the table's selection model permits it. </p>
343 @note Possible reasons for addColumnSelection to return \c False
345 \li The table does not support Selection
346 \li The table column includes cells which do not have STATE_SELECTABLE
347 \li The table does not support selection by column
348 \li The table does not support selection of multiple columns, and
349 one column is already selected.
350 \li The table does not support non-contiguous selections (i.e.
351 does not include STATE_MULTISELECTABLE), and the specified column
352 would result in selection of non-contiguous columns.
353 \li The table does not support user-instigated selection. </p>
355 <arg direction="in" name="column" type="i"/>
356 <arg direction="out" type="b" tp:type="boolean">
358 \c True if the specified column was successfully selected, \c False if not.
362 <method name="removeRowSelection">
363 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
364 <p>Remove the specified row from current row selection,
365 if the table's selection model permits it. </p>
368 @note Possible reasons for removeRowSelection to return \c False
370 \li The table does not support user-instigated Selection
371 \li The table has no selected rows or does not support deselection by row </p>
373 <arg direction="in" name="row" type="i"/>
374 <arg direction="out" type="b" tp:type="boolean">
376 \c True if the specified row was successfully de-selected, \c False if not.
380 <method name="removeColumnSelection">
381 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
382 <p>Remove the specified column from current column selection,
383 if the table's selection model permits it. </p>
386 @note Possible reasons for removeColumnSelection to return \c False
388 \li The table does not support user-instigated modification of
390 \li The table has no selected columns or does not support
391 deselection by column. </p>
393 <arg direction="in" name="column" type="i"/>
394 <arg direction="out" type="b" tp:type="boolean">
396 \c True if the specified column was successfully de-selected, \c False if not.
400 <method name="getRowColumnExtentsAtIndex">
401 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
402 <p>Given a child index, determine the row and column indices and
403 extents, and whether the cell is currently selected. If
404 the child at \c index is not a cell (for instance, if it is
405 a summary, caption, etc.), \c False is returned. </p>
407 <p>@param index the index of the Table child whose row/column
408 extents are requested.
409 @param row back-filled with the first table row associated with
410 the cell with child index \c index.
411 @param col back-filled with the first table column associated
412 with the cell with child index \c index.
413 @param row_extents back-filled with the number of table rows
414 across which child \c i extends.
415 @param col_extents back-filled with the number of table columns
416 across which child \c i extends.
417 @param is_selected a boolean which is back-filled with \c True
418 if the child at index \c i corresponds to a selected table cell,
419 \c False otherwise. </p>
422 If the Table child at index '6' extends across columns 5 and 6 of
423 row 2 of a Table instance, and is currently selected, then
425 retval = table::getRowColumnExtentsAtIndex (6, row, col,
430 will return True, and after the call
431 \c row, \c col, \c row_extents, \c col_extents,
432 and \c is_selected will contain \c 2, \c 5, \c 1, \c 2, and
433 \c True, respectively. </p>
435 <arg direction="in" name="index" type="i"/>
436 <arg direction="out" name="row" type="i"/>
437 <arg direction="out" name="col" type="i"/>
438 <arg direction="out" name="row_extents" type="i"/>
439 <arg direction="out" name="col_extents" type="i"/>
440 <arg direction="out" name="is_selected" type="b" tp:type="boolean"/>
441 <arg direction="out" type="b" tp:type="boolean">
443 \c True if the index is associated with a valid tablecell, \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
447 <method name="unImplemented">
448 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
452 <p>placeholders for future expansion.</p>
455 <method name="unImplemented2">
457 <method name="unImplemented3">
459 <method name="unImplemented4">
461 <method name="unImplemented5">
463 <method name="unImplemented6">
465 <method name="unImplemented7">