atk.Table — the ATK interface implemented for UI components which contain tabular or row/column information.
| class atk.Table(gobject.GInterface): | 
|     def callback( | |
|     def callback( | |
|     def callback( | |
|     def callback( | |
|     def callback( | |
|     def callback( | |
|     def callback( | 
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", 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.
    def ref_at(row, column)| 
 | an index representing a row in table | 
| 
 | an index representing a column in table | 
| Returns : | a atk.Objectrepresenting the referred to accessible | 
Get a reference to the table cell at row,
      column.
    def get_index_at(row, column)| 
 | an index representing a row in table | 
| 
 | an index representing a column in table | 
| Returns : | an index representing the index at specified position | 
Gets 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.
    def get_column_at_index(index)| 
 | |
| 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 interface
    def get_row_at_index(index)| 
 | |
| 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 interface
    def get_n_columns()| Returns : | an integer representing the number of columns, or 0 if value does not implement this interface. | 
Gets the number of columns in the table.
    def get_n_rows()| Returns : | an integer representing the number of rows, or 0 if value does not implement this interface. | 
Gets the number of rows in the table.
    def get_column_extent_at(row, column)| 
 | an index representing a row in table | 
| 
 | an index representing a column in table | 
| Returns : | 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.
    def get_row_extent_at(row, column)| 
 | an index representing a row in table | 
| 
 | an index representing a column in table | 
| Returns : | 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.
    def get_caption()| Returns : | a atk.Objectrepresenting the table caption, orNoneif
          value does not implement this interface. | 
Gets the caption for the table.
    def get_column_description(column)| 
 | an index representing a column in the table | 
| Returns : | a string representing the column description,
          or Noneif value does not implement this
          interface. | 
Gets the description text of the specified
      column in the table
    def get_column_header(column)| 
 | an index representing a column in the table | 
| Returns : | a atk.Objectrepresenting the specified column header, orNoneif value does not implement this
          interface. | 
Gets the column header of a specified column in an accessible table.
    def get_row_description(row)| 
 | an index representing a row in table | 
| Returns : | a string representing the row description, or Noneif value does not implement this
          interface. | 
Gets the description text of the specified row in the table
    def get_row_header(row)| 
 | an index representing a row in the table | 
| Returns : | a atk.Objectrepresenting the specified row header, orNoneif value does not implement this interface. | 
Gets the row header of a specified row in an accessible table.
    def get_summary()| Returns : | a atk.Objectrepresenting a summary description of the table, or zero if value
          does not implement this interface. | 
Gets the summary description of the table.
    def set_caption(caption)| 
 | a atk.Objectrepresenting the caption to set for table | 
Sets the caption for the table.
    def set_column_description(column, description)| 
 | an index representing a column in table | 
| 
 | a string representing the description text to
          set for the specified columnof the
          table | 
Sets the description text for the specified
      column of the table.
    def set_column_header(column, header)| 
 | an index representing a column in table | 
| 
 | an atk.Table | 
Sets the specified column header to
      header.
    def set_row_description(row, description)| 
 | an index representing a row in table | 
| 
 | a string representing the description text to
          set for the specified rowof
          table | 
Sets the description text for the specified
      row of table.
    def set_row_header(row, header)| 
 | an index representing a row in table | 
| 
 | an atk.Table | 
Sets the specified row header to
      header.
    def set_summary(accessible)| 
 | an atk.Objectrepresenting the summary description to set for
          table | 
Sets the summary description of the table.
    def get_selected_columns()| Returns : | a tuple containing the indices ofthe selected columns. | 
Gets the selected columns of the table.
    def get_selected_rows()| Returns : | a tuple containing the indices ofthe selected rows. | 
Gets the selected rows of the table.
    def is_column_selected(column)| 
 | an index representing a column in table | 
| Returns : | Trueif the column is
          selected, or 0 if value does not implement this
          interface. | 
Gets a boolean value indicating whether the specified
      column is selected
    def is_row_selected(row)| 
 | an index representing a row in table | 
| Returns : | Trueif the row is selected,
          or 0 if value does not implement this
          interface. | 
Gets a boolean value indicating whether the specified
      row is selected
    def is_selected(row, column)| 
 | an index representing a row in table | 
| 
 | an index representing a column in table | 
| Returns : | Trueif 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 selected
    def add_row_selection(row)| 
 | an index representing a row in table | 
| Returns : | Trueifrowwas successfully added to selection, or
          0 if value does not implement this interface. | 
Adds the specified row to the
      selection.
    def remove_row_selection(row)| 
 | an index representing a row in table | 
| Returns : | Trueifrowwas successfully removed from the
          selection, or 0 if value does not implement this
          interface. | 
Removes the specified row from the
      selection.
    def callback(atktable, arg1, arg2, user_param1, ...)| 
 | the object which received the signal. | 
| 
 | The index of the first column deleted. | 
| 
 | The number of columns deleted. | 
| 
 | the first user parameter (if any) specified
          with the connect() | 
| 
 | 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.
    def callback(atktable, column, count, user_param1, ...)| 
 | the object which received the signal. | 
| 
 | The index of the column inserted. | 
| 
 | The number of colums inserted. | 
| 
 | the first user parameter (if any) specified
          with the connect() | 
| 
 | 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.
    def callback(atktable, user_param1, ...)| 
 | the object which received the signal. | 
| 
 | the first user parameter (if any) specified
          with the connect() | 
| 
 | 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.
    def callback(atktable, user_param1, ...)| 
 | the object which received the signal. | 
| 
 | the first user parameter (if any) specified
          with the connect() | 
| 
 | 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.
    def callback(atktable, row, count, user_param1, ...)| 
 | the object which received the signal. | 
| 
 | The index of the first row deleted. | 
| 
 | The number of rows deleted. | 
| 
 | the first user parameter (if any) specified
          with the connect() | 
| 
 | 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.
    def callback(atktable, row, count, user_param1, ...)| 
 | the object which received the signal. | 
| 
 | The index of the first row deleted. | 
| 
 | The number of rows deleted. | 
| 
 | the first user parameter (if any) specified
          with the connect() | 
| 
 | 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.
    def callback(atktable, user_param1, ...)| 
 | the object which received the signal. | 
| 
 | the first user parameter (if any) specified
          with the connect() | 
| 
 | additional user parameters (if any) | 
The "row-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered.