This interface gives access to a two-dimensional table. More...

import"ia2_api_all.idl";

Inheritance diagram for IAccessibleTable:

Collaboration diagram for IAccessibleTable:

Public Member Functions
HRESULT	selectRow ([in] long row)
	Selects a row and unselects all previously selected rows. More...

HRESULT	selectColumn ([in] long column)
	Selects a column and unselects all previously selected columns. More...

HRESULT	unselectRow ([in] long row)
	Unselects one row, leaving other selected rows selected (if any). More...

HRESULT	unselectColumn ([in] long column)
	Unselects one column, leaving other selected columns selected (if any). More...

Properties
IUnknown	accessibleAt ([in] long row,[in] long column) `[get]`
	Returns the accessible object at the specified row and column in the table. More...

IUnknown	caption `[get]`
	Returns the caption for the table. More...

long	childIndex ([in] long rowIndex,[in] long columnIndex) `[get]`
	Translates the given row and column indexes into the corresponding cell index. More...

BSTR	columnDescription ([in] long column) `[get]`
	Returns the description text of the specified column in the table. More...

long	columnExtentAt ([in] long row,[in] long column) `[get]`
	Returns the number of columns occupied by the accessible object at the specified row and column in the table. More...

long	columnHeader ([out] IAccessibleTable accessibleTable) `[get]`
	Returns the column headers as an IAccessibleTable object. More...

long	columnIndex ([in] long cellIndex) `[get]`
	Translates the given cell index into the corresponding column index. More...

long	nColumns `[get]`
	Returns the total number of columns in table. More...

long	nRows `[get]`
	Returns the total number of rows in table. More...

long	nSelectedChildren `[get]`
	Returns the total number of selected cells. More...

long	nSelectedColumns `[get]`
	Returns the total number of selected columns. More...

long	nSelectedRows `[get]`
	Returns the total number of selected rows. More...

BSTR	rowDescription ([in] long row) `[get]`
	Returns the description text of the specified row in the table. More...

long	rowExtentAt ([in] long row,[in] long column) `[get]`
	Returns the number of rows occupied by the accessible object at the specified row and column in the table. More...

long	rowHeader ([out] IAccessibleTable accessibleTable) `[get]`
	Returns the row headers as an IAccessibleTable object. More...

long	rowIndex ([in] long cellIndex) `[get]`
	Translates the given cell index into a row index. More...

long	selectedChildren ([in] long maxChildren,[out, size_is(, maxChildren), length_is(, *nChildren)] long children) `[get]`
	Returns a list of cell indexes currently selected (0 based). More...

long	selectedColumns ([in] long maxColumns,[out, size_is(, maxColumns), length_is(, *nColumns)] long columns) `[get]`
	Returns a list of column indexes currently selected (0 based). More...

long	selectedRows ([in] long maxRows,[out, size_is(, maxRows), length_is(, *nRows)] long rows) `[get]`
	Returns a list of row indexes currently selected (0 based). More...

IUnknown	summary `[get]`
	Returns the summary description of the table. More...

boolean	isColumnSelected ([in] long column) `[get]`
	Returns a boolean value indicating whether the specified column is completely selected. More...

boolean	isRowSelected ([in] long row) `[get]`
	Returns a boolean value indicating whether the specified row is completely selected. More...

boolean	isSelected ([in] long row,[in] long column) `[get]`
	Returns a boolean value indicating whether the specified cell is selected. More...

boolean	rowColumnExtentsAtIndex ([in] long index,[out] long row,[out] long column,[out] long rowExtents,[out] long columnExtents) `[get]`
	Given a cell index, gets the row and column indexes and extents of a cell and whether or not it is selected. More...

IA2TableModelChange	modelChange `[get]`
	Returns the type and extents describing how a table changed. More...

Detailed Description

This interface gives access to a two-dimensional table.

Typically all accessible objects that represent cells or cell-clusters of a table will be at the same time children of the table. In this case IAccessible2::indexInParent will return the child index which then can be used when calling IAccessibleTable::rowIndex and IAccessibleTable::columnIndex.

