~ubuntu-branches/ubuntu/intrepid/atk1.0/intrepid

« back to all changes in this revision

Viewing changes to docs/html/AtkDocument.html

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2008-09-22 23:34:37 UTC
  • mfrom: (1.2.20 upstream)
  • Revision ID: james.westby@ubuntu.com-20080922233437-kftxzjtscz1248n3
Tags: 1.24.0-0ubuntu1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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);
 
54
const <a
 
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);
 
57
<a
 
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);
 
60
const <a
 
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,
 
63
                                                         const <a
 
64
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
65
>gchar</a> *attribute_name);
 
66
<a
 
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,
 
69
                                                         const <a
 
70
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
71
>gchar</a> *attribute_name,
 
72
                                                         const <a
 
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);
 
76
const <a
 
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);
63
79
</pre>
64
80
</div>
65
81
<div class="refsect1" lang="en">
108
124
<hr>
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>
112
130
<p>
113
131
Gets a string indicating the document type.</p>
114
132
<p>
119
137
<tbody>
120
138
<tr>
121
139
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
122
 
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
 
140
<td> a <a
 
141
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
142
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
123
143
</td>
124
144
</tr>
125
145
<tr>
133
153
<hr>
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>
137
159
<p>
138
 
Gets a <code class="literal">gpointer</code> that points to an instance of the DOM.  It is
 
160
Gets a <a
 
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>
141
165
<p>
146
170
<tbody>
147
171
<tr>
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
 
173
<td> a <a
 
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
150
176
</td>
151
177
</tr>
152
178
<tr>
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.
 
180
<td> a <a
 
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.
155
183
</td>
156
184
</tr>
157
185
</tbody>
160
188
<hr>
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,
 
194
                                                         const <a
 
195
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
196
>gchar</a> *attribute_name);</pre>
165
197
<p>
166
198
</p>
167
199
<p>
172
204
<tbody>
173
205
<tr>
174
206
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
175
 
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
 
207
<td> a <a
 
208
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
209
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
176
210
</td>
177
211
</tr>
178
212
<tr>
197
231
<hr>
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,
 
237
                                                         const <a
 
238
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
239
>gchar</a> *attribute_name,
 
240
                                                         const <a
 
241
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
242
>gchar</a> *attribute_value);</pre>
203
243
<p>
204
244
</p>
205
245
<p>
210
250
<tbody>
211
251
<tr>
212
252
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
213
 
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
 
253
<td> a <a
 
254
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
255
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
214
256
</td>
215
257
</tr>
216
258
<tr>
252
294
<tbody>
253
295
<tr>
254
296
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
255
 
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
 
297
<td> a <a
 
298
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
299
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
256
300
</td>
257
301
</tr>
258
302
<tr>
271
315
<hr>
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>
275
321
<p>
276
322
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
277
323
         of the content of this document instance.  Individual
286
332
<tbody>
287
333
<tr>
288
334
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
289
 
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
 
335
<td> a <a
 
336
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
337
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
290
338
</td>
291
339
</tr>
292
340
<tr>
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>
 
356
                                                        <a
 
357
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
358
>gpointer</a>     user_data)        : Run Last</pre>
309
359
<p>
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>
 
388
                                                        <a
 
389
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
390
>gpointer</a>     user_data)        : Run Last</pre>
339
391
<p>
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>
 
418
                                                        <a
 
419
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
420
>gpointer</a>     user_data)        : Run Last</pre>
367
421
<p>
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'