<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::ContentStream Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="tabs2">
<ul class="tablist">
<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="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1ContentStream.html">Accessibility::ContentStream</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Accessibility::ContentStream Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::ContentStream" -->
<p><code>import "<a class="el" href="Accessibility__StreamableContent_8idl_source.html">Accessibility_StreamableContent.idl</a>";</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" 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" 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" 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>
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#a73bba2b2c114a719cc0ba095063fdeb2">SeekType</a> { <a class="el" href="interfaceAccessibility_1_1ContentStream.html#a73bba2b2c114a719cc0ba095063fdeb2a218beadb76afc4b26bd7374e21de2390">SEEK_SET</a>,
<a class="el" href="interfaceAccessibility_1_1ContentStream.html#a73bba2b2c114a719cc0ba095063fdeb2a0883248c28863de04e0572241e7c1477">SEEK_CURRENT</a>,
<a class="el" href="interfaceAccessibility_1_1ContentStream.html#a73bba2b2c114a719cc0ba095063fdeb2a2ccbe0c9974bcc3f373998c9bc445ec3">SEEK_END</a>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef sequence< octet > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#a8554cffb7178852d6e32f5d31acea7b2">iobuf</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#a9d2e27a11b34ef37915fbe9faaa0b1c3">seek</a> (in long offset, in <a class="el" href="interfaceAccessibility_1_1ContentStream.html#a73bba2b2c114a719cc0ba095063fdeb2">SeekType</a> whence) raises (NoPermission, IOError, NotSupported)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#a2c7c1a819f382074dbed4a171230e12b">read</a> (in long count, out <a class="el" href="interfaceAccessibility_1_1ContentStream.html#a8554cffb7178852d6e32f5d31acea7b2">iobuf</a> buffer) raises (NoPermission, IOError)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#a19338fb054d17f19662f7547eb0ed5ca">close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#a2bc0e530c02eb51ae4c29b7807db636a">unimplemented</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1ContentStream.html#a553d83c4bdb7824ef24d3cc3765b139b">unimplemented2</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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. </p>
<dl class="note"><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"><dt><b>Since:</b></dt><dd>AT-SPI 1.7.0 </dd></dl>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a8554cffb7178852d6e32f5d31acea7b2"></a><!-- doxytag: member="Accessibility::ContentStream::iobuf" ref="a8554cffb7178852d6e32f5d31acea7b2" 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#a8554cffb7178852d6e32f5d31acea7b2">Accessibility::ContentStream::iobuf</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a73bba2b2c114a719cc0ba095063fdeb2"></a><!-- doxytag: member="Accessibility::ContentStream::SeekType" ref="a73bba2b2c114a719cc0ba095063fdeb2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceAccessibility_1_1ContentStream.html#a73bba2b2c114a719cc0ba095063fdeb2">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. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a73bba2b2c114a719cc0ba095063fdeb2a218beadb76afc4b26bd7374e21de2390"></a><!-- doxytag: member="SEEK_SET" ref="a73bba2b2c114a719cc0ba095063fdeb2a218beadb76afc4b26bd7374e21de2390" args="" -->SEEK_SET</em> </td><td>
<p>Seek from the start of the stream or data source. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a73bba2b2c114a719cc0ba095063fdeb2a0883248c28863de04e0572241e7c1477"></a><!-- doxytag: member="SEEK_CURRENT" ref="a73bba2b2c114a719cc0ba095063fdeb2a0883248c28863de04e0572241e7c1477" args="" -->SEEK_CURRENT</em> </td><td>
<p>Seek relative to the current position. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a73bba2b2c114a719cc0ba095063fdeb2a2ccbe0c9974bcc3f373998c9bc445ec3"></a><!-- doxytag: member="SEEK_END" ref="a73bba2b2c114a719cc0ba095063fdeb2a2ccbe0c9974bcc3f373998c9bc445ec3" args="" -->SEEK_END</em> </td><td>
<p>Seek from the end of the file, stream, or data source. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a19338fb054d17f19662f7547eb0ed5ca"></a><!-- doxytag: member="Accessibility::ContentStream::close" ref="a19338fb054d17f19662f7547eb0ed5ca" 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></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. </p>
</div>
</div>
<a class="anchor" id="a2c7c1a819f382074dbed4a171230e12b"></a><!-- doxytag: member="Accessibility::ContentStream::read" ref="a2c7c1a819f382074dbed4a171230e12b" 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#a8554cffb7178852d6e32f5d31acea7b2">iobuf</a> </td>
<td class="paramname"> <em>buffer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> 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. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of bytes actually read into the client buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a9d2e27a11b34ef37915fbe9faaa0b1c3"></a><!-- doxytag: member="Accessibility::ContentStream::seek" ref="a9d2e27a11b34ef37915fbe9faaa0b1c3" 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#a73bba2b2c114a719cc0ba095063fdeb2">SeekType</a> </td>
<td class="paramname"> <em>whence</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> 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. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the actual resulting offset, if no exception was raised. </dd></dl>
</div>
</div>
<a class="anchor" id="a2bc0e530c02eb51ae4c29b7807db636a"></a><!-- doxytag: member="Accessibility::ContentStream::unimplemented" ref="a2bc0e530c02eb51ae4c29b7807db636a" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>/cond </p>
</div>
</div>
<a class="anchor" id="a553d83c4bdb7824ef24d3cc3765b139b"></a><!-- doxytag: member="Accessibility::ContentStream::unimplemented2" ref="a553d83c4bdb7824ef24d3cc3765b139b" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
