← Back to branch summary

~ubuntu-branches/ubuntu/trusty/atk1.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/html/AtkDocument.html

  • Committer: Package Import Robot
  • Author(s): Luke Yelavich
  • Date: 2013-01-17 15:47:20 UTC
  • mfrom: (1.4.5)
  • Revision ID: package-import@ubuntu.com-20130117154720-hb5bjugb7p2k5hxv
Tags: 2.7.4-0ubuntu1
* New upstream release
  - Bug 690379: Atk lacks any kind of version utilities
  - Fixed out of tree builds caused by fix of bug 690379
  - Bug 656750: AtkWindow requires documentation
* Update symbols file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/AtkDocument.html
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.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
44
44
<div class="refsynopsisdiv">
45
45
<a name="AtkDocument.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">                    <a class="link" href="AtkDocument.html#AtkDocument-struct" title="AtkDocument">AtkDocument</a>;
47
 
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
 
<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
 
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>,
50
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>);
51
 
<span class="returnvalue">gboolean</span>            <a class="link" href="AtkDocument.html#atk-document-set-attribute-value" title="atk_document_set_attribute_value ()">atk_document_set_attribute_value</a>    (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
52
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>,
53
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *attribute_value</code></em>);
 
47
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <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
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            <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
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <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>,
 
50
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute_name</code></em>);
 
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtkDocument.html#atk-document-set-attribute-value" title="atk_document_set_attribute_value ()">atk_document_set_attribute_value</a>    (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
 
52
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute_name</code></em>,
 