However, in some cases that kind of implementation will not be possible. When the table cells are not direct children of a table, the object representing the cell can define a "table-cell-index" object attribute identifying the 0 based table cell index. This object attribute is obtained by parsing the attribute string returned by IAccessible2::attributes. The "table-cell-index" attribute can be used just like a child index of the typical case. ATs should first test for the presence of the "table-cell-index" attribute and if it is not present then IAccessible2::indexInParent can be used as in the typical case where cells are direct children of the table.

The range of valid coordinates for this interface are implementation dependent. However, that range includes at least the intervals from the first row or column with the index 0 up to the last (but not including) used row or column as returned by IAccessibleTable::nRows and IAccessibleTable::nColumns.

Note that newer implementations are now using IAccessibleTable2 and IAccessibleTableCell rather than this interface.

Definition at line 3800 of file ia2_api_all.idl.

Member Function Documentation

◆ selectColumn()

HRESULT IAccessibleTable::selectColumn ( [in] long column )

Selects a column and unselects all previously selected columns.

Parameters

[in] column 0 based index of the column to be selected.

Return values

S_OK
E_INVALIDARG	if bad [in] passed

Implemented in CAccTable.

◆ selectRow()

HRESULT IAccessibleTable::selectRow ( [in] long row )

Selects a row and unselects all previously selected rows.

Parameters

[in] row 0 based index of the row to be selected.

Return values

S_OK
E_INVALIDARG	if bad [in] passed

Implemented in CAccTable.

◆ unselectColumn()

HRESULT IAccessibleTable::unselectColumn ( [in] long column )

Unselects one column, leaving other selected columns selected (if any).

Parameters

[in] column 0 based index of the column to be unselected.

Return values

S_OK
E_INVALIDARG	if bad [in] passed

Implemented in CAccTable.

◆ unselectRow()

HRESULT IAccessibleTable::unselectRow ( [in] long row )

Unselects one row, leaving other selected rows selected (if any).

Parameters

[in] row 0 based index of the row to be unselected.

Return values

S_OK
E_INVALIDARG	if bad [in] passed

Implemented in CAccTable.

Property Documentation

◆ accessibleAt

IUnknown IAccessibleTable::accessibleAt([in] long row, [in] long column)

get

Returns the accessible object at the specified row and column in the table.

This object could be an IAccessible or an IAccessible2.

Parameters

[in]	row	The 0 based row index for which to retrieve the cell.
[in]	column	The 0 based column index for which to retrieve the cell.
[out]	accessible	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 values

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

◆ caption

IUnknown IAccessibleTable::caption

get

Returns the caption for the table.

The returned object could be an IAccessible or an IAccessible2.

Parameters

[out] accessible If the table has a caption then a reference to it is returned, else a NULL pointer is returned.

Return values

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

◆ childIndex

long IAccessibleTable::childIndex([in] long rowIndex, [in] long columnIndex)

get

Translates the given row and column indexes into the corresponding cell index.

Parameters

[in]	rowIndex	0 based row index for the cell.
[in]	columnIndex	0 based column index for the cell.
[out]	cellIndex	Returns the 0 based index of the cell at the specified row and column indexes.

Return values

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

Note: The returned value is not necessarily a child index of the immediate parent. In cases where the table cells are not direct children of the table the index is actually the cell index, i.e. conceptually it's an index into a one dimensional array of cells laid out in row order.

Referenced by CAccTable::get_childIndex(), CAccTable::get_columnIndex(), and CAccTable::get_rowIndex().

◆ columnDescription

BSTR IAccessibleTable::columnDescription([in] long column)

get

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

Parameters

[in]	column	The 0 based index of the column for which to retrieve the description.
[out]	description	Returns the description text of the specified column in the table if such a description exists. Otherwise a NULL pointer is returned.

Return values

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

◆ columnExtentAt

long IAccessibleTable::columnExtentAt([in] long row, [in] long column)

get

Returns the number of columns occupied by the accessible object at the specified row and column in the table.

The result is greater than 1 if the specified cell spans multiple columns.

Parameters

[in]	row	0 based row index of the accessible for which to return the column extent.
[in]	column	0 based column index of the accessible for which to return the column extent.
[out]	nColumnsSpanned	Returns the 1 based column extent of the specified cell.

Return values

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

◆ columnHeader

long IAccessibleTable::columnHeader([out] IAccessibleTable accessibleTable)

