IAccessibleTable2

This interface gives access to a two-dimensional table.
1.0
28
Introduced
Gecko 1.9.2
Inherits from: IUnknown Last changed in Gecko 1.9.2 (Firefox 3.6 / Thunderbird 3.1 / Fennec 1.0)

Please also refer to the IAccessibleTableCell interface. If you want to support older applications you should also support the IAccessibleTable interface.

Method overview

[propget] HRESULT caption([out] IUnknown accessible );
[propget] HRESULT cellAt([in] long row, [in] long column, [out] IUnknown cell );
[propget] HRESULT columnDescription([in] long column, [out] BSTR description );
[propget] HRESULT isColumnSelected([in] long column, [out] boolean isSelected );
[propget] HRESULT isRowSelected([in] long row, [out] boolean isSelected );
[propget] HRESULT modelChange([out] IA2TableModelChange modelChange );
[propget] HRESULT nColumns([out] long columnCount );
[propget] HRESULT nRows([out] long rowCount );
[propget] HRESULT nSelectedCells([out] long cellCount );
[propget] HRESULT nSelectedColumns([out] long columnCount );
[propget] HRESULT nSelectedRows([out] long rowCount );
[propget] HRESULT rowDescription([in] long row, [out] BSTR description );
HRESULT selectColumn([in] long column );
[propget] HRESULT selectedCells([out, size_is(, nSelectedCells,)] IUnknown cells, [out] long nSelectedCells );
[propget] HRESULT selectedColumns([out, size_is(, nColumns)] long selectedColumns, [out] long nColumns );
[propget] HRESULT selectedRows([out, size_is(, nRows)] long selectedRows, [out] long nRows );
HRESULT selectRow([in] long row );
[propget] HRESULT summary([out] IUnknown accessible );
HRESULT unselectColumn([in] long column );
HRESULT unselectRow([in] long row );

Methods

caption()

Returns the caption for the table. The returned object could be an IAccessible or an IAccessible2.

[propget] HRESULT caption(
  [out] IUnknown accessible 
);
Parameters
accessible
If the table has a caption then a reference to it is returned, else a null pointer is returned.
Return value

S_FALSE if there is nothing to return, [out] value is null. S_OK.

cellAt()

Returns the accessible object at the specified row and column in the table. This object could be an IAccessible or an IAccessible2.

[propget] HRESULT cellAt(
  [in] long row,
  [in] long column,
  [out] IUnknown cell 
);
Parameters
row
The 0 based row index for which to retrieve the cell.
column
The 0 based column index for which to retrieve the cell.
cell
If both row and column index are valid then the corresponding accessible object is returned that represents the requested cell regardless of whether the cell is currently visible (on the screen).
Return value

E_INVALIDARG if bad [in] passed, [out] value is null. S_OK.

columnDescription()

Returns the description text of the specified column in the table.

[propget] HRESULT columnDescription(
  [in] long column,
  [out] BSTR description 
);
Parameters
column
The 0 based index of the column for which to retrieve the description.
description
Returns the description text of the specified column in the table if such a description exists. Otherwise a null pointer is returned.
Return value

E_INVALIDARG if bad [in] passed, [out] value is null. S_FALSE if there is nothing to return, [out] value is null. S_OK.

isColumnSelected()

Returns a boolean value indicating whether the specified column is completely selected.

[propget] HRESULT isColumnSelected(
  [in] long column,
  [out] boolean isSelected 
);
Parameters
column
0 based index of the column for which to determine whether it is selected.
isSelected
Returns true if the specified column is selected completely and false otherwise.
Return value

E_INVALIDARG if bad [in] passed, [out] value is false. S_OK.

isRowSelected()

Returns a boolean value indicating whether the specified row is completely selected.

[propget] HRESULT isRowSelected(
  [in] long row,
  [out] boolean isSelected 
);
Parameters
row
0 based index of the row for which to determine whether it is selected.
isSelected
Returns true if the specified row is selected completely and false otherwise.
Return value

E_INVALIDARG if bad [in] passed, [out] value is false. S_OK.

modelChange()

Returns the type and extents describing how a table changed. Provided for use by the IA2_EVENT_TABLE_MODEL_CHANGED event handler. This data is only guaranteed to be valid while the thread notifying the event continues. Once the handler has returned, the validity of the data depends on how the server manages the life cycle of its objects. Also, note that the server may have different life cycle management strategies for controls depending on whether or not a control manages its children. Lists, trees, and tables can have a large number of children and thus it's possible that the child objects for those controls would only be created as needed. Servers should document their life cycle strategy as this will be of interest to assistive technology or script engines accessing data out of process or from other threads. Servers only need to save the most recent row and column values associated with the change and a scope of the entire application is adequate.

[propget] HRESULT modelChange(
  [out] IA2TableModelChange modelChange 
);
Parameters
modelChange
A struct of (type(insert, delete, update), firstRow, lastRow, firstColumn, lastColumn).
Return value

S_FALSE if there is nothing to return, [out] value is null. S_OK.

nColumns()

Returns the total number of columns in table.

[propget] HRESULT nColumns(
  [out] long columnCount 
);
Parameters
columnCount
Number of columns in table (including columns outside the current viewport)
Return value

