Atk.Table¶

Implementations:
	`Atk.NoOpObject`

Methods¶

	`add_column_selection` (column)
	`add_row_selection` (row)
	`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_row_at_index` (index_)
	`get_row_description` (row)
	`get_row_extent_at` (row, column)
	`get_row_header` (row)
	`get_selected_columns` (selected)
	`get_selected_rows` (selected)
	`get_summary` ()
	`is_column_selected` (column)
	`is_row_selected` (row)
	`is_selected` (row, column)
	`ref_at` (row, column)
	`remove_column_selection` (column)
	`remove_row_selection` (row)
	`set_caption` (caption)
	`set_column_description` (column, description)
	`set_column_header` (column, header)
	`set_row_description` (row, description)
	`set_row_header` (row, header)
	`set_summary` (accessible)

Virtual Methods¶

	`do_add_column_selection` (column)
	`do_add_row_selection` (row)
	`do_column_deleted` (column, num_deleted)
	`do_column_inserted` (column, num_inserted)
	`do_column_reordered` ()
	`do_get_caption` ()
	`do_get_column_at_index` (index_)
	`do_get_column_description` (column)
	`do_get_column_extent_at` (row, column)
	`do_get_column_header` (column)
	`do_get_index_at` (row, column)
	`do_get_n_columns` ()
	`do_get_n_rows` ()
	`do_get_row_at_index` (index_)
	`do_get_row_description` (row)
	`do_get_row_extent_at` (row, column)
	`do_get_row_header` (row)
	`do_get_selected_columns` (selected)
	`do_get_selected_rows` (selected)
	`do_get_summary` ()
	`do_is_column_selected` (column)
	`do_is_row_selected` (row)
	`do_is_selected` (row, column)
	`do_model_changed` ()
	`do_ref_at` (row, column)
	`do_remove_column_selection` (column)
	`do_remove_row_selection` (row)
	`do_row_deleted` (row, num_deleted)
	`do_row_inserted` (row, num_inserted)
	`do_row_reordered` ()
	`do_set_caption` (caption)
	`do_set_column_description` (column, description)
	`do_set_column_header` (column, header)
	`do_set_row_description` (row, description)
	`do_set_row_header` (row, header)
	`do_set_summary` (accessible)

Properties¶

None

Signals¶

Name	Short Description
`column-deleted`	The “column-deleted” signal is emitted by an object which implements the `Atk.Table` interface when a column is deleted.
`column-inserted`	The “column-inserted” signal is emitted by an object which implements the `Atk.Table` interface when a column is inserted.
`column-reordered`	The “column-reordered” signal is emitted by an object which implements the `Atk.Table` interface when the columns are reordered.
`model-changed`	The “model-changed” signal is emitted by an object which implements the `Atk.Table` interface when the model displayed by the table changes.
`row-deleted`	The “row-deleted” signal is emitted by an object which implements the `Atk.Table` interface when a row is deleted.
`row-inserted`	The “row-inserted” signal is emitted by an object which implements the `Atk.Table` interface when a row is inserted.
`row-reordered`	The “row-reordered” signal is emitted by an object which implements the `Atk.Table` interface when the rows are reordered.

Fields¶

None

Class Details¶

class Atk.Table¶

Bases:	`GObject.GInterface`
Structure:	`Atk.TableIface`

Atk.Table should be implemented by components which present elements ordered via rows and columns. It may also be used to present tree-structured information if the nodes of the trees can be said to contain multiple “columns”. Individual elements of an Atk.Table are typically referred to as “cells”. Those cells should implement the interface Atk.TableCell, but #Atk doesn’t require them to be direct children of the current Atk.Table. They can be grand-children, grand-grand-children etc. Atk.Table provides the API needed to get a individual cell based on the row and column numbers.

Children of Atk.Table are frequently “lightweight” objects, that is, they may not have backing widgets in the host UI toolkit. They are therefore often transient.

Since tables are often very complex, Atk.Table includes provision for offering simplified summary information, as well as row and column headers and captions. Headers and captions are Atk.Objects which may implement other interfaces (Atk.Text, Atk.Image, etc.) as appropriate. Atk.Table summaries may themselves be (simplified) Atk.Tables, etc.

Note for implementors: in the past, Atk.Table required that all the cells should be direct children of Atk.Table, and provided some index based methods to request the cells. The practice showed that that forcing made Atk.Table implementation complex, and hard to expose other kind of children, like rows or captions. Right now, index-based methods are deprecated.

add_column_selection(column)[source]¶

Parameters:	column (`int`) – a `int` representing a column in self
Returns:	a `bool` representing if the column was successfully added to the selection, or 0 if value does not implement this interface.
Return type:	`bool`

Adds the specified column to the selection.

add_row_selection(row)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self
Returns:	a `bool` representing if row was successfully added to selection, or 0 if value does not implement this interface.
Return type:	`bool`

Adds the specified row to the selection.

get_caption()[source]¶

Returns:	a `Atk.Object` representing the table caption, or `None` if value does not implement this interface.
Return type:	`Atk.Object` or `None`

Gets the caption for the self.

get_column_at_index(index_)[source]¶

Parameters:	index (`int`) – a `int` representing an index in self
Returns:	a `int` representing the column at the specified index, or -1 if the table does not implement this method.
Return type:	`int`

Gets a int representing the column at the specified index_.

Deprecated since version 2.12.

get_column_description(column)[source]¶

Parameters:	column (`int`) – a `int` representing a column in self
Returns:	a `str` representing the column description, or `None` if value does not implement this interface.
Return type:	`str`

Gets the description text of the specified column in the table

get_column_extent_at(row, column)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self column (`int`) – a `int` representing a column in self
Returns:	a `int` representing the column extent at specified position, or 0 if value does not implement this interface.
Return type:	`int`

Gets the number of columns occupied by the accessible object at the specified row and column in the self.

get_column_header(column)[source]¶

Parameters:	column (`int`) – a `int` representing a column in the table
Returns:	a `Atk.Object` representing the specified column header, or `None` if value does not implement this interface.
Return type:	`Atk.Object` or `None`

Gets the column header of a specified column in an accessible table.

get_index_at(row, column)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self column (`int`) – a `int` representing a column in self
Returns:	a `int` representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.
Return type:	`int`

Gets a int representing the index at the specified row and column.

Deprecated since version 2.12: Use Atk.Table.ref_at() in order to get the accessible that represents the cell at (row, column)

get_n_columns()[source]¶

Returns:	a `int` representing the number of columns, or 0 if value does not implement this interface.
Return type:	`int`

Gets the number of columns in the table.

get_n_rows()[source]¶

Returns:	a `int` representing the number of rows, or 0 if value does not implement this interface.
Return type:	`int`

Gets the number of rows in the table.

get_row_at_index(index_)[source]¶

Parameters:	index (`int`) – a `int` representing an index in self
Returns:	a `int` representing the row at the specified index, or -1 if the table does not implement this method.
Return type:	`int`

Gets a int representing the row at the specified index_.

Deprecated since version ???: since 2.12.

get_row_description(row)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self
Returns:	a `str` representing the row description, or `None` if value does not implement this interface.
Return type:	`str` or `None`

Gets the description text of the specified row in the table

get_row_extent_at(row, column)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self column (`int`) – a `int` representing a column in self
Returns:	a `int` representing the row extent at specified position, or 0 if value does not implement this interface.
Return type:	`int`

Gets the number of rows occupied by the accessible object at a specified row and column in the self.

get_row_header(row)[source]¶

Parameters:	row (`int`) – a `int` representing a row in the table
Returns:	a `Atk.Object` representing the specified row header, or `None` if value does not implement this interface.
Return type:	`Atk.Object` or `None`

Gets the row header of a specified row in an accessible table.

get_selected_columns(selected)[source]¶

Parameters:	selected (`int`) – a `int` that is to contain the selected columns numbers
Returns:	a `int` representing the number of selected columns, or %0 if value does not implement this interface.
Return type:	`int`

Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

get_selected_rows(selected)[source]¶

Parameters:	selected (`int`) – a `int` that is to contain the selected row numbers
Returns:	a `int` representing the number of selected rows, or zero if value does not implement this interface.
Return type:	`int`

Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

get_summary()[source]¶

