atkdocument.xml

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

<refentry id="AtkDocument">
<refmeta>
<refentrytitle role="top_of_page" id="AtkDocument.top_of_page">AtkDocument</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>AtkDocument</refname>
<refpurpose>The ATK interface which represents the toplevel container for document content.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="AtkDocument.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="AtkDocument-struct">AtkDocument</link>;
const <link linkend="gchar">gchar</link>*        <link linkend="atk-document-get-document-type">atk_document_get_document_type</link>      (<link linkend="AtkDocument">AtkDocument</link> *document);
<link linkend="gpointer">gpointer</link>            <link linkend="atk-document-get-document">atk_document_get_document</link>           (<link linkend="AtkDocument">AtkDocument</link> *document);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-document-get-attribute-value">atk_document_get_attribute_value</link>    (<link linkend="AtkDocument">AtkDocument</link> *document,
                                                         const <link linkend="gchar">gchar</link> *attribute_name);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-document-set-attribute-value">atk_document_set_attribute_value</link>    (<link linkend="AtkDocument">AtkDocument</link> *document,
                                                         const <link linkend="gchar">gchar</link> *attribute_name,
                                                         const <link linkend="gchar">gchar</link> *attribute_value);
<link linkend="AtkAttributeSet">AtkAttributeSet</link>*    <link linkend="atk-document-get-attributes">atk_document_get_attributes</link>         (<link linkend="AtkDocument">AtkDocument</link> *document);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-document-get-locale">atk_document_get_locale</link>             (<link linkend="AtkDocument">AtkDocument</link> *document);
</synopsis>
</refsynopsisdiv>

<refsect1 id="AtkDocument.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GInterface">GInterface</link>
   +----AtkDocument
</synopsis>

</refsect1>




<refsect1 id="AtkDocument.implementations" role="implementations">
<title role="implementations.title">Known Implementations</title>
<para>
AtkDocument is implemented by
 <link linkend="AtkNoOpObject">AtkNoOpObject</link>.</para>

</refsect1>


<refsect1 id="AtkDocument.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="AtkDocument-load-complete">load-complete</link>&quot;                                  : Run Last
  &quot;<link linkend="AtkDocument-load-stopped">load-stopped</link>&quot;                                   : Run Last
  &quot;<link linkend="AtkDocument-reload">reload</link>&quot;                                         : Run Last
</synopsis>
</refsect1>


<refsect1 id="AtkDocument.description" role="desc">
<title role="desc.title">Description</title>
<para>
The AtkDocument interface should be supported by any object whose content is a 
representation or view of a document.  The AtkDocument interface should appear
on the toplevel container for the document content; however AtkDocument 
instances may be nested (i.e. an AtkDocument may be a descendant of another
AtkDocument) in those cases where one document contains "embedded content" 
which can reasonably be considered a document in its own right.
</para>
</refsect1>

<refsect1 id="AtkDocument.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkDocument-struct" role="struct">
<title>AtkDocument</title>
<indexterm zone="AtkDocument-struct"><primary>AtkDocument</primary></indexterm><programlisting>typedef struct _AtkDocument AtkDocument;</programlisting>
<para>
The AtkDocument structure does not contain any fields.


</para></refsect2>
<refsect2 id="atk-document-get-document-type" role="function">
<title>atk_document_get_document_type ()</title>
<indexterm zone="atk-document-get-document-type"><primary>atk_document_get_document_type</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_document_get_document_type      (<link linkend="AtkDocument">AtkDocument</link> *document);</programlisting>
<para>
Gets a string indicating the document type.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>document</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkDocumentIface
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string indicating the document type
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-document-get-document" role="function">
<title>atk_document_get_document ()</title>
<indexterm zone="atk-document-get-document"><primary>atk_document_get_document</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            atk_document_get_document           (<link linkend="AtkDocument">AtkDocument</link> *document);</programlisting>
<para>
Gets a <link linkend="gpointer"><literal>gpointer</literal></link> 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>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>document</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkDocumentIface
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="gpointer"><literal>gpointer</literal></link> that points to an instance of the DOM.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-document-get-attribute-value" role="function" condition="since:ATK 1.12">
<title>atk_document_get_attribute_value ()</title>
<indexterm zone="atk-document-get-attribute-value" role="ATK 1.12"><primary>atk_document_get_attribute_value</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_document_get_attribute_value    (<link linkend="AtkDocument">AtkDocument</link> *document,
                                                         const <link linkend="gchar">gchar</link> *attribute_name);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>document</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link> instance that implements AtkDocumentIface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attribute_name</parameter>&nbsp;:</term>
<listitem><simpara> a character string representing the name of the attribute
           whose value is being queried.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string value associated with the named attribute for this
   document, or NULL if a value for <link linkend="attribute-name"><type>attribute_name</type></link> has not been specified
   for this document.