IAccessibleTableCell Interface Reference

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

import "AccessibleTableCell.idl";

List of all members.


Public Member Functions

HRESULT columnExtent ([out, retval] long *nColumnsSpanned)
 Returns the number of columns occupied by this cell accessible.
HRESULT columnHeaderCells ([out, size_is(,*nColumnHeaderCells,)] IUnknown ***cellAccessibles,[out, retval] long *nColumnHeaderCells)
 Returns the column headers as an array of cell accessibles.
HRESULT columnIndex ([out, retval] long *columnIndex)
 Translates this cell accessible into the corresponding column index.
HRESULT rowExtent ([out, retval] long *nRowsSpanned)
 Returns the number of rows occupied by this cell accessible.
HRESULT rowHeaderCells ([out, size_is(,*nRowHeaderCells,)] IUnknown ***cellAccessibles,[out, retval] long *nRowHeaderCells)
 Returns the row headers as an array of cell accessibles.
HRESULT rowIndex ([out, retval] long *rowIndex)
 Translates this cell accessible into the corresponding row index.
HRESULT isSelected ([out, retval] boolean *isSelected)
 Returns a boolean value indicating whether this cell is selected.
HRESULT rowColumnExtents ([out] long *row,[out] long *column,[out] long *rowExtents,[out] long *columnExtents,[out, retval] boolean *isSelected)
 Gets the row and column indexes and extents of this cell accessible and whether or not it is selected.
HRESULT table ([out, retval] IUnknown **table)
 Returns a reference to the accessbile of the containing table.

Detailed Description

This interface gives access to the cells of a two-dimensional table.

Please also refer to the IAccessibleTable2 interface.


Member Function Documentation

HRESULT IAccessibleTableCell::columnExtent ( [out, retval] long *  nColumnsSpanned  )  [get]

Returns the number of columns occupied by this cell accessible.

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

Parameters:
[out] nColumnsSpanned Returns the 1 based column extent of the specified cell.
Return values:
S_OK 

HRESULT IAccessibleTableCell::columnHeaderCells ( [out, size_is(,*nColumnHeaderCells,)] IUnknown ***  cellAccessibles,
[out, retval] long *  nColumnHeaderCells 
) [get]

Returns the column headers as an array of cell accessibles.

Parameters:
[out] cellAccessibles Pointer to an array of references to cell accessibles. The array is allocated by the server. Free it with CoTaskMemFree.
[out] nColumnHeaderCells The number of accessibles returned; the size of the returned array.
Return values:
S_OK 
S_FALSE if there is no header, [out] values are NULL and 0 respectively

HRESULT IAccessibleTableCell::columnIndex ( [out, retval] long *  columnIndex  )  [get]

Translates this cell accessible into the corresponding column index.

Parameters:
[out] columnIndex Returns the 0 based column index of the cell of the specified cell or the index of the first column if the cell spans multiple columns.
Return values:
S_OK 

HRESULT IAccessibleTableCell::isSelected ( [out, retval] boolean *  isSelected  )  [get]

Returns a boolean value indicating whether this cell is selected.

Parameters:
[out] isSelected Returns TRUE if the specified cell is selected and FALSE otherwise.
Return values:
S_OK 

HRESULT IAccessibleTableCell::rowColumnExtents ( [out] long *  row,
[out] long *  column,
[out] long *  rowExtents,
[out] long *  columnExtents,
[out, retval] boolean *  isSelected 
) [get]

Gets the row and column indexes and extents of this cell accessible and whether or not it is selected.

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

Parameters:
[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 

HRESULT IAccessibleTableCell::rowExtent ( [out, retval] long *  nRowsSpanned  )  [get]

Returns the number of rows occupied by this cell accessible.

Parameters:
[out] nRowsSpanned Returns the row extent of the specified cell.
Return values:
S_OK 

HRESULT IAccessibleTableCell::rowHeaderCells ( [out, size_is(,*nRowHeaderCells,)] IUnknown ***  cellAccessibles,
[out, retval] long *  nRowHeaderCells 
) [get]

Returns the row headers as an array of cell accessibles.

Parameters:
[out] cellAccessibles Pointer to an array of references to cell accessibles. The array is allocated by the server. Free it with CoTaskMemFree.
[out] nRowHeaderCells The number of accessibles returned; the size of the returned array.
Return values:
S_OK 
S_FALSE if there is no header, [out] values are NULL and 0 respectively

HRESULT IAccessibleTableCell::rowIndex ( [out, retval] long *  rowIndex  )  [get]

Translates this cell accessible into the corresponding row index.

Parameters:
[out] rowIndex Returns the 0 based row index of the specified cell or the index of the first row if the cell spans multiple rows.
Return values:
S_OK 

HRESULT IAccessibleTableCell::table ( [out, retval] IUnknown **  table  )  [get]

Returns a reference to the accessbile of the containing table.

Parameters:
[out] table Returns a reference to the IUnknown of the containing table.
Return values:
S_OK 


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

To submit feedback on IAccessible2 API Version 1.2, please use the Bugzilla interface located at: http://bugs.linuxfoundation.org/. When using Bugzilla please be sure to select IAccessible2 from the list of components. Bugzilla is the preferred method for receiving feedback because it automatically logs one's feedback in the IAccessible2 tracking system without additional human intervention. One may also, however, send email to accessibility-rfc@a11y.org, a publicly archived emailing list. Please address any technical problems you encounter with this document or the resources to which it links, to the Open A11y Webmaster <webmaster@a11y.org>

A stable online reference version of the documentation for IAccessible2 API Version 1.2, is available at: http://a11y.org/ia2-spec. A list of known and reported errors in the documentation for IAccessible2 API Version 1.2 can be found at: http://a11y.org/ia2-errata


Generated on Mon Jun 21 10:42:52 2010 for IAccessible2 API Version 1.2 by  doxygen 1.5.6