Returns:	a `Atk.Object` representing a summary description of the table, or zero if value does not implement this interface.
Return type:	`Atk.Object`

Gets the summary description of the table.

is_column_selected(column)[source]¶

Parameters:	column (`int`) – a `int` representing a column in self
Returns:	a `bool` representing if the column is selected, or 0 if value does not implement this interface.
Return type:	`bool`

Gets a boolean value indicating whether the specified column is selected

is_row_selected(row)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self
Returns:	a `bool` representing if the row is selected, or 0 if value does not implement this interface.
Return type:	`bool`

Gets a boolean value indicating whether the specified row is selected

is_selected(row, column)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self column (`int`) – a `int` representing a column in self
Returns:	a `bool` representing if the cell is selected, or 0 if value does not implement this interface.
Return type:	`bool`

Gets a boolean value indicating whether the accessible object at the specified row and column is selected

ref_at(row, column)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self column (`int`) – a `int` representing a column in self
Returns:	an `Atk.Object` representing the referred to accessible
Return type:	`Atk.Object`

Get a reference to the table cell at row, column. This cell should implement the interface Atk.TableCell

remove_column_selection(column)[source]¶

Parameters:	column (`int`) – a `int` representing a column in self
Returns:	a `bool` representing if the column was successfully removed from the selection, or 0 if value does not implement this interface.
Return type:	`bool`

Adds the specified column to the selection.

remove_row_selection(row)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self
Returns:	a `bool` representing if the row was successfully removed from the selection, or 0 if value does not implement this interface.
Return type:	`bool`

Removes the specified row from the selection.

set_caption(caption)[source]¶

Parameters:	caption (`Atk.Object`) – a `Atk.Object` representing the caption to set for self

Sets the caption for the table.

set_column_description(column, description)[source]¶

Parameters:	column (`int`) – a `int` representing a column in self description (`str`) – a `str` representing the description text to set for the specified column of the self

Sets the description text for the specified column of the self.

set_column_header(column, header)[source]¶

Parameters:	column (`int`) – a `int` representing a column in self header (`Atk.Object`) – an `Atk.Table`

Sets the specified column header to header.

set_row_description(row, description)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self description (`str`) – a `str` representing the description text to set for the specified row of self

Sets the description text for the specified row of self.

set_row_header(row, header)[source]¶

Parameters:	row (`int`) – a `int` representing a row in self header (`Atk.Object`) – an `Atk.Table`

Sets the specified row header to header.

set_summary(accessible)[source]¶

Parameters:	accessible (`Atk.Object`) – an `Atk.Object` representing the summary description to set for self

Sets the summary description of the table.

do_add_column_selection(column) virtual¶

Parameters:	column (`int`) – a `int` representing a column in table
Returns:	a `bool` representing if the column was successfully added to the selection, or 0 if value does not implement this interface.
Return type:	`bool`

Adds the specified column to the selection.

do_add_row_selection(row) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table
Returns:	a `bool` representing if row was successfully added to selection, or 0 if value does not implement this interface.
Return type:	`bool`

Adds the specified row to the selection.

do_column_deleted(column, num_deleted) virtual¶

Parameters:	column (`int`) – num_deleted (`int`) –

do_column_inserted(column, num_inserted) virtual¶

Parameters:	column (`int`) – num_inserted (`int`) –

do_column_reordered() virtual¶

do_get_caption() virtual¶

Returns:	a `Atk.Object` representing the table caption, or `None` if value does not implement this interface.
Return type:	`Atk.Object` or `None`

Gets the caption for the table.

do_get_column_at_index(index_) virtual¶

Parameters:	index (`int`) – a `int` representing an index in table
Returns:	a `int` representing the column at the specified index, or -1 if the table does not implement this method.
Return type:	`int`

Gets a int representing the column at the specified index_.

Deprecated since version 2.12.

do_get_column_description(column) virtual¶

Parameters:	column (`int`) – a `int` representing a column in table
Returns:	a `str` representing the column description, or `None` if value does not implement this interface.
Return type:	`str`

Gets the description text of the specified column in the table

do_get_column_extent_at(row, column) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table column (`int`) – a `int` representing a column in table
Returns:	a `int` representing the column extent at specified position, or 0 if value does not implement this interface.
Return type:	`int`

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

do_get_column_header(column) virtual¶

Parameters:	column (`int`) – a `int` representing a column in the table
Returns:	a `Atk.Object` representing the specified column header, or `None` if value does not implement this interface.
Return type:	`Atk.Object` or `None`

Gets the column header of a specified column in an accessible table.

do_get_index_at(row, column) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table column (`int`) – a `int` representing a column in table
Returns:	a `int` representing the index at specified position. The value -1 is returned if the object at row,column is not a child of table or table does not implement this interface.
Return type:	`int`

Gets a int representing the index at the specified row and column.

Deprecated since version 2.12: Use Atk.Table.ref_at() in order to get the accessible that represents the cell at (row, column)

do_get_n_columns() virtual¶

Returns:	a `int` representing the number of columns, or 0 if value does not implement this interface.
Return type:	`int`

Gets the number of columns in the table.

do_get_n_rows() virtual¶

Returns:	a `int` representing the number of rows, or 0 if value does not implement this interface.
Return type:	`int`

Gets the number of rows in the table.

do_get_row_at_index(index_) virtual¶

Parameters:	index (`int`) – a `int` representing an index in table
Returns:	a `int` representing the row at the specified index, or -1 if the table does not implement this method.
Return type:	`int`

Gets a int representing the row at the specified index_.

Deprecated since version ???: since 2.12.

do_get_row_description(row) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table
Returns:	a `str` representing the row description, or `None` if value does not implement this interface.
Return type:	`str` or `None`

Gets the description text of the specified row in the table

do_get_row_extent_at(row, column) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table column (`int`) – a `int` representing a column in table
Returns:	a `int` representing the row extent at specified position, or 0 if value does not implement this interface.
Return type:	`int`

Gets the number of rows occupied by the accessible object at a specified row and column in the table.

do_get_row_header(row) virtual¶

Parameters:	row (`int`) – a `int` representing a row in the table
Returns:	a `Atk.Object` representing the specified row header, or `None` if value does not implement this interface.
Return type:	`Atk.Object` or `None`

Gets the row header of a specified row in an accessible table.

do_get_selected_columns(selected) virtual¶

Parameters:	selected (`int`) – a `int` that is to contain the selected columns numbers
Returns:	a `int` representing the number of selected columns, or %0 if value does not implement this interface.
Return type:	`int`

Gets the selected columns of the table by initializing **selected with the selected column numbers. This array should be freed by the caller.

do_get_selected_rows(selected) virtual¶

Parameters:	selected (`int`) – a `int` that is to contain the selected row numbers
Returns:	a `int` representing the number of selected rows, or zero if value does not implement this interface.
Return type:	`int`

Gets the selected rows of the table by initializing **selected with the selected row numbers. This array should be freed by the caller.

do_get_summary() virtual¶

Returns:	a `Atk.Object` representing a summary description of the table, or zero if value does not implement this interface.
Return type:	`Atk.Object`

Gets the summary description of the table.

do_is_column_selected(column) virtual¶

Parameters:	column (`int`) – a `int` representing a column in table
Returns:	a `bool` representing if the column is selected, or 0 if value does not implement this interface.
Return type:	`bool`

Gets a boolean value indicating whether the specified column is selected

do_is_row_selected(row) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table
Returns:	a `bool` representing if the row is selected, or 0 if value does not implement this interface.
Return type:	`bool`

Gets a boolean value indicating whether the specified row is selected

do_is_selected(row, column) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table column (`int`) – a `int` representing a column in table
Returns:	a `bool` representing if the cell is selected, or 0 if value does not implement this interface.
Return type:	`bool`

Gets a boolean value indicating whether the accessible object at the specified row and column is selected

do_model_changed() virtual¶

do_ref_at(row, column) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table column (`int`) – a `int` representing a column in table
Returns:	an `Atk.Object` representing the referred to accessible
Return type:	`Atk.Object`

Get a reference to the table cell at row, column. This cell should implement the interface Atk.TableCell

do_remove_column_selection(column) virtual¶

Parameters:	column (`int`) – a `int` representing a column in table
Returns:	a `bool` representing if the column was successfully removed from the selection, or 0 if value does not implement this interface.
Return type:	`bool`

Adds the specified column to the selection.

do_remove_row_selection(row) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table
Returns:	a `bool` representing if the row was successfully removed from the selection, or 0 if value does not implement this interface.
Return type:	`bool`

Removes the specified row from the selection.

do_row_deleted(row, num_deleted) virtual¶

Parameters:	row (`int`) – num_deleted (`int`) –

do_row_inserted(row, num_inserted) virtual¶

Parameters:	row (`int`) – num_inserted (`int`) –

do_row_reordered() virtual¶

do_set_caption(caption) virtual¶

Parameters:	caption (`Atk.Object`) – a `Atk.Object` representing the caption to set for table

Sets the caption for the table.

do_set_column_description(column, description) virtual¶

Parameters:	column (`int`) – a `int` representing a column in table description (`str`) – a `str` representing the description text to set for the specified column of the table

Sets the description text for the specified column of the table.

do_set_column_header(column, header) virtual¶

Parameters:	column (`int`) – a `int` representing a column in table header (`Atk.Object`) – an `Atk.Table`

Sets the specified column header to header.

do_set_row_description(row, description) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table description (`str`) – a `str` representing the description text to set for the specified row of table

Sets the description text for the specified row of table.

do_set_row_header(row, header) virtual¶

Parameters:	row (`int`) – a `int` representing a row in table header (`Atk.Object`) – an `Atk.Table`

Sets the specified row header to header.

do_set_summary(accessible) virtual¶

Parameters:	accessible (`Atk.Object`) – an `Atk.Object` representing the summary description to set for table

Sets the summary description of the table.

Signal Details¶

Atk.Table.signals.column_deleted(table, arg1, arg2)¶

Signal Name:	`column-deleted`
Flags:	`RUN_LAST`
Parameters:	table (`Atk.Table`) – The object which received the signal arg1 (`int`) – The index of the first column deleted. arg2 (`int`) – The number of columns deleted.

The “column-deleted” signal is emitted by an object which implements the Atk.Table interface when a column is deleted.

Atk.Table.signals.column_inserted(table, arg1, arg2)¶

Signal Name:	`column-inserted`
Flags:	`RUN_LAST`
Parameters:	table (`Atk.Table`) – The object which received the signal arg1 (`int`) – The index of the column inserted. arg2 (`int`) – The number of colums inserted.

The “column-inserted” signal is emitted by an object which implements the Atk.Table interface when a column is inserted.

Atk.Table.signals.column_reordered(table)¶

Signal Name:	`column-reordered`
Flags:	`RUN_LAST`
Parameters:	table (`Atk.Table`) – The object which received the signal

The “column-reordered” signal is emitted by an object which implements the Atk.Table interface when the columns are reordered.

Atk.Table.signals.model_changed(table)¶

Signal Name:	`model-changed`
Flags:	`RUN_LAST`
Parameters:	table (`Atk.Table`) – The object which received the signal

The “model-changed” signal is emitted by an object which implements the Atk.Table interface when the model displayed by the table changes.

Atk.Table.signals.row_deleted(table, arg1, arg2)¶

Signal Name:	`row-deleted`
Flags:	`RUN_LAST`
Parameters:	table (`Atk.Table`) – The object which received the signal arg1 (`int`) – The index of the first row deleted. arg2 (`int`) – The number of rows deleted.

The “row-deleted” signal is emitted by an object which implements the Atk.Table interface when a row is deleted.

Atk.Table.signals.row_inserted(table, arg1, arg2)¶

Signal Name:	`row-inserted`
Flags:	`RUN_LAST`
Parameters:	table (`Atk.Table`) – The object which received the signal arg1 (`int`) – The index of the first row inserted. arg2 (`int`) – The number of rows inserted.

The “row-inserted” signal is emitted by an object which implements the Atk.Table interface when a row is inserted.

Atk.Table.signals.row_reordered(table)¶

Signal Name:	`row-reordered`
Flags:	`RUN_LAST`
Parameters:	table (`Atk.Table`) – The object which received the signal

The “row-reordered” signal is emitted by an object which implements the Atk.Table interface when the rows are reordered.