IAccessible2 API  Version 1.3
Public Member Functions | List of all members
IAccessibleTable2 Interface Reference

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

import "AccessibleTable2.idl";

Inheritance diagram for IAccessibleTable2:

Public Member Functions

HRESULT cellAt ([in] long row,[in] long column,[out, retval] IUnknown **cell)
 Returns the accessible object at the specified row and column in the table. This object could be an IAccessible or an IAccessible2. More...
 
HRESULT caption ([out, retval] IUnknown **accessible)
 Returns the caption for the table. The returned object could be an IAccessible or an IAccessible2. More...
 
HRESULT columnDescription ([in] long column,[out, retval] BSTR *description)
 Returns the description text of the specified column in the table. More...
 
HRESULT nColumns ([out, retval] long *columnCount)
 Returns the total number of columns in table. More...
 
HRESULT nRows ([out, retval] long *rowCount)
 Returns the total number of rows in table. More...
 
HRESULT nSelectedCells ([out, retval] long *cellCount)
 Returns the total number of selected cells. More...
 
HRESULT nSelectedColumns ([out, retval] long *columnCount)
 Returns the total number of selected columns. More...
 
HRESULT nSelectedRows ([out, retval] long *rowCount)
 Returns the total number of selected rows. More...
 
HRESULT rowDescription ([in] long row,[out, retval] BSTR *description)
 Returns the description text of the specified row in the table. More...
 
HRESULT selectedCells ([out, size_is(,*nSelectedCells)] IUnknown ***cells,[out, retval] long *nSelectedCells)
 Returns a list of accessibles currently selected. More...
 
HRESULT selectedColumns ([out, size_is(,*nColumns)] long **selectedColumns,[out, retval] long *nColumns)
 Returns a list of column indexes currently selected (0 based). More...
 
HRESULT selectedRows ([out, size_is(,*nRows)] long **selectedRows,[out, retval] long *nRows)
 Returns a list of row indexes currently selected (0 based). More...
 
HRESULT summary ([out, retval] IUnknown **accessible)
 Returns the summary description of the table. The returned object could be an IAccessible or an IAccessible2. More...
 
HRESULT isColumnSelected ([in] long column,[out, retval] boolean *isSelected)
 Returns a boolean value indicating whether the specified column is completely selected. More...
 
HRESULT isRowSelected ([in] long row,[out, retval] boolean *isSelected)
 Returns a boolean value indicating whether the specified row is completely selected. More...
 
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...
 
HRESULT modelChange ([out, retval] IA2TableModelChange *modelChange)
 Returns the type and extents describing how a table changed. More...
 

Detailed Description

This interface gives access to a two-dimensional table.

Please also refer to the IAccessibleTableCell interface.

If you want to support older applications you should also support the IAccessibleTable inteface.

Member Function Documentation

HRESULT IAccessibleTable2::caption ( [out, retval] IUnknown **  accessible)
get

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

Parameters
[out]accessibleIf the table has a caption then a reference to it is returned, else a NULL pointer is returned.
Return values
S_OK
S_FALSEif there is nothing to return, [out] value is NULL
Deprecated:
use a describedBy relation
HRESULT IAccessibleTable2::cellAt ( [in] long  row,
[in] long  column,
[out, retval] IUnknown **  cell 
)
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]rowThe 0 based row index for which to retrieve the cell.
[in]columnThe 0 based column index for which to retrieve the cell.
[out]cellIf 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_INVALIDARGif bad [in] passed
HRESULT IAccessibleTable2::columnDescription ( [in] long  column,
[out, retval] BSTR *  description 
)
get

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

Parameters
[in]columnThe 0 based index of the column for which to retrieve the description.
[out]descriptionReturns 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_FALSEif there is nothing to return, [out] value is NULL
E_INVALIDARGif bad [in] passed
HRESULT IAccessibleTable2::isColumnSelected ( [in] long  column,
[out, retval] boolean *  isSelected 
)
get

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

Parameters
[in]column0 based index of the column for which to determine whether it is selected.
[out]isSelectedReturns TRUE if the specified column is selected completely and FALSE otherwise.
Return values
S_OK
E_INVALIDARGif bad [in] passed
HRESULT IAccessibleTable2::isRowSelected ( [in] long  row,
[out, retval] boolean *  isSelected 
)
get

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

