wxWidgets/docs/latex/wx/fltinstr.tex
Michael Wetherell 716b1f7091 Document filter streams take owner ship when created with a pointer,
new feature of the archive factories and new filter factories.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42614 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2006-10-29 12:56:48 +00:00

45 lines
1.3 KiB
TeX

% -----------------------------------------------------------------------------
% wxFilterInputStream
% -----------------------------------------------------------------------------
\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 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}\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.