get

Returns the column headers as an IAccessibleTable object.

Content and size of the returned table are implementation dependent.

Parameters

[out]	accessibleTable	The column header
[out]	startingRowIndex	The 0 based row index where the header starts, usually 0.

Return values

S_OK
S_FALSE	if there is no header, [out] values are NULL and 0 respectively

◆ columnIndex

long IAccessibleTable::columnIndex([in] long cellIndex)

get

Translates the given cell index into the corresponding column index.

Parameters

[in]	cellIndex	0 based index of the cell in the parent or closest ancestor table. Typically this is the value returned from IAccessible2::indexInParent, but in the case where the table cells are not direct children of the table this is the cell index specified by the "table-cell-index" object attribute obtained from parsing the attributes string returned by calling IAccessible2::attributes on the cell object.
[out]	columnIndex	Returns the 0 based column index of the cell of the specified child or the index of the first column if the child spans multiple columns.

Return values

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

Referenced by CAccTable::get_childIndex(), and CAccTable::get_columnIndex().

◆ isColumnSelected

boolean IAccessibleTable::isColumnSelected([in] long column)

get

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

Parameters

[in]	column	0 based index of the column for which to determine whether it is selected.
[out]	isSelected	Returns TRUE if the specified column is selected completely and FALSE otherwise.

Return values

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

◆ isRowSelected

boolean IAccessibleTable::isRowSelected([in] long row)

get

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

Parameters

[in]	row	0 based index of the row for which to determine whether it is selected.
[out]	isSelected	Returns TRUE if the specified row is selected completely and FALSE otherwise.

Return values

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

◆ isSelected

boolean IAccessibleTable::isSelected([in] long row, [in] long column)

get

Returns a boolean value indicating whether the specified cell is selected.

Parameters

[in]	row	0 based index of the row for the cell to determine whether it is selected.
[in]	column	0 based index of the column for the cell to determine whether it is selected.
[out]	isSelected	Returns TRUE if the specified cell is selected and FALSE otherwise.

Return values

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

Referenced by CAccTable::get_isColumnSelected(), CAccTable::get_isRowSelected(), and CAccTable::get_isSelected().

◆ modelChange

IA2TableModelChange IAccessibleTable::modelChange

get

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.

Parameters

[out] modelChange A struct of (type(insert, delete, update), firstRow, lastRow, firstColumn, lastColumn).

Return values

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

◆ nColumns

long IAccessibleTable::nColumns

get

Returns the total number of columns in table.

Parameters

[out] columnCount Number of columns in table (including columns outside the current viewport)

Return values

S_OK

◆ nRows

long IAccessibleTable::nRows

get

Returns the total number of rows in table.

Parameters

[out] rowCount Number of rows in table (including rows outside the current viewport)

Return values

S_OK

Referenced by CAccTable::get_selectedRows().

◆ nSelectedChildren

long IAccessibleTable::nSelectedChildren

get

Returns the total number of selected cells.

Parameters

[out] cellCount Number of cells currently selected

Return values

S_OK

◆ nSelectedColumns

long IAccessibleTable::nSelectedColumns

get

Returns the total number of selected columns.

Parameters

[out] columnCount Number of columns currently selected

Return values

S_OK

◆ nSelectedRows

long IAccessibleTable::nSelectedRows

get

Returns the total number of selected rows.

Parameters

[out] rowCount Number of rows currently selected

Return values

S_OK

◆ rowColumnExtentsAtIndex

boolean IAccessibleTable::rowColumnExtentsAtIndex([in] long index, [out] long row, [out] long column, [out] long rowExtents, [out] long columnExtents)

get

Given a cell index, gets the row and column indexes and extents of a cell and whether or not it is selected.

This is a convenience function. It is not mandatory to implement it.

Parameters

[in]	index	0 based index of this cell in the table.
[out]	row	0 based row index.
[out]	column	0 based column index.
[out]	rowExtents	Number of cells spanned by this cell in this row.
[out]	columnExtents	Number of cells spanned by this cell in this column.
[out]	isSelected	Indicates if the specified cell is selected.

Return values

S_OK
E_INVALIDARG	if bad [in] passed, [out] values are 0s and FALSE respectively

◆ rowDescription

