<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>at-spi-idl: Accessibility::ContentStream Interface Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.2 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> <div class="nav"> <a class="el" href="namespaceAccessibility.html">Accessibility</a>::<a class="el" href="interfaceAccessibility_1_1ContentStream.html">ContentStream</a></div> <h1>Accessibility::ContentStream Interface Reference</h1><!-- doxytag: class="Accessibility::ContentStream" --><code>import "<a class="el" href="Accessibility__StreamableContent_8idl-source.html">Accessibility_StreamableContent.idl</a>";</code> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#4a1a5ddc2ea1eed1c7b7e2ced6446670">SeekType</a> { <a class="el" href="interfaceAccessibility_1_1ContentStream.html#4a1a5ddc2ea1eed1c7b7e2ced64466704a0b8493423f05ab26e5846444b50cec">SEEK_SET</a>, <a class="el" href="interfaceAccessibility_1_1ContentStream.html#4a1a5ddc2ea1eed1c7b7e2ced64466705268bca16e26f97aa8c8213d804e8239">SEEK_CURRENT</a>, <a class="el" href="interfaceAccessibility_1_1ContentStream.html#4a1a5ddc2ea1eed1c7b7e2ced64466703662841022b56ddafa83ad8e28402508">SEEK_END</a> }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef sequence< octet > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#1ae044794ce26c96441ddec475067b95">iobuf</a></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#c5e3115836f279dfe36997d74b84eabb">seek</a> (in long offset, in <a class="el" href="interfaceAccessibility_1_1ContentStream.html#4a1a5ddc2ea1eed1c7b7e2ced6446670">SeekType</a> whence) raises (NoPermission, IOError, NotSupported)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#59cbbe1737fba200ce7ea9b0c04b6185">read</a> (in long count, out <a class="el" href="interfaceAccessibility_1_1ContentStream.html#1ae044794ce26c96441ddec475067b95">iobuf</a> buffer) raises (NoPermission, IOError)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#dec3f2ce4f911dac6e22d3e9f2e6526a">close</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#878e5f0bb4194d5e60c1db3769c4006c">unimplemented</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#4725d0bf5ab1d016a1b7735886842426">unimplemented2</a> ()</td></tr> <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">exception </td><td class="memItemRight" valign="bottom"><a class="el" href="exceptionAccessibility_1_1ContentStream_1_1IOError.html">IOError</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">exception </td><td class="memItemRight" valign="bottom"><a class="el" href="exceptionAccessibility_1_1ContentStream_1_1NoPermission.html">NoPermission</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">exception </td><td class="memItemRight" valign="bottom"><a class="el" href="exceptionAccessibility_1_1ContentStream_1_1NotSupported.html">NotSupported</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An interface by which the requested data from a <a class="el" href="interfaceAccessibility_1_1StreamableContent.html">StreamableContent</a> object may be read by the client. <dl class="note" compact><dt><b>Note:</b></dt><dd>this interface supercedes the use of BonoboStream by previous versions of <a class="el" href="interfaceAccessibility_1_1StreamableContent.html">StreamableContent</a>.</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd>AT-SPI 1.7.0 </dd></dl> <p> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="1ae044794ce26c96441ddec475067b95"></a><!-- doxytag: member="Accessibility::ContentStream::iobuf" ref="1ae044794ce26c96441ddec475067b95" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef sequence<octet> <a class="el" href="interfaceAccessibility_1_1ContentStream.html#1ae044794ce26c96441ddec475067b95">Accessibility::ContentStream::iobuf</a> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Enumeration Documentation</h2> <a class="anchor" name="4a1a5ddc2ea1eed1c7b7e2ced6446670"></a><!-- doxytag: member="Accessibility::ContentStream::SeekType" ref="4a1a5ddc2ea1eed1c7b7e2ced6446670" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="interfaceAccessibility_1_1ContentStream.html#4a1a5ddc2ea1eed1c7b7e2ced6446670">Accessibility::ContentStream::SeekType</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Specifies the meaning of a seek 'offset'. Not all SeekTypes are supported by all <a class="el" href="interfaceAccessibility_1_1StreamableContent.html">StreamableContent</a> data sources, for instance some streams may not support seeking from the beginning or other types of 'backwards' seeks. <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" name="4a1a5ddc2ea1eed1c7b7e2ced64466704a0b8493423f05ab26e5846444b50cec"></a><!-- doxytag: member="SEEK_SET" ref="4a1a5ddc2ea1eed1c7b7e2ced64466704a0b8493423f05ab26e5846444b50cec" args="" -->SEEK_SET</em> </td><td> Seek from the start of the stream or data source. </td></tr> <tr><td valign="top"><em><a class="anchor" name="4a1a5ddc2ea1eed1c7b7e2ced64466705268bca16e26f97aa8c8213d804e8239"></a><!-- doxytag: member="SEEK_CURRENT" ref="4a1a5ddc2ea1eed1c7b7e2ced64466705268bca16e26f97aa8c8213d804e8239" args="" -->SEEK_CURRENT</em> </td><td> Seek relative to the current position. </td></tr> <tr><td valign="top"><em><a class="anchor" name="4a1a5ddc2ea1eed1c7b7e2ced64466703662841022b56ddafa83ad8e28402508"></a><!-- doxytag: member="SEEK_END" ref="4a1a5ddc2ea1eed1c7b7e2ced64466703662841022b56ddafa83ad8e28402508" args="" -->SEEK_END</em> </td><td> Seek from the end of the file, stream, or data source. </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="c5e3115836f279dfe36997d74b84eabb"></a><!-- doxytag: member="Accessibility::ContentStream::seek" ref="c5e3115836f279dfe36997d74b84eabb" args="(in long offset, in SeekType whence)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">long Accessibility::ContentStream::seek </td> <td>(</td> <td class="paramtype">in long </td> <td class="paramname"> <em>offset</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1ContentStream.html#4a1a5ddc2ea1eed1c7b7e2ced6446670">SeekType</a> </td> <td class="paramname"> <em>whence</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"> raises (<a class="el" href="exceptionAccessibility_1_1ContentStream_1_1NoPermission.html">NoPermission</a>, <a class="el" href="exceptionAccessibility_1_1ContentStream_1_1IOError.html">IOError</a>, <a class="el" href="exceptionAccessibility_1_1ContentStream_1_1NotSupported.html">NotSupported</a>)</td> </tr> </table> </div> <div class="memdoc"> <p> Seek to a specified position in the Stream. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>an offset specifying the requested position in the stream, relative to the SeekType specified in <code>whence</code>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>whence</em> </td><td>a SeekType specifying the reference point from which the seek offset is calculated. Some forms of seek are not supported by certain implementations of Stream, in which case a <a class="el" href="exceptionAccessibility_1_1ContentStream_1_1NotSupported.html">NotSupported</a> exception will be raised. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the actual resulting offset, if no exception was raised. </dd></dl> </div> </div><p> <a class="anchor" name="59cbbe1737fba200ce7ea9b0c04b6185"></a><!-- doxytag: member="Accessibility::ContentStream::read" ref="59cbbe1737fba200ce7ea9b0c04b6185" args="(in long count, out iobuf buffer)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">long Accessibility::ContentStream::read </td> <td>(</td> <td class="paramtype">in long </td> <td class="paramname"> <em>count</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">out <a class="el" href="interfaceAccessibility_1_1ContentStream.html#1ae044794ce26c96441ddec475067b95">iobuf</a> </td> <td class="paramname"> <em>buffer</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"> raises (<a class="el" href="exceptionAccessibility_1_1ContentStream_1_1NoPermission.html">NoPermission</a>, <a class="el" href="exceptionAccessibility_1_1ContentStream_1_1IOError.html">IOError</a>)</td> </tr> </table> </div> <div class="memdoc"> <p> Request/read a specified amount of data from a Stream. <dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of bytes actually read into the client buffer. </dd></dl> </div> </div><p> <a class="anchor" name="dec3f2ce4f911dac6e22d3e9f2e6526a"></a><!-- doxytag: member="Accessibility::ContentStream::close" ref="dec3f2ce4f911dac6e22d3e9f2e6526a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Accessibility::ContentStream::close </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> close the stream and release associated resources. A client should not perform further operations on a StreamableContent::Stream object after closing it. </div> </div><p> <a class="anchor" name="878e5f0bb4194d5e60c1db3769c4006c"></a><!-- doxytag: member="Accessibility::ContentStream::unimplemented" ref="878e5f0bb4194d5e60c1db3769c4006c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Accessibility::ContentStream::unimplemented </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> /cond </div> </div><p> <a class="anchor" name="4725d0bf5ab1d016a1b7735886842426"></a><!-- doxytag: member="Accessibility::ContentStream::unimplemented2" ref="4725d0bf5ab1d016a1b7735886842426" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Accessibility::ContentStream::unimplemented2 </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr>The documentation for this interface was generated from the following file:<ul> <li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__StreamableContent_8idl-source.html">Accessibility_StreamableContent.idl</a></ul> <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jul 10 10:46:52 2007 for at-spi-idl by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address> </body> </html>