Atspi.Table¶

Implementations:: Atspi.Accessible

Methods¶

	`add_column_selection` (column)
	`add_row_selection` (row)
	`get_accessible_at` (row, column)
	`get_caption` ()
	`get_column_at_index` (index)
	`get_column_description` (column)
	`get_column_extent_at` (row, column)
	`get_column_header` (column)
	`get_index_at` (row, column)
	`get_n_columns` ()
	`get_n_rows` ()
	`get_n_selected_columns` ()
	`get_n_selected_rows` ()
	`get_row_at_index` (index)
	`get_row_column_extents_at_index` (index)
	`get_row_description` (row)
	`get_row_extent_at` (row, column)
	`get_row_header` (row)
	`get_selected_columns` ()
	`get_selected_rows` ()
	`get_summary` ()
	`is_column_selected` (column)
	`is_row_selected` (row)
	`is_selected` (row, column)
	`remove_column_selection` (column)
	`remove_row_selection` (row)

Virtual Methods¶

None

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class Atspi.Table¶

Bases:: GObject.GInterface

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.

add_column_selection(column)¶

Parameters:: column (int) – the zero-indexed column number of the column being selected.
Raises:: GLib.Error
Returns:: True if the specified column was successfully selected, False if not.
Return type:: bool

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

add_row_selection(row)¶

Parameters:: row (int) – the zero-indexed row number of the row being selected.
Raises:: GLib.Error
Returns:: True if the specified row was successfully selected, False if not.
Return type:: bool

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

get_accessible_at(row, column)¶

Parameters:

row (int) – the specified table row, zero-indexed.
column (int) – the specified table column, zero-indexed.

Raises:

GLib.Error

Returns:

an Atspi.Accessible object representing the specified table cell.

Return type:

Atspi.Accessible

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.

get_caption()¶

Raises:: GLib.Error
Returns:: an Atspi.Accessible object that serves as the table’s caption.
Return type:: Atspi.Accessible

Gets an accessible representation of the caption for an Atspi.Table.

get_column_at_index(index)¶

Parameters:: index (int) – the specified child index, zero-indexed.
Raises:: GLib.Error
Returns:: a int indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) index.
Return type:: int

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

see Atspi.Table.get_index_at, Atspi.Table.get_row_at_index

get_column_description(column)¶

Parameters:: column (int) – the specified table column, zero-indexed.
Raises:: GLib.Error
Returns:: a UTF-8 string describing the specified table column, if available.
Return type:: str

Gets a text description of a particular table column. This differs from Atspi.Table.get_column_header, which returns an #Accessible.

get_column_extent_at(row, column)¶

Parameters:

row (int) – the specified table row, zero-indexed.
column (int) – the specified table column, zero-indexed.

Raises:

GLib.Error

Returns:

a int indicating the number of columns spanned by the specified cell.

Return type:

int

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.

get_column_header(column)¶

Parameters:: column (int) – the specified table column, zero-indexed.
Raises:: GLib.Error
Returns:: an Atspi.Accessible representation of the specified table column, if available.
Return type:: Atspi.Accessible

Gets the header associated with a table column, if available. This differs from Atspi.Table.get_column_description, which returns a string.

get_index_at(row, column)¶

Parameters:

row (int) – the specified table row, zero-indexed.
column (int) – the specified table column, zero-indexed.

Raises:

GLib.Error

Returns:

a int which serves as the index of a specified cell in the table, in a form usable by #atspi_get_child_at_index.

Return type:

int

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.

see Atspi.Table.get_row_at_index, Atspi.Table.get_column_at_index

get_n_columns()¶

Raises:: GLib.Error
Returns:: a int indicating the number of columns in the table.
Return type:: int

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

get_n_rows()¶

Raises:: GLib.Error
Returns:: a int indicating the number of rows in the table.
Return type:: int

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

get_n_selected_columns()¶

Raises:: GLib.Error
Returns:: a int indicating the number of columns currently selected.
Return type:: int

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

get_n_selected_rows()¶

Raises:: GLib.Error
Returns:: a int indicating the number of rows currently selected.
Return type:: int

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

