The ATK interface implemented for UI components which contain tabular or row/column information.
<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.
<gint>
) (arg1 <gint>
)The "row-inserted" signal is emitted by an object which implements the AtkTable interface when a column is inserted.
<gint>
) (arg1 <gint>
)The "column-inserted" signal is emitted by an object which implements the AtkTable interface when a column is inserted.
<gint>
) (arg1 <gint>
)The "row-deleted" signal is emitted by an object which implements the AtkTable interface when a column is inserted.
<gint>
) (arg1 <gint>
)The "column-deleted" signal is emitted by an object which implements the AtkTable interface when a column is deleted.
The "row-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered.
The "column-reordered" signal is emitted by an object which implements the AtkTable interface when the columns are reordered.
The "model-changed" signal is emitted by an object which implements the AtkTable interface when the model displayed by the table changes.
<atk-table>
) (row int
) (column int
) ⇒ (ret <atk-object>
)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
<atk-table>
) (row int
) (column int
) ⇒ (ret int
)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.
<atk-table>
) (index_ int
) ⇒ (ret int
)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
<atk-table>
) (index_ int
) ⇒ (ret int
)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
<atk-table>
) ⇒ (ret int
)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.
<atk-table>
) ⇒ (ret int
)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.
<atk-table>
) (row int
) (column int
) ⇒ (ret int
)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.
<atk-table>
) (row int
) (column int
) ⇒ (ret int
)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.
<atk-table>
) ⇒ (ret <atk-object>
)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.
<atk-table>
) (column int
) ⇒ (ret mchars
)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.
<atk-table>
) (row int
) ⇒ (ret mchars
)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.
<atk-table>
) (column int
) ⇒ (ret <atk-object>
)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.
<atk-table>
) (row int
) ⇒ (ret <atk-object>
)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.
<atk-table>
) ⇒ (ret <atk-object>
)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.
<atk-table>
) (caption <atk-object>
)Sets the caption for the table.
- table
- a GObject instance that implements AtkTableIface
- caption
- a
<atk-object>
representing the caption to set for table
<atk-table>
) (row int
) (description mchars
)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
<atk-table>
) (column int
) (description mchars
)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
<atk-table>
) (row int
) (header <atk-object>
)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>
<atk-table>
) (column int
) (header <atk-object>
)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>
<atk-table>
) (accessible <atk-object>
)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
<atk-table>
) (column int
) ⇒ (ret bool
)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.
<atk-table>
) (row int
) ⇒ (ret bool
)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.
<atk-table>
) (row int
) (column int
) ⇒ (ret bool
)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.
<atk-table>
) (column int
) ⇒ (ret bool
)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.
<atk-table>
) (row int
) ⇒ (ret bool
)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.
<atk-table>
) (column int
) ⇒ (ret bool
)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.
<atk-table>
) (row int
) ⇒ (ret bool
)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.