AccessibleTable Interface

Name

AccessibleTable Interface -- 

Synopsis



void        AccessibleTable_ref             (AccessibleTable *obj);
void        AccessibleTable_unref           (AccessibleTable *obj);
Accessible* AccessibleTable_getAccessibleAt (AccessibleTable *obj,
                                             long int row,
                                             long int column);
Accessible* AccessibleTable_getCaption      (AccessibleTable *obj);
long        AccessibleTable_getColumnAtIndex
                                            (AccessibleTable *obj,
                                             long int index);
char*       AccessibleTable_getColumnDescription
                                            (AccessibleTable *obj,
                                             long int column);
long        AccessibleTable_getColumnExtentAt
                                            (AccessibleTable *obj,
                                             long int row,
                                             long int column);
Accessible* AccessibleTable_getColumnHeader (AccessibleTable *obj,
                                             long int column);
long        AccessibleTable_getIndexAt      (AccessibleTable *obj,
                                             long int row,
                                             long int column);
long        AccessibleTable_getNColumns     (AccessibleTable *obj);
long        AccessibleTable_getNRows        (AccessibleTable *obj);
long        AccessibleTable_getNSelectedColumns
                                            (AccessibleTable *obj);
long        AccessibleTable_getNSelectedRows
                                            (AccessibleTable *obj);
long        AccessibleTable_getRowAtIndex   (AccessibleTable *obj,
                                             long int index);
char*       AccessibleTable_getRowDescription
                                            (AccessibleTable *obj,
                                             long int row);
long        AccessibleTable_getRowExtentAt  (AccessibleTable *obj,
                                             long int row,
                                             long int column);
Accessible* AccessibleTable_getRowHeader    (AccessibleTable *obj,
                                             long int row);
long        AccessibleTable_getSelectedRows (AccessibleTable *obj,
                                             long int **selectedRows);
long        AccessibleTable_getSelectedColumns
                                            (AccessibleTable *obj,
                                             long int **selectedColumns);
Accessible* AccessibleTable_getSummary      (AccessibleTable *obj);
SPIBoolean  AccessibleTable_isColumnSelected
                                            (AccessibleTable *obj,
                                             long int column);
SPIBoolean  AccessibleTable_isRowSelected   (AccessibleTable *obj,
                                             long int row);
SPIBoolean  AccessibleTable_isSelected      (AccessibleTable *obj,
                                             long int row,
                                             long int column);

Description

Details

AccessibleTable_ref ()

void        AccessibleTable_ref             (AccessibleTable *obj);

Increment the reference count for an AccessibleTable object.


AccessibleTable_unref ()

void        AccessibleTable_unref           (AccessibleTable *obj);

Decrement the reference count for an AccessibleTable object.


AccessibleTable_getAccessibleAt ()

Accessible* AccessibleTable_getAccessibleAt (AccessibleTable *obj,
                                             long int row,
                                             long int column);

Get the table cell at the specified row and column indices. To get the accessible object at a particular (x, y) screen coordinate, use #Accessible_getAccessibleAtPoint().


AccessibleTable_getCaption ()

Accessible* AccessibleTable_getCaption      (AccessibleTable *obj);

Get an accessible representation of the caption for an AccessibleTable.


AccessibleTable_getColumnAtIndex ()

long        AccessibleTable_getColumnAtIndex
                                            (AccessibleTable *obj,
                                             long int index);

Get the table column index occupied by the child at a particular 1-D child index.

see #AccessibleTable_getIndexAt(), #AccessibleTable_getRowAtIndex()


AccessibleTable_getColumnDescription ()

char*       AccessibleTable_getColumnDescription
                                            (AccessibleTable *obj,
                                             long int column);

Get a text description of a particular table column. This differs from AccessibleTable_getColumnHeader, which returns an Accessible.


AccessibleTable_getColumnExtentAt ()

long        AccessibleTable_getColumnExtentAt
                                            (AccessibleTable *obj,
                                             long int row,
                                             long int column);

Get the number of columns spanned by the table cell at the specific row and column. (some tables can have cells which span multiple rows and/or columns).


