path: root/docs/tmpl/atktable.sgml

<!-- ##### SECTION Title ##### -->
AtkTable

<!-- ##### SECTION Short_Description ##### -->
The ATK interface implemented for UI components which contain tabular or
row/column information.

<!-- ##### SECTION Long_Description ##### -->
<para>
#AtkTable 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 #AtkTable are
typically referred to as "cells", and these cells are exposed by
#AtkTable as child #AtkObjects of the #AtkTable.  Both row/column and
child-index-based access to these children is provided.
</para>
<para>
Children of #AtkTable are frequently "lightweight" objects, that is,
they may not have backing widgets in the host UI toolkit.  They are
therefore often transient.
</para>
<para>
Since tables are often very complex, #AtkTable includes provision for
offering simplified summary information, as well as row and column
headers and captions.  Headers and captions are #AtkObjects which may
implement other interfaces (#AtkText, #AtkImage, etc.) as appropriate.
#AtkTable summaries may themselves be (simplified) #AtkTables, etc.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#AtkObject, #ATK_STATE_TRANSIENT
</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### SECTION Image ##### -->


<!-- ##### STRUCT AtkTable ##### -->
<para>
The AtkTable structure does not contain any fields.

</para>


<!-- ##### SIGNAL AtkTable::column-deleted ##### -->
<para>
The "column-deleted" signal is emitted by an object which implements the 
AtkTable interface when a column is deleted.
</para>

@atktable: the object which received the signal.
@arg1: The index of the first column deleted.
@arg2: The number of columns deleted.

<!-- ##### SIGNAL AtkTable::column-inserted ##### -->
<para>
The "column-inserted" signal is emitted by an object which implements the 
AtkTable interface when a column is inserted.

</para>

@atktable: the object which received the signal.
@arg1: The index of the column inserted.
@arg2: The number of colums inserted.

<!-- ##### SIGNAL AtkTable::column-reordered ##### -->
<para>
The "column-reordered" signal is emitted by an object which implements the 
AtkTable interface when the columns are reordered.
</para>

@atktable: the object which received the signal.

<!-- ##### SIGNAL AtkTable::model-changed ##### -->
<para>
The "model-changed" signal is emitted by an object which implements the 
AtkTable interface when the model displayed by the table changes.
</para>

@atktable: the object which received the signal.

<!-- ##### SIGNAL AtkTable::row-deleted ##### -->
<para>
The "row-deleted" signal is emitted by an object which implements the 
AtkTable interface when a column is inserted.

</para>

@atktable: the object which received the signal.
@arg1: The index of the first row deleted.
@arg2: The number of rows deleted.

<!-- ##### SIGNAL AtkTable::row-inserted ##### -->
<para>
The "row-inserted" signal is emitted by an object which implements the 
AtkTable interface when a column is inserted.
</para>

@atktable: the object which received the signal.
@arg1: The index of the first row deleted.
@arg2: The number of rows deleted.

<!-- ##### SIGNAL AtkTable::row-reordered ##### -->
<para>
The "row-reordered" signal is emitted by an object which implements the 
AtkTable interface when the columns are reordered.
</para>

@atktable: the object which received the signal.

<!-- ##### FUNCTION atk_table_ref_at ##### -->
<para>

</para>

@table: 
@row: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_index_at ##### -->
<para>

</para>

@table: 
@row: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_column_at_index ##### -->
<para>

</para>

@table: 
@index_: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_row_at_index ##### -->
<para>

</para>

@table: 
@index_: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_n_columns ##### -->
<para>

</para>

@table: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_n_rows ##### -->
<para>

</para>

@table: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_column_extent_at ##### -->
<para>

</para>

@table: 
@row: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_row_extent_at ##### -->
<para>

</para>

@table: 
@row: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_caption ##### -->
<para>

</para>

@table: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_column_description ##### -->
<para>

</para>

@table: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_row_description ##### -->
<para>

</para>

@table: 
@row: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_column_header ##### -->
<para>

</para>

@table: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_row_header ##### -->
<para>

</para>

@table: 
@row: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_summary ##### -->
<para>

</para>

@table: 
@Returns: 


<!-- ##### FUNCTION atk_table_set_caption ##### -->
<para>

</para>

@table: 
@caption: 


<!-- ##### FUNCTION atk_table_set_row_description ##### -->
<para>

</para>

@table: 
@row: 
@description: 


<!-- ##### FUNCTION atk_table_set_column_description ##### -->
<para>

</para>

@table: 
@column: 
@description: 


<!-- ##### FUNCTION atk_table_set_row_header ##### -->
<para>

</para>

@table: 
@row: 
@header: 


<!-- ##### FUNCTION atk_table_set_column_header ##### -->
<para>

</para>

@table: 
@column: 
@header: 


<!-- ##### FUNCTION atk_table_set_summary ##### -->
<para>

</para>

@table: 
@accessible: 


<!-- ##### FUNCTION atk_table_get_selected_columns ##### -->
<para>

</para>

@table: 
@selected: 
@Returns: 


<!-- ##### FUNCTION atk_table_get_selected_rows ##### -->
<para>

</para>

@table: 
@selected: 
@Returns: 


<!-- ##### FUNCTION atk_table_is_column_selected ##### -->
<para>

</para>

@table: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_is_row_selected ##### -->
<para>

</para>

@table: 
@row: 
@Returns: 


<!-- ##### FUNCTION atk_table_is_selected ##### -->
<para>

</para>

@table: 
@row: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_add_column_selection ##### -->
<para>

</para>

@table: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_add_row_selection ##### -->
<para>

</para>

@table: 
@row: 
@Returns: 


<!-- ##### FUNCTION atk_table_remove_column_selection ##### -->
<para>

</para>

@table: 
@column: 
@Returns: 


<!-- ##### FUNCTION atk_table_remove_row_selection ##### -->
<para>

</para>

@table: 
@row: 
@Returns: