Atspi.Table
Description: Reference for Atspi.Table

### Interface

# AtspiTable

#### Description [src]

    interface Atspi.Table : GObject.Object

An interface used by containers whose data is arranged in a tabular form.

An interface used by containers whose contained data is arranged in a tabular (i.e. row-column) form. Tables may resemble a two-dimensional grid, as in a spreadsheet, or may feature objects which span multiple rows and/or columns, but whose bounds are aligned on a row/column matrix. Objects within tables are children of the table object, and they may be referenced either via a child index or via a row/column pair. Table ‘cells’ may implement other interfaces, such as Text, Action, Image, and Component, and should do so as appropriate to their onscreen presentation and/or behavior.

#### Prerequisite

In order to implement Table, your type must inherit from`GObject`.

#### Implementations

- AtspiAccessible

#### Instance methods

###### atspi_table_add_column_selection

Selects the specified column, adding it to the current column selection. Not all tables support column selection.

###### atspi_table_add_row_selection

Selects the specified row, adding it to the current row selection. Not all tables support row selection.

###### atspi_table_get_accessible_at

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

###### atspi_table_get_caption

Gets an accessible representation of the caption for an `AtspiTable`.

###### atspi_table_get_column_at_index

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

###### atspi_table_get_column_description

Gets a text description of a particular table column. This differs from

# atspi_table_get_column_header, which returns an `Accessible`.

###### atspi_table_get_column_extent_at

Gets 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). The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING.

###### atspi_table_get_column_header

Gets the header associated with a table column, if available. This differs from #atspi_table_get_column_description, which returns a string.

###### atspi_table_get_index_at

Gets 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 #atspi_component_get_accessible_at_point.

###### atspi_table_get_n_columns

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

###### atspi_table_get_n_rows

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

###### atspi_table_get_n_selected_columns

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

###### atspi_table_get_n_selected_rows

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

###### atspi_table_get_row_at_index

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

###### atspi_table_get_row_column_extents_at_index

Given a child index, determines the row and column indices and extents, and whether the cell is currently selected. If the child at index is not a cell (for instance, if it is a summary, caption, etc.), `FALSE` is returned. The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING.

###### atspi_table_get_row_description

Gets a text description of a particular table row. This differs from

# atspi_table_get_row_header, which returns an `AtspiAccessible`.

###### atspi_table_get_row_extent_at

Gets 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). The returned values are meaningful only if the Table has both STATE_VISIBLE and STATE_SHOWING.

###### atspi_table_get_row_header

Gets the header associated with a table row, if available. This differs from

# atspi_table_get_row_description, which returns a string.

###### atspi_table_get_selected_columns

Queries a table for a list of indices of columns which are currently selected.

###### atspi_table_get_selected_rows

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

###### atspi_table_get_summary

Gets an accessible object which summarizes the contents of an `AtspiTable`.

###### atspi_table_is_column_selected

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

###### atspi_table_is_row_selected

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

###### atspi_table_is_selected

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

###### atspi_table_remove_column_selection

De-selects the specified column, removing it from the current column selection. Not all tables support column selection.

###### atspi_table_remove_row_selection

De-selects the specified row, removing it from the current row selection. Not all tables support row selection.