IAccessibleTable Interface Reference

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

import "AccessibleTable.idl";

List of all members.

Public Member Functions

HRESULT accessibleAt ([in] long row,[in] long column,[out, retval] IAccessible2 **accessible)
 Returns the IAccessible2 object at the specified row and column in the table.
HRESULT caption ([out, retval] IAccessible2 **accessible)
 Returns the caption for the table.
HRESULT childIndex ([in] long rowIndex,[in] long columnIndex,[out, retval] long *childIndex)
 Translates the given row and column indices into the corresponding child index.
HRESULT columnDescription ([in] long column,[out, retval] BSTR *description)
 Returns the description text of the specified column in the table.
HRESULT columnExtentAt ([in] long row,[in] long column,[out, retval] long *nColumnsSpanned)
 Returns the number of columns occupied by the accessible object at the specified row and column in the table.
HRESULT columnHeader ([out] IAccessibleTable **accessibleTable,[out, retval] long *startingRowIndex)
 Returns the column headers as an IAccessibleTable object.
HRESULT columnIndex ([in] long childIndex,[out, retval] long *columnIndex)
 Translates the given child index into the corresponding column index.
HRESULT nColumns ([out, retval] long *columnCount)
 Returns the total number of columns in table.
HRESULT nRows ([out, retval] long *rowCount)
 Returns the total number of rows in table.
HRESULT nSelectedColumns ([out, retval] long *columnCount)
 Returns the total number of selected columns.
HRESULT nSelectedRows ([out, retval] long *rowCount)
 Returns the total number of selected rows.
HRESULT rowDescription ([in] long row,[out, retval] BSTR *description)
 Returns the description text of the specified row in the table.
HRESULT rowExtentAt ([in] long row,[in] long column,[out, retval] long *nRowsSpanned)
 Returns the number of rows occupied by the accessible oject at the specified row and column in the table.
HRESULT rowHeader ([out] IAccessibleTable **accessibleTable,[out, retval] long *startingColumnIndex)
 Returns the row headers as an IAccessibleTable object.
HRESULT rowIndex ([in] long childIndex,[out, retval] long *rowIndex)
 Translates the given child index into a row index.
HRESULT selectedRows ([in] long maxRows,[out, size_is(, maxRows), length_is(,*nRows)] long **rows,[out, retval] long *nRows)
 Returns a list of row indexes currently selected (0-based).
HRESULT selectedColumns ([in] long maxColumns,[out, size_is(, maxColumns), length_is(,*nColumns)] long **columns,[out, retval] long *nColumns)
 Returns a list of column indexes currently selected (0-based).
HRESULT summary ([out, retval] IAccessible2 **accessible)
 Returns the summary description of the table.
HRESULT isColumnSelected ([in] long column,[out, retval] boolean *isSelected)
 Returns a boolean value indicating whether the specified column is completely selected.
HRESULT isRowSelected ([in] long row,[out, retval] boolean *isSelected)
 Returns a boolean value indicating whether the specified row is completely selected.
HRESULT isSelected ([in] long row,[in] long column,[out, retval] boolean *isSelected)
 Returns a boolean value indicating whether the specified cell is selected.
HRESULT selectRow ([in] long row)
 Selects a row and unselects all previously selected rows.
HRESULT selectColumn ([in] long column)
 Selects a column and unselects all previously selected columns.
HRESULT unselectRow ([in] long row)
 Unselects one row, leaving other selected rows selected (if any).
HRESULT unselectColumn ([in] long column)
 Unselects one column, leaving other selected columns selected (if any).
HRESULT rowColumnExtentsAtIndex ([in] long index,[out] long *row,[out] long *column,[out] long *rowExtents,[out] long *columnExtents,[out, retval] boolean *isSelected)
 Given a child index, gets the row and column indexes and extents of a cell and whether or not it is selected.
HRESULT modelChange ([out, retval] IA2TableModelChange *modelChange)
 Returns the type and extents describing how a table changed.


Detailed Description

This interface gives access to a two-dimensional table.

All accessible objects that represent cells or cell-clusters of a table have to be at the same time children of the table. This is necessary to be able to convert row and column indices into child indices and vice versa with the methods IAccessibleTable::childIndex, IAccessibleTable::rowIndex, and IAccessibleTable::columnIndex.

The range of valid coordinates for this interface are implementation dependent. However, that range includes at least the intervals from the 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.


Member Function Documentation

HRESULT IAccessibleTable::accessibleAt [in] long  row,
[in] long  column,
[out, retval] IAccessible2 **  accessible
 

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

Parameters:
[in] row The row index for which to retrieve the cell.
[in] column The 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).

HRESULT IAccessibleTable::caption [out, retval] IAccessible2 **  accessible  ) 
 

Returns the caption for the table.

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

HRESULT IAccessibleTable::childIndex [in] long  rowIndex,
[in] long  columnIndex,
[out, retval] long *  childIndex
 

Translates the given row and column indices into the corresponding child index.

Parameters:
[in] rowIndex Index of the child of the table for which to return the row index.
[in] columnIndex Index of the child of the table for which to return the column index.
[out] childIndex Returns the row index of the cell of the specified child or the index of the first row if the child spans multiple rows.

