qnpstream(3qt)

1QNPStream(3qt)                                                  QNPStream(3qt)
2
3
4

NAME

6       QNPStream - Stream of data provided to a QNPInstance by the browser
7

SYNOPSIS

9       This class is part of the Qt Netscape Extension.
10
11       #include <qnp.h>
12
13   Public Members
14       ~QNPStream ()
15       const char * url () const
16       uint end () const
17       uint lastModified () const
18       const char * type () const
19       bool seekable () const
20       bool okay () const
21       bool complete () const
22       void requestRead ( int offset, uint length )
23       int write ( int len, void * buffer )
24       QNPInstance * instance ()
25       QNPStream ( QNPInstance * in, const char * mt, _NPStream * st, bool se
26           )
27

DESCRIPTION

29       This class is defined in the Qt Netscape Extension, which can be found
30       in the qt/extensions directory. It is not included in the main Qt API.
31
32       The QNPStream class provides a stream of data provided to a QNPInstance
33       by the browser.
34
35       Note that this is neither a QTextStream nor a QDataStream.
36
37       See also QNPInstance::write() and QNPInstance::newStreamCreated().
38

MEMBER FUNCTION DOCUMENTATION

QNPStream::QNPStream ( QNPInstance * in, const char * mt, _NPStream * st, bool

41       se )
42       Creates a stream. Plugins should not call this; they should call
43       QNPInstance::newStream() if they need a stream.
44
45       Takes a QNPInstance in, MIME type mt, a pointer to an _NPStream st and
46       a seekable flag se.
47

QNPStream::~QNPStream ()

49       Destroys the stream.
50

bool QNPStream::complete () const

52       Returns TRUE if the stream has received all the data from the source;
53       otherwise returns FALSE.
54

uint QNPStream::end () const

56       Returns the length of the stream in bytes. The function might return 0
57       for streams of unknown length.
58

QNPInstance * QNPStream::instance ()

60       Returns the QNPInstance for which this stream was created.
61

uint QNPStream::lastModified () const

63       Returns the time when the source of the stream was last modified.
64

bool QNPStream::okay () const

66       Returns TRUE if no errors have occurred on the stream; otherwise
67       returns FALSE.
68

void QNPStream::requestRead ( int offset, uint length )

70       Requests the section of the stream, of length bytes from offset, be
71       sent to the QNPInstance::write() function of the instance() of this
72       stream.
73

bool QNPStream::seekable () const

75       Returns TRUE if the stream is seekable; otherwise returns FALSE.
76

const char * QNPStream::type () const

78       Returns the MIME type of the stream.
79

const char * QNPStream::url () const

81       Returns the URL from which the stream was created.
82

int QNPStream::write ( int len, void * buffer )

84       Writes len bytes from buffer to the stream.
85
86

COPYRIGHT

92       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
93       license file included in the distribution for a complete license
94       statement.
95

AUTHOR

97       Generated automatically from the source code.
98

BUGS

100       If you find a bug in Qt, please report it as described in
101       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
102       help you. Thank you.
103
104       The definitive Qt documentation is provided in HTML format; it is
105       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
106       web browser. This man page is provided as a convenience for those users
107       who prefer man pages, although this format is not officially supported
108       by Trolltech.
109
110       If you find errors in this manual page, please report them to qt-
111       bugs@trolltech.com.  Please include the name of the manual page
112       (qnpstream.3qt) and the Qt version (3.3.8).
113
114
115
116Trolltech AS                    2 February 2007                 QNPStream(3qt)