<?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-atkdocument">

  <refnamediv>
    <refname>atk.Document</refname>
      <refpurpose>the ATK interface which allows access to a DOM associated
      with on object.  </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>atk.Document</classname></ooclass>
      <ooclass><classname>gobject.GInterface</classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkdocument--get-document-type">get_document_type</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
<!-- NOT IMPLEMENTED
      <methodsynopsis language="python">
        <methodname><link linkend="method-atkdocument- -get-document">get_document</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
END -->
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
    linkend="class-atkdocument"><classname>atk.Document</classname></link>
    interface should be supported by any object that has an associated
    document object model (DOM). This interface provides the standard
    mechanism allowing an assistive technology access to the DOM.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-atkdocument--get-document-type">
      <title>atk.Document.get_document_type</title>

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

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a string indicating the document type</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets a string indicating the document type.</para>

    </refsect2>

<!-- NOT IMPLEMENTED
    <refsect2 id="method-atkdocument- -get-document">
      <title>atk.Document.get_document</title>

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

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <literal>gpointer</literal> that points to an instance of the DOM.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>Gets a <literal>gpointer</literal> that points to an instance of the DOM.  It is
      up to the caller to check atk_document_get_type to determine
      how to cast this pointer.</para>

    </refsect2>
END -->

  </refsect1>

</refentry>