get_row_at_index(index)¶

Parameters:: index (int) – the specified child index, zero-indexed.
Raises:: GLib.Error
Returns:: a int indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) index.
Return type:: int

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

see Atspi.Table.get_index_at, Atspi.Table.get_column_at_index

get_row_column_extents_at_index(index)¶

Parameters:

index (int) – the index of the Atspi.Table child whose row/column extents are requested.

Raises:

GLib.Error

Returns:

True if the index is associated with a valid table cell, False if the index does not correspond to a cell. If False is returned, the values of the out parameters are undefined.

row:: back-filled with the first table row associated with the cell with child index.
col:: back-filled with the first table column associated with the cell with child index.
row_extents:: back-filled with the number of table rows across which child i extends.
col_extents:: back-filled with the number of table columns across which child i extends.
is_selected:: a boolean which is back-filled with True if the child at index i corresponds to a selected table cell, False otherwise.

Return type:

(bool, row: int, col: int, row_extents: int, col_extents: int, is_selected: bool)

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.

Example: If the Atspi.Table child at index ‘6’ extends across columns 5 and 6 of row 2 of an Atspi.Table instance, and is currently selected, then

retval = Atspi.Table.get_row_column_extents_at_index (table, 6, row, col, row_extents, col_extents, is_selected);

will return True, and after the call row, col, row_extents, col_extents, and is_selected will contain 2, 5, 1, 2, and True, respectively.

get_row_description(row)¶

Parameters:: row (int) – the specified table row, zero-indexed.
Raises:: GLib.Error
Returns:: a UTF-8 string describing the specified table row, if available.
Return type:: str

Gets a text description of a particular table row. This differs from Atspi.Table.get_row_header, which returns an Atspi.Accessible.

get_row_extent_at(row, column)¶

Parameters:

row (int) – the specified table row, zero-indexed.
column (int) – the specified table column, zero-indexed.

Raises:

GLib.Error

Returns:

a int indicating the number of rows spanned by the specified cell.

Return type:

int

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.

get_row_header(row)¶

Parameters:: row (int) – the specified table row, zero-indexed.
Raises:: GLib.Error
Returns:: an Atspi.Accessible representation of the specified table row, if available.
Return type:: Atspi.Accessible

Gets the header associated with a table row, if available. This differs from Atspi.Table.get_row_description, which returns a string.

get_selected_columns()¶

Raises:: GLib.Error
Returns:: an array of int values, specifying which columns are currently selected.
Return type:: [int]

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

get_selected_rows()¶

Raises:: GLib.Error
Returns:: an array of int values, specifying which rows are currently selected.
Return type:: [int]

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

get_summary()¶

Raises:: GLib.Error
Returns:: an Atspi.Accessible object that serves as the table’s summary (often a reduced Atspi.Table).
Return type:: Atspi.Accessible

Gets an accessible object which summarizes the contents of an Atspi.Table.

is_column_selected(column)¶

Parameters:: column (int) – the zero-indexed column number of the column being queried.
Raises:: GLib.Error
Returns:: True if the specified column is currently selected, False if not.
Return type:: bool

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

is_row_selected(row)¶

Parameters:: row (int) – the zero-indexed row number of the row being queried.
Raises:: GLib.Error
Returns:: True if the specified row is currently selected, False if not.
Return type:: bool

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

is_selected(row, column)¶

Parameters:

row (int) – the zero-indexed row of the cell being queried.
column (int) – the zero-indexed column of the cell being queried.

Raises:

GLib.Error

Returns:

True if the specified cell is currently selected, False if not.

Return type:

bool

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

remove_column_selection(column)¶

Parameters:: column (int) – the zero-indexed column number of the column being de-selected.
Raises:: GLib.Error
Returns:: True if the specified column was successfully de-selected, False if not.
Return type:: bool

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

remove_row_selection(row)¶

Parameters:: row (int) – the zero-indexed number of the row being de-selected.
Raises:: GLib.Error
Returns:: True if the specified row was successfully de-selected, False if not.
Return type:: bool

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