atktable.xml

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

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> :</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>
<title><anchor id="atk-table-set-caption"/>atk_table_set_caption ()</title>
<indexterm><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>

</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>caption</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="AtkObject"><type>AtkObject</type></link> representing the caption to set for <parameter>table</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-set-row-description"/>atk_table_set_row_description ()</title>
<indexterm><primary>atk_table_set_row_description</primary></indexterm><programlisting><link linkend="void">void</link>        atk_table_set_row_description   (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             const <link linkend="gchar">gchar</link> *description);</programlisting>
<para>
Sets the description text for the specified <parameter>row</parameter> of <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>description</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gchar"><type>gchar</type></link> representing the description text
to set for the specified <parameter>row</parameter> of <parameter>table</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-set-column-description"/>atk_table_set_column_description ()</title>
<indexterm><primary>atk_table_set_column_description</primary></indexterm><programlisting><link linkend="void">void</link>        atk_table_set_column_description
                                            (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column,
                                             const <link linkend="gchar">gchar</link> *description);</programlisting>
<para>
Sets the description text for the specified <parameter>column</parameter> of 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>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><parameter>description</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gchar"><type>gchar</type></link> representing the description text
to set for the specified <parameter>column</parameter> of the <parameter>table</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-set-row-header"/>atk_table_set_row_header ()</title>
<indexterm><primary>atk_table_set_row_header</primary></indexterm><programlisting><link linkend="void">void</link>        atk_table_set_row_header        (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="AtkObject">AtkObject</link> *header);</programlisting>
<para>
Sets the specified row header to <parameter>header</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>header</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkTable"><type>AtkTable</type></link> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-set-column-header"/>atk_table_set_column_header ()</title>
<indexterm><primary>atk_table_set_column_header</primary></indexterm><programlisting><link linkend="void">void</link>        atk_table_set_column_header     (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column,
                                             <link linkend="AtkObject">AtkObject</link> *header);</programlisting>
<para>
Sets the specified column header to <parameter>header</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>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><parameter>header</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkTable"><type>AtkTable</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-set-summary"/>atk_table_set_summary ()</title>
<indexterm><primary>atk_table_set_summary</primary></indexterm><programlisting><link linkend="void">void</link>        atk_table_set_summary           (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Sets 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><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link> representing the summary description
to set for <parameter>table</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-get-selected-columns"/>atk_table_get_selected_columns ()</title>
<indexterm><primary>atk_table_get_selected_columns</primary></indexterm><programlisting><link linkend="gint">gint</link>        atk_table_get_selected_columns  (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> **selected);</programlisting>
<para>
Gets the selected columns of the table by initializing **selected with 
the selected column numbers. This array should be freed by the caller.</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>selected</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gint"><type>gint</type></link>** that is to contain the selected columns numbers
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a gint representing the number of selected columns,
or <literal>0</literal> if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-get-selected-rows"/>atk_table_get_selected_rows ()</title>
<indexterm><primary>atk_table_get_selected_rows</primary></indexterm><programlisting><link linkend="gint">gint</link>        atk_table_get_selected_rows     (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> **selected);</programlisting>
<para>
Gets the selected rows of the table by initializing **selected with 
the selected row numbers. This array should be freed by the caller.</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>selected</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gint"><type>gint</type></link>** that is to contain the selected row numbers
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a gint representing the number of selected rows,
or zero if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-is-column-selected"/>atk_table_is_column_selected ()</title>
<indexterm><primary>atk_table_is_column_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_table_is_column_selected    (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> column);</programlisting>
<para>
Gets a boolean value indicating whether the specified <parameter>column</parameter>
is selected</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> :</term><listitem><simpara> a gboolean representing if the column is selected, or 0
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-is-row-selected"/>atk_table_is_row_selected ()</title>
<indexterm><primary>atk_table_is_row_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_table_is_row_selected       (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row);</programlisting>
<para>
Gets a boolean value indicating whether the specified <parameter>row</parameter>
is selected</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> :</term><listitem><simpara> a gboolean representing if the row is selected, or 0
if value does not implement this interface.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-table-is-selected"/>atk_table_is_selected ()</title>
<indexterm><primary>atk_table_is_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_table_is_selected           (<link linkend="AtkTable">AtkTable</link> *table,
                                             <link linkend="gint">gint</link> row,
                                             <link linkend="gint">gint</link> column);</programlisting>
<para>
Gets a boolean value indicating whether the accessible object
at the specified <parameter>row</parameter> and <parameter>column</parameter> is selected</para>
<para>

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