]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/fltoutst.tex
Added missing documentation for a function
[wxWidgets.git] / docs / latex / wx / fltoutst.tex
index bb126f619e3c600fa73484057dc4053ef9c9819d..5b6e6d37d96bc5b43364c5f16633763fb8b3a480 100644 (file)
@@ -3,16 +3,27 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxFilterOutputStream}}\label{wxfilteroutputstream}
 
+A filter stream has the capability of a normal
+stream but it can be placed on top of another stream. So, for example, it
+can compress, encrypt the data which are passed to it and write them to another
+stream.
+
 \wxheading{Derived from}
 
 \helpref{wxOutputStream}{wxoutputstream}\\
 \helpref{wxStreamBase}{wxstreambase}
 
+\wxheading{Include files}
+
+<wx/stream.h>
+
 \wxheading{Note}
 
 The use of this class is exactly the same as of wxOutputStream. Only a constructor
 differs and it is documented below.
 
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 % -----------
 % ctor & dtor
 % -----------
@@ -20,3 +31,5 @@ differs and it is documented below.
 
 \func{}{wxFilterOutputStream}{\param{wxOutputStream\&}{ stream}}
 
+Initializes a "filter" stream.
+