]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/fltoutst.tex
interface headers reviewed
[wxWidgets.git] / docs / latex / wx / fltoutst.tex
1 % -----------------------------------------------------------------------------
2 % wxFilterOutputStream
3 % -----------------------------------------------------------------------------
4 \section{\class{wxFilterOutputStream}}\label{wxfilteroutputstream}
5
6 A filter stream has the capability of a normal
7 stream but it can be placed on top of another stream. So, for example, it
8 can compress, encrypt the data which are passed to it and write them to another
9 stream.
10
11 \wxheading{Derived from}
12
13 \helpref{wxOutputStream}{wxoutputstream}\\
14 \helpref{wxStreamBase}{wxstreambase}
15
16 \wxheading{Include files}
17
18 <wx/stream.h>
19
20 \wxheading{Library}
21
22 \helpref{wxBase}{librarieslist}
23
24 \wxheading{Note}
25
26 The use of this class is exactly the same as of wxOutputStream. Only a constructor
27 differs and it is documented below.
28
29 \wxheading{See also}
30
31 \helpref{wxFilterClassFactory}{wxfilterclassfactory}\\
32 \helpref{wxFilterInputStream}{wxfilterinputstream}
33
34 \latexignore{\rtfignore{\wxheading{Members}}}
35
36 % -----------
37 % ctor & dtor
38 % -----------
39 \membersection{wxFilterOutputStream::wxFilterOutputStream}\label{wxfilteroutputstreamctor}
40
41 \func{}{wxFilterOutputStream}{\param{wxOutputStream\&}{ stream}}
42
43 \func{}{wxFilterOutputStream}{\param{wxOutputStream*}{ stream}}
44
45 Initializes a "filter" stream.
46
47 If the parent stream is passed as a pointer then the new filter stream
48 takes ownership of it. If it is passed by reference then it does not.
49