AccessibleTable_getColumnHeader ()

Accessible* AccessibleTable_getColumnHeader (AccessibleTable *obj,
                                             long int column);

Get the header associated with a table column, if available. This differs from AccessibleTable_getColumnDescription, which returns a string.


AccessibleTable_getIndexAt ()

long        AccessibleTable_getIndexAt      (AccessibleTable *obj,
                                             long int row,
                                             long int column);

Get the 1-D child index corresponding to the specified 2-D row and column indices. To get the accessible object at a particular (x, y) screen coordinate, use #Accessible_getAccessibleAtPoint(). see #AccessibleTable_getRowAtIndex(), #AccessibleTable_getColumnAtIndex()


AccessibleTable_getNColumns ()

long        AccessibleTable_getNColumns     (AccessibleTable *obj);

Get the number of columns in an AccessibleTable, exclusive of any columns that are programmatically hidden, but inclusive of columns that may be outside of the current scrolling window or viewport.


AccessibleTable_getNRows ()

long        AccessibleTable_getNRows        (AccessibleTable *obj);

Get the number of rows in an AccessibleTable, exclusive of any rows that are programmatically hidden, but inclusive of rows that may be outside of the current scrolling window or viewport.


AccessibleTable_getNSelectedColumns ()

long        AccessibleTable_getNSelectedColumns
                                            (AccessibleTable *obj);

Query a table to find out how many columnss are currently selected. Not all tables support column selection.


AccessibleTable_getNSelectedRows ()

long        AccessibleTable_getNSelectedRows
                                            (AccessibleTable *obj);

Query a table to find out how many rows are currently selected. Not all tables support row selection.


AccessibleTable_getRowAtIndex ()

long        AccessibleTable_getRowAtIndex   (AccessibleTable *obj,
                                             long int index);

Get the table row index occupied by the child at a particular 1-D child index.

see #AccessibleTable_getIndexAt(), #AccessibleTable_getColumnAtIndex()


AccessibleTable_getRowDescription ()

char*       AccessibleTable_getRowDescription
                                            (AccessibleTable *obj,
                                             long int row);

Get a text description of a particular table row. This differs from AccessibleTable_getRowHeader, which returns an Accessible.


AccessibleTable_getRowExtentAt ()

long        AccessibleTable_getRowExtentAt  (AccessibleTable *obj,
                                             long int row,
                                             long int column);

Get the number of rows spanned by the table cell at the specific row and column. (some tables can have cells which span multiple rows and/or columns).


AccessibleTable_getRowHeader ()

Accessible* AccessibleTable_getRowHeader    (AccessibleTable *obj,
                                             long int row);

Get the header associated with a table row, if available. This differs from AccessibleTable_getRowDescription, which returns a string.


AccessibleTable_getSelectedRows ()

long        AccessibleTable_getSelectedRows (AccessibleTable *obj,
                                             long int **selectedRows);

Query a table for a list of indices of rows which are currently selected.


AccessibleTable_getSelectedColumns ()

long        AccessibleTable_getSelectedColumns
                                            (AccessibleTable *obj,
                                             long int **selectedColumns);

Query a table for a list of indices of columns which are currently selected. Not all tables support column selection.


AccessibleTable_getSummary ()

Accessible* AccessibleTable_getSummary      (AccessibleTable *obj);

Get an accessible object which summarizes the contents of an AccessibleTable.


AccessibleTable_isColumnSelected ()

SPIBoolean  AccessibleTable_isColumnSelected
                                            (AccessibleTable *obj,
                                             long int column);

Determine whether specified table column is selected. Not all tables support column selection.


AccessibleTable_isRowSelected ()

SPIBoolean  AccessibleTable_isRowSelected   (AccessibleTable *obj,
                                             long int row);

Determine whether a table row is selected. Not all tables support row selection.


AccessibleTable_isSelected ()

SPIBoolean  AccessibleTable_isSelected      (AccessibleTable *obj,
                                             long int row,
                                             long int column);

Determine whether the cell at a specific row and column is selected.