← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/html/AtkDocument.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-01-14 16:25:56 UTC
  • mfrom: (1.2.16 upstream)
  • Revision ID: james.westby@ubuntu.com-20080114162556-f3dbeslu5w2hspoe
Tags: 1.21.5-0ubuntu1
https://launchpad.net/bugs/182900
* New upstream bugfix release (LP: #182900)
* Bump Standards-Version to 3.7.3
* Modify Maintainer value to match Debian-Maintainer-Field Spec

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/AtkDocument.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>AtkDocument</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
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.8 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="atk.html" title="ATK Library">
14
14
<link rel="index" href="ix01.html" title="Index">
28
28
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
29
29
<td><a accesskey="n" href="AtkEditableText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
30
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id333367" class="shortcut">Top</a>
32
 
                  &#160;|&#160;
33
 
                  <a href="#id333973" class="shortcut">Description</a>
34
 
                  &#160;|&#160;
35
 
                  <a href="#id333885" class="shortcut">Object Hierarchy</a>
36
 
                  &#160;|&#160;
37
 
                  <a href="#id333909" class="shortcut">Known Implementations</a>
38
 
                  &#160;|&#160;
39
 
                  <a href="#id333930" class="shortcut">Signals</a></nobr></td></tr>
 
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id349215" class="shortcut">Top</a>
 
32
                  &#160;|&#160;
 
33
                  <a href="#id349821" class="shortcut">Description</a>
 
34
                  &#160;|&#160;
 
35
                  <a href="#id349733" class="shortcut">Object Hierarchy</a>
 
36
                  &#160;|&#160;
 
37
                  <a href="#id349756" class="shortcut">Known Implementations</a>
 
38
                  &#160;|&#160;
 
39
                  <a href="#id349778" class="shortcut">Signals</a></nobr></td></tr>
40
40
</table>
41
41
<div class="refentry" lang="en">
42
42
<a name="AtkDocument"></a><div class="titlepage"></div>
43
43
<div class="refnamediv"><table width="100%"><tr>
44
44
<td valign="top">
45
45
<h2>
46
 
<a name="id333367"></a><span class="refentrytitle">AtkDocument</span>
 
46
<a name="id349215"></a><span class="refentrytitle">AtkDocument</span>
47
47
</h2>
48
48
<p>AtkDocument &#8212; The ATK interface which represents the toplevel container for document content.</p>
49
49
</td>
55
55
 
56
56
 
57
57
 
58
 
                    <a href="AtkDocument.html#AtkDocument-struct">AtkDocument</a>;
59
 
const gchar*        <a href="AtkDocument.html#atk-document-get-document-type">atk_document_get_document_type</a>      (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
60
 
gpointer            <a href="AtkDocument.html#atk-document-get-document">atk_document_get_document</a>           (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
61
 
const gchar*        <a href="AtkDocument.html#atk-document-get-attribute-value">atk_document_get_attribute_value</a>    (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
 
58
                    <a class="link" href="AtkDocument.html#AtkDocument-struct">AtkDocument</a>;
 
59
const gchar*        <a class="link" href="AtkDocument.html#atk-document-get-document-type">atk_document_get_document_type</a>      (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
 
60
gpointer            <a class="link" href="AtkDocument.html#atk-document-get-document">atk_document_get_document</a>           (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
 
61
const gchar*        <a class="link" href="AtkDocument.html#atk-document-get-attribute-value">atk_document_get_attribute_value</a>    (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
62
62
                                                         const gchar *attribute_name);
63
 
gboolean            <a href="AtkDocument.html#atk-document-set-attribute-value">atk_document_set_attribute_value</a>    (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
 
63
gboolean            <a class="link" href="AtkDocument.html#atk-document-set-attribute-value">atk_document_set_attribute_value</a>    (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
64
64
                                                         const gchar *attribute_name,
65
65
                                                         const gchar *attribute_value);
66
 
<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>*    <a href="AtkDocument.html#atk-document-get-attributes">atk_document_get_attributes</a>         (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
67
 
const gchar*        <a href="AtkDocument.html#atk-document-get-locale">atk_document_get_locale</a>             (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
 
66
<a class="link" href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>*    <a class="link" href="AtkDocument.html#atk-document-get-attributes">atk_document_get_attributes</a>         (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
 
67
const gchar*        <a class="link" href="AtkDocument.html#atk-document-get-locale">atk_document_get_locale</a>             (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
68
68
 
69
69
</pre>
70
70
</div>
71
71
<div class="refsect1" lang="en">
72
 
<a name="id333885"></a><h2>Object Hierarchy</h2>
 
72
<a name="id349733"></a><h2>Object Hierarchy</h2>
73
73
<pre class="synopsis">
74
74
 
75
75
  GInterface
77
77
</pre>
78
78
</div>
79
79
<div class="refsect1" lang="en">
80
 
<a name="id333909"></a><h2>Known Implementations</h2>
 
80
<a name="id349756"></a><h2>Known Implementations</h2>
81
81
<p>
82
82
AtkDocument is implemented by
83
 
 <a href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
 
83
 <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
84
84
</div>
85
85
<div class="refsect1" lang="en">
86
 
<a name="id333930"></a><h2>Signals</h2>
 
86
<a name="id349778"></a><h2>Signals</h2>
87
87
<pre class="synopsis">
88
88
 
89
 
  "<a href="AtkDocument.html#AtkDocument-load-complete">load-complete</a>"                                  : Run Last
90
 
  "<a href="AtkDocument.html#AtkDocument-load-stopped">load-stopped</a>"                                   : Run Last
91
 
  "<a href="AtkDocument.html#AtkDocument-reload">reload</a>"                                         : Run Last
 
89
  "<a class="link" href="AtkDocument.html#AtkDocument-load-complete">load-complete</a>"                                  : Run Last
 
90
  "<a class="link" href="AtkDocument.html#AtkDocument-load-stopped">load-stopped</a>"                                   : Run Last
 
91
  "<a class="link" href="AtkDocument.html#AtkDocument-reload">reload</a>"                                         : Run Last
92
92
</pre>
93
93
</div>
94
94
<div class="refsect1" lang="en">
95
 
<a name="id333973"></a><h2>Description</h2>
 
95
<a name="id349821"></a><h2>Description</h2>
96
96
<p>
97
97
The AtkDocument interface should be supported by any object whose content is a 
98
98
representation or view of a document.  The AtkDocument interface should appear
103
103
</p>
104
104
</div>
105
105
<div class="refsect1" lang="en">
106
 
<a name="id333991"></a><h2>Details</h2>
 
106
<a name="id349839"></a><h2>Details</h2>
107
107
<div class="refsect2" lang="en">
108
 
<a name="id334001"></a><h3>
 
108
<a name="id349849"></a><h3>
109
109
<a name="AtkDocument-struct"></a>AtkDocument</h3>
110
 
<a class="indexterm" name="id334013"></a><pre class="programlisting">typedef struct _AtkDocument AtkDocument;</pre>
 
110
<a class="indexterm" name="id349861"></a><pre class="programlisting">typedef struct _AtkDocument AtkDocument;</pre>
111
111
<p>
112
112
The AtkDocument structure does not contain any fields.
113
113
 
116
116
</div>
117
117
<hr>
118
118
<div class="refsect2" lang="en">
119
 
<a name="id334029"></a><h3>
 
119
<a name="id349877"></a><h3>
120
120
<a name="atk-document-get-document-type"></a>atk_document_get_document_type ()</h3>
121
 
<a class="indexterm" name="id334041"></a><pre class="programlisting">const gchar*        atk_document_get_document_type      (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
 
121
<a class="indexterm" name="id349889"></a><pre class="programlisting">const gchar*        atk_document_get_document_type      (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
122
122
<p>
123
123
Gets a string indicating the document type.</p>
124
124
<p>
128
128
<col align="left" valign="top">
129
129
<tbody>
130
130
<tr>
131
 
<td><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></td>
 
131
<td><p><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></p></td>
132
132
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
133
133
</td>
134
134
</tr>
135
135
<tr>
136
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
136
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
137
137
<td> a string indicating the document type
138
138
</td>
139
139
</tr>
142
142
</div>
143
143
<hr>
144
144
<div class="refsect2" lang="en">
145
 
<a name="id334111"></a><h3>
 
145
<a name="id349958"></a><h3>
146
146
<a name="atk-document-get-document"></a>atk_document_get_document ()</h3>
147
 
<a class="indexterm" name="id334123"></a><pre class="programlisting">gpointer            atk_document_get_document           (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
 
147
<a class="indexterm" name="id349971"></a><pre class="programlisting">gpointer            atk_document_get_document           (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
148
148
<p>
149
149
Gets a <code class="literal">gpointer</code> that points to an instance of the DOM.  It is
150
150
up to the caller to check atk_document_get_type to determine
156
156
<col align="left" valign="top">
157
157
<tbody>
158
158
<tr>
159
 
<td><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></td>
 
159
<td><p><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></p></td>
160
160
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
161
161
</td>
162
162
</tr>
163
163
<tr>
164
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
164
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
165
165
<td> a <code class="literal">gpointer</code> that points to an instance of the DOM.
166
166
</td>
167
167
</tr>
170
170
</div>
171
171
<hr>
172
172
<div class="refsect2" lang="en">
173
 
<a name="id334212"></a><h3>
 
173
<a name="id350060"></a><h3>
174
174
<a name="atk-document-get-attribute-value"></a>atk_document_get_attribute_value ()</h3>
175
 
<a class="indexterm" name="id334227"></a><pre class="programlisting">const gchar*        atk_document_get_attribute_value    (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
 
175
<a class="indexterm" name="id350075"></a><pre class="programlisting">const gchar*        atk_document_get_attribute_value    (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
176
176
                                                         const gchar *attribute_name);</pre>
177
177
<p>
178
 
Returns:</p>
 
178
</p>
179
179
<p>
180
180
 
181
181
</p>
183
183
<col align="left" valign="top">
184
184
<tbody>
185
185
<tr>
186
 
<td><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></td>
 
186
<td><p><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></p></td>
187
187
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
188
188
</td>
189
189
</tr>
190
190
<tr>
191
 
<td><span class="term"><em class="parameter"><code>attribute_name</code></em>&#160;:</span></td>
 
191
<td><p><span class="term"><em class="parameter"><code>attribute_name</code></em>&#160;:</span></p></td>
192
192
<td> a character string representing the name of the attribute
193
193
           whose value is being queried.
194
194
</td>
195
195
</tr>
196
196
<tr>
197
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
197
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
198
198
<td> a string value associated with the named attribute for this
199
199
   document, or NULL if a value for <span class="type">attribute_name</span> has not been specified
200
200
   for this document.
208
208
</div>
209
209
<hr>
210
210
<div class="refsect2" lang="en">
211
 
<a name="id334334"></a><h3>
 
211
<a name="id350182"></a><h3>
212
212
<a name="atk-document-set-attribute-value"></a>atk_document_set_attribute_value ()</h3>
213
 
<a class="indexterm" name="id334349"></a><pre class="programlisting">gboolean            atk_document_set_attribute_value    (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
 
213
<a class="indexterm" name="id350196"></a><pre class="programlisting">gboolean            atk_document_set_attribute_value    (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
214
214
                                                         const gchar *attribute_name,
215
215
                                                         const gchar *attribute_value);</pre>
216
216
<p>
217
 
Returns:</p>
 
217
</p>
218
218
<p>
219
219
 
220
220
</p>
222
222
<col align="left" valign="top">
223
223
<tbody>
224
224
<tr>
225
 
<td><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></td>
 
225
<td><p><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></p></td>
226
226
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
227
227
</td>
228
228
</tr>
229
229
<tr>
230
 
<td><span class="term"><em class="parameter"><code>attribute_name</code></em>&#160;:</span></td>
 
230
<td><p><span class="term"><em class="parameter"><code>attribute_name</code></em>&#160;:</span></p></td>
231
231
<td> a character string representing the name of the attribute
232
232
           whose value is being set.
233
233
</td>
234
234
</tr>
235
235
<tr>
236
 
<td><span class="term"><em class="parameter"><code>attribute_value</code></em>&#160;:</span></td>
 
236
<td><p><span class="term"><em class="parameter"><code>attribute_value</code></em>&#160;:</span></p></td>
237
237
<td> a string value to be associated with <span class="type">attribute_name</span>.
238
238
</td>
239
239
</tr>
240
240
<tr>
241
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
241
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
242
242
<td> TRUE if <span class="type">value</span> is successfully associated with <span class="type">attribute_name</span>
243
243
         for this document, FALSE otherwise (e.g. if the document does not
244
244
         allow the attribute to be modified).
252
252
</div>
253
253
<hr>
254
254
<div class="refsect2" lang="en">
255
 
<a name="id334492"></a><h3>
 
255
<a name="id350340"></a><h3>
256
256
<a name="atk-document-get-attributes"></a>atk_document_get_attributes ()</h3>
257
 
<a class="indexterm" name="id334507"></a><pre class="programlisting"><a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>*    atk_document_get_attributes         (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
 
257
<a class="indexterm" name="id350354"></a><pre class="programlisting"><a class="link" href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>*    atk_document_get_attributes         (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
258
258
<p>
259
259
Gets an AtkAttributeSet which describes document-wide
260
 
         attributes as name-value pairs.
261
 
</p>
262
 
<p>
263
 
Returns:</p>
 
260
         attributes as name-value pairs.</p>
264
261
<p>
265
262
 
266
263
</p>
268
265
<col align="left" valign="top">
269
266
<tbody>
270
267
<tr>
271
 
<td><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></td>
 
268
<td><p><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></p></td>
272
269
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
273
270
</td>
274
271
</tr>
275
272
<tr>
276
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
273
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
277
274
<td> An AtkAttributeSet containing the explicitly
278
275
         set name-value-pair attributes associated with this document
279
276
         as a whole.
287
284
</div>
288
285
<hr>
289
286
<div class="refsect2" lang="en">
290
 
<a name="id334587"></a><h3>
 
287
<a name="id350430"></a><h3>
291
288
<a name="atk-document-get-locale"></a>atk_document_get_locale ()</h3>
292
 
<a class="indexterm" name="id334599"></a><pre class="programlisting">const gchar*        atk_document_get_locale             (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
 
289
<a class="indexterm" name="id350443"></a><pre class="programlisting">const gchar*        atk_document_get_locale             (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
293
290
<p>
294
291
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
295
292
         of the content of this document instance.  Individual
303
300
<col align="left" valign="top">
304
301
<tbody>
305
302
<tr>
306
 
<td><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></td>
 
303
<td><p><span class="term"><em class="parameter"><code>document</code></em>&#160;:</span></p></td>
307
304
<td> a <span class="type">GObject</span> instance that implements AtkDocumentIface
308
305
</td>
309
306
</tr>
310
307
<tr>
311
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
308
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
312
309
<td> a UTF-8 string indicating the POSIX-style LC_MESSAGES
313
310
         locale of the document content as a whole, or NULL if
314
311
         the document content does not specify a locale.
319
316
</div>
320
317
</div>
321
318
<div class="refsect1" lang="en">
322
 
<a name="id334672"></a><h2>Signal Details</h2>
 
319
<a name="id350516"></a><h2>Signal Details</h2>
323
320
<div class="refsect2" lang="en">
324
 
<a name="id334682"></a><h3>
325
 
<a name="AtkDocument-load-complete"></a>The "load-complete" signal</h3>
326
 
<a class="indexterm" name="id334692"></a><pre class="programlisting">void                user_function                      (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
 
321
<a name="id350526"></a><h3>
 
322
<a name="AtkDocument-load-complete"></a>The <code class="literal">"load-complete"</code> signal</h3>
 
323
<a class="indexterm" name="id350542"></a><pre class="programlisting">void                user_function                      (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
327
324
                                                        gpointer     user_data)        : Run Last</pre>
328
325
<p>
329
326
The 'load-complete' signal is emitted when a pending load of a static
338
335
<col align="left" valign="top">
339
336
<tbody>
340
337
<tr>
341
 
<td><span class="term"><em class="parameter"><code>atkdocument</code></em>&#160;:</span></td>
 
338
<td><p><span class="term"><em class="parameter"><code>atkdocument</code></em>&#160;:</span></p></td>
342
339
<td>the object which received the signal.
343
340
 
344
341
</td>
345
342
</tr>
346
343
<tr>
347
 
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
344
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
348
345
<td>user data set when the signal handler was connected.</td>
349
346
</tr>
350
347
</tbody>
352
349
</div>
353
350
<hr>
354
351
<div class="refsect2" lang="en">
355
 
<a name="id334762"></a><h3>
356
 
<a name="AtkDocument-load-stopped"></a>The "load-stopped" signal</h3>
357
 
<a class="indexterm" name="id334772"></a><pre class="programlisting">void                user_function                      (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
 
352
<a name="id350612"></a><h3>
 
353
<a name="AtkDocument-load-stopped"></a>The <code class="literal">"load-stopped"</code> signal</h3>
 
354
<a class="indexterm" name="id350627"></a><pre class="programlisting">void                user_function                      (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
358
355
                                                        gpointer     user_data)        : Run Last</pre>
359
356
<p>
360
357
The 'load-stopped' signal is emitted when a pending load of document contents
367
364
<col align="left" valign="top">
368
365
<tbody>
369
366
<tr>
370
 
<td><span class="term"><em class="parameter"><code>atkdocument</code></em>&#160;:</span></td>
 
367
<td><p><span class="term"><em class="parameter"><code>atkdocument</code></em>&#160;:</span></p></td>
371
368
<td>the object which received the signal.
372
369
 
373
370
</td>
374
371
</tr>
375
372
<tr>
376
 
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
373
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
377
374
<td>user data set when the signal handler was connected.</td>
378
375
</tr>
379
376
</tbody>
381
378
</div>
382
379
<hr>
383
380
<div class="refsect2" lang="en">
384
 
<a name="id334840"></a><h3>
385
 
<a name="AtkDocument-reload"></a>The "reload" signal</h3>
386
 
<a class="indexterm" name="id334850"></a><pre class="programlisting">void                user_function                      (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
 
381
<a name="id350696"></a><h3>
 
382
<a name="AtkDocument-reload"></a>The <code class="literal">"reload"</code> signal</h3>
 
383
<a class="indexterm" name="id350711"></a><pre class="programlisting">void                user_function                      (<a class="link" href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *atkdocument,
387
384
                                                        gpointer     user_data)        : Run Last</pre>
388
385
<p>
389
386
The 'reload' signal is emitted when the contents of a document is refreshed
395
392
<col align="left" valign="top">
396
393
<tbody>
397
394
<tr>
398
 
<td><span class="term"><em class="parameter"><code>atkdocument</code></em>&#160;:</span></td>
 
395
<td><p><span class="term"><em class="parameter"><code>atkdocument</code></em>&#160;:</span></p></td>
399
396
<td>the object which received the signal.
400
397
 
401
398
</td>
402
399
</tr>
403
400
<tr>
404
 
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
401
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
405
402
<td>user data set when the signal handler was connected.</td>
406
403
</tr>
407
404
</tbody>
408
405
</table></div>
409
406
</div>
410
407
</div>
 
408
<div class="refsect1" lang="en">
 
409
<a name="id350782"></a><div class="refsect2" lang="en"><a name="id350783"></a></div>
 
410
<hr>
 
411
<div class="refsect2" lang="en"><a name="id350784"></a></div>
 
412
</div>
411
413
</div>
412
414
</body>
413
415
</html>