S_OK.

nRows()

Returns the total number of rows in table.

[propget] HRESULT nRows(
  [out] long rowCount 
);
Parameters
rowCount
Number of rows in table (including rows outside the current viewport)
Return value

S_OK.

nSelectedCells()

Returns the total number of selected cells.

[propget] HRESULT nSelectedCells(
  [out] long cellCount 
);
Parameters
cellCount
Number of cells currently selected.
Return value

S_OK.

nSelectedColumns()

Returns the total number of selected columns.

[propget] HRESULT nSelectedColumns(
  [out] long columnCount 
);
Parameters
columnCount
Number of columns currently selected.
Return value

S_OK.

nSelectedRows()

Returns the total number of selected rows.

[propget] HRESULT nSelectedRows(
  [out] long rowCount 
);
Parameters
rowCount
Number of rows currently selected.
Return value

S_OK.

rowDescription()

Returns the description text of the specified row in the table.

[propget] HRESULT rowDescription(
  [in] long row,
  [out] BSTR description 
);
Parameters
row
The 0 based index of the row for which to retrieve the description.
description
Returns the description text of the specified row in the table if such a description exists. Otherwise a null pointer is returned.
Return value

E_INVALIDARG if bad [in] passed, [out] value is null. S_FALSE if there is nothing to return, [out] value is null. S_OK.

selectColumn()

Selects a column and unselects all previously selected columns. The behavior should mimic that of the application, but for those applications which do not have a means in the GUI to select a full column of cells the behavior should be as follows: First any selected columns in the table are unselected. Then the entire column of cells for the specified column is selected. If any of the cells in the selected column span additional columns, the cells in those columns are also selected.

HRESULT selectColumn(
  [in] long column 
);
Parameters
column
0 based index of the column to be selected.
Return value

E_INVALIDARG if bad [in] passed. S_OK.

selectedCells()

Returns a list of accessibles currently selected.

[propget] HRESULT selectedCells(
  [out, size_is(, nSelectedCells,)] IUnknown cells,
  [out] long nSelectedCells 
);
Parameters
cells
Pointer to an array of references to selected accessibles. The array is allocated by the server. Free it with CoTaskMemFree.
nSelectedCells
The number of accessibles returned; the size of the returned array.
Return value

S_FALSE if there are none, [out] values are null and 0 respectively. S_OK.

selectedColumns()

Returns a list of column indexes currently selected (0 based).

[propget] HRESULT selectedColumns(
  [out, size_is(, nColumns)] long selectedColumns,
  [out] long nColumns 
);
Parameters
selectedColumns
A pointer to an array of column indexes of selected columns (each index is 0 based). The array is allocated by the server. Free it with CoTaskMemFree.
nColumns
The number of column indexes returned; the size of the returned array.
Return value

S_FALSE if there are none, [out] values are null and 0 respectively. S_OK.

selectedRows()

Returns a list of row indexes currently selected (0 based).

[propget] HRESULT selectedRows(
  [out, size_is(, nRows)] long selectedRows,
  [out] long nRows 
);
Parameters
selectedRows
An array of row indexes of selected rows (each index is 0 based), allocated by the server. Free it with CoTaskMemFree.
nRows
The number of row indexes returned; the size of the returned array.
Return value

S_FALSE if there are none, [out] values are null and 0 respectively. S_OK.

selectRow()

Selects a row and unselects all previously selected rows. The behavior should mimic that of the application, but for those applications which do not have a means in the GUI to select a full row of cells the behavior should be as follows: First any selected rows in the table are unselected. Then the entire row of cells for the specified row is selected. If any of the cells in the selected row span additional rows, the cells in those rows are also selected.

HRESULT selectRow(
  [in] long row 
);
Parameters
row
0 based index of the row to be selected.
Return value

E_INVALIDARG if bad [in] passed. S_OK.

summary()

Returns the summary description of the table. The returned object could be an IAccessible or an IAccessible2.

[propget] HRESULT summary(
  [out] IUnknown accessible 
);
Parameters
accessible
Returns a reference to an implementation dependent accessible object representing the table's summary or a null pointer if the table does not support a summary.
Return value

S_FALSE if there is nothing to return, [out] value is null. S_OK.

unselectColumn()

Unselects one column, leaving other selected columns selected (if any). The behavior should mimic that of the application, but for those applications which do not have a means in the GUI to unselect a full column of cells the behavior should be as follows: The entire column of cells for the specified column is unselected. If any of the cells in the selected column span additional columns, the cells in those columns are also unselected.

HRESULT unselectColumn(
  [in] long column 
);
Parameters
column
0 based index of the column to be unselected.
Return value

E_INVALIDARG if bad [in] passed. S_OK.

unselectRow()

Unselects one row, leaving other selected rows selected (if any). The behavior should mimic that of the application, but for those applications which do not have a means in the GUI to unselect a full row of cells the behavior should be as follows: The entire row of cells for the specified row is unselected. If any of the cells in the selected row span additional rows, the cells in those rows are also unselected.

HRESULT unselectRow(
  [in] long row 
);
Parameters
row
0 based index of the row to be unselected.
Return value

E_INVALIDARG if bad [in] passed. S_OK.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh
Last updated by: Sheppy,