at-spi-doc 1.32.0-1ubuntu1 / usr / share / gtk-doc / html / at-spi-cspi / at-spi-cspi-AccessibleStreamableContent-Interface.html

This file is indexed.

/usr/share/gtk-doc/html/at-spi-cspi/at-spi-cspi-AccessibleStreamableContent-Interface.html is in at-spi-doc 1.32.0-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AccessibleStreamableContent Interface</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
<link rel="up" href="spi-component.html" title="Subinterface Methods">
<link rel="prev" href="at-spi-cspi-AccessibleSelection-Interface.html" title="AccessibleSelection Interface">
<link rel="next" href="at-spi-cspi-AccessibleTable-Interface.html" title="AccessibleTable Interface">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="at-spi-cspi-AccessibleSelection-Interface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="spi-component.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">AT-SPI C Bindings Reference Manual</th>
<td><a accesskey="n" href="at-spi-cspi-AccessibleTable-Interface.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#at-spi-cspi-AccessibleStreamableContent-Interface.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#at-spi-cspi-AccessibleStreamableContent-Interface.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="at-spi-cspi-AccessibleStreamableContent-Interface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="at-spi-cspi-AccessibleStreamableContent-Interface.top_of_page"></a>AccessibleStreamableContent Interface</span></h2>
<p>AccessibleStreamableContent Interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="at-spi-cspi-AccessibleStreamableContent-Interface.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum                <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContentSeekType" title="enum AccessibleStreamableContentSeekType">AccessibleStreamableContentSeekType</a>;
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-freeContentTypesList" title="AccessibleStreamableContent_freeContentTypesList ()">AccessibleStreamableContent_freeContentTypesList</a>
                                                        (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **content_types</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-ref" title="AccessibleStreamableContent_ref ()">AccessibleStreamableContent_ref</a>     (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-unref" title="AccessibleStreamableContent_unref ()">AccessibleStreamableContent_unref</a>   (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>);
<span class="returnvalue">char</span> **             <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-getContentTypes" title="AccessibleStreamableContent_getContentTypes ()">AccessibleStreamableContent_getContentTypes</a>
                                                        (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>);
<span class="returnvalue">SPIBoolean</span>          <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-open" title="AccessibleStreamableContent_open ()">AccessibleStreamableContent_open</a>    (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *content_type</code></em>);
<span class="returnvalue">long</span>                <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-seek" title="AccessibleStreamableContent_seek ()">AccessibleStreamableContent_seek</a>    (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> offset</code></em>,
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContentSeekType" title="enum AccessibleStreamableContentSeekType"><span class="type">AccessibleStreamableContentSeekType</span></a> seek_type</code></em>);
<span class="returnvalue">SPIBoolean</span>          <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-read" title="AccessibleStreamableContent_read ()">AccessibleStreamableContent_read</a>    (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">void</span> *buff</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> nbytes</code></em>,
                                                         <em class="parameter"><code>unsigned <span class="type">int</span> read_type</code></em>);
<span class="returnvalue">SPIBoolean</span>          <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-close" title="AccessibleStreamableContent_close ()">AccessibleStreamableContent_close</a>   (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleStreamableContent-Interface.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleStreamableContent-Interface.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AccessibleStreamableContentSeekType"></a><h3>enum AccessibleStreamableContentSeekType</h3>
<pre class="programlisting">typedef enum {
  SPI_STREAM_SEEK_SET,
  SPI_STREAM_SEEK_CUR,
  SPI_STREAM_SEEK_END
} AccessibleStreamableContentSeekType;
</pre>
<p>
The seek type for a specified offset in AccessibleStreamableContent_seek.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="SPI-STREAM-SEEK-SET:CAPS"></a><span class="term"><code class="literal">SPI_STREAM_SEEK_SET</code></span></p></td>
<td>seek from the 'top' of the streamable
</td>
</tr>
<tr>
<td><p><a name="SPI-STREAM-SEEK-CUR:CAPS"></a><span class="term"><code class="literal">SPI_STREAM_SEEK_CUR</code></span></p></td>
<td>seek from the current position in the stream
</td>
</tr>
<tr>
<td><p><a name="SPI-STREAM-SEEK-END:CAPS"></a><span class="term"><code class="literal">SPI_STREAM_SEEK_END</code></span></p></td>
<td>seek from the end of the stream (if known)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleStreamableContent-freeContentTypesList"></a><h3>AccessibleStreamableContent_freeContentTypesList ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleStreamableContent_freeContentTypesList
                                                        (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **content_types</code></em>);</pre>
