![]() | ![]() | ![]() | AT-SPI C Bindings Reference Manual | ![]() |
---|
AccessibleTable Interface —
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);
void AccessibleTable_ref (AccessibleTable *obj);
Increment the reference count for an
obj : | a pointer to the |
void AccessibleTable_unref (AccessibleTable *obj);
Decrement the reference count for an
obj : | a pointer to the |
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 #
obj : | a pointer to the |
row : | the specified table row, zero-indexed. |
column : | the specified table column, zero-indexed. |
Returns : | an Accessible object representing the specified table cell. |
Accessible* AccessibleTable_getCaption (AccessibleTable *obj);
Get an accessible representation of the caption for an
obj : | a pointer to the |
Returns : | an Accessible object that serves as the table's caption. |
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()
obj : | a pointer to the |
index : | the specified child index, zero-indexed. |
Returns : | a long integer indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) index. |
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.
obj : | a pointer to the |
column : | the specified table column, zero-indexed. |
Returns : | a UTF-8 string describing the specified table column, if available. |
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).
obj : | a pointer to the |
row : | the specified table row, zero-indexed. |
column : | the specified table column, zero-indexed. |
Returns : | a long integer indicating the number of columns spanned by the specified cell. |
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.
obj : | a pointer to the |
column : | the specified table column, zero-indexed. |
Returns : | a Accessible representatin of the specified table column, if available. |
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 #
obj : | a pointer to the |
row : | the specified table row, zero-indexed. |
column : | the specified table column, zero-indexed. |
Returns : | a long integer which serves as the index of a specified cell in the table, in a form usable by #Accessible_getChildAtIndex(). |
long AccessibleTable_getNColumns (AccessibleTable *obj);
Get the number of columns in an
obj : | a pointer to the |
Returns : | a |
long AccessibleTable_getNRows (AccessibleTable *obj);
Get the number of rows in an
obj : | a pointer to the |
Returns : | a |
long AccessibleTable_getNSelectedColumns (AccessibleTable *obj);
Query a table to find out how many columns are currently selected. Not all tables support column selection.
obj : | a pointer to the |
Returns : | a long integer indicating the number of columns currently selected. |
long AccessibleTable_getNSelectedRows (AccessibleTable *obj);
Query a table to find out how many rows are currently selected. Not all tables support row selection.
obj : | a pointer to the |
Returns : | a long integer indicating the number of rows currently selected. |
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()
obj : | a pointer to the |
index : | the specified child index, zero-indexed. |
Returns : | a long integer indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) index. |
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.
obj : | a pointer to the |
row : | the specified table row, zero-indexed. |
Returns : | a UTF-8 string describing the specified table row, if available. |
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).
obj : | a pointer to the |
row : | the specified table row, zero-indexed. |
column : | the specified table column, zero-indexed. |
Returns : | a long integer indicating the number of rows spanned by the specified cell. |
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.
obj : | a pointer to the |
row : | the specified table row, zero-indexed. |
Returns : | a Accessible representatin of the specified table row, if available. |
long AccessibleTable_getSelectedRows (AccessibleTable *obj,long int **selectedRows);
Query a table for a list of indices of rows which are currently selected.
obj : | a pointer to the |
selectedRows : | a doubly indirected pointer which will be set to the address of an array of long integers, specifying which rows are currently selected. |
Returns : | a long integer indicating the length of the array returned in selectedRows. |
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.
obj : | a pointer to the |
selectedColumns : | a doubly indirected pointer which will be set to the address of an array of long integers, specifying which columns are currently selected. |
Returns : | a long integer indicating the length of the array returned in selectedColumns. |
Accessible* AccessibleTable_getSummary (AccessibleTable *obj);
Get an accessible object which summarizes the contents of an
obj : | a pointer to the |
Returns : | an Accessible object that serves as the table's summary (often a
reduced |
SPIBoolean AccessibleTable_isColumnSelected (AccessibleTable *obj,long int column);
Determine whether specified table column is selected. Not all tables support column selection.
obj : | a pointer to the |
column : | |
Returns : | |
SPIBoolean AccessibleTable_isRowSelected (AccessibleTable *obj,long int row);
Determine whether a table row is selected. Not all tables support row selection.
obj : | a pointer to the |
row : | |
Returns : | |
SPIBoolean AccessibleTable_isSelected (AccessibleTable *obj,long int row,long int column);
Determine whether the cell at a specific row and column is selected.
obj : | a pointer to the |
row : | |
column : | |
Returns : | |
<< AccessibleSelection Interface | AccessibleText Interface >> |