atktable.xml

linux下图形库开发包atk-1.4.0.tar.gz

<refentry id="AtkTable">
<refmeta>
<refentrytitle>AtkTable</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>AtkTable</refname><refpurpose>The ATK interface implemented for UI components which contain tabular or
row/column information.</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <link linkend="AtkTable-struct">AtkTable</link>;
<link linkend="AtkObject">AtkObject</link>*  <link linkend="atk-table-ref-at">atk_table_ref_at</link>                (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="gint">gint</link> column);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-index-at">atk_table_get_index_at</link>          (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="gint">gint</link> column);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-column-at-index">atk_table_get_column_at_index</link>   (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> index_);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-row-at-index">atk_table_get_row_at_index</link>      (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> index_);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-n-columns">atk_table_get_n_columns</link>         (<link linkend="AtkTable">AtkTable</link> *table);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-n-rows">atk_table_get_n_rows</link>            (<link linkend="AtkTable">AtkTable</link> *table);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-column-extent-at">atk_table_get_column_extent_at</link>  (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="gint">gint</link> column);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-row-extent-at">atk_table_get_row_extent_at</link>     (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="gint">gint</link> column);
<link linkend="AtkObject">AtkObject</link>*  <link linkend="atk-table-get-caption">atk_table_get_caption</link>           (<link linkend="AtkTable">AtkTable</link> *table);
G_CONST_RETURN <link linkend="gchar">gchar</link>* <link linkend="atk-table-get-column-description">atk_table_get_column_description</link>
                                            (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column);
G_CONST_RETURN <link linkend="gchar">gchar</link>* <link linkend="atk-table-get-row-description">atk_table_get_row_description</link>
                                            (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row);
<link linkend="AtkObject">AtkObject</link>*  <link linkend="atk-table-get-column-header">atk_table_get_column_header</link>     (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column);
<link linkend="AtkObject">AtkObject</link>*  <link linkend="atk-table-get-row-header">atk_table_get_row_header</link>        (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row);
<link linkend="AtkObject">AtkObject</link>*  <link linkend="atk-table-get-summary">atk_table_get_summary</link>           (<link linkend="AtkTable">AtkTable</link> *table);
<link linkend="void">void</link>        <link linkend="atk-table-set-caption">atk_table_set_caption</link>           (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="AtkObject">AtkObject</link> *caption);
<link linkend="void">void</link>        <link linkend="atk-table-set-row-description">atk_table_set_row_description</link>   (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             const <link linkend="gchar">gchar</link> *description);
<link linkend="void">void</link>        <link linkend="atk-table-set-column-description">atk_table_set_column_description</link>
                                            (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column,
                                             const <link linkend="gchar">gchar</link> *description);
<link linkend="void">void</link>        <link linkend="atk-table-set-row-header">atk_table_set_row_header</link>        (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="AtkObject">AtkObject</link> *header);
<link linkend="void">void</link>        <link linkend="atk-table-set-column-header">atk_table_set_column_header</link>     (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column,
                                             <link linkend="AtkObject">AtkObject</link> *header);
<link linkend="void">void</link>        <link linkend="atk-table-set-summary">atk_table_set_summary</link>           (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-selected-columns">atk_table_get_selected_columns</link>  (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> **selected);
<link linkend="gint">gint</link>        <link linkend="atk-table-get-selected-rows">atk_table_get_selected_rows</link>     (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> **selected);
<link linkend="gboolean">gboolean</link>    <link linkend="atk-table-is-column-selected">atk_table_is_column_selected</link>    (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column);
<link linkend="gboolean">gboolean</link>    <link linkend="atk-table-is-row-selected">atk_table_is_row_selected</link>       (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row);
<link linkend="gboolean">gboolean</link>    <link linkend="atk-table-is-selected">atk_table_is_selected</link>           (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="gint">gint</link> column);
<link linkend="gboolean">gboolean</link>    <link linkend="atk-table-add-column-selection">atk_table_add_column_selection</link>  (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column);
<link linkend="gboolean">gboolean</link>    <link linkend="atk-table-add-row-selection">atk_table_add_row_selection</link>     (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row);
<link linkend="gboolean">gboolean</link>    <link linkend="atk-table-remove-column-selection">atk_table_remove_column_selection</link>
                                            (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column);
<link linkend="gboolean">gboolean</link>    <link linkend="atk-table-remove-row-selection">atk_table_remove_row_selection</link>  (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GInterface">GInterface</link>
   +----AtkTable
</synopsis>

</refsect1>




<refsect1>
<title>Known Implementations</title>
<para>
AtkTable is implemented by
 <link linkend="AtkNoOpObject">AtkNoOpObject</link>.</para>

</refsect1>


<refsect1>
<title>Signal Prototypes</title>
<synopsis>

&quot;<link linkend="AtkTable-column-deleted">column-deleted</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                            <link linkend="gint">gint</link> arg1,
                                            <link linkend="gint">gint</link> arg2,
                                            <link linkend="gpointer">gpointer</link> user_data);
&quot;<link linkend="AtkTable-column-inserted">column-inserted</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                            <link linkend="gint">gint</link> arg1,
                                            <link linkend="gint">gint</link> arg2,
                                            <link linkend="gpointer">gpointer</link> user_data);