<p>
Free the memory associated with a call to <a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-getContentTypes" title="AccessibleStreamableContent_getContentTypes ()"><span class="type">AccessibleStreamableContent_getContentTypes</span></a>, once 
the result has been used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>the AccessibleStreamableContent implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>content_types</code></em> :</span></p></td>
<td>a list of content types previously returned by
<a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-getContentTypes" title="AccessibleStreamableContent_getContentTypes ()"><span class="type">AccessibleStreamableContent_getContentTypes</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since AT-SPI 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleStreamableContent-ref"></a><h3>AccessibleStreamableContent_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleStreamableContent_ref     (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>);</pre>
<p>
Increment the reference count for an <span class="type">AccessibleStreamableContent</span> object.
</p>
<p>
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleStreamableContent</span> implementor on which to
operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleStreamableContent-unref"></a><h3>AccessibleStreamableContent_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleStreamableContent_unref   (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>);</pre>
<p>
Decrement the reference count for an <span class="type">AccessibleStreamableContent</span> object.
</p>
<p>
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleStreamableContent</span> implementor
on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleStreamableContent-getContentTypes"></a><h3>AccessibleStreamableContent_getContentTypes ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> **             AccessibleStreamableContent_getContentTypes
                                                        (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>);</pre>
<p>
Get a list of strings containing the content mimetypes available from an
      <span class="type">AccessibleStreamableContent</span> implementor.
</p>
<p>
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleStreamableContent</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an array of strings, terminated by a NULL string, specifying the
mimetypes for which the streamed content is available.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleStreamableContent-open"></a><h3>AccessibleStreamableContent_open ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span>          AccessibleStreamableContent_open    (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *content_type</code></em>);</pre>
<p>
Open a streaming connection to an AccessibleStreamableContent implementor,
      of a particular content type.  Note that a client may only have one
      open stream per streamable interface instance in the current 
      implementation.
</p>
<p>
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleStreamableContent</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td>
<td>a string specifying the content type to retrieve (should match one
of the return strings from #<a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-getContentTypes" title="AccessibleStreamableContent_getContentTypes ()"><code class="function">AccessibleStreamableContent_getContentTypes()</code></a>).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> if unsuccessful.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleStreamableContent-seek"></a><h3>AccessibleStreamableContent_seek ()</h3>
<pre class="programlisting"><span class="returnvalue">long</span>                AccessibleStreamableContent_seek    (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> offset</code></em>,
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContentSeekType" title="enum AccessibleStreamableContentSeekType"><span class="type">AccessibleStreamableContentSeekType</span></a> seek_type</code></em>);</pre>
<p>
Cause the current streamable content connection (obtained via
    #<a class="link" href="at-spi-cspi-AccessibleStreamableContent-Interface.html#AccessibleStreamableContent-open" title="AccessibleStreamableContent_open ()"><code class="function">AccessibleStreamableContent_open()</code></a>) to seek to a particular offset in the
    stream.
</p>
<p>
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleStreamableContent</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>a long int specifying the offset into the stream.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>seek_type</code></em> :</span></p></td>
<td>an enum indicating the seek offset type, may be SEEK_SET,
SEEK_CUR, SEEK_END (as in the <code class="function">lseek()</code> libc command).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> if unsuccessful.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleStreamableContent-read"></a><h3>AccessibleStreamableContent_read ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span>          AccessibleStreamableContent_read    (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">void</span> *buff</code></em>,
                                                         <em class="parameter"><code>long <span class="type">int</span> nbytes</code></em>,
                                                         <em class="parameter"><code>unsigned <span class="type">int</span> read_type</code></em>);</pre>
<p>
Copy (read) bytes from the currently open streamable content connection
    to a buffer.  This is a blocking API, in the sense that it does not 
    return until the bytes have been read, or an error condition is 
    detected.
</p>
<p>
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleStreamableContent</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buff</code></em> :</span></p></td>
<td>a pointer to a buffer into which the resulting bytes read from the stream
are to be written.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nbytes</code></em> :</span></p></td>
<td>a long integer indicating the number of bytes to read/write.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>read_type</code></em> :</span></p></td>
<td>currently unused, specifies behavior of reads for streamed content
if blocking is not allowed, etc.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer indicating the number of bytes read, or -1 on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleStreamableContent-close"></a><h3>AccessibleStreamableContent_close ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span>          AccessibleStreamableContent_close   (<em class="parameter"><code><span class="type">AccessibleStreamableContent</span> *obj</code></em>);</pre>
<p>
Close the current streaming connection to an AccessibleStreamableContent implementor.
This must be called before any subsequent AccessibleStreamableContent_open
calls on the same object.
</p>
<p>
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleStreamableContent</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> if unsuccessful.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.