X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/da3aea64f9e3cb2a3135ec108ab1721eae8457e2..78cb09ec439962b53ba75fef814b9a3871412287:/docs/latex/wx/fltinstr.tex?ds=sidebyside diff --git a/docs/latex/wx/fltinstr.tex b/docs/latex/wx/fltinstr.tex index 4e935524df..f20a3659c9 100644 --- a/docs/latex/wx/fltinstr.tex +++ b/docs/latex/wx/fltinstr.tex @@ -3,24 +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{wxStreamBase}{wxstreambase} +\wxheading{Include files} + + + +\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}} -Initializes a "filter" stream. A filter stream has the capability of a normal -stream but it can be placed on the top of another stream. So, for example, it -can uncompress, uncrypt the datas which are read from another stream and pass it -to the requester. +\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. +