source: trunk/doc/html/qnpstream.html

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

reference documentation added

File size: 6.1 KB
RevLine 
[190]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/extensions/nsplugin/src/qnp.cpp:1271 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QNPStream 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>QNPStream Class Reference</h1>
33
34<p>The QNPStream class provides a stream of data provided to a QNPInstance by the browser.
35<a href="#details">More...</a>
36<p>This class is part of the <b>Qt Netscape Extension</b>.
37<p><tt>#include &lt;<a href="qnp-h.html">qnp.h</a>&gt;</tt>
38<p><a href="qnpstream-members.html">List of all member functions.</a>
39<h2>Public Members</h2>
40<ul>
41<li class=fn><a href="#~QNPStream"><b>~QNPStream</b></a> ()</li>
42<li class=fn>const char * <a href="#url"><b>url</b></a> () const</li>
43<li class=fn>uint <a href="#end"><b>end</b></a> () const</li>
44<li class=fn>uint <a href="#lastModified"><b>lastModified</b></a> () const</li>
45<li class=fn>const char * <a href="#type"><b>type</b></a> () const</li>
46<li class=fn>bool <a href="#seekable"><b>seekable</b></a> () const</li>
47<li class=fn>bool <a href="#okay"><b>okay</b></a> () const</li>
48<li class=fn>bool <a href="#complete"><b>complete</b></a> () const</li>
49<li class=fn>void <a href="#requestRead"><b>requestRead</b></a> ( int&nbsp;offset, uint&nbsp;length )</li>
50<li class=fn>int <a href="#write"><b>write</b></a> ( int&nbsp;len, void&nbsp;*&nbsp;buffer )</li>
51<li class=fn>QNPInstance * <a href="#instance"><b>instance</b></a> ()</li>
52<li class=fn><a href="#QNPStream"><b>QNPStream</b></a> ( QNPInstance&nbsp;*&nbsp;in, const&nbsp;char&nbsp;*&nbsp;mt, _NPStream&nbsp;*&nbsp;st, bool&nbsp;se )</li>
53</ul>
54<hr><a name="details"></a><h2>Detailed Description</h2>
55<p> This class is defined in the <b>Qt <a href="netscape-plugin.html#Netscape">Netscape</a> Extension</b>, which can be found in the <tt>qt/extensions</tt> directory. It is not included in the main Qt API.
56<p>
57
58The QNPStream class provides a stream of data provided to a <a href="qnpinstance.html">QNPInstance</a> by the browser.
59<p>
60<p> Note that this is neither a <a href="qtextstream.html">QTextStream</a> nor a <a href="qdatastream.html">QDataStream</a>.
61<p> <p>See also <a href="qnpinstance.html#write">QNPInstance::write</a>() and <a href="qnpinstance.html#newStreamCreated">QNPInstance::newStreamCreated</a>().
62
63<hr><h2>Member Function Documentation</h2>
64<h3 class=fn><a name="QNPStream"></a>QNPStream::QNPStream ( <a href="qnpinstance.html">QNPInstance</a>&nbsp;*&nbsp;in, const&nbsp;char&nbsp;*&nbsp;mt, _NPStream&nbsp;*&nbsp;st, bool&nbsp;se )
65</h3>
66Creates a stream. Plugins should not call this; they should call
67<a href="qnpinstance.html#newStream">QNPInstance::newStream</a>() if they need a stream.
68<p> Takes a <a href="qnpinstance.html">QNPInstance</a> <em>in</em>, MIME type <em>mt</em>, a pointer to an
69_NPStream <em>st</em> and a seekable flag <em>se</em>.
70
71<h3 class=fn><a name="~QNPStream"></a>QNPStream::~QNPStream ()
72</h3>
73Destroys the stream.
74
75<h3 class=fn>bool <a name="complete"></a>QNPStream::complete () const
76</h3>
77Returns TRUE if the stream has received all the data from the
78source; otherwise returns FALSE.
79
80<h3 class=fn>uint <a name="end"></a>QNPStream::end () const
81</h3>
82Returns the length of the stream in bytes. The function might
83return 0 for streams of unknown length.
84
85<h3 class=fn><a href="qnpinstance.html">QNPInstance</a>&nbsp;* <a name="instance"></a>QNPStream::instance ()
86</h3>
87
88<p> Returns the <a href="qnpinstance.html">QNPInstance</a> for which this stream was created.
89
90<h3 class=fn>uint <a name="lastModified"></a>QNPStream::lastModified () const
91</h3>
92Returns the time when the source of the stream was last modified.
93
94<h3 class=fn>bool <a name="okay"></a>QNPStream::okay () const
95</h3>
96Returns TRUE if no errors have occurred on the stream; otherwise
97returns FALSE.
98
99<h3 class=fn>void <a name="requestRead"></a>QNPStream::requestRead ( int&nbsp;offset, uint&nbsp;length )
100</h3>
101Requests the section of the stream, of <em>length</em> bytes from <em>offset</em>, be sent to the <a href="qnpinstance.html#write">QNPInstance::write</a>() function of the
102<a href="#instance">instance</a>() of this stream.
103
104<h3 class=fn>bool <a name="seekable"></a>QNPStream::seekable () const
105</h3>
106Returns TRUE if the stream is seekable; otherwise returns FALSE.
107
108<h3 class=fn>const char * <a name="type"></a>QNPStream::type () const
109</h3>
110Returns the MIME type of the stream.
111
112<h3 class=fn>const char * <a name="url"></a>QNPStream::url () const
113</h3>
114Returns the URL from which the stream was created.
115
116<h3 class=fn>int <a name="write"></a>QNPStream::write ( int&nbsp;len, void&nbsp;*&nbsp;buffer )
117</h3>
118Writes <em>len</em> bytes from <em>buffer</em> <em>to</em> the stream.
119
120<!-- eof -->
121<hr><p>
122This file is part of the <a href="index.html">Qt toolkit</a>.
123Copyright &copy; 1995-2007
124<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
125<table width=100% cellspacing=0 border=0><tr>
126<td>Copyright &copy; 2007
127<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
128<td align=right><div align=right>Qt 3.3.8</div>
129</table></div></address></body>
130</html>
Note: See TracBrowser for help on using the repository browser.