51
51
<a name="AtkDocument.synopsis"></a><h2>Synopsis</h2>
52
52
<pre class="synopsis">
53
53
<a class="link" href="AtkDocument.html#AtkDocument-struct" title="AtkDocument">AtkDocument</a>;
54
const gchar* <a class="link" href="AtkDocument.html#atk-document-get-document-type" title="atk_document_get_document_type ()">atk_document_get_document_type</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
55
gpointer <a class="link" href="AtkDocument.html#atk-document-get-document" title="atk_document_get_document ()">atk_document_get_document</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
56
const gchar* <a class="link" href="AtkDocument.html#atk-document-get-attribute-value" title="atk_document_get_attribute_value ()">atk_document_get_attribute_value</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
57
const gchar *attribute_name);
58
gboolean <a class="link" href="AtkDocument.html#atk-document-set-attribute-value" title="atk_document_set_attribute_value ()">atk_document_set_attribute_value</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
59
const gchar *attribute_name,
60
const gchar *attribute_value);
55
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
56
>gchar</a>* <a class="link" href="AtkDocument.html#atk-document-get-document-type" title="atk_document_get_document_type ()">atk_document_get_document_type</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
58
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
59
>gpointer</a> <a class="link" href="AtkDocument.html#atk-document-get-document" title="atk_document_get_document ()">atk_document_get_document</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
61
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
62
>gchar</a>* <a class="link" href="AtkDocument.html#atk-document-get-attribute-value" title="atk_document_get_attribute_value ()">atk_document_get_attribute_value</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
64
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
65
>gchar</a> *attribute_name);
67
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
68
>gboolean</a> <a class="link" href="AtkDocument.html#atk-document-set-attribute-value" title="atk_document_set_attribute_value ()">atk_document_set_attribute_value</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
70
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
71
>gchar</a> *attribute_name,
73
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
74
>gchar</a> *attribute_value);
61
75
<a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet">AtkAttributeSet</a>* <a class="link" href="AtkDocument.html#atk-document-get-attributes" title="atk_document_get_attributes ()">atk_document_get_attributes</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
62
const gchar* <a class="link" href="AtkDocument.html#atk-document-get-locale" title="atk_document_get_locale ()">atk_document_get_locale</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
77
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
78
>gchar</a>* <a class="link" href="AtkDocument.html#atk-document-get-locale" title="atk_document_get_locale ()">atk_document_get_locale</a> (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
65
81
<div class="refsect1" lang="en">
109
125
<div class="refsect2" lang="en">
110
126
<a name="atk-document-get-document-type"></a><h3>atk_document_get_document_type ()</h3>
111
<pre class="programlisting">const gchar* atk_document_get_document_type (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
127
<pre class="programlisting">const <a
128
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
129
>gchar</a>* atk_document_get_document_type (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
113
131
Gets a string indicating the document type.</p>
134
154
<div class="refsect2" lang="en">
135
155
<a name="atk-document-get-document"></a><h3>atk_document_get_document ()</h3>
136
<pre class="programlisting">gpointer atk_document_get_document (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
156
<pre class="programlisting"><a
157
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
158
>gpointer</a> atk_document_get_document (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
138
Gets a <code class="literal">gpointer</code> that points to an instance of the DOM. It is
161
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
162
><code class="literal">gpointer</code></a> that points to an instance of the DOM. It is
139
163
up to the caller to check atk_document_get_type to determine
140
164
how to cast this pointer.</p>
148
172
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
149
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
174
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
175
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
153
179
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
154
<td> a <code class="literal">gpointer</code> that points to an instance of the DOM.
181
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
182
><code class="literal">gpointer</code></a> that points to an instance of the DOM.
161
189
<div class="refsect2" lang="en">
162
190
<a name="atk-document-get-attribute-value"></a><h3>atk_document_get_attribute_value ()</h3>
163
<pre class="programlisting">const gchar* atk_document_get_attribute_value (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
164
const gchar *attribute_name);</pre>
191
<pre class="programlisting">const <a
192
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
193
>gchar</a>* atk_document_get_attribute_value (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
195
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
196
>gchar</a> *attribute_name);</pre>
198
232
<div class="refsect2" lang="en">
199
233
<a name="atk-document-set-attribute-value"></a><h3>atk_document_set_attribute_value ()</h3>
200
<pre class="programlisting">gboolean atk_document_set_attribute_value (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
201
const gchar *attribute_name,
202
const gchar *attribute_value);</pre>
234
<pre class="programlisting"><a
235
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
236
>gboolean</a> atk_document_set_attribute_value (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
238
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
239
>gchar</a> *attribute_name,
241
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
242
>gchar</a> *attribute_value);</pre>
272
316
<div class="refsect2" lang="en">
273
317
<a name="atk-document-get-locale"></a><h3>atk_document_get_locale ()</h3>
274
<pre class="programlisting">const gchar* atk_document_get_locale (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
318
<pre class="programlisting">const <a
319
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
320
>gchar</a>* atk_document_get_locale (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
276
322
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
277
323
of the content of this document instance. Individual
305
353
<div class="refsect2" lang="en">
306
354
<a name="AtkDocument-load-complete"></a><h3>The <code class="literal">"load-complete"</code> signal</h3>
307
355
<pre class="programlisting">void user_function (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
308
gpointer user_data) : Run Last</pre>
357
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
358
>gpointer</a> user_data) : Run Last</pre>
310
360
The 'load-complete' signal is emitted when a pending load of a static
311
361
document has completed. This signal is to be expected by ATK clients
335
385
<div class="refsect2" lang="en">
336
386
<a name="AtkDocument-load-stopped"></a><h3>The <code class="literal">"load-stopped"</code> signal</h3>
337
387
<pre class="programlisting">void user_function (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
338
gpointer user_data) : Run Last</pre>
389
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
390
>gpointer</a> user_data) : Run Last</pre>
340
392
The 'load-stopped' signal is emitted when a pending load of document contents
341
393
is cancelled, paused, or otherwise interrupted by the user or application
363
415
<div class="refsect2" lang="en">
364
416
<a name="AtkDocument-reload"></a><h3>The <code class="literal">"reload"</code> signal</h3>
365
417
<pre class="programlisting">void user_function (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
366
gpointer user_data) : Run Last</pre>
419
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
420
>gpointer</a> user_data) : Run Last</pre>
368
422
The 'reload' signal is emitted when the contents of a document is refreshed
369
423
from its source. Once 'reload' has been emitted, a matching 'load-complete'