source: trunk/doc/html/qiodevicesource.html@ 203

Last change on this file since 203 was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 5.3 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qasyncio.cpp:208 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QIODeviceSource Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QIODeviceSource Class Reference<br><small>[obsolete]</small></h1>
33
34<p>The QIODeviceSource class is a QDataSource that draws data from a QIODevice.
35<a href="#details">More...</a>
36<p><tt>#include &lt;<a href="qasyncio-h.html">qasyncio.h</a>&gt;</tt>
37<p>Inherits <a href="qdatasource.html">QDataSource</a>.
38<p><a href="qiodevicesource-members.html">List of all member functions.</a>
39<h2>Public Members</h2>
40<ul>
41<li class=fn><a href="#QIODeviceSource"><b>QIODeviceSource</b></a> ( QIODevice&nbsp;*&nbsp;device, int&nbsp;buffer_size = 4096 )</li>
42<li class=fn><a href="#~QIODeviceSource"><b>~QIODeviceSource</b></a> ()</li>
43<li class=fn>virtual int <a href="#readyToSend"><b>readyToSend</b></a> ()</li>
44<li class=fn>virtual void <a href="#sendTo"><b>sendTo</b></a> ( QDataSink&nbsp;*&nbsp;sink, int&nbsp;n )</li>
45<li class=fn>virtual bool <a href="#rewindable"><b>rewindable</b></a> () const</li>
46<li class=fn>virtual void <a href="#enableRewind"><b>enableRewind</b></a> ( bool&nbsp;on )</li>
47<li class=fn>virtual void <a href="#rewind"><b>rewind</b></a> ()</li>
48</ul>
49<hr><a name="details"></a><h2>Detailed Description</h2>
50
51
52<b>This class is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code.
53<p> The QIODeviceSource class is a QDataSource that draws data from a <a href="qiodevice.html">QIODevice</a>.
54<p> This class encapsulates retrieving data from a QIODevice (such as a <a href="qfile.html">QFile</a>).
55
56<hr><h2>Member Function Documentation</h2>
57<h3 class=fn><a name="QIODeviceSource"></a>QIODeviceSource::QIODeviceSource ( <a href="qiodevice.html">QIODevice</a>&nbsp;*&nbsp;device, int&nbsp;buffer_size = 4096 )
58</h3>
59Constructs a QIODeviceSource from the <a href="qiodevice.html">QIODevice</a> <em>device</em>. The QIODevice
60<em>must</em> be dynamically allocated, becomes owned by the QIODeviceSource,
61and will be deleted when the QIODeviceSource is destroyed. <em>buffer_size</em>
62determines the size of buffering to use between asynchronous operations.
63The higher the <em>buffer_size</em>, the more efficient, but the less interleaved
64the operation will be with other processing.
65
66<h3 class=fn><a name="~QIODeviceSource"></a>QIODeviceSource::~QIODeviceSource ()
67</h3>
68Destroys the QIODeviceSource, deleting the <a href="qiodevice.html">QIODevice</a> from which it was
69constructed.
70
71<h3 class=fn>void <a name="enableRewind"></a>QIODeviceSource::enableRewind ( bool&nbsp;on )<tt> [virtual]</tt>
72</h3>
73If <em>on</em> is set to TRUE then rewinding is enabled.
74No special action is taken. If <em>on</em> is set to
75FALSE then rewinding is disabled.
76
77<p>Reimplemented from <a href="qdatasource.html#enableRewind">QDataSource</a>.
78<h3 class=fn>int <a name="readyToSend"></a>QIODeviceSource::readyToSend ()<tt> [virtual]</tt>
79</h3>
80Ready until end-of-file.
81
82<p>Reimplemented from <a href="qdatasource.html#readyToSend">QDataSource</a>.
83<h3 class=fn>void <a name="rewind"></a>QIODeviceSource::rewind ()<tt> [virtual]</tt>
84</h3>
85Calls reset() on the <a href="qiodevice.html">QIODevice</a>.
86
87<p>Reimplemented from <a href="qdatasource.html#rewind">QDataSource</a>.
88<h3 class=fn>bool <a name="rewindable"></a>QIODeviceSource::rewindable () const<tt> [virtual]</tt>
89</h3>
90All QIODeviceSource's are rewindable.
91
92<p>Reimplemented from <a href="qdatasource.html#rewindable">QDataSource</a>.
93<h3 class=fn>void <a name="sendTo"></a>QIODeviceSource::sendTo ( <a href="qdatasink.html">QDataSink</a>&nbsp;*&nbsp;sink, int&nbsp;n )<tt> [virtual]</tt>
94</h3>
95Reads a block of data and sends up to <em>n</em> bytes to the <em>sink</em>.
96
97<p>Reimplemented from <a href="qdatasource.html#sendTo">QDataSource</a>.
98<!-- eof -->
99<hr><p>
100This file is part of the <a href="index.html">Qt toolkit</a>.
101Copyright &copy; 1995-2007
102<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
103<table width=100% cellspacing=0 border=0><tr>
104<td>Copyright &copy; 2007
105<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
106<td align=right><div align=right>Qt 3.3.8</div>
107</table></div></address></body>
108</html>
Note: See TracBrowser for help on using the repository browser.