53
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute_value</code></em>);
54
54
<a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *   <a class="link" href="AtkDocument.html#atk-document-get-attributes" title="atk_document_get_attributes ()">atk_document_get_attributes</a>         (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
55
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkDocument.html#atk-document-get-locale" title="atk_document_get_locale ()">atk_document_get_locale</a>             (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
 
55
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkDocument.html#atk-document-get-locale" title="atk_document_get_locale ()">atk_document_get_locale</a>             (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
56
56
</pre>
57
57
</div>
58
58
<div class="refsect1">
71
71
<div class="refsect1">
72
72
<a name="AtkDocument.signals"></a><h2>Signals</h2>
73
73
<pre class="synopsis">
74
 
  "<a class="link" href="AtkDocument.html#AtkDocument-load-complete" title='The "load-complete" signal'>load-complete</a>"                                  : <code class="literal">Run Last</code>
75
 
  "<a class="link" href="AtkDocument.html#AtkDocument-load-stopped" title='The "load-stopped" signal'>load-stopped</a>"                                   : <code class="literal">Run Last</code>
76
 
  "<a class="link" href="AtkDocument.html#AtkDocument-reload" title='The "reload" signal'>reload</a>"                                         : <code class="literal">Run Last</code>
 
74
  "<a class="link" href="AtkDocument.html#AtkDocument-load-complete" title='The "load-complete" signal'>load-complete</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
75
  "<a class="link" href="AtkDocument.html#AtkDocument-load-stopped" title='The "load-stopped" signal'>load-stopped</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
76
  "<a class="link" href="AtkDocument.html#AtkDocument-reload" title='The "reload" signal'>reload</a>"                                         : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
77
77
</pre>
78
78
</div>
79
79
<div class="refsect1">
99
99
<hr>
100
100
<div class="refsect2">
101
101
<a name="atk-document-get-document-type"></a><h3>atk_document_get_document_type ()</h3>
102
 
<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>
 
102
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
103
103
<p>
104
104
Gets a string indicating the document type.
105
105
</p>
108
108
<tbody>
109
109
<tr>
110
110
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
111
 
<td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
 
111
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkDocumentIface</td>
112
112
</tr>
113
113
<tr>
114
114
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
120
120
<hr>
121
121
<div class="refsect2">
122
122
<a name="atk-document-get-document"></a><h3>atk_document_get_document ()</h3>
123
 
<pre class="programlisting"><span class="returnvalue">gpointer</span>            atk_document_get_document           (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
 
123
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            atk_document_get_document           (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
124
124
<p>
125
 
Gets a <code class="literal">gpointer</code> that points to an instance of the DOM.  It is
 
125
Gets a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><code class="literal">gpointer</code></a> that points to an instance of the DOM.  It is
126
126
up to the caller to check atk_document_get_type to determine
127
127
how to cast this pointer.
128
128
</p>
131
131
<tbody>
132
132
<tr>
133
133
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
134
 
<td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
 
134
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkDocumentIface</td>
135
135
</tr>
136
136
<tr>
137
137
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
138
 
<td>a <code class="literal">gpointer</code> that points to an instance of the DOM. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
 
138
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><code class="literal">gpointer</code></a> that points to an instance of the DOM. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
139
139
</td>
140
140
</tr>
141
141
</tbody>
144
144
<hr>
145
145
<div class="refsect2">
146
146
<a name="atk-document-get-attribute-value"></a><h3>atk_document_get_attribute_value ()</h3>
147
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_document_get_attribute_value    (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
148
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>);</pre>
 
147
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_document_get_attribute_value    (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
 
148
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute_name</code></em>);</pre>
149
149
<div class="variablelist"><table border="0">
150
150
<col align="left" valign="top">
151
151
<tbody>
152
152
<tr>
153
153
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
154
 
<td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
 
154
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkDocumentIface</td>
155
155
</tr>
156
156
<tr>
157
157
<td><p><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></p></td>
172
172
<hr>
173
173
<div class="refsect2">
174
174
<a name="atk-document-set-attribute-value"></a><h3>atk_document_set_attribute_value ()</h3>
175
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atk_document_set_attribute_value    (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
176
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>,
177
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *attribute_value</code></em>);</pre>
 
175
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atk_document_set_attribute_value    (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
 
176
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute_name</code></em>,
 
177
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute_value</code></em>);</pre>
178
178
<div class="variablelist"><table border="0">
179
179
<col align="left" valign="top">
180
180
<tbody>
181
181
<tr>
182
182
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
183
 
<td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
 
183
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkDocumentIface</td>
184
184
</tr>
185
185
<tr>
186
186
<td><p><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></p></td>
215
215
<tbody>
216
216
<tr>
217
217
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
218
 
<td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
 
218
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkDocumentIface</td>
219
219
</tr>
220
220
<tr>
221
221
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
232
232
<hr>
233
233
<div class="refsect2">
234
234
<a name="atk-document-get-locale"></a><h3>atk_document_get_locale ()</h3>
235
 
<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>
 
235
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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
236
<p>
237
237
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
238
238
         of the content of this document instance.  Individual
245
245
<tbody>
246
246
<tr>
247
247
<td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
248
 
<td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
 
248
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkDocumentIface</td>
249
249
</tr>
250
250
<tr>
251
251
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
263
263
<div class="refsect2">
264
264
<a name="AtkDocument-load-complete"></a><h3>The <code class="literal">"load-complete"</code> signal</h3>
265
265
<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,
266
 
                                                        <span class="type">gpointer</span>     user_data)        : <code class="literal">Run Last</code></pre>
 
266
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
267
267
<p>
268
268
The 'load-complete' signal is emitted when a pending load of a static
269
269
document has completed.  This signal is to be expected by ATK clients
291
291
<div class="refsect2">
292
292
<a name="AtkDocument-load-stopped"></a><h3>The <code class="literal">"load-stopped"</code> signal</h3>
293
293
<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,
294
 
                                                        <span class="type">gpointer</span>     user_data)        : <code class="literal">Run Last</code></pre>
 
294
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
295
295
<p>
296
296
The 'load-stopped' signal is emitted when a pending load of document contents
297
297
is cancelled, paused, or otherwise interrupted by the user or application
317
317
<div class="refsect2">
318
318
<a name="AtkDocument-reload"></a><h3>The <code class="literal">"reload"</code> signal</h3>
319
319
<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,
320
 
                                                        <span class="type">gpointer</span>     user_data)        : <code class="literal">Run Last</code></pre>
 
320
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
321
321
<p>
322
322
The 'reload' signal is emitted when the contents of a document is refreshed
323
323
from its source.  Once 'reload' has been emitted, a matching 'load-complete'
342
342
</div>
343
343
<div class="footer">
344
344
<hr>
345
 
          Generated by GTK-Doc V1.18.1</div>
 
345
          Generated by GTK-Doc V1.18</div>
346
346
</body>
347
347
</html>
 
 
b'\\ No newline at end of file'