BSTR IAccessibleTable::rowDescription([in] long row)

get

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

Parameters

[in]	row	The 0 based index of the row for which to retrieve the description.
[out]	description	Returns the description text of the specified row in the table if such a description exists. Otherwise a NULL pointer is returned.

Return values

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

◆ rowExtentAt

long IAccessibleTable::rowExtentAt([in] long row, [in] long column)

get

Returns the number of rows occupied by the accessible object at the specified row and column in the table.

The result is greater than 1 if the specified cell spans multiple rows.

Parameters

[in]	row	0 based row index of the accessible for which to return the row extent.
[in]	column	0 based column index of the accessible for which to return the row extent.
[out]	nRowsSpanned	Returns the row extent of the specified cell.

Return values

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

◆ rowHeader

long IAccessibleTable::rowHeader([out] IAccessibleTable accessibleTable)

get

Returns the row headers as an IAccessibleTable object.

Content and size of the returned table are implementation dependent.

Parameters

[out]	accessibleTable	The row header.
[out]	startingColumnIndex	The 0 based column index where the header starts, usually 0.

Return values

S_OK
S_FALSE	if there is no header, [out] values are NULL and 0 respectively

◆ rowIndex

long IAccessibleTable::rowIndex([in] long cellIndex)

get

Translates the given cell index into a row index.

Parameters

[in]	cellIndex	0 based index of the cell in the parent or closest ancestor table. Typically this is the value returned from IAccessible2::indexInParent, but in the case where the table cells are not direct children of the table this is the cell index specified by the "table-cell-index" object attribute obtained from parsing the attributes string returned by calling IAccessible2::attributes on the cell object.
[out]	rowIndex	0 based row index

Return values

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

Referenced by CAccTable::get_rowIndex().

◆ selectedChildren

long IAccessibleTable::selectedChildren([in] long maxChildren, [out, size_is(,maxChildren), length_is(,*nChildren)] long children)

get

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

Parameters

[in]	maxChildren	This parameter is ignored. Refer to Special Consideration when using Arrays for more details.
[out]	children	An array of cell indexes of selected cells (each index is 0 based), allocated by the server. The client must free it with CoTaskMemFree.
[out]	nChildren	The number of cell indexes returned; the size of the returned array.

Return values

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

◆ selectedColumns

long IAccessibleTable::selectedColumns([in] long maxColumns, [out, size_is(,maxColumns), length_is(,*nColumns)] long columns)

get

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

Parameters

[in]	maxColumns	This parameter is ignored. Refer to Special Consideration when using Arrays for more details.
[out]	columns	An array of column indexes of selected columns (each index is 0 based), allocated by the server. The client must free it with CoTaskMemFree.
[out]	nColumns	The number of column indexes returned; the size of the returned array.

Return values

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

◆ selectedRows

long IAccessibleTable::selectedRows([in] long maxRows, [out, size_is(,maxRows), length_is(,*nRows)] long rows)

get

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

Parameters

[in]	maxRows	This parameter is ignored. Refer to Special Consideration when using Arrays for more details.
[out]	rows	An array of row indexes of selected rows (each index is 0 based), allocated by the server. The client must free it with CoTaskMemFree.
[out]	nRows	The number of row indexes returned; the size of the returned array.

Return values

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

◆ summary

IUnknown IAccessibleTable::summary

get

Returns the summary description of the table.

The returned object could be an IAccessible or an IAccessible2.

Parameters

[out] 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 values

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

The documentation for this interface was generated from the following file:

ia2_api_all.idl

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ selectColumn()

◆ selectRow()

◆ unselectColumn()

◆ unselectRow()

Property Documentation

◆ accessibleAt

◆ caption

◆ childIndex

◆ columnDescription

◆ columnExtentAt

◆ columnHeader

◆ columnIndex

◆ isColumnSelected

◆ isRowSelected

◆ isSelected

◆ modelChange

◆ nColumns

◆ nRows

◆ nSelectedChildren

◆ nSelectedColumns

◆ nSelectedRows

◆ rowColumnExtentsAtIndex

◆ rowDescription

◆ rowExtentAt

◆ rowHeader

◆ rowIndex

◆ selectedChildren

◆ selectedColumns

◆ selectedRows

◆ summary