atktable.xml

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

<para>
Adds the specified <parameter>column</parameter> to the selection.</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 gboolean representing if the column was successfully added to 
the selection, or 0 if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-add-row-selection" role="function">
<title>atk_table_add_row_selection ()</title>
<indexterm zone="atk-table-add-row-selection"><primary>atk_table_add_row_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_table_add_row_selection         (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Adds the specified <parameter>row</parameter> to the selection.</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 gboolean representing if row was successfully added to selection,
or 0 if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-remove-column-selection" role="function">
<title>atk_table_remove_column_selection ()</title>
<indexterm zone="atk-table-remove-column-selection"><primary>atk_table_remove_column_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_table_remove_column_selection   (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> column);</programlisting>
<para>
Adds the specified <parameter>column</parameter> to the selection.</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 gboolean representing if the column was successfully removed from
the selection, or 0 if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-table-remove-row-selection" role="function">
<title>atk_table_remove_row_selection ()</title>
<indexterm zone="atk-table-remove-row-selection"><primary>atk_table_remove_row_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_table_remove_row_selection      (<link linkend="AtkTable">AtkTable</link> *table,
                                                         <link linkend="gint">gint</link> row);</programlisting>
<para>
Removes the specified <parameter>row</parameter> from the selection.</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 gboolean representing if the row was successfully removed from
the selection, or 0 if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="AtkTable.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="AtkTable-column-deleted"><title>The <literal>&quot;column-deleted&quot;</literal> signal</title>
<indexterm zone="AtkTable-column-deleted"><primary>AtkTable::column-deleted</primary></indexterm><programlisting><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)      : Run Last</programlisting>
<para>
The "column-deleted" signal is emitted by an object which implements the 
AtkTable interface when a column is deleted.
</para><variablelist role="params">
<varlistentry><term><parameter>atktable</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>The index of the first column deleted.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>The number of columns deleted.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="AtkTable-column-inserted"><title>The <literal>&quot;column-inserted&quot;</literal> signal</title>
<indexterm zone="AtkTable-column-inserted"><primary>AtkTable::column-inserted</primary></indexterm><programlisting><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)      : Run Last</programlisting>
<para>
The "column-inserted" signal is emitted by an object which implements the 
AtkTable interface when a column is inserted.

</para><variablelist role="params">
<varlistentry><term><parameter>atktable</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>The index of the column inserted.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>The number of colums inserted.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="AtkTable-column-reordered"><title>The <literal>&quot;column-reordered&quot;</literal> signal</title>
<indexterm zone="AtkTable-column-reordered"><primary>AtkTable::column-reordered</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last</programlisting>
<para>
The "column-reordered" signal is emitted by an object which implements the 
AtkTable interface when the columns are reordered.
</para><variablelist role="params">
<varlistentry><term><parameter>atktable</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="AtkTable-model-changed"><title>The <literal>&quot;model-changed&quot;</literal> signal</title>
<indexterm zone="AtkTable-model-changed"><primary>AtkTable::model-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last</programlisting>
<para>
The "model-changed" signal is emitted by an object which implements the 
AtkTable interface when the model displayed by the table changes.
</para><variablelist role="params">
<varlistentry><term><parameter>atktable</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="AtkTable-row-deleted"><title>The <literal>&quot;row-deleted&quot;</literal> signal</title>
<indexterm zone="AtkTable-row-deleted"><primary>AtkTable::row-deleted</primary></indexterm><programlisting><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)      : Run Last</programlisting>
<para>
The "row-deleted" signal is emitted by an object which implements the 
AtkTable interface when a column is inserted.

</para><variablelist role="params">
<varlistentry><term><parameter>atktable</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>The index of the first row deleted.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>The number of rows deleted.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="AtkTable-row-inserted"><title>The <literal>&quot;row-inserted&quot;</literal> signal</title>
<indexterm zone="AtkTable-row-inserted"><primary>AtkTable::row-inserted</primary></indexterm><programlisting><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)      : Run Last</programlisting>
<para>
The "row-inserted" signal is emitted by an object which implements the 
AtkTable interface when a column is inserted.
</para><variablelist role="params">
<varlistentry><term><parameter>atktable</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>The index of the first row deleted.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>The number of rows deleted.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="AtkTable-row-reordered"><title>The <literal>&quot;row-reordered&quot;</literal> signal</title>
<indexterm zone="AtkTable-row-reordered"><primary>AtkTable::row-reordered</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkTable">AtkTable</link> *atktable,
                                                        <link linkend="gpointer">gpointer</link>  user_data)      : Run Last</programlisting>
<para>
The "row-reordered" signal is emitted by an object which implements the 
AtkTable interface when the columns are reordered.
</para><variablelist role="params">
<varlistentry><term><parameter>atktable</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>


<refsect1 id="AtkTable.see-also">
<title>See Also</title>
<para>
<link linkend="AtkObject"><type>AtkObject</type></link>, <link linkend="ATK-STATE-TRANSIENT:CAPS"><type>ATK_STATE_TRANSIENT</type></link>
</para>
</refsect1>

</refentry>