]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/fltinstr.tex
fixed another return FALSE in a function returning a pointer (patch 545046)
[wxWidgets.git] / docs / latex / wx / fltinstr.tex
index df80a2cdfffcceff5570ef8d1a3363b1d5343584..395751351d21a9087f33806e4a246023c8555128 100644 (file)
@@ -3,15 +3,26 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxFilterInputStream}}\label{wxfilterinputstream}
 
+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 uncompress or uncrypt the data which are read
+from another stream and pass it to the requester.
+
 \wxheading{Derived from}
 
-\helpref{wxInputStream}{wxinputstream}
+\helpref{wxInputStream}{wxinputstream}\\
+\helpref{wxStreamBase}{wxstreambase}
+
+\wxheading{Include files}
+
+<wx/stream.h>
 
 \wxheading{Note}
 
-The use of this class is exactly the same as of wxInputStream. Only a constructor
+The interface of this class is the same as that of wxInputStream. Only a constructor
 differs and it is documented below.
 
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 % -----------
 % ctor & dtor
 % -----------
@@ -19,3 +30,5 @@ differs and it is documented below.
 
 \func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
 
+Initializes a "filter" stream.
+