Parameters
[in]row0 based index of the row for which to determine whether it is selected.
[out]isSelectedReturns TRUE if the specified row is selected completely and FALSE otherwise.
Return values
S_OK
E_INVALIDARGif bad [in] passed
HRESULT IAccessibleTable2::modelChange ( [out, retval] IA2TableModelChange 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]modelChangeA struct of (type(insert, delete, update), firstRow, lastRow, firstColumn, lastColumn).
Return values
S_OK
S_FALSEif there is nothing to return, [out] value is NULL
HRESULT IAccessibleTable2::nColumns ( [out, retval] long *  columnCount)
get

Returns the total number of columns in table.

Parameters
[out]columnCountNumber of columns in table (including columns outside the current viewport)
Return values
S_OK
HRESULT IAccessibleTable2::nRows ( [out, retval] long *  rowCount)
get

Returns the total number of rows in table.

Parameters
[out]rowCountNumber of rows in table (including rows outside the current viewport)
Return values
S_OK
HRESULT IAccessibleTable2::nSelectedCells ( [out, retval] long *  cellCount)
get

Returns the total number of selected cells.

Parameters
[out]cellCountNumber of cells currently selected
Return values
S_OK
HRESULT IAccessibleTable2::nSelectedColumns ( [out, retval] long *  columnCount)
get

Returns the total number of selected columns.

Parameters
[out]columnCountNumber of columns currently selected
Return values
S_OK
HRESULT IAccessibleTable2::nSelectedRows ( [out, retval] long *  rowCount)
get

Returns the total number of selected rows.

Parameters
[out]rowCountNumber of rows currently selected
Return values
S_OK
HRESULT IAccessibleTable2::rowDescription ( [in] long  row,
[out, retval] BSTR *  description 
)
get

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

Parameters
[in]rowThe 0 based index of the row for which to retrieve the description.
[out]descriptionReturns 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_FALSEif there is nothing to return, [out] value is NULL
E_INVALIDARGif bad [in] passed
HRESULT IAccessibleTable2::selectColumn ( [in] long  column)

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.

Parameters
[in]column0 based index of the column to be selected.
Return values
S_OK
E_INVALIDARGif bad [in] passed
HRESULT IAccessibleTable2::selectedCells ( [out, size_is(,*nSelectedCells)] IUnknown ***  cells,
[out, retval] long *  nSelectedCells 
)
get

Returns a list of accessibles currently selected.

Parameters
[out]cellsPointer to an array of references to selected accessibles. The array is allocated by the server with CoTaskMemAlloc and freed by the client with CoTaskMemFree.
[out]nSelectedCellsThe number of accessibles returned; the size of the returned array.
Return values
S_OK
S_FALSEif there are none, [out] values are NULL and 0 respectively
HRESULT IAccessibleTable2::selectedColumns ( [out, size_is(,*nColumns)] long **  selectedColumns,
[out, retval] long *  nColumns 
)
get

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

Parameters
[out]selectedColumnsA pointer to an array of column indexes of selected columns (each index is 0 based). The array is allocated by the server with CoTaskMemAlloc and freed by the client with CoTaskMemFree.
[out]nColumnsThe number of column indexes returned; the size of the returned array.
Return values
S_OK
S_FALSEif there are none, [out] values are NULL and 0 respectively
HRESULT IAccessibleTable2::selectedRows ( [out, size_is(,*nRows)] long **  selectedRows,
[out, retval] long *  nRows 
)
get

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

Parameters
[out]selectedRowsAn array of row indexes of selected rows (each index is 0 based). The array is allocated by the server with CoTaskMemAlloc and freed by the client with CoTaskMemFree.
[out]nRowsThe number of row indexes returned; the size of the returned array.
Return values
S_OK
S_FALSEif there are none, [out] values are NULL and 0 respectively
HRESULT IAccessibleTable2::selectRow ( [in] long  row)

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.

Parameters
[in]row0 based index of the row to be selected.
Return values
S_OK
E_INVALIDARGif bad [in] passed
HRESULT IAccessibleTable2::summary ( [out, retval] IUnknown **  accessible)
get

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

Parameters
[out]accessibleReturns 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_FALSEif there is nothing to return, [out] value is NULL
Deprecated:
Use the labeledBy relation
HRESULT IAccessibleTable2::unselectColumn ( [in] long  column)

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.

Parameters
[in]column0 based index of the column to be unselected.
Return values
S_OK
E_INVALIDARGif bad [in] passed
HRESULT IAccessibleTable2::unselectRow ( [in] long  row)

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.

Parameters
[in]row0 based index of the row to be unselected.
Return values
S_OK
E_INVALIDARGif bad [in] passed

The documentation for this interface was generated from the following file:
Generated on Wed Jul 10 2013 09:47:26 for IAccessible2 API Version 1.3 by  doxygen 1.8.3.1