Applied patch [ 1586964 ] Getting the PID of the process executed by wxProcess::Open()

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

diff --git a/docs/latex/wx/fltinstr.tex b/docs/latex/wx/fltinstr.tex
index 954e025cc5ed5be4a44b2b4907631ecdc8082df5..f521c0ddff2ac2ee6ea3067c14344977f95f34ff 100644 (file)
--- a/docs/latex/wx/fltinstr.tex
+++ b/docs/latex/wx/fltinstr.tex
@@ -3,20 +3,42 @@
 % -----------------------------------------------------------------------------
 \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{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.
 
+\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.
+