HRESULT IAccessibleTable::columnDescription [in] long  column,
[out, retval] BSTR *  description
 

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

Parameters:
[in] column The index of the column 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.

HRESULT IAccessibleTable::columnExtentAt [in] long  row,
[in] long  column,
[out, retval] long *  nColumnsSpanned
 

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

The result differs from 1 if the specified cell spans multiple columns.

Parameters:
[in] row Row index of the accessible for which to return the column extent.
[in] column Column index of the accessible for which to return the column extent.
[out] nColumnsSpanned Returns the column extent of the specified cell.

HRESULT IAccessibleTable::columnHeader [out] IAccessibleTable **  accessibleTable,
[out, retval] long *  startingRowIndex
 

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 row index where the header starts, usually 0.

HRESULT IAccessibleTable::columnIndex [in] long  childIndex,
[out, retval] long *  columnIndex
 

Translates the given child index into the corresponding column index.

Parameters:
[in] childIndex Index of the child of the table for which to return the column index.
[out] columnIndex Returns the column index of the cell of the specified child or the index of the first column if the child spans multiple columns.

HRESULT IAccessibleTable::isColumnSelected [in] long  column,
[out, retval] boolean *  isSelected
 

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

Parameters:
[in] column 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.

HRESULT IAccessibleTable::isRowSelected [in] long  row,
[out, retval] boolean *  isSelected
 

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

Parameters:
[in] row 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.

HRESULT IAccessibleTable::isSelected [in] long  row,
[in] long  column,
[out, retval] boolean *  isSelected
 

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

Parameters:
[in] row Index of the row for the cell to determine whether it is selected.
[in] column 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.

HRESULT IAccessibleTable::modelChange [out, retval] IA2TableModelChange modelChange  ) 
 

Returns the type and extents describing how a table changed.

Provided for use by the IA2_EVENT_TABLE_MODEL_CHANGED event handler.

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

HRESULT IAccessibleTable::nColumns [out, retval] long *  columnCount  ) 
 

Returns the total number of columns in table.

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

HRESULT IAccessibleTable::nRows [out, retval] long *  rowCount  ) 
 

Returns the total number of rows in table.

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

HRESULT IAccessibleTable::nSelectedColumns [out, retval] long *  columnCount  ) 
 

Returns the total number of selected columns.

Parameters:
[out] columnCount Number of columns currently selected

HRESULT IAccessibleTable::nSelectedRows [out, retval] long *  rowCount  ) 
 

Returns the total number of selected rows.

Parameters:
[out] rowCount Number of rows currently selected

HRESULT IAccessibleTable::rowColumnExtentsAtIndex [in] long  index,
[out] long *  row,
[out] long *  column,
[out] long *  rowExtents,
[out] long *  columnExtents,
[out, retval] boolean *  isSelected
 

Given a child 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 Index of this child in the parent.
[out] row Row index.
[out] column 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.

HRESULT IAccessibleTable::rowDescription [in] long  row,
[out, retval] BSTR *  description
 

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

Parameters:
[in] row The 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.

HRESULT IAccessibleTable::rowExtentAt [in] long  row,
[in] long  column,
[out, retval] long *  nRowsSpanned
 

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

The result differs from 1 if the specified cell spans multiple rows.

Parameters:
[in] row Row index of the accessible for which to return the column extent.
[in] column Column index of the accessible for which to return the column extent.
[out] nRowsSpanned Returns the row extent of the specified cell.

HRESULT IAccessibleTable::rowHeader [out] IAccessibleTable **  accessibleTable,
[out, retval] long *  startingColumnIndex
 

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 column index where the header starts, usually 0.

HRESULT IAccessibleTable::rowIndex [in] long  childIndex,
[out, retval] long *  rowIndex
 

Translates the given child index into a row index.

Parameters:
[in] childIndex Index in parent (0 based)
[out] rowIndex Row index (0 based)

HRESULT IAccessibleTable::selectColumn [in] long  column  ) 
 

Selects a column and unselects all previously selected columns.

Parameters:
[in] column Index of the column to be selected.

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

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

Parameters:
[in] maxColumns Max rows requested (possibly from IAccessibleTable::nSelectedColumns)
[out] columns array of indexes of selected columns (each index is 0-based)
[out] nColumns Length of array (not more than maxColumns)

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

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

Parameters:
[in] maxRows Max rows requested (possibly from IAccessibleTable::nSelectedRows)
[out] rows array of indexes of selected rows (each index is 0-based)
[out] nRows Length of array (not more than maxRows)

HRESULT IAccessibleTable::selectRow [in] long  row  ) 
 

Selects a row and unselects all previously selected rows.

Parameters:
[in] row Index of the row to be selected.

HRESULT IAccessibleTable::summary [out, retval] IAccessible2 **  accessible  ) 
 

Returns the summary description of the table.

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.

HRESULT IAccessibleTable::unselectColumn [in] long  column  ) 
 

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

Parameters:
[in] column Index of the column to be selected.

HRESULT IAccessibleTable::unselectRow [in] long  row  ) 
 

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

Parameters:
[in] row Index of the row to be selected.


The documentation for this interface was generated from the following file:
Generated on Sat Dec 2 00:45:22 2006 for IAccessible2 API by  doxygen 1.4.6-NO