atktable.xml

The ATK library provides a set of interfaces for accessibility.By supporting the ATK interfaces, an

<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a gint representing the column at the specified index,
or -1 if the table does not implement this interface
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-row-at-index" role="function">
<title>atk_table_get_row_at_index ()</title>
<indexterm zone="atk-table-get-row-at-index"><primary>atk_table_get_row_at_index</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_table_get_row_at_index          (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> index_);</programlisting>
<para>
Gets a <link linkend="gint"><type>gint</type></link> representing the row at the specified <parameter>index_</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>table</parameter>&nbsp;:</term>
<listitem><simpara> a GObject instance that implements AtkTableInterface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gint"><type>gint</type></link> representing an index in <parameter>table</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a gint representing the row at the specified index,
or -1 if the table does not implement this interface
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-n-columns" role="function">
<title>atk_table_get_n_columns ()</title>
<indexterm zone="atk-table-get-n-columns"><primary>atk_table_get_n_columns</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_table_get_n_columns             (<link linkend="AtkTable">AtkTable</link> *table);</programlisting>
<para>
Gets the number of columns in the table.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a gint representing the number of columns, or 0
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-n-rows" role="function">
<title>atk_table_get_n_rows ()</title>
<indexterm zone="atk-table-get-n-rows"><primary>atk_table_get_n_rows</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_table_get_n_rows                (<link linkend="AtkTable">AtkTable</link> *table);</programlisting>
<para>
Gets the number of rows in the table.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a gint representing the number of rows, or 0
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-column-extent-at" role="function">
<title>atk_table_get_column_extent_at ()</title>
<indexterm zone="atk-table-get-column-extent-at"><primary>atk_table_get_column_extent_at</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_table_get_column_extent_at      (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> row,
                                                         <link linkend="gint">gint</link> column);</programlisting>
<para>
Gets the number of columns occupied by the accessible object
at the specified <parameter>row</parameter> and <parameter>column</parameter> in the <parameter>table</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>&nbsp;:</term><listitem><simpara> a gint representing the column extent at specified position, or 0
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-row-extent-at" role="function">
<title>atk_table_get_row_extent_at ()</title>
<indexterm zone="atk-table-get-row-extent-at"><primary>atk_table_get_row_extent_at</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_table_get_row_extent_at         (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> row,
                                                         <link linkend="gint">gint</link> column);</programlisting>
<para>
Gets the number of rows occupied by the accessible object
at a specified <parameter>row</parameter> and <parameter>column</parameter> in the <parameter>table</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>&nbsp;:</term><listitem><simpara> a gint representing the row extent at specified position, or 0
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-caption" role="function">
<title>atk_table_get_caption ()</title>
<indexterm zone="atk-table-get-caption"><primary>atk_table_get_caption</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_table_get_caption               (<link linkend="AtkTable">AtkTable</link> *table);</programlisting>
<para>
Gets the caption for the <parameter>table</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>table</parameter>&nbsp;:</term>
<listitem><simpara> a GObject instance that implements AtkTableInterface
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a AtkObject* representing the table caption, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-column-description" role="function">
<title>atk_table_get_column_description ()</title>
<indexterm zone="atk-table-get-column-description"><primary>atk_table_get_column_description</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_table_get_column_description    (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> column);</programlisting>
<para>
Gets the description text of the specified <parameter>column</parameter> in the table</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>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>&nbsp;:</term><listitem><simpara> a gchar* representing the column description, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-row-description" role="function">
<title>atk_table_get_row_description ()</title>
<indexterm zone="atk-table-get-row-description"><primary>atk_table_get_row_description</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_table_get_row_description       (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Gets the description text of the specified row in the table</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a gchar* representing the row description, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-column-header" role="function">
<title>atk_table_get_column_header ()</title>
<indexterm zone="atk-table-get-column-header"><primary>atk_table_get_column_header</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_table_get_column_header         (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> column);</programlisting>
<para>
Gets the column header of a specified column in an accessible table.</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>column</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gint"><type>gint</type></link> representing a column in the table
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a AtkObject* representing the specified column header, or
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-row-header" role="function">
<title>atk_table_get_row_header ()</title>
<indexterm zone="atk-table-get-row-header"><primary>atk_table_get_row_header</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_table_get_row_header            (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Gets the row header of a specified row in an accessible table.</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 the table
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a AtkObject* representing the specified row header, or
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-get-summary" role="function">
<title>atk_table_get_summary ()</title>
<indexterm zone="atk-table-get-summary"><primary>atk_table_get_summary</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_table_get_summary               (<link linkend="AtkTable">AtkTable</link> *table);</programlisting>
<para>
Gets the summary description of the table.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a AtkObject* representing a summary description of the table,
or zero if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-set-caption" role="function">
<title>atk_table_set_caption ()</title>
<indexterm zone="atk-table-set-caption"><primary>atk_table_set_caption</primary></indexterm><programlisting><link linkend="void">void</link>                atk_table_set_caption               (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="AtkObject">AtkObject</link> *caption);</programlisting>
<para>
Sets the caption for the table.</para>
<para>