&quot;<link linkend="AtkTable-column-reordered">column-reordered</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                            <link linkend="gpointer">gpointer</link> user_data);
&quot;<link linkend="AtkTable-model-changed">model-changed</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                            <link linkend="gpointer">gpointer</link> user_data);
&quot;<link linkend="AtkTable-row-deleted">row-deleted</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                            <link linkend="gint">gint</link> arg1,
                                            <link linkend="gint">gint</link> arg2,
                                            <link linkend="gpointer">gpointer</link> user_data);
&quot;<link linkend="AtkTable-row-inserted">row-inserted</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                            <link linkend="gint">gint</link> arg1,
                                            <link linkend="gint">gint</link> arg2,
                                            <link linkend="gpointer">gpointer</link> user_data);
&quot;<link linkend="AtkTable-row-reordered">row-reordered</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                            <link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>


<refsect1>
<title>Description</title>
<para>
<link linkend="AtkTable"><type>AtkTable</type></link> 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 <link linkend="AtkTable"><type>AtkTable</type></link> are
typically referred to as "cells", and these cells are exposed by
<link linkend="AtkTable"><type>AtkTable</type></link> as child <link linkend="AtkObjects"><type>AtkObjects</type></link> of the <link linkend="AtkTable"><type>AtkTable</type></link>.  Both row/column and
child-index-based access to these children is provided.
</para>
<para>
Children of <link linkend="AtkTable"><type>AtkTable</type></link> 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, <link linkend="AtkTable"><type>AtkTable</type></link> includes provision for
offering simplified summary information, as well as row and column
headers and captions.  Headers and captions are <link linkend="AtkObjects"><type>AtkObjects</type></link> which may
implement other interfaces (<link linkend="AtkText"><type>AtkText</type></link>, <link linkend="AtkImage"><type>AtkImage</type></link>, etc.) as appropriate.
<link linkend="AtkTable"><type>AtkTable</type></link> summaries may themselves be (simplified) <link linkend="AtkTables"><type>AtkTables</type></link>, etc.
</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="AtkTable-struct"/>struct AtkTable</title>
<indexterm><primary>AtkTable</primary></indexterm><programlisting>struct AtkTable;</programlisting>
<para>
The AtkTable structure does not contain any fields.

</para></refsect2>
<refsect2>
<title><anchor id="atk-table-ref-at"/>atk_table_ref_at ()</title>
<indexterm><primary>atk_table_ref_at</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*  atk_table_ref_at                (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="gint">gint</link> column);</programlisting>
<para>
Get a reference to the table cell at <parameter>row</parameter>, <parameter>column</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>table</parameter>&nbsp;:</term>
<listitem><simpara> a GObject instance that implements AtkTableIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gint"><type>gint</type></link> representing a row in <parameter>table</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>column</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gint"><type>gint</type></link> representing a column in <parameter>table</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a AtkObject* representing the referred to accessible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-get-index-at"/>atk_table_get_index_at ()</title>
<indexterm><primary>atk_table_get_index_at</primary></indexterm><programlisting><link linkend="gint">gint</link>        atk_table_get_index_at          (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="gint">gint</link> column);</programlisting>
<para>
Gets a <link linkend="gint"><type>gint</type></link> representing the index at the specified <parameter>row</parameter> and <parameter>column</parameter>.
The value -1 is returned if the object at row,column is not a child
of table or table does not implement this interface.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>table</parameter>&nbsp;:</term>
<listitem><simpara> a GObject instance that implements AtkTableIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>row</parameter>&nbsp;:</term>