added null pointer check and assert

[wxWidgets.git] / docs / latex / wx / fltinstr.tex

diff --git a/docs/latex/wx/fltinstr.tex b/docs/latex/wx/fltinstr.tex
index df80a2cdfffcceff5570ef8d1a3363b1d5343584..f20a3659c97364f1b7817810804756f40c9da8b9 100644 (file)
--- a/docs/latex/wx/fltinstr.tex
+++ b/docs/latex/wx/fltinstr.tex
@@ -3,19 +3,46 @@
 % -----------------------------------------------------------------------------
 \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 decrypt 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{Library}
+
+\helpref{wxBase}{librarieslist}
 
 \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.
 
+\wxheading{See also}
+
+\helpref{wxFilterClassFactory}{wxfilterclassfactory}\\
+\helpref{wxFilterOutputStream}{wxfilteroutputstream}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 % -----------
 % ctor & dtor
 % -----------
-\membersection{wxFilterInputStream::wxFilterInputStream}
+\membersection{wxFilterInputStream::wxFilterInputStream}\label{wxfilterinputstreamctor}
 
 \func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
 
+\func{}{wxFilterInputStream}{\param{wxInputStream*}{ stream}}
+
+Initializes a "filter" stream.
+
+If the parent stream is passed as a pointer then the new filter stream
+takes ownership of it. If it is passed by reference then it does not.
+