8
8
<link rel="up" href="atk.html" title="ATK Library">
9
9
<link rel="prev" href="AtkComponent.html" title="AtkComponent">
10
10
<link rel="next" href="AtkEditableText.html" title="AtkEditableText">
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="AtkComponent.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
21
<td><a accesskey="n" href="AtkEditableText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#AtkDocument.synopsis" class="shortcut">Top</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
<td width="100%" align="left">
17
<a href="#" class="shortcut">Top</a>
26
19
<a href="#AtkDocument.description" class="shortcut">Description</a>
30
23
<a href="#AtkDocument.implementations" class="shortcut">Known Implementations</a>
32
25
<a href="#AtkDocument.signals" class="shortcut">Signals</a>
27
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
28
<td><a accesskey="u" href="atk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
29
<td><a accesskey="p" href="AtkComponent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
30
<td><a accesskey="n" href="AtkEditableText.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
35
32
<div class="refentry">
36
33
<a name="AtkDocument"></a><div class="titlepage"></div>
37
34
<div class="refnamediv"><table width="100%"><tr>
39
36
<h2><span class="refentrytitle"><a name="AtkDocument.top_of_page"></a>AtkDocument</span></h2>
40
<p>AtkDocument — The ATK interface which represents the toplevel container for document content.</p>
37
<p>AtkDocument — The ATK interface which represents the toplevel
38
container for document content.</p>
42
40
<td valign="top" align="right"></td>
43
41
</tr></table></div>
44
42
<div class="refsynopsisdiv">
45
43
<a name="AtkDocument.synopsis"></a><h2>Synopsis</h2>
46
44
<pre class="synopsis"> <a class="link" href="AtkDocument.html#AtkDocument-struct" title="AtkDocument">AtkDocument</a>;
45
struct <a class="link" href="AtkDocument.html#AtkDocumentIface" title="struct AtkDocumentIface">AtkDocumentIface</a>;
47
46
const <span class="returnvalue">gchar</span> * <a class="link" href="AtkDocument.html#atk-document-get-document-type" title="atk_document_get_document_type ()">atk_document_get_document_type</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
48
47
<span class="returnvalue">gpointer</span> <a class="link" href="AtkDocument.html#atk-document-get-document" title="atk_document_get_document ()">atk_document_get_document</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
49
48
const <span class="returnvalue">gchar</span> * <a class="link" href="AtkDocument.html#atk-document-get-attribute-value" title="atk_document_get_attribute_value ()">atk_document_get_attribute_value</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
79
78
<div class="refsect1">
80
79
<a name="AtkDocument.description"></a><h2>Description</h2>
82
The AtkDocument interface should be supported by any object whose content is a
83
representation or view of a document. The AtkDocument interface should appear
84
on the toplevel container for the document content; however AtkDocument
85
instances may be nested (i.e. an AtkDocument may be a descendant of another
86
AtkDocument) in those cases where one document contains "embedded content"
87
which can reasonably be considered a document in its own right.
81
The AtkDocument interface should be supported by any object whose
82
content is a representation or view of a document. The AtkDocument
83
interface should appear on the toplevel container for the document
84
content; however AtkDocument instances may be nested (i.e. an
85
AtkDocument may be a descendant of another AtkDocument) in those
86
cases where one document contains "embedded content" which can
87
reasonably be considered a document in its own right.
90
90
<div class="refsect1">
93
93
<a name="AtkDocument-struct"></a><h3>AtkDocument</h3>
94
94
<pre class="programlisting">typedef struct _AtkDocument AtkDocument;</pre>
96
The AtkDocument structure does not contain any fields.
100
99
<div class="refsect2">
100
<a name="AtkDocumentIface"></a><h3>struct AtkDocumentIface</h3>
101
<pre class="programlisting">struct AtkDocumentIface {
102
GTypeInterface parent;
103
const gchar* ( *get_document_type) (AtkDocument *document);
104
gpointer ( *get_document) (AtkDocument *document);
106
const gchar* ( *get_document_locale) (AtkDocument *document);
107
AtkAttributeSet * ( *get_document_attributes) (AtkDocument *document);
108
const gchar* ( *get_document_attribute_value) (AtkDocument *document,
109
const gchar *attribute_name);
110
gboolean ( *set_document_attribute) (AtkDocument *document,
111
const gchar *attribute_name,
112
const gchar *attribute_value);
115
<div class="variablelist"><table border="0">
116
<col align="left" valign="top">
119
<td><p><span class="term"><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="AtkDocumentIface.parent"></a>parent</code></em>;</span></p></td>
123
<td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document-type"></a>get_document_type</code></em> ()</span></p></td>
127
<td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document"></a>get_document</code></em> ()</span></p></td>
131
<td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document-locale"></a>get_document_locale</code></em> ()</span></p></td>
132
<td>gets locale. This virtual function is
133
deprecated since 2.7.90 and it should not be overriden.</td>
136
<td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document-attributes"></a>get_document_attributes</code></em> ()</span></p></td>
140
<td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document-attribute-value"></a>get_document_attribute_value</code></em> ()</span></p></td>
144
<td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.set-document-attribute"></a>set_document_attribute</code></em> ()</span></p></td>
151
<div class="refsect2">
101
152
<a name="atk-document-get-document-type"></a><h3>atk_document_get_document_type ()</h3>
102
153
<pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_document_get_document_type (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
233
284
<div class="refsect2">
234
285
<a name="atk-document-get-locale"></a><h3>atk_document_get_locale ()</h3>
235
286
<pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_document_get_locale (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
236
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
287
<div class="warning">
237
288
<h3 class="title">Warning</h3>
238
289
<p><code class="literal">atk_document_get_locale</code> is deprecated and should not be used in newly-written code. This method is deprecated since ATK version
239
2.7.90. Please use atk_object_get_object_locale instead.</p>
290
2.7.90. Please use <a class="link" href="AtkObject.html#atk-object-get-object-locale" title="atk_object_get_object_locale ()"><code class="function">atk_object_get_object_locale()</code></a> instead.</p>
242
293
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
270
321
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
271
322
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
273
The 'load-complete' signal is emitted when a pending load of a static
274
document has completed. This signal is to be expected by ATK clients
275
if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state
276
of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY,
277
it should be safe for clients to assume that the AtkDocument's static contents
278
are fully loaded into the container. (Dynamic document contents should
279
be exposed via other signals.)
324
The 'load-complete' signal is emitted when a pending load of
325
a static document has completed. This signal is to be
326
expected by ATK clients if and when AtkDocument implementors
327
expose ATK_STATE_BUSY. If the state of an AtkObject which
328
implements AtkDocument does not include ATK_STATE_BUSY, it
329
should be safe for clients to assume that the AtkDocument's
330
static contents are fully loaded into the container.
331
(Dynamic document contents should be exposed via other
281
334
<div class="variablelist"><table border="0">
282
335
<col align="left" valign="top">
298
351
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
299
352
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
301
The 'load-stopped' signal is emitted when a pending load of document contents
302
is cancelled, paused, or otherwise interrupted by the user or application
303
logic. It should not however be
304
emitted while waiting for a resource (for instance while blocking on a file or
305
network read) unless a user-significant timeout has occurred.
354
The 'load-stopped' signal is emitted when a pending load of
355
document contents is cancelled, paused, or otherwise
356
interrupted by the user or application logic. It should not
357
however be emitted while waiting for a resource (for instance
358
while blocking on a file or network read) unless a
359
user-significant timeout has occurred.
307
361
<div class="variablelist"><table border="0">
308
362
<col align="left" valign="top">
324
378
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
325
379
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
327
The 'reload' signal is emitted when the contents of a document is refreshed
328
from its source. Once 'reload' has been emitted, a matching 'load-complete'
329
or 'load-stopped' signal should follow, which clients may await before
381
The 'reload' signal is emitted when the contents of a
382
document is refreshed from its source. Once 'reload' has
383
been emitted, a matching 'load-complete' or 'load-stopped'
384
signal should follow, which clients may await before
330
385
interrogating ATK for the latest document content.
332
387
<div class="variablelist"><table border="0">
added
removed
docs/html/AtkDocument.html
