other-licenses/ia2/AccessibleTableCell.idl
Not scriptableIUnknown
Last changed in Gecko 1.9.2 (Firefox 3.6 / Thunderbird 3.1 / Fennec 1.0)Method overview
[propget] HRESULT columnExtent([out] long nColumnsSpanned ); |
[propget] HRESULT columnHeaderCells([out, size_is(, nColumnHeaderCells,)] IUnknown cellAccessibles, [out] long nColumnHeaderCells ); |
[propget] HRESULT columnIndex([out] long columnIndex ); |
[propget] HRESULT isSelected([out] boolean isSelected ); |
[propget] HRESULT rowColumnExtents([out] long row, [out] long column, [out] long rowExtents, [out] long columnExtents, [out] boolean isSelected ); |
[propget] HRESULT rowExtent([out] long nRowsSpanned ); |
[propget] HRESULT rowHeaderCells([out, size_is(, nRowHeaderCells,)] IUnknown cellAccessibles, [out] long nRowHeaderCells ); |
[propget] HRESULT rowIndex([out] long rowIndex ); |
[propget] HRESULT table([out] IUnknown table ); |
Methods
columnExtent()
Returns the number of columns occupied by this cell accessible. The result is greater than 1 if the specified cell spans multiple columns.
[propget] HRESULT columnExtent( [out] long nColumnsSpanned );
Parameters
nColumnsSpanned
- Returns the 1 based column extent of the specified cell.
Return value
S_OK.
columnHeaderCells()
Returns the column headers as an array of cell accessibles.
[propget] HRESULT columnHeaderCells( [out, size_is(, nColumnHeaderCells,)] IUnknown cellAccessibles, [out] long nColumnHeaderCells );
Parameters
cellAccessibles
- Pointer to an array of references to cell accessibles. The array is allocated by the server. Free it with CoTaskMemFree.
nColumnHeaderCells
- The number of accessibles returned; the size of the returned array.
Return value
S_FALSE if there is no header, [out] values are null
and 0 respectively. S_OK.
columnIndex()
Translates this cell accessible into the corresponding column index.
[propget] HRESULT columnIndex( [out] long columnIndex );
Parameters
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 value
S_OK.
isSelected()
Returns a boolean value indicating whether this cell is selected.
[propget] HRESULT isSelected( [out] boolean isSelected );
Parameters
isSelected
- Returns
true
if the specified cell is selected andfalse
otherwise.
Return value
S_OK.
rowColumnExtents()
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.
[propget] HRESULT rowColumnExtents( [out] long row, [out] long column, [out] long rowExtents, [out] long columnExtents, [out] boolean isSelected );
Parameters
row
- 0 based row index.
column
- 0 based column index.
rowExtents
- Number of cells spanned by this cell in this row.
columnExtents
- Number of cells spanned by this cell in this column.
isSelected
- Indicates if the specified cell is selected.
Return value
S_OK.
rowExtent()
Returns the number of rows occupied by this cell accessible.
[propget] HRESULT rowExtent( [out] long nRowsSpanned );
Parameters
nRowsSpanned
- Returns the row extent of the specified cell.
Return value
S_OK.
rowHeaderCells()
Returns the row headers as an array of cell accessibles.
[propget] HRESULT rowHeaderCells( [out, size_is(, nRowHeaderCells,)] IUnknown cellAccessibles, [out] long nRowHeaderCells );
Parameters
cellAccessibles
- Pointer to an array of references to cell accessibles. The array is allocated by the server. Free it with CoTaskMemFree.
nRowHeaderCells
- The number of accessibles returned; the size of the returned array.
Return value
S_FALSE if there is no header, [out] values are null
and 0 respectively. S_OK.
rowIndex()
Translates this cell accessible into the corresponding row index.
[propget] HRESULT rowIndex( [out] long rowIndex );
Parameters
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 value
S_OK.
table()
Returns a reference to the accessbile of the containing table
.
[propget] HRESULT table( [out] IUnknown table );
Parameters
table
- Returns a reference to the
IUnknown
of the containingtable
.
Return value
S_OK.