atkdocument.xml

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

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  ATK 1.12

</para></refsect2>
<refsect2 id="atk-document-set-attribute-value" role="function" condition="since:ATK 1.12">
<title>atk_document_set_attribute_value ()</title>
<indexterm zone="atk-document-set-attribute-value" role="ATK 1.12"><primary>atk_document_set_attribute_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_document_set_attribute_value    (<link linkend="AtkDocument">AtkDocument</link> *document,
                                                         const <link linkend="gchar">gchar</link> *attribute_name,
                                                         const <link linkend="gchar">gchar</link> *attribute_value);</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 set.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attribute_value</parameter>&nbsp;:</term>
<listitem><simpara> a string value to be associated with <link linkend="attribute-name"><type>attribute_name</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if <link linkend="value"><type>value</type></link> is successfully associated with <link linkend="attribute-name"><type>attribute_name</type></link>
         for this document, FALSE otherwise (e.g. if the document does not
         allow the attribute to be modified).
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  ATK 1.12

</para></refsect2>
<refsect2 id="atk-document-get-attributes" role="function" condition="since:ATK 1.12">
<title>atk_document_get_attributes ()</title>
<indexterm zone="atk-document-get-attributes" role="ATK 1.12"><primary>atk_document_get_attributes</primary></indexterm><programlisting><link linkend="AtkAttributeSet">AtkAttributeSet</link>*    atk_document_get_attributes         (<link linkend="AtkDocument">AtkDocument</link> *document);</programlisting>
<para>
Gets an AtkAttributeSet which describes document-wide
         attributes as name-value pairs.</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> An AtkAttributeSet containing the explicitly
         set name-value-pair attributes associated with this document
         as a whole.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  ATK 1.12

</para></refsect2>
<refsect2 id="atk-document-get-locale" role="function">
<title>atk_document_get_locale ()</title>
<indexterm zone="atk-document-get-locale"><primary>atk_document_get_locale</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_document_get_locale             (<link linkend="AtkDocument">AtkDocument</link> *document);</programlisting>
<para>
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
         of the content of this document instance.  Individual
         text substrings or images within this document may have
         a different locale, see atk_text_get_attributes and
         atk_image_get_image_locale.</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 UTF-8 string indicating the POSIX-style LC_MESSAGES
         locale of the document content as a whole, or NULL if
         the document content does not specify a locale.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="AtkDocument.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="AtkDocument-load-complete"><title>The <literal>&quot;load-complete&quot;</literal> signal</title>
<indexterm zone="AtkDocument-load-complete"><primary>AtkDocument::load-complete</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkDocument">AtkDocument</link> *atkdocument,
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run Last</programlisting>
<para>
The 'load-complete' signal is emitted when a pending load of a static
document has completed.  This signal is to be expected by ATK clients 
if and when AtkDocument implementors expose ATK_STATE_BUSY.  If the state
of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY,
it should be safe for clients to assume that the AtkDocument's static contents
are fully loaded into the container.  (Dynamic document contents should
be exposed via other signals.)
</para><variablelist role="params">
<varlistentry><term><parameter>atkdocument</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="AtkDocument-load-stopped"><title>The <literal>&quot;load-stopped&quot;</literal> signal</title>
<indexterm zone="AtkDocument-load-stopped"><primary>AtkDocument::load-stopped</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkDocument">AtkDocument</link> *atkdocument,
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run Last</programlisting>
<para>
The 'load-stopped' signal is emitted when a pending load of document contents
is cancelled, paused, or otherwise interrupted by the user or application 
logic.  It should not however be
emitted while waiting for a resource (for instance while blocking on a file or 
network read) unless a user-significant timeout has occurred.
</para><variablelist role="params">
<varlistentry><term><parameter>atkdocument</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="AtkDocument-reload"><title>The <literal>&quot;reload&quot;</literal> signal</title>
<indexterm zone="AtkDocument-reload"><primary>AtkDocument::reload</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkDocument">AtkDocument</link> *atkdocument,
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run Last</programlisting>
<para>
The 'reload' signal is emitted when the contents of a document is refreshed
from its source.  Once 'reload' has been emitted, a matching 'load-complete' 
or 'load-stopped' signal should follow, which clients may await before 
interrogating ATK for the latest document content.
</para><variablelist role="params">
<varlistentry><term><parameter>atkdocument</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>



</refentry>