<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-atktable">

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

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>atk.Table</classname></ooclass>
      <ooclass><classname>gobject.GInterface</classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--ref-at">ref_at</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-index-at">get_index_at</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-column-at-index">get_column_at_index</link></methodname>
        <methodparam><parameter role="keyword">index</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-row-at-index">get_row_at_index</link></methodname>
        <methodparam><parameter role="keyword">index</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-n-columns">get_n_columns</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-n-rows">get_n_rows</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-column-extent-at">get_column_extent_at</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-row-extent-at">get_row_extent_at</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-caption">get_caption</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-column-description">get_column_description</link></methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-column-header">get_column_header</link></methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-row-description">get_row_description</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-row-header">get_row_header</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-summary">get_summary</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--set-caption">set_caption</link></methodname>
        <methodparam><parameter role="keyword">caption</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--set-column-description">set_column_description</link></methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
        <methodparam><parameter role="keyword">description</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--set-column-header">set_column_header</link></methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
        <methodparam><parameter role="keyword">header</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--set-row-description">set_row_description</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">description</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--set-row-header">set_row_header</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">header</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--set-summary">set_summary</link></methodname>
        <methodparam><parameter role="keyword">accessible</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-selected-columns">get_selected_columns</link></methodname>
        <methodparam><parameter role="keyword">selected</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--get-selected-rows">get_selected_rows</link></methodname>
        <methodparam><parameter role="keyword">selected</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--is-column-selected">is_column_selected</link></methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--is-row-selected">is_row_selected</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--is-selected">is_selected</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--add-row-selection">add_row_selection</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--remove-row-selection">remove_row_selection</link></methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--add-column-selection">add_column_selection</link></methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atktable--remove-column-selection">remove_column_selection</link></methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1 id="signal-prototypes-atktable">
    <title>atk.Table Signal Prototypes</title>


      <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-atktable--column-deleted">column-deleted</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>column</parameter></methodparam>
            <methodparam><parameter>count</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-atktable--column-inserted">column-inserted</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>column</parameter></methodparam>
            <methodparam><parameter>count</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-atktable--column-reordered">column-reordered</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-atktable--model-changed">model-changed</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-atktable--row-deleted">row-deleted</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>row</parameter></methodparam>
            <methodparam><parameter>count</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-atktable--row-inserted">row-inserted</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>row</parameter></methodparam>
            <methodparam><parameter>count</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-atktable--row-reordered">row-reordered</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link
    linkend="class-atktable"><classname>atk.Table</classname></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="class-atktable"><classname>atk.Table</classname></link> are
    typically referred to as "cells", and these cells are exposed by <link
    linkend="class-atktable"><classname>atk.Table</classname></link> as
    child <link
    linkend="class-atkobject"><classname>atk.Object</classname></link>
    objects of the <link
    linkend="class-atktable"><classname>atk.Table</classname></link>.  Both
    row/column and child-index-based access to these children is
    provided.</para>

    <para>Children of <link
    linkend="class-atktable"><classname>atk.Table</classname></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="class-atktable"><classname>atk.Table</classname></link>
    includes provision for offering simplified summary information, as well
    as row and column headers and captions.  Headers and captions are <link
    linkend="class-atkobject"><classname>atk.Object</classname></link>
    objects which may implement other interfaces (<link
    linkend="class-atktext"><classname>atk.Text</classname></link>, <link
    linkend="class-atkimage"><classname>atk.Image</classname></link>, etc.)
    as appropriate.  <link
    linkend="class-atktable"><classname>atk.Table</classname></link>
    summaries may themselves be (simplified) <link
    linkend="class-atktable"><classname>atk.Table</classname></link>
    objects, etc.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-atktable--ref-at">
      <title>atk.Table.ref_at</title>

      <programlisting><methodsynopsis language="python">
        <methodname>ref_at</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          <parameter>table</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          <parameter>table</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          representing the referred to accessible</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Get a reference to the table cell at <parameter>row</parameter>,
      <parameter>column</parameter>.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-index-at">
      <title>atk.Table.get_index_at</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_index_at</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          <parameter>table</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          <parameter>table</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an index representing the index at specified
          position</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets 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>

    </refsect2>

    <refsect2 id="method-atktable--get-column-at-index">
      <title>atk.Table.get_column_at_index</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_column_at_index</methodname>
        <methodparam><parameter role="keyword">index</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">index</parameter>&nbsp;:</term>
          <listitem><simpara></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an integer representing the column at the
          specified index.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets an index representing the column at the specified
      <parameter>index</parameter>, or -1 if the table does not implement
      this interface</para>

    </refsect2>

    <refsect2 id="method-atktable--get-row-at-index">
      <title>atk.Table.get_row_at_index</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_row_at_index</methodname>
        <methodparam><parameter role="keyword">index</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">index</parameter>&nbsp;:</term>
          <listitem><simpara></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an integer representing the row at the
          specified index.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets an index representing the row at the specified
      <parameter>index</parameter>, or -1 if the table does not implement
      this interface</para>

    </refsect2>

    <refsect2 id="method-atktable--get-n-columns">
      <title>atk.Table.get_n_columns</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_n_columns</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an integer representing the number of columns,
          or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the number of columns in the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-n-rows">
      <title>atk.Table.get_n_rows</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_n_rows</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an integer representing the number of rows, or
          0 if value does not implement this interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the number of rows in the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-column-extent-at">
      <title>atk.Table.get_column_extent_at</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_column_extent_at</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          <parameter>table</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          <parameter>table</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an integer representing the column extent at
          specified position, or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the number of columns occupied by the accessible object at
      the specified <parameter>row</parameter> and
      <parameter>column</parameter>.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-row-extent-at">
      <title>atk.Table.get_row_extent_at</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_row_extent_at</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          <parameter>table</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          <parameter>table</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>an integer representing the row extent at
          specified position, or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the number of rows occupied by the accessible object at a
      specified <parameter>row</parameter> and
      <parameter>column</parameter>.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-caption">
      <title>atk.Table.get_caption</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_caption</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          representing the table caption, or <literal>None</literal> if
          value does not implement this interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the caption for the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-column-description">
      <title>atk.Table.get_column_description</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_column_description</methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in the
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a string representing the column description,
          or <literal>None</literal> if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the description text of the specified
      <parameter>column</parameter> in the table</para>

    </refsect2>

    <refsect2 id="method-atktable--get-column-header">
      <title>atk.Table.get_column_header</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_column_header</methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in the
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          representing the specified column header, or
          <literal>None</literal> if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the column header of a specified column in an accessible
      table.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-row-description">
      <title>atk.Table.get_row_description</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_row_description</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a string representing the row description, or
          <literal>None</literal> if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the description text of the specified row in the
      table</para>

    </refsect2>

    <refsect2 id="method-atktable--get-row-header">
      <title>atk.Table.get_row_header</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_row_header</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in the
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          representing the specified row header, or <literal>None</literal>
          if value does not implement this interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the row header of a specified row in an accessible
      table.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-summary">
      <title>atk.Table.get_summary</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_summary</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          representing a summary description of the table, or zero if value
          does not implement this interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the summary description of the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--set-caption">
      <title>atk.Table.set_caption</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_caption</methodname>
        <methodparam><parameter role="keyword">caption</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">caption</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          representing the caption to set for table</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the caption for the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--set-column-description">
      <title>atk.Table.set_column_description</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_column_description</methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
        <methodparam><parameter role="keyword">description</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">description</parameter>&nbsp;:</term>
          <listitem><simpara>a string representing the description text to
          set for the specified <parameter>column</parameter> of the
          table</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the description text for the specified
      <parameter>column</parameter> of the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--set-column-header">
      <title>atk.Table.set_column_header</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_column_header</methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
        <methodparam><parameter role="keyword">header</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">header</parameter>&nbsp;:</term>
          <listitem><simpara>an <link
          linkend="class-atktable"><classname>atk.Table</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the specified column header to
      <parameter>header</parameter>.</para>

    </refsect2>

    <refsect2 id="method-atktable--set-row-description">
      <title>atk.Table.set_row_description</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_row_description</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">description</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">description</parameter>&nbsp;:</term>
          <listitem><simpara>a string representing the description text to
          set for the specified <parameter>row</parameter> of
          table</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the description text for the specified
      <parameter>row</parameter> of table.</para>

    </refsect2>

    <refsect2 id="method-atktable--set-row-header">
      <title>atk.Table.set_row_header</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_row_header</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">header</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">header</parameter>&nbsp;:</term>
          <listitem><simpara>an <link
          linkend="class-atktable"><classname>atk.Table</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the specified row header to
      <parameter>header</parameter>.</para>

    </refsect2>

    <refsect2 id="method-atktable--set-summary">
      <title>atk.Table.set_summary</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_summary</methodname>
        <methodparam><parameter role="keyword">accessible</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">accessible</parameter>&nbsp;:</term>
          <listitem><simpara>an <link
          linkend="class-atkobject"><classname>atk.Object</classname></link>
          representing the summary description to set for
          table</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Sets the summary description of the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-selected-columns">
      <title>atk.Table.get_selected_columns</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_selected_columns</methodname>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a tuple containing the indices ofthe selected
          columns.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the selected columns of the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--get-selected-rows">
      <title>atk.Table.get_selected_rows</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_selected_rows</methodname>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a tuple containing the indices ofthe selected
          rows.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets the selected rows of the table.</para>

    </refsect2>

    <refsect2 id="method-atktable--is-column-selected">
      <title>atk.Table.is_column_selected</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_column_selected</methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the column is
          selected, or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets a boolean value indicating whether the specified
      <parameter>column</parameter> is selected</para>

    </refsect2>

    <refsect2 id="method-atktable--is-row-selected">
      <title>atk.Table.is_row_selected</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_row_selected</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the row is selected,
          or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets a boolean value indicating whether the specified
      <parameter>row</parameter> is selected</para>

    </refsect2>

    <refsect2 id="method-atktable--is-selected">
      <title>atk.Table.is_selected</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_selected</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the cell is
          selected, or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets a boolean value indicating whether the accessible object at
      the specified <parameter>row</parameter> and
      <parameter>column</parameter> is selected</para>

    </refsect2>

    <refsect2 id="method-atktable--add-row-selection">
      <title>atk.Table.add_row_selection</title>

      <programlisting><methodsynopsis language="python">
        <methodname>add_row_selection</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if
          <parameter>row</parameter> was successfully added to selection, or
          0 if value does not implement this interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Adds the specified <parameter>row</parameter> to the
      selection.</para>

    </refsect2>

    <refsect2 id="method-atktable--remove-row-selection">
      <title>atk.Table.remove_row_selection</title>

      <programlisting><methodsynopsis language="python">
        <methodname>remove_row_selection</methodname>
        <methodparam><parameter role="keyword">row</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">row</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a row in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if
          <parameter>row</parameter> was successfully removed from the
          selection, or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Removes the specified <parameter>row</parameter> from the
      selection.</para>

    </refsect2>

    <refsect2 id="method-atktable--add-column-selection">
      <title>atk.Table.add_column_selection</title>

      <programlisting><methodsynopsis language="python">
        <methodname>add_column_selection</methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if
          <parameter>column</parameter> was successfully added to the
          selection, or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Adds the specified <parameter>column</parameter> to the
      selection.</para>

    </refsect2>

    <refsect2 id="method-atktable--remove-column-selection">
      <title>atk.Table.remove_column_selection</title>

      <programlisting><methodsynopsis language="python">
        <methodname>remove_column_selection</methodname>
        <methodparam><parameter role="keyword">column</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">column</parameter>&nbsp;:</term>
          <listitem><simpara>an index representing a column in
          table</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if
          <parameter>column</parameter> was successfully removed from the
          selection, or 0 if value does not implement this
          interface.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Adds the specified <parameter>column</parameter> to the
      selection.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-atktable--column-deleted">
      <title>The "column-deleted" atk.Table Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>arg1</parameter></methodparam>
            <methodparam><parameter>arg2</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>atktable</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>column</parameter>&nbsp;:</term>
          <listitem><simpara>The index of the first column deleted.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>count</parameter>&nbsp;:</term>
          <listitem><simpara>The number of columns deleted.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The "column-deleted" signal is emitted by an object which
      implements the <link
      linkend="class-atktable"><classname>atk.Table</classname></link>
      interface when a column is deleted.</para>

    </refsect2>

    <refsect2 id="signal-atktable--column-inserted">
      <title>The "column-inserted" atk.Table Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>column</parameter></methodparam>
            <methodparam><parameter>count</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>atktable</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>column</parameter>&nbsp;:</term>
          <listitem><simpara>The index of the column inserted.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>count</parameter>&nbsp;:</term>
          <listitem><simpara>The number of colums inserted.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The "column-inserted" signal is emitted by an object which
      implements the <link
      linkend="class-atktable"><classname>atk.Table</classname></link>
      interface when a column is inserted.</para>

    </refsect2>

    <refsect2 id="signal-atktable--column-reordered">
      <title>The "column-reordered" atk.Table Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>atktable</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The "column-reordered" signal is emitted by an object which
      implements the <link
      linkend="class-atktable"><classname>atk.Table</classname></link>
      interface when the columns are reordered.</para>

    </refsect2>

    <refsect2 id="signal-atktable--model-changed">
      <title>The "model-changed" atk.Table Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>atktable</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The "model-changed" signal is emitted by an object which
      implements the <link
      linkend="class-atktable"><classname>atk.Table</classname></link>
      interface when the model displayed by the table changes.</para>

    </refsect2>

    <refsect2 id="signal-atktable--row-deleted">
      <title>The "row-deleted" atk.Table Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>row</parameter></methodparam>
            <methodparam><parameter>count</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>atktable</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>row</parameter>&nbsp;:</term>
          <listitem><simpara>The index of the first row deleted.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>count</parameter>&nbsp;:</term>
          <listitem><simpara>The number of rows deleted.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The "row-deleted" signal is emitted by an object which
      implements the <link
      linkend="class-atktable"><classname>atk.Table</classname></link>
      interface when a column is inserted.</para>

    </refsect2>

    <refsect2 id="signal-atktable--row-inserted">
      <title>The "row-inserted" atk.Table Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>row</parameter></methodparam>
            <methodparam><parameter>count</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>atktable</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>row</parameter>&nbsp;:</term>
          <listitem><simpara>The index of the first row
          deleted.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>count</parameter>&nbsp;:</term>
          <listitem><simpara>The number of rows
          deleted.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The "row-inserted" signal is emitted by an object which
      implements the <link
      linkend="class-atktable"><classname>atk.Table</classname></link>
      interface when a column is inserted.</para>

    </refsect2>

    <refsect2 id="signal-atktable--row-reordered">
      <title>The "row-reordered" atk.Table Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>atktable</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>atktable</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

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

    </refsect2>

</refsect1>

</refentry>
