LibreOffice Module winaccessibility (master) 1
Properties | List of all members
IAccessibleTableCell Interface Reference

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

import"ia2_api_all.idl";

Inheritance diagram for IAccessibleTableCell:
[legend]
Collaboration diagram for IAccessibleTableCell:
[legend]

Properties

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

Detailed Description

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

Please also refer to the IAccessibleTable2 interface.

Definition at line 4707 of file ia2_api_all.idl.

Property Documentation

◆ columnExtent

long IAccessibleTableCell::columnExtent
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]nColumnsSpannedReturns the 1 based column extent of the specified cell.
Return values
S_OK

◆ columnHeaderCells

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

Returns the column headers as an array of cell accessibles.

Parameters
[out]cellAccessiblesPointer to an array of references to cell accessibles. The array is allocated by the server. The client must free it with CoTaskMemFree.
[out]nColumnHeaderCellsThe number of accessibles returned; the size of the returned array.
Return values
S_OK
S_FALSEif there is no header, [out] values are NULL and 0 respectively

◆ columnIndex

long IAccessibleTableCell::columnIndex
get

Translates this cell accessible into the corresponding column index.

Parameters
[out]columnIndexReturns 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

◆ isSelected

boolean IAccessibleTableCell::isSelected
get

Returns a boolean value indicating whether this cell is selected.

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

◆ rowColumnExtents

boolean IAccessibleTableCell::rowColumnExtents([out] long row, [out] long column, [out] long rowExtents, [out] long columnExtents)
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]row0 based row index.
[out]column0 based column index.
[out]rowExtentsNumber of cells spanned by this cell in this row.
[out]columnExtentsNumber of cells spanned by this cell in this column.
[out]isSelectedIndicates if the specified cell is selected.
Return values
S_OK

◆ rowExtent

long IAccessibleTableCell::rowExtent
get

Returns the number of rows occupied by this cell accessible.

Parameters
[out]nRowsSpannedReturns the row extent of the specified cell.
Return values
S_OK

◆ rowHeaderCells

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

Returns the row headers as an array of cell accessibles.

Parameters
[out]cellAccessiblesPointer to an array of references to cell accessibles. The array is allocated by the server. The client must free it with CoTaskMemFree.
[out]nRowHeaderCellsThe number of accessibles returned; the size of the returned array.
Return values
S_OK
S_FALSEif there is no header, [out] values are NULL and 0 respectively

◆ rowIndex

long IAccessibleTableCell::rowIndex
get

Translates this cell accessible into the corresponding row index.

Parameters
[out]rowIndexReturns 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

◆ table

IUnknown IAccessibleTableCell::table
get

Returns a reference to the accessible of the containing table.

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

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