Next: , Previous: AtkStreamableContent, Up: Top


22 AtkTable

The ATK interface implemented for UI components which contain tabular or row/column information.

22.1 Overview

<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-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-objects> which may implement other interfaces (<atk-text>, <atk-image>, etc.) as appropriate. <atk-table> summaries may themselves be (simplified) <atk-tables>, etc.

22.2 Usage

— Class: <atk-table>

Derives from <ginterface>.

This class defines no direct slots.

— Signal on <atk-table>: row-inserted (arg0 <gint>) (arg1 <gint>)

The "row-inserted" signal is emitted by an object which implements the AtkTable interface when a column is inserted.

— Signal on <atk-table>: column-inserted (arg0 <gint>) (arg1 <gint>)

The "column-inserted" signal is emitted by an object which implements the AtkTable interface when a column is inserted.

— Signal on <atk-table>: row-deleted (arg0 <gint>) (arg1 <gint>)

The "row-deleted" signal is emitted by an object which implements the AtkTable interface when a column is inserted.

— Signal on <atk-table>: column-deleted (arg0 <gint>) (arg1 <gint>)

The "column-deleted" signal is emitted by an object which implements the AtkTable interface when a column is deleted.

— Signal on <atk-table>: row-reordered

The "row-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered.

— Signal on <atk-table>: column-reordered

The "column-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered.

— Signal on <atk-table>: model-changed

The "model-changed" signal is emitted by an object which implements the AtkTable interface when the model displayed by the table changes.

— Function: atk-table-ref-at (self <atk-table>) (row int) (column int) ⇒  (ret <atk-object>)
— Method: ref-at

Get a reference to the table cell at row, column.

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
column
a <gint> representing a column in table
ret
a AtkObject* representing the referred to accessible
— Function: atk-table-get-index-at (self <atk-table>) (row int) (column int) ⇒  (ret int)
— Method: get-index-at

Gets a <gint> representing the index at the specified row and column.

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
column
a <gint> representing a column in table
ret
a <gint> 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.
— Function: atk-table-get-column-at-index (self <atk-table>) (index_ int) ⇒  (ret int)
— Method: get-column-at-index

Gets a <gint> representing the column at the specified index.

table
a GObject instance that implements AtkTableInterface
index
a <gint> representing an index in table
ret
a gint representing the column at the specified index, or -1 if the table does not implement this interface
— Function: atk-table-get-row-at-index (self <atk-table>) (index_ int) ⇒  (ret int)
— Method: get-row-at-index

Gets a <gint> representing the row at the specified index.

table
a GObject instance that implements AtkTableInterface
index
a <gint> representing an index in table
ret
a gint representing the row at the specified index, or -1 if the table does not implement this interface
— Function: atk-table-get-n-columns (self <atk-table>) ⇒  (ret int)
— Method: get-n-columns

Gets the number of columns in the table.

table
a GObject instance that implements AtkTableIface
ret
a gint representing the number of columns, or 0 if value does not implement this interface.
— Function: atk-table-get-n-rows (self <atk-table>) ⇒  (ret int)
— Method: get-n-rows

Gets the number of rows in the table.

table
a GObject instance that implements AtkTableIface
ret
a gint representing the number of rows, or 0 if value does not implement this interface.
— Function: atk-table-get-column-extent-at (self <atk-table>) (row int) (column int) ⇒  (ret int)
— Method: get-column-extent-at

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

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
column
a <gint> representing a column in table
ret
a gint representing the column extent at specified position, or 0 if value does not implement this interface.
— Function: atk-table-get-row-extent-at (self <atk-table>) (row int) (column int) ⇒  (ret int)
— Method: get-row-extent-at

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

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
column
a <gint> representing a column in table
ret
a gint representing the row extent at specified position, or 0 if value does not implement this interface.
— Function: atk-table-get-caption (self <atk-table>) ⇒  (ret <atk-object>)
— Method: get-caption

Gets the caption for the table.

table
a GObject instance that implements AtkTableInterface
ret
a AtkObject* representing the table caption, or ‘#f’ if value does not implement this interface.
— Function: atk-table-get-column-description (self <atk-table>) (column int) ⇒  (ret mchars)
— Method: get-column-description

Gets the description text of the specified column in the table

table
a GObject instance that implements AtkTableIface
column
a <gint> representing a column in table
ret
a gchar* representing the column description, or ‘#f’ if value does not implement this interface.
— Function: atk-table-get-row-description (self <atk-table>) (row int) ⇒  (ret mchars)
— Method: get-row-description

Gets the description text of the specified row in the table

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
ret
a gchar* representing the row description, or ‘#f’ if value does not implement this interface.
— Function: atk-table-get-column-header (self <atk-table>) (column int) ⇒  (ret <atk-object>)
— Method: get-column-header

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

table
a GObject instance that implements AtkTableIface
column
a <gint> representing a column in the table
ret
a AtkObject* representing the specified column header, or ‘#f’ if value does not implement this interface.
— Function: atk-table-get-row-header (self <atk-table>) (row int) ⇒  (ret <atk-object>)
— Method: get-row-header

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

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in the table
ret
a AtkObject* representing the specified row header, or ‘#f’ if value does not implement this interface.
— Function: atk-table-get-summary (self <atk-table>) ⇒  (ret <atk-object>)
— Method: get-summary

Gets the summary description of the table.

table
a GObject instance that implements AtkTableIface
ret
a AtkObject* representing a summary description of the table, or zero if value does not implement this interface.
— Function: atk-table-set-caption (self <atk-table>) (caption <atk-object>)
— Method: set-caption

Sets the caption for the table.

table
a GObject instance that implements AtkTableIface
caption
a <atk-object> representing the caption to set for table
— Function: atk-table-set-row-description (self <atk-table>) (row int) (description mchars)
— Method: set-row-description

Sets the description text for the specified row of table.

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
description
a <gchar> representing the description text to set for the specified row of table
— Function: atk-table-set-column-description (self <atk-table>) (column int) (description mchars)
— Method: set-column-description

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

table
a GObject instance that implements AtkTableIface
column
a <gint> representing a column in table
description
a <gchar> representing the description text to set for the specified column of the table
— Function: atk-table-set-row-header (self <atk-table>) (row int) (header <atk-object>)
— Method: set-row-header

Sets the specified row header to header.

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
header
an <atk-table>
— Function: atk-table-set-column-header (self <atk-table>) (column int) (header <atk-object>)
— Method: set-column-header

Sets the specified column header to header.

table
a GObject instance that implements AtkTableIface
column
a <gint> representing a column in table
header
an <atk-table>
— Function: atk-table-set-summary (self <atk-table>) (accessible <atk-object>)
— Method: set-summary

Sets the summary description of the table.

table
a GObject instance that implements AtkTableIface
accessible
an <atk-object> representing the summary description to set for table
— Function: atk-table-is-column-selected (self <atk-table>) (column int) ⇒  (ret bool)
— Method: is-column-selected

Gets a boolean value indicating whether the specified column is selected

table
a GObject instance that implements AtkTableIface
column
a <gint> representing a column in table
ret
a gboolean representing if the column is selected, or 0 if value does not implement this interface.
— Function: atk-table-is-row-selected (self <atk-table>) (row int) ⇒  (ret bool)
— Method: is-row-selected

Gets a boolean value indicating whether the specified row is selected

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
ret
a gboolean representing if the row is selected, or 0 if value does not implement this interface.
— Function: atk-table-is-selected (self <atk-table>) (row int) (column int) ⇒  (ret bool)
— Method: is-selected

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

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
column
a <gint> representing a column in table
ret
a gboolean representing if the cell is selected, or 0 if value does not implement this interface.
— Function: atk-table-add-column-selection (self <atk-table>) (column int) ⇒  (ret bool)
— Method: add-column-selection

Adds the specified column to the selection.

table
a GObject instance that implements AtkTableIface
column
a <gint> representing a column in table
ret
a gboolean representing if the column was successfully added to the selection, or 0 if value does not implement this interface.
— Function: atk-table-add-row-selection (self <atk-table>) (row int) ⇒  (ret bool)
— Method: add-row-selection

Adds the specified row to the selection.

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
ret
a gboolean representing if row was successfully added to selection, or 0 if value does not implement this interface.
— Function: atk-table-remove-column-selection (self <atk-table>) (column int) ⇒  (ret bool)
— Method: remove-column-selection

Adds the specified column to the selection.

table
a GObject instance that implements AtkTableIface
column
a <gint> representing a column in table
ret
a gboolean representing if the column was successfully removed from the selection, or 0 if value does not implement this interface.
— Function: atk-table-remove-row-selection (self <atk-table>) (row int) ⇒  (ret bool)
— Method: remove-row-selection

Removes the specified row from the selection.

table
a GObject instance that implements AtkTableIface
row
a <gint> representing a row in table
ret
a gboolean representing if the row was successfully removed from the selection, or 0 if value does not implement this interface.