summaryrefslogtreecommitdiffstats
path: root/doc/html/tqnpstream.html
blob: 2c6437a7925c69b5b3cb2bdc5878200ab6944e06 (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQNPStream Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQNPStream Class Reference</h1>

<p>The TQNPStream class provides a stream of data provided to a TQNPInstance by the browser.
<a href="#details">More...</a>
<p>This class is part of the <b>TQt Netscape Extension</b>.
<p><tt>#include &lt;<a href="tqnp-h.html">tqnp.h</a>&gt;</tt>
<p><a href="tqnpstream-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#~TQNPStream"><b>~TQNPStream</b></a> ()</li>
<li class=fn>const char * <a href="#url"><b>url</b></a> () const</li>
<li class=fn>uint <a href="#end"><b>end</b></a> () const</li>
<li class=fn>uint <a href="#lastModified"><b>lastModified</b></a> () const</li>
<li class=fn>const char * <a href="#type"><b>type</b></a> () const</li>
<li class=fn>bool <a href="#seekable"><b>seekable</b></a> () const</li>
<li class=fn>bool <a href="#okay"><b>okay</b></a> () const</li>
<li class=fn>bool <a href="#complete"><b>complete</b></a> () const</li>
<li class=fn>void <a href="#requestRead"><b>requestRead</b></a> ( int&nbsp;offset, uint&nbsp;length )</li>
<li class=fn>int <a href="#write"><b>write</b></a> ( int&nbsp;len, void&nbsp;*&nbsp;buffer )</li>
<li class=fn>TQNPInstance * <a href="#instance"><b>instance</b></a> ()</li>
<li class=fn><a href="#TQNPStream"><b>TQNPStream</b></a> ( TQNPInstance&nbsp;*&nbsp;in, const&nbsp;char&nbsp;*&nbsp;mt, _NPStream&nbsp;*&nbsp;st, bool&nbsp;se )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
<p> This class is defined in the <b>TQt <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 TQt API.
<p>

The TQNPStream class provides a stream of data provided to a <a href="tqnpinstance.html">TQNPInstance</a> by the browser.
<p> 
<p> Note that this is neither a <a href="tqtextstream.html">TQTextStream</a> nor a <a href="tqdatastream.html">TQDataStream</a>.
<p> <p>See also <a href="tqnpinstance.html#write">TQNPInstance::write</a>() and <a href="tqnpinstance.html#newStreamCreated">TQNPInstance::newStreamCreated</a>().

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="TQNPStream"></a>TQNPStream::TQNPStream ( <a href="tqnpinstance.html">TQNPInstance</a>&nbsp;*&nbsp;in, const&nbsp;char&nbsp;*&nbsp;mt, _NPStream&nbsp;*&nbsp;st, bool&nbsp;se )
</h3>
Creates a stream. Plugins should not call this; they should call
<a href="tqnpinstance.html#newStream">TQNPInstance::newStream</a>() if they need a stream.
<p> Takes a <a href="tqnpinstance.html">TQNPInstance</a> <em>in</em>, MIME type <em>mt</em>, a pointer to an
_NPStream <em>st</em> and a seekable flag <em>se</em>.

<h3 class=fn><a name="~TQNPStream"></a>TQNPStream::~TQNPStream ()
</h3>
Destroys the stream.

<h3 class=fn>bool <a name="complete"></a>TQNPStream::complete () const
</h3>
Returns TRUE if the stream has received all the data from the
source; otherwise returns FALSE.

<h3 class=fn>uint <a name="end"></a>TQNPStream::end () const
</h3>
Returns the length of the stream in bytes. The function might
return 0 for streams of unknown length.

<h3 class=fn><a href="tqnpinstance.html">TQNPInstance</a>&nbsp;* <a name="instance"></a>TQNPStream::instance ()
</h3>

<p> Returns the <a href="tqnpinstance.html">TQNPInstance</a> for which this stream was created.

<h3 class=fn>uint <a name="lastModified"></a>TQNPStream::lastModified () const
</h3>
Returns the time when the source of the stream was last modified.

<h3 class=fn>bool <a name="okay"></a>TQNPStream::okay () const
</h3>
Returns TRUE if no errors have occurred on the stream; otherwise
returns FALSE.

<h3 class=fn>void <a name="requestRead"></a>TQNPStream::requestRead ( int&nbsp;offset, uint&nbsp;length )
</h3>
Requests the section of the stream, of <em>length</em> bytes from <em>offset</em>, be sent to the <a href="tqnpinstance.html#write">TQNPInstance::write</a>() function of the
<a href="#instance">instance</a>() of this stream.

<h3 class=fn>bool <a name="seekable"></a>TQNPStream::seekable () const
</h3>
Returns TRUE if the stream is seekable; otherwise returns FALSE.

<h3 class=fn>const char * <a name="type"></a>TQNPStream::type () const
</h3>
Returns the MIME type of the stream.

<h3 class=fn>const char * <a name="url"></a>TQNPStream::url () const
</h3>
Returns the URL from which the stream was created.

<h3 class=fn>int <a name="write"></a>TQNPStream::write ( int&nbsp;len, void&nbsp;*&nbsp;buffer )
</h3>
Writes <em>len</em> bytes from <em>buffer</em> <em>to</em> the stream.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>