atk.Tablethe ATK interface implemented for UI components which
contain tabular or row/column information. Synopsisatk.Tablegobject.GInterfaceref_atrowcolumnget_index_atrowcolumnget_column_at_indexindexget_row_at_indexindexget_n_columnsget_n_rowsget_column_extent_atrowcolumnget_row_extent_atrowcolumnget_captionget_column_descriptioncolumnget_column_headercolumnget_row_descriptionrowget_row_headerrowget_summaryset_captioncaptionset_column_descriptioncolumndescriptionset_column_headercolumnheaderset_row_descriptionrowdescriptionset_row_headerrowheaderset_summaryaccessibleget_selected_columnsselectedget_selected_rowsselectedis_column_selectedcolumnis_row_selectedrowis_selectedrowcolumnadd_row_selectionrowremove_row_selectionrowadd_column_selectioncolumnremove_column_selectioncolumnatk.Table Signal Prototypes"column-deleted"callbackatktablecolumncountuser_param1..."column-inserted"callbackatktablecolumncountuser_param1..."column-reordered"callbackatktableuser_param1..."model-changed"callbackatktableuser_param1..."row-deleted"callbackatktablerowcountuser_param1..."row-inserted"callbackatktablerowcountuser_param1..."row-reordered"callbackatktableuser_param1...Descriptionatk.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", and these cells are exposed by atk.Table as
child atk.Object
objects of the atk.Table. Both
row/column and child-index-based access to these children is
provided.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.Object
objects which may implement other interfaces (atk.Text, atk.Image, etc.)
as appropriate. atk.Table
summaries may themselves be (simplified) atk.Table
objects, etc.Methodsatk.Table.ref_atref_atrowcolumnrow :an index representing a row in
tablecolumn :an index representing a column in
tableReturns :a atk.Object
representing the referred to accessibleGet a reference to the table cell at row,
column.atk.Table.get_index_atget_index_atrowcolumnrow :an index representing a row in
tablecolumn :an index representing a column in
tableReturns :an index representing the index at specified
positionGets the index at the specified row and
column. The value -1 is returned if the object
at row,column is not a child of table or table does not implement this
interface.atk.Table.get_column_at_indexget_column_at_indexindexindex :Returns :an integer representing the column at the
specified index.Gets an index representing the column at the specified
index, or -1 if the table does not implement
this interfaceatk.Table.get_row_at_indexget_row_at_indexindexindex :Returns :an integer representing the row at the
specified index.Gets an index representing the row at the specified
index, or -1 if the table does not implement
this interfaceatk.Table.get_n_columnsget_n_columnsReturns :an integer representing the number of columns,
or 0 if value does not implement this
interface.Gets the number of columns in the table.atk.Table.get_n_rowsget_n_rowsReturns :an integer representing the number of rows, or
0 if value does not implement this interface.Gets the number of rows in the table.atk.Table.get_column_extent_atget_column_extent_atrowcolumnrow :an index representing a row in
tablecolumn :an index representing a column in
tableReturns :an integer representing the column extent at
specified position, or 0 if value does not implement this
interface.Gets the number of columns occupied by the accessible object at
the specified row and
column.atk.Table.get_row_extent_atget_row_extent_atrowcolumnrow :an index representing a row in
tablecolumn :an index representing a column in
tableReturns :an integer representing the row extent at
specified position, or 0 if value does not implement this
interface.Gets the number of rows occupied by the accessible object at a
specified row and
column.atk.Table.get_captionget_captionReturns :a atk.Object
representing the table caption, or None if
value does not implement this interface.Gets the caption for the table.atk.Table.get_column_descriptionget_column_descriptioncolumncolumn :an index representing a column in the
tableReturns :a string representing the column description,
or None if value does not implement this
interface.Gets the description text of the specified
column in the tableatk.Table.get_column_headerget_column_headercolumncolumn :an index representing a column in the
tableReturns :a atk.Object
representing the specified column header, or
None if value does not implement this
interface.Gets the column header of a specified column in an accessible
table.atk.Table.get_row_descriptionget_row_descriptionrowrow :an index representing a row in
tableReturns :a string representing the row description, or
None if value does not implement this
interface.Gets the description text of the specified row in the
tableatk.Table.get_row_headerget_row_headerrowrow :an index representing a row in the
tableReturns :a atk.Object
representing the specified row header, or None
if value does not implement this interface.Gets the row header of a specified row in an accessible
table.atk.Table.get_summaryget_summaryReturns :a atk.Object
representing a summary description of the table, or zero if value
does not implement this interface.Gets the summary description of the table.atk.Table.set_captionset_captioncaptioncaption :a atk.Object
representing the caption to set for tableSets the caption for the table.atk.Table.set_column_descriptionset_column_descriptioncolumndescriptioncolumn :an index representing a column in
tabledescription :a string representing the description text to
set for the specified column of the
tableSets the description text for the specified
column of the table.atk.Table.set_column_headerset_column_headercolumnheadercolumn :an index representing a column in
tableheader :an atk.TableSets the specified column header to
header.atk.Table.set_row_descriptionset_row_descriptionrowdescriptionrow :an index representing a row in
tabledescription :a string representing the description text to
set for the specified row of
tableSets the description text for the specified
row of table.atk.Table.set_row_headerset_row_headerrowheaderrow :an index representing a row in
tableheader :an atk.TableSets the specified row header to
header.atk.Table.set_summaryset_summaryaccessibleaccessible :an atk.Object
representing the summary description to set for
tableSets the summary description of the table.atk.Table.get_selected_columnsget_selected_columnsReturns :a tuple containing the indices ofthe selected
columns.Gets the selected columns of the table.atk.Table.get_selected_rowsget_selected_rowsReturns :a tuple containing the indices ofthe selected
rows.Gets the selected rows of the table.atk.Table.is_column_selectedis_column_selectedcolumncolumn :an index representing a column in
tableReturns :True if the column is
selected, or 0 if value does not implement this
interface.Gets a boolean value indicating whether the specified
column is selectedatk.Table.is_row_selectedis_row_selectedrowrow :an index representing a row in
tableReturns :True if the row is selected,
or 0 if value does not implement this
interface.Gets a boolean value indicating whether the specified
row is selectedatk.Table.is_selectedis_selectedrowcolumnrow :an index representing a row in
tablecolumn :an index representing a column in
tableReturns :True if the cell is
selected, or 0 if value does not implement this
interface.Gets a boolean value indicating whether the accessible object at
the specified row and
column is selectedatk.Table.add_row_selectionadd_row_selectionrowrow :an index representing a row in
tableReturns :True if
row was successfully added to selection, or
0 if value does not implement this interface.Adds the specified row to the
selection.atk.Table.remove_row_selectionremove_row_selectionrowrow :an index representing a row in
tableReturns :True if
row was successfully removed from the
selection, or 0 if value does not implement this
interface.Removes the specified row from the
selection.atk.Table.add_column_selectionadd_column_selectioncolumncolumn :an index representing a column in
tableReturns :True if
column was successfully added to the
selection, or 0 if value does not implement this
interface.Adds the specified column to the
selection.atk.Table.remove_column_selectionremove_column_selectioncolumncolumn :an index representing a column in
tableReturns :True if
column was successfully removed from the
selection, or 0 if value does not implement this
interface.Adds the specified column to the
selection.SignalsThe "column-deleted" atk.Table Signalcallbackatktablearg1arg2user_param1...atktable :the object which received the signal.column :The index of the first column deleted.count :The number of columns deleted.user_param1 :the first user parameter (if any) specified
with the connect()
method... :additional user parameters (if any)The "column-deleted" signal is emitted by an object which
implements the atk.Table
interface when a column is deleted.The "column-inserted" atk.Table Signalcallbackatktablecolumncountuser_param1...atktable :the object which received the signal.column :The index of the column inserted.count :The number of colums inserted.user_param1 :the first user parameter (if any) specified
with the connect()
method... :additional user parameters (if any)The "column-inserted" signal is emitted by an object which
implements the atk.Table
interface when a column is inserted.The "column-reordered" atk.Table Signalcallbackatktableuser_param1...atktable :the object which received the signal.user_param1 :the first user parameter (if any) specified
with the connect()
method... :additional user parameters (if any)The "column-reordered" signal is emitted by an object which
implements the atk.Table
interface when the columns are reordered.The "model-changed" atk.Table Signalcallbackatktableuser_param1...atktable :the object which received the signal.user_param1 :the first user parameter (if any) specified
with the connect()
method... :additional user parameters (if any)The "model-changed" signal is emitted by an object which
implements the atk.Table
interface when the model displayed by the table changes.The "row-deleted" atk.Table Signalcallbackatktablerowcountuser_param1...atktable :the object which received the signal.row :The index of the first row deleted.count :The number of rows deleted.user_param1 :the first user parameter (if any) specified
with the connect()
method... :additional user parameters (if any)The "row-deleted" signal is emitted by an object which
implements the atk.Table
interface when a column is inserted.The "row-inserted" atk.Table Signalcallbackatktablerowcountuser_param1...atktable :the object which received the signal.row :The index of the first row
deleted.count :The number of rows
deleted.user_param1 :the first user parameter (if any) specified
with the connect()
method... :additional user parameters (if any)The "row-inserted" signal is emitted by an object which
implements the atk.Table
interface when a column is inserted.The "row-reordered" atk.Table Signalcallbackatktableuser_param1...atktable :the object which received the signal.user_param1 :the first user parameter (if any) specified
with the connect()
method... :additional user parameters (if any)The "row-reordered" signal is emitted by an object which
implements the AtkTable interface when